Split tox lint env into three envs, all safe #1870
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
This is no longer used. No pre-commit hook specifies it anymore in `stages`, since 517f83a (gitpython-developers#1865). See b059cd5 (gitpython-developers#1868) for context. In the lint.yml GitHub Actions workflow, this removes the extra_args key altogether, because all that would remain there is --all-files, which is already the default for that action, when the extra_args key is absent.
It makes sense for ruff linting and ruff autoformatting to be
easily runnable individually and to have their results be shown
separately. Splitting them out in tox.ini also makes it so tox can
do the other tests corresponding to those in lint.yml on CI in an
environment that requries no custom behavior from pre-commit other
than skipping the ruff checks.
The ruff linting ("ruff") and ruff format checking ("format") tox
environments specify ruff as a dependency and call it directly
rather than through pre-commit, invoking it in such a way that it
does not attempt to modify any files in the working tree.
See b059cd5 (gitpython-developers#1868) for context. All three of these tox envs that
"lint" has been split into are listed in the env_list and thus run
automatically when tox is run with no arguments, since no tox envs
unexpectedly (or at all) modify files in the working tree anymore.
One limitation of the current approach is that new pre-commit hooks
configured in .pre-commit-config.yml will automatically be run as
part of the "misc" tox environment, which means that new unexpected
mutating operatons could be added if the impact on tox is not
considered. The benefit of having it work this way is that most
hooks that are likely to be added to GitPython would not modify
files and would be wanted as part of "misc". But this may benefit
from further refinement.
In most other situations it is typically already colorized. This also includes comments about how to override this to suppress color.
On Unix-like systems, this approach is currently only sufficient if the TERM environment variable is set. In practice this means that if tox is run on CI, color will not be shown. Because GitPython does not itself use tox on CI, and other (e.g. downstream) projects may not want color on CI or in other situations where this would be insufficient, the further step of defining TERM as a workaround is deliberately omitted. See aeacb0 in gitpython-developers#1859 for what adding TERM would look like. This does not make any changes to how mypy runs on CI because that change is already included there.
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.
See 4c034db for details on the main changes.
This adds tox environments for both linting and format checking with Ruff, specifying Ruff as a dependency and calling it in such a way that it does not mutate files in the working tree, since one expects tox not to do that. This still has tox use pre-commit to run other hooks (which do not modify files).
Since none of these modify files, they all can and should run automatically when
toxis run with no arguments, so they are added to theenv_list(which the old lint env had been removed from in #1868, pending a change like this).With this approach taken, there is no clear use for the already-unused manual hook stage in the near future anymore, and it's easy to bring back if needed, so I've also removed that, including in the CI linting workflow.
After adding the tox envs for Ruff, I tweaked them so they would show colored output, so then I went ahead and made a similar change for mypy when run with tox. I have included that here as well, even though it is not related to Ruff. But the changes here do not cause mypy to show colored output when run in the
pythonpackage.ymlworkflow, because I ended up doing that in #1859 to help with the work there (alongside other mypy configuration improvements).