FazBrowse GitHub Viewer | Trending | | Home

Tools: [Download Repo ZIP] [Original HTTPS Page]

Improve static typing and docstrings related to git object types by EliahKagan · Pull Request #1859 · gitpython-developers/GitPython · GitHub

Improve static typing and docstrings related to git object types - #1859

Merged

Byron merged 82 commits into

gitpython-developers:mainfrom

EliahKagan:doc-types

Mar 14, 2024

Commits on Mar 3, 2024

Revise assert_never
EliahKagan
committed
f83b056
Fix unnecessarily long reference in Tree docstrings
EliahKagan
committed
01cc8e2
Change how tree[subscript] is introduced
EliahKagan
committed
6f3a20f
Refine how tree[subscript] is introduced
EliahKagan
committed
85889cd
Start adding docstrings to types in git.types
EliahKagan
committed
9e47083
Document Tree_ish, Commit_ish, and related types
EliahKagan
committed
3bd8177

Commits on Mar 4, 2024

Expand docs of classes representing Git objects
EliahKagan
committed
f3b9a69
Do a bit of tidying related to unused names
EliahKagan
committed
2af7640
Add docstrings to TypedDicts in git.types
EliahKagan
committed
2aa053e
Revise a couple new docstrings for clarity
EliahKagan
committed
15d50de
Fix possible inaccuracy in Lit_config_levels docstring
EliahKagan
committed
7166703
Use phrases like "git object type" where applicable
EliahKagan
committed
1530fd2
Add docstrings to protocols in git.types
EliahKagan
committed
2e02b09
Move our PathLike below even TYPE_CHECKING imports
EliahKagan
committed
012d710
Remove commented-out is_config_level function
EliahKagan
committed
a06f1fc
Expand git.compat docstring
EliahKagan
committed
c93e431
Add a cationary note about Object vs. object
EliahKagan
committed
29443ce
Don't bind unused _assertion_msg_format
EliahKagan
committed
b6e3ad2

Commits on Mar 6, 2024

Remove commented-out code
EliahKagan
committed
b5d9198

Commits on Mar 7, 2024

Fix Sphinx reference that rendered overly long
EliahKagan
committed
2212ac9
Simplify _safer_popen_windows "if shell" logic
EliahKagan
committed
3c5ca52
Annotate safer_popen broad enough for all platforms
EliahKagan
committed
43b7f8a
Fix mypy error with creationflags in subprocess module
EliahKagan
committed
dc95a76
Refactor kill_after_timeout logic so mypy can check it
EliahKagan
committed
4191f7d
Factor communicate and watchdog logic to helper
EliahKagan
committed
1ef3365
Fix new mypy confusion about kill_after_timeout type
EliahKagan
committed
4083dd8
Fix how Diffable annotates expected repo attribute
EliahKagan
committed
3aeef46

Commits on Mar 8, 2024

Fix how HEAD annotates inherited commit property
EliahKagan
committed
f1cc1fe
Broaden cygpath parameter annotation
EliahKagan
committed
e133018
Have Repo.__init__ convert epath to str first instead
EliahKagan
committed
c34a466
Fix how Remote annotates dynamic config-backed url attribute
EliahKagan
committed
4dfd480
Drop wrong variable annotations in BlobFilter.__call__
EliahKagan
committed
e4fd2e3
Clarify CallableProgress vs. CallableRemoteProgress
EliahKagan
committed
94344b4
Fix RootModule.update `ignore[override]` suppression
EliahKagan
committed
8e8b87a
Fix wrong class name in git.objects.tag docstring
EliahKagan
committed
1cdec7a
Correct and clarify Diffable.diff docstring
EliahKagan
committed
ed6ead9

Commits on Mar 9, 2024

Start fixing diff and _process_diff_args type annotations
EliahKagan
committed
0e1df29
Consolidate str and os.PathLike[str] (use GitPython's PathLike)
EliahKagan
committed
62c0823
Further clarify Diffable.diff docstring
EliahKagan
committed
7204cc1
Annotate _process_diff_args without Diffable.Index
EliahKagan
committed
2f5e258
Make NULL_TREE and Index precisely annotatable
EliahKagan
committed
65863a2
Fix Sphinx references; give Diffable.Index a docstring
EliahKagan
committed
c9952e1
Modify annotations to accommodate NULL_TREE
EliahKagan
committed
b8a25df
Add refresh to top-level __all__
EliahKagan
committed
e49327d
Deprecate public access to typing imports in git
EliahKagan
committed
c8ad3a3
Mention collections.abc for Sequence
EliahKagan
committed
3c8cbe9
Add INDEX and DiffConstants to git.__all__
EliahKagan
committed
87b314e
Adjust mypy options to work well with mypy 1.9.0
EliahKagan
committed
9ed904c
Colorize mypy output on CI for easier reading
EliahKagan
committed
aeacb00

Commits on Mar 10, 2024

Remove some unneeded mypy suppressions
EliahKagan
committed
84fc806
Drop deprecated mypy option
EliahKagan
committed
96ecc2e
Apply intended suppression in Tree.traverse
EliahKagan
committed
97d9b65
Spell self.Index as self.INDEX in IndexFile.diff
EliahKagan
committed
ad00c77
Test that redefined Diffable.Index should be compatible
EliahKagan
committed
2decbe4
Have git module use sys.platform to check for Windows
EliahKagan
committed
88557bc
Fix new mypy error in _read_win_env_flag
EliahKagan
committed
7204c13
Fix new mypy error in is_cygwin_git
EliahKagan
committed
42e10c0
Have test suite use sys.platform to check for Windows
EliahKagan
committed
465ab56
Wrap docstrings and comments in _safer_popen_windows
EliahKagan
committed
ad8190b
Further improve _safer_popen_windows doc
EliahKagan
committed
b9d9e56
Temporarily rename Commit_ish to Old_commit_ish
EliahKagan
committed
04a2753
Define and document AnyGitObject and (new) Commit_ish
EliahKagan
committed
787f65c
Define GitObjectTypeString and update Object to use it
EliahKagan
committed
1fe4dc8
Start fixing annotations that used the old Commit_ish
EliahKagan
committed
7328a00
Fix some annotations in git.repo.fun
EliahKagan
committed
191f4cf
Remove extra `parents` param in Commit.__init__ docstring
EliahKagan
committed
d1ce940

Commits on Mar 11, 2024

Help tools know the type of a Commit's `parents`
EliahKagan
committed
fe42ca7
Keep the type of a Commit's `parents` from being too narrow
EliahKagan
committed
e66297a
Fix remaining old Commit_ish annotations in git.repo.fun
EliahKagan
committed
fe7f9f2
Fix remaining old Commit_ish annotations in git.refs
EliahKagan
committed
ab27827
Fix IndexFile.commit `parent_commits` annotation
EliahKagan
committed
b4b6e1e
Fix old Commit_ish annotations in git.remote
EliahKagan
committed
5b2869f

Commits on Mar 14, 2024

Start on fixing Submodule parent_commit annotations
EliahKagan
committed
1541c62
Fix other submodule.base parent_commit annotations
EliahKagan
committed
1f03e7f
Fix old Commit_ish annotation in RootModule
EliahKagan
committed
e66b8f1
Remove the temporary Old_commit_ish type
EliahKagan
committed
93d19dc
Fix and deprecate Lit_commit_ish
EliahKagan
committed
ebcfced
Make some broad mypy suppressions more specific
EliahKagan
committed
b070e93
Merge branch 'main' into doc-types
EliahKagan
committed
0b99041
Apply Ruff auto-fixes not included in merge
EliahKagan
committed
011cb0a
Help Ruff avoid a very long line
EliahKagan
committed
74f3c2e
Use LBYL for imports where EAFP is a mypy type error
EliahKagan
committed
5778b7a

Back | FazBrowse Home | New Git URL