Reformat codebase with the Black code formatter #877
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
akrabat
changed the title
|
Sorry, @stephenfin - looks like the python3-ification branch conflicted. |
One should generally avoid applying large, style-only changes to existing code bases because they tend to make a complete mess of our ability to use 'git-blame' and related tools effectively. With that said, the code base is in pretty bad shape owing to its sheer age and we'd otherwise be fixing this stuff manually for years. Bite the bullet and run all the code through black [1] (specifically, 'black -S', to avoid unnecessary conversion of single quotes to double quotes) to address the worst of the issues. A future change will address the remaining issues like use of wildcard imports and commented out (dead) code. Note that black defaults to a max line length of 88, not 79 [2], which means we need to configure flake8 to allow this. [1] https://pypi.org/project/black/ [2] https://black.readthedocs.io/en/stable/the_black_code_style.html Signed-off-by: Stephen Finucane <stephen@that.guru> Closes: rst2pdf#724 Closes: rst2pdf#711
|
Rebased |
|
Can we add a note to the DEVELOPERS.rst for the exactly Also, can we validate that the code is formatted correctly using Travis? |
|
My first guess on a travis check is Edit: Should we include |
|
Working on it |
Mostly end of file/whitespace fixes. Signed-off-by: Stephen Finucane <stephen@that.guru>
The pre-commit tool [1] can be used to validate black automatically before committing, saving the need to do so manually. Integrate it, initially for black and some other basic tests, with an aim to extend to flake8 and others later. Signed-off-by: Stephen Finucane <stephen@that.guru>
Nothing too funky here. This is based on what black itself does [1]. [1] https://github.com/psf/black/blob/master/.travis.yml Signed-off-by: Stephen Finucane <stephen@that.guru>
|
This is done now. I integrated pre-commit to automate the process of these locally. Let me know if anything doesn't make sense. |
akrabat
approved these changes
Jul 4, 2020
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.
Now that we've got tests passing consistently on different platforms, it's time to start fixing various bugs and closing feature gaps.
Before we do that though, we need to do something about the code style, which is in a somewhat sorry state.
While one should generally avoid applying large, style-only changes to existing code bases because they tend to make a complete mess of our ability to use 'git-blame' and related tools effectively, without this we'd otherwise be fixing this stuff manually for years.
Bite the bullet and run all the code through black [1] (specifically,
black -S, to avoid unnecessary conversion of single quotes to double quotes) to address the worst of the issues.A future change will address the remaining issues like use of wildcard imports and commented out (dead) code.
Note that black defaults to a max line length of 88, not 79 [2], which means we need to configure flake8 to allow this.
Closes: #724
Closes: #711