Slightly broaden Ruff, and update and clarify tool configuration #1871

EliahKagan · 2024-03-13T18:26:49Z

Changes:

Lets Ruff scan doc/source/conf.py, and other Python modules in doc outside build if there were any (00ff7e3).
Adds comments on all suppressed Ruff rules and puts all of pyproject.toml in closer to the same style (4814775).
Adds Ruff (and ShellCheck, which could've been added before) to the file currently used to list tools not listed as dependencies (a8a73ff).
Bumps pre-commit hook versions, which brings small benefits for Ruff and ShellCheck (ff1ebf8).

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

Thanks a lot for this improvement!

EliahKagan added 4 commits March 13, 2024 13:34

EliahKagan marked this pull request as ready for review March 13, 2024 18:27

EliahKagan marked this pull request as draft March 13, 2024 19:15

EliahKagan force-pushed the ruff branch from ff1ebf8 to 00ff7e3 Compare March 13, 2024 19:16

EliahKagan marked this pull request as ready for review March 13, 2024 19:17

Byron approved these changes Mar 14, 2024

View reviewed changes

Byron merged commit fc669cc into gitpython-developers:main Mar 14, 2024
51 checks passed

EliahKagan deleted the ruff branch March 14, 2024 09:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Slightly broaden Ruff, and update and clarify tool configuration #1871

Slightly broaden Ruff, and update and clarify tool configuration #1871

EliahKagan commented Mar 13, 2024 •

edited

Loading

Byron left a comment

Slightly broaden Ruff, and update and clarify tool configuration #1871

Slightly broaden Ruff, and update and clarify tool configuration #1871

Conversation

EliahKagan commented Mar 13, 2024 • edited Loading

Byron left a comment

Choose a reason for hiding this comment

EliahKagan commented Mar 13, 2024 •

edited

Loading