Format tests with black and auto-exclude untracked paths #1668

EliahKagan · 2023-09-19T14:28:14Z

This expands the use of black to cover the whole codebase (still excluding submodules).

Replaced exclude with extend-exclude so black's default exclusions, which include anything specified in .gitignore, remain in effect as well as the specific path(s) specified to be excluded. This allows black . to be run to format everything that should be formatted and nothing that shouldn't.
Made a few manual formatting adjustments that lead to more readable code in a few places once formatted with black. (This does not have to be redone; the idea is to be in the common subset of what was intended and what black considers its style.)
Changed black git to black . in the instructions in README.md and in the command in tox.ini that runs via tox or tox -e black.
Actually ran black ., formatting the tests in black style.

This replaces "exclude" with "extend-exclude" in the black configuration, so that it keeps its default exclusions, of which all directories listed in .gitignore are automatically a part. That makes it possible to run "black ." to format just the files that should be formatted (git/ files, test/ files, and setup.py), while automatically omitting .venv/, .tox/, build/, and so on. This commit does not change how black is run yet, it just fixes the way its exclusions are configured.

This adds a trailing "," in a few multi-line function calls in test/, where putting one argument per line was intended and is clearer. This is so that when black is run over test/, it recognizes the form and avoids collapsing it.

This changes the documentation in README.md to recommend running "black ." and changes the command to that in tox.ini, so that more paths are covered (in practice, test/ and setup.py).

This actually runs black on the whole project, but the only changes are in test/ (as expected).

Byron

Thanks a lot, looks good to me.

It's interesting to see that the rest of the project apparently is formatted with it already, I wasn't aware.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [GitPython](https://togithub.com/gitpython-developers/GitPython) | `==3.1.36` -> `==3.1.37` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/GitPython/3.1.37?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/GitPython/3.1.37?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/GitPython/3.1.36/3.1.37?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/GitPython/3.1.36/3.1.37?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>gitpython-developers/GitPython (GitPython)</summary> ### [`v3.1.37`](https://togithub.com/gitpython-developers/GitPython/releases/tag/3.1.37): - a proper fix CVE-2023-41040 [Compare Source](https://togithub.com/gitpython-developers/GitPython/compare/3.1.36...3.1.37) #### What's Changed - Improve Python version and OS compatibility, fixing deprecations by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1654 - Better document env_case test/fixture and cwd by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1657 - Remove spurious executable permissions by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1658 - Fix up checks in Makefile and make them portable by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1661 - Fix URLs that were redirecting to another license by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1662 - Assorted small fixes/improvements to root dir docs by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1663 - Use venv instead of virtualenv in test_installation by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1664 - Omit py_modules in setup by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1665 - Don't track code coverage temporary files by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1666 - Configure tox by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1667 - Format tests with black and auto-exclude untracked paths by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1668 - Upgrade and broaden flake8, fixing style problems and bugs by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1673 - Fix rollback bug in SymbolicReference.set_reference by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1675 - Remove `@NoEffect` annotations by [@EliahKagan](https://togithub.com/EliahKagan) in [gitpython-developers/GitPython#1677 - Add more checks for the validity of refnames by [@facutuesca](https://togithub.com/facutuesca) in [gitpython-developers/GitPython#1672 **Full Changelog**: gitpython-developers/GitPython@3.1.36...3.1.37 </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. --- - [ ] 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).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

@NoEffect

Bump gitpython from 3.1.35 to 3.1.37 Bumps gitpython from 3.1.35 to 3.1.37. Release notes Sourced from gitpython's releases. 3.1.37 - a proper fix CVE-2023-41040 What's Changed Improve Python version and OS compatibility, fixing deprecations by @EliahKagan in gitpython-developers/GitPython#1654 Better document env_case test/fixture and cwd by @EliahKagan in gitpython-developers/GitPython#1657 Remove spurious executable permissions by @EliahKagan in gitpython-developers/GitPython#1658 Fix up checks in Makefile and make them portable by @EliahKagan in gitpython-developers/GitPython#1661 Fix URLs that were redirecting to another license by @EliahKagan in gitpython-developers/GitPython#1662 Assorted small fixes/improvements to root dir docs by @EliahKagan in gitpython-developers/GitPython#1663 Use venv instead of virtualenv in test_installation by @EliahKagan in gitpython-developers/GitPython#1664 Omit py_modules in setup by @EliahKagan in gitpython-developers/GitPython#1665 Don't track code coverage temporary files by @EliahKagan in gitpython-developers/GitPython#1666 Configure tox by @EliahKagan in gitpython-developers/GitPython#1667 Format tests with black and auto-exclude untracked paths by @EliahKagan in gitpython-developers/GitPython#1668 Upgrade and broaden flake8, fixing style problems and bugs by @EliahKagan in gitpython-developers/GitPython#1673 Fix rollback bug in SymbolicReference.set_reference by @EliahKagan in gitpython-developers/GitPython#1675 Remove @NoEffect annotations by @EliahKagan in gitpython-developers/GitPython#1677 Add more checks for the validity of refnames by @facutuesca in gitpython-developers/GitPython#1672 Full Changelog: gitpython-developers/GitPython@3.1.36...3.1.37 Commits b27a89f fix makefile to compare commit hashes only 0bd2890 prepare next release 832b6ee remove unnecessary list comprehension to fix CI e98f57b Merge pull request #1672 from trail-of-forks/robust-refname-checks 1774f1e Merge pull request #1677 from EliahKagan/no-noeffect a4701a0 Remove @NoEffect annotations d40320b Merge pull request #1675 from EliahKagan/rollback d1c1f31 Merge pull request #1673 from EliahKagan/flake8 e480985 Tweak rollback logic in log.to_file ff84b26 Refactor try-finally cleanup in git/ Additional commits viewable in compare view Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase. Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: @dependabot rebase will rebase this PR @dependabot recreate will recreate this PR, overwriting any edits that have been made to it @dependabot merge will merge this PR after your CI passes on it @dependabot squash and merge will squash and merge this PR after your CI passes on it @dependabot cancel merge will cancel a previously requested merge and block automerging @dependabot reopen will reopen this PR if it is closed @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page. Reviewed-by: Vladimir Vshivkov

EliahKagan added 4 commits September 19, 2023 09:06

Small manual formatting improvements

e39ecb7

This adds a trailing "," in a few multi-line function calls in test/, where putting one argument per line was intended and is clearer. This is so that when black is run over test/, it recognizes the form and avoids collapsing it.

Don't limit black to git/

288cf03

This changes the documentation in README.md to recommend running "black ." and changes the command to that in tox.ini, so that more paths are covered (in practice, test/ and setup.py).

Reformat tests with black

15c736d

This actually runs black on the whole project, but the only changes are in test/ (as expected).

EliahKagan marked this pull request as ready for review September 19, 2023 14:29

EliahKagan mentioned this pull request Sep 19, 2023

Configure tox #1667

Merged

Byron approved these changes Sep 20, 2023

View reviewed changes

Byron merged commit a5a6464 into gitpython-developers:main Sep 20, 2023
8 checks passed

EliahKagan deleted the black branch September 20, 2023 05:32

Byron added this to the v3.1.37 - Bugfixes milestone Sep 21, 2023

EliahKagan mentioned this pull request Nov 2, 2023

Revise comments, docstrings, some messages, and a bit of code #1725

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format tests with black and auto-exclude untracked paths #1668

Format tests with black and auto-exclude untracked paths #1668

EliahKagan commented Sep 19, 2023 •

edited

Byron left a comment

Format tests with black and auto-exclude untracked paths #1668

Format tests with black and auto-exclude untracked paths #1668

Conversation

EliahKagan commented Sep 19, 2023 • edited

Byron left a comment

Choose a reason for hiding this comment

EliahKagan commented Sep 19, 2023 •

edited