Slightly broaden Ruff, and update and clarify tool configuration #1871
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
And other .py files in doc/, if there ever were any. This may have been turned off before either for performance or out of a concern than some flake8 plugin would catch something in the docs themselves, but that's no longer an issue. The doc/build directory, which should still not be scanned, is already excluded in other ways (and does not need to be excluded for pre-commit to improve performance, since it is untracked).
This adds comments to all specific Ruff rules suppressed in pyproject.toml (most of which are global but one is for the tests only). Some already had such comments but now all do. This also harmonizes the toml formatting style with the rest of pyproject.toml.
Although it seems likely that the requirements-dev.txt file will be removed when the project definition is made declarative (discussed in gitpython-developers#1716 comments), if not before, for now it exists and might be in use, so this updates it with tools that are currently used but not listed in any extras or other requirements files: - ruff: This has replaced flake8 and its plugins (gitpython-developers#1862) as well as black (gitpython-developers#1865). Currently there is no separate extra for tooling that is not part of unit testing, with some such tools listed in test-requirements.txt. The `ruff` package belongs here rather than there for now because it should not be installed just to run unit tests, since Ruff has to be built from source on some rarer platforms like Cygwin, which would take a long time and/or fail. - shellcheck: The PyPI package for this is a convenience for installing it in projects that are already using pip (shellcheck is neither written in Python nor a tool to scan Python code). It installs pre-built binaries, which are not available for all platforms. These packages remain listed: - pytest-icdiff: This seems not to have been promoted to be in the test-requirements.txt file and the `test` extra because it does not work as well for diffs from tests that the pytest runner runs but that are written for the unittest framework. - pytest-profiling [commented out]: I am not sure what the status of this is, perhaps it has just not been experimented with enough to know if it would be useful for profiling in GitPython. This requirements-dev.txt file has a few limitations that suggest it should be removed altogether sometime soon: - It is not updated regularly. - It is not always clear why something is there. Originally I believe it was for tools where the desire to use the tool was established but the tool did not yet work or worked but performed checks for which code had to be fixed. That purpose has drifted. - It uses a different naming convention from the test-requirements.txt file in active use. - It cannot be readily used to create an extra in the current project definition in setup.py because the simple parsing done there will not recognize the `-r` lines and will not skip the comments, and neither enhancement should be done in setup.py since that would move things farther away from a declarative project definition. - It will naturally go away when the project definition is made declarative, since it will then be feasible to define as many extras as desired without proliferating separate requirements files (while still allowing their contents to be statically available to tools). Since it may go away soon and is not regularly updated, I have kept the explanations for why particular packages are there out of it. But as long as it exists it may as well list the tools that really are being used yet are not explicitly listed as dependencies.
The changes, per hook repository, are: - ruff-pre-commit: Uses the newest stable version of Ruff. See: * https://github.com/astral-sh/ruff-pre-commit/releases/tag/v0.3.2 - shellcheck-py: Makes ShellCheck installable on ARM64 Windows machines. See: * shellcheck-py/shellcheck-py@v0.9.0.5...v0.9.0.6 * shellcheck-py/shellcheck-py@e39ba22 - pre-commit-hooks: Offers no relevant changes for the few hooks currently being used from that repository, but I went ahead and included this while bumping the others. This may be a small benefit if more hooks are added from it sometime soon and because we don't currently have a mechanism for keeping track of updates that are skipped as unneeded.
Byron
approved these changes
Mar 14, 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.
Changes:
doc/source/conf.py, and other Python modules indocoutsidebuildif there were any (00ff7e3).pyproject.tomlin closer to the same style (4814775).