Revise type annotations slightly #1860
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The correct type is inferred, and no other __slots__ variable in the codebase has an annotation.
A few docstrings had parts that were meant to be indented the usual four spaces beyond the surrounding indentation, but were indented only three spaces beyond it instead.
Although sometimes found unintuitive, the reutrn type of a class's __init__ method is best annotated as None, as in other functions that return implicitly or by operand-less return statements. Note that this is only a minor improvement, effectively just a style fix, because mypy treats __init__ specially and, *when at least one parameter is annotated*, its return type is implicitly None rather than implicitly Any like other functions. All the __init__ methods modified here did already have one or more annotated parameters. However, having __init__ methods without the return type makes it easier to introduce a bug where an __init__ method with no parameters besides self -- which itself should almost always be unannotated and is properly inferred -- is written and the return annotation needed to get mypy to regard it as statically typed, so it checks it at all, is omitted. (It is also inelegant when one considers the meaning of __init__ and the distinction between it and __new__.) This commit does not add any return type annotations to functions in the test suite, since the test suite doesn't currently use static typing. Further reading: - https://peps.python.org/pep-0484/#the-meaning-of-annotations - python/mypy#604 - gitpython-developers#1755 (comment)
Byron
approved these changes
Mar 5, 2024
renovate bot
added a commit
to allenporter/flux-local
that referenced
this pull request
Mar 31, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [GitPython](https://togithub.com/gitpython-developers/GitPython) | `==3.1.42` -> `==3.1.43` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>gitpython-developers/GitPython (GitPython)</summary> ### [`v3.1.43`](https://togithub.com/gitpython-developers/GitPython/releases/tag/3.1.43) [Compare Source](https://togithub.com/gitpython-developers/GitPython/compare/3.1.42...3.1.43) #### Particularly Important Changes These are likely to affect you, please do take a careful look. - Issue and test deprecation warnings by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1886 - Fix version_info cache invalidation, typing, parsing, and serialization by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1838 - Document manual refresh path treatment by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1839 - Improve static typing and docstrings related to git object types by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1859 #### Other Changes - Test in Docker with Alpine Linux on CI by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1826 - Build online docs (RTD) with -W and dependencies by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1843 - Suggest full-path refresh() in failure message by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1844 - `repo.blame` and `repo.blame_incremental` now accept `None` as the `rev` parameter. by [@​Gaubbe](https://togithub.com/Gaubbe) in [gitpython-developers/GitPython#1846 - Make sure diff always uses the default diff driver when `create_patch=True` by [@​can-taslicukur](https://togithub.com/can-taslicukur) in [gitpython-developers/GitPython#1832 - Revise docstrings, comments, and a few messages by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1850 - Expand what is included in the API Reference by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1855 - Restore building of documentation downloads by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1856 - Revise type annotations slightly by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1860 - Updating regex pattern to handle unicode whitespaces. by [@​jcole-crowdstrike](https://togithub.com/jcole-crowdstrike) in [gitpython-developers/GitPython#1853 - Use upgraded pip in test fixture virtual environment by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1864 - lint: replace `flake8` with `ruff` check by [@​Borda](https://togithub.com/Borda) in [gitpython-developers/GitPython#1862 - lint: switch Black with `ruff-format` by [@​Borda](https://togithub.com/Borda) in [gitpython-developers/GitPython#1865 - Update readme and tox.ini for recent tooling changes by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1868 - Split tox lint env into three envs, all safe by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1870 - Slightly broaden Ruff, and update and clarify tool configuration by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1871 - Add a "doc" extra for documentation build dependencies by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1872 - Describe `Submodule.__init__` parent_commit parameter by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1877 - Include TagObject in git.types.Tree_ish by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1878 - Improve Sphinx role usage, including linking Git manpages by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1879 - Replace all wildcard imports with explicit imports by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1880 - Clarify how tag objects are usually tree-ish and commit-ish by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1881 #### New Contributors - [@​Gaubbe](https://togithub.com/Gaubbe) made their first contribution in [gitpython-developers/GitPython#1846 - [@​can-taslicukur](https://togithub.com/can-taslicukur) made their first contribution in [gitpython-developers/GitPython#1832 - [@​jcole-crowdstrike](https://togithub.com/jcole-crowdstrike) made their first contribution in [gitpython-developers/GitPython#1853 - [@​Borda](https://togithub.com/Borda) made their first contribution in [gitpython-developers/GitPython#1862 **Full Changelog**: gitpython-developers/GitPython@3.1.42...3.1.43 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/allenporter/flux-local). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
lettuce-bot bot
added a commit
to lettuce-financial/github-bot-signed-commit
that referenced
this pull request
Apr 1, 2024
](https://renovatebot.com){kind=link}
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [GitPython](https://togithub.com/gitpython-developers/GitPython) | `==3.1.42` -> `==3.1.43` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>gitpython-developers/GitPython (GitPython)</summary> ### [`v3.1.43`](https://togithub.com/gitpython-developers/GitPython/releases/tag/3.1.43) [Compare Source](https://togithub.com/gitpython-developers/GitPython/compare/3.1.42...3.1.43) #### Particularly Important Changes These are likely to affect you, please do take a careful look. - Issue and test deprecation warnings by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1886 - Fix version_info cache invalidation, typing, parsing, and serialization by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1838 - Document manual refresh path treatment by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1839 - Improve static typing and docstrings related to git object types by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1859 #### Other Changes - Test in Docker with Alpine Linux on CI by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1826 - Build online docs (RTD) with -W and dependencies by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1843 - Suggest full-path refresh() in failure message by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1844 - `repo.blame` and `repo.blame_incremental` now accept `None` as the `rev` parameter. by [@​Gaubbe](https://togithub.com/Gaubbe) in [gitpython-developers/GitPython#1846 - Make sure diff always uses the default diff driver when `create_patch=True` by [@​can-taslicukur](https://togithub.com/can-taslicukur) in [gitpython-developers/GitPython#1832 - Revise docstrings, comments, and a few messages by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1850 - Expand what is included in the API Reference by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1855 - Restore building of documentation downloads by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1856 - Revise type annotations slightly by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1860 - Updating regex pattern to handle unicode whitespaces. by [@​jcole-crowdstrike](https://togithub.com/jcole-crowdstrike) in [gitpython-developers/GitPython#1853 - Use upgraded pip in test fixture virtual environment by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1864 - lint: replace `flake8` with `ruff` check by [@​Borda](https://togithub.com/Borda) in [gitpython-developers/GitPython#1862 - lint: switch Black with `ruff-format` by [@​Borda](https://togithub.com/Borda) in [gitpython-developers/GitPython#1865 - Update readme and tox.ini for recent tooling changes by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1868 - Split tox lint env into three envs, all safe by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1870 - Slightly broaden Ruff, and update and clarify tool configuration by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1871 - Add a "doc" extra for documentation build dependencies by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1872 - Describe `Submodule.__init__` parent_commit parameter by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1877 - Include TagObject in git.types.Tree_ish by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1878 - Improve Sphinx role usage, including linking Git manpages by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1879 - Replace all wildcard imports with explicit imports by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1880 - Clarify how tag objects are usually tree-ish and commit-ish by [@​EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1881 #### New Contributors - [@​Gaubbe](https://togithub.com/Gaubbe) made their first contribution in [gitpython-developers/GitPython#1846 - [@​can-taslicukur](https://togithub.com/can-taslicukur) made their first contribution in [gitpython-developers/GitPython#1832 - [@​jcole-crowdstrike](https://togithub.com/jcole-crowdstrike) made their first contribution in [gitpython-developers/GitPython#1853 - [@​Borda](https://togithub.com/Borda) made their first contribution in [gitpython-developers/GitPython#1862 **Full Changelog**: gitpython-developers/GitPython@3.1.42...3.1.43 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/lettuce-financial/github-bot-signed-commit). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request is mostly a small revision to type hints to improve a couple things I had noticed when working on #1850 but omitted from there to avoid bloating its scope:
__slots__is typically unannotated, but in once place it had an unnecessary annotation.mypytreats it the same when there are parameter annotations,__init__is best annotated with an explicit return type ofNone, per PEP 484.In addition, I noticed some slight under-indentation in a few docstrings I had worked on #1850, and fixed that here in e984bfe. (The type annotation tweaks are sufficiently minor that there is an argument to be made that this is really the most significant individual change in this pull request.)
There is some more information in the commit messages.