Enable black, isort, and doc formatters and checks #774
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
1. Temporarily avoid recent asyncssh version that breaks the tests 2. Workaround pylance issue with pyproject.toml related changes and pip editable modules install format (microsoft#768) See Also: - microsoft/pylance-release#3473 May also affect `mypy`: - python/mypy#16988 - python/mypy#12313
bpkroth
force-pushed
the
enable-black-isort-reformatting
branch
from
2ec2f39
to
b17696b
Compare
bpkroth
changed the title
motus
approved these changes
Jul 12, 2024
bpkroth
added a commit
that referenced
this pull request
Jul 15, 2024
Follow-on work to #774, this PR uses a [`.git-blame-ignore-revs` file](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view) to ignore revs that cause major reformatting changes in git blame view.
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.
Follow on work to #766.
This enabled both formatters and applies their changes to the repo.
Additionally, since
blackdoes not make changes to comments nor docstrings, we also enabledocformatterto reformat docstrings which better aligns withpydocstylerules as well.Without this additional change (and some manual fixups),
pycodestyleandpylintwould still complain about line lengths, for instance.Finally, we make a minor adjustment to the max line length setting it to 99 (which is also accepted and mentioned in pep8) instead of 88 to avoid some comment (especially linter overrides) wrapping.