E704 and concise formatting for dummy implementations #3887
Comments
|
I'm not a fan of this change, but can live with it. I do agree with the removing of the new lines after a class definition here, but I don't see the benefit with overloads stated in the issue within these Abstract Base classes etc. This has made some projects I maintain require a change to line number set in tests for flake8-bugbear unittests and have set the formatting off for a chunk of bandersnatch code as I don't find it easier to read. Saving vertical space has never been a goal of black. I tend to agree with flake8's E704 here. I like not to put multiple statements on a line. But if we stick with this we will be forcing people to have to add exempting E704 in their flake8 configs on projects. This will cause CI to miss other multiple statements per line on black formatted projects if this behavior is maintained. |
cooperlees
added
F: empty lines
|
I'm a little confused by the last paragraph. E704 is something that is typically completely obviated by an autoformatter (which is e.g. why ruff doesn't implement the check). So the only "other multiple statements per line" I could see CI missing are due to disabling autoformatting (or due to bugs in Black). If someone wants multiple statements on a line between I don't expect formatting changes to be uncontroversial. But I was hopeful, since in addition to my personal preference, #1797 is fairly popular, PEP 8 itself uses this kind of formatting in a couple places, and pycodestyle also disables E704 by default. I'll update the docs, so that main is at least self-consistent. Hopefully |
Linking psf#3887
|
For what it's worth, I would find the linked bandersnatch code more readable with Black's new formatting. Fewer lines make it easier to see the whole protocol at a glance. For the same reason, we've always formatted stubs in typeshed this way. On flake8-bugbear the change is annoying because so many line numbers have to change, but that's a risk of that project's test setup. |
|
Rightio - I'll conform. |
|
We decided to keep the change. There is an open issue about updating docs related to E704. |
Black changes witnessed (mainly) include:
- addition of blank line between module docstrings and imports
- removal of blank lines between class declarations and docstrings
- prefer splitting assignment statements on right-hand side
- wrap conditional expressions that span multiple lines in parens
- put `...` in stubs on same line
- add E701 and E704 to flake8 ignore list, see:
- https://github.com/psf/black/blob/main/docs/guides/using_black_with_other_tools.md#e701--e704
- psf/black#3887 (E704)
- psf/black#4173 (E701)
Black changes witnessed (mainly) include:
- addition of blank line between module docstrings and imports
- removal of blank lines between class declarations and docstrings
- prefer splitting assignment statements on right-hand side
- wrap conditional expressions that span multiple lines in parens
- put `...` in stubs on same line
- add E701 and E704 to flake8 ignore list, see:
- https://github.com/psf/black/blob/main/docs/guides/using_black_with_other_tools.md#e701--e704
- psf/black#3887 (E704)
- psf/black#4173 (E701)
Black changes witnessed (mainly) include:
- addition of blank line between module docstrings and imports
- removal of blank lines between class declarations and docstrings
- prefer splitting assignment statements on right-hand side
- wrap conditional expressions that span multiple lines in parens
- put `...` in stubs on same line
- add E701 and E704 to flake8 ignore list, see:
- https://github.com/psf/black/blob/main/docs/guides/using_black_with_other_tools.md#e701--e704
- psf/black#3887 (E704)
- psf/black#4173 (E701)
Black changes witnessed (mainly) include:
- addition of blank line between module docstrings and imports
- removal of blank lines between class declarations and docstrings
- prefer splitting assignment statements on right-hand side
- wrap conditional expressions that span multiple lines in parens
- put `...` in stubs on same line
- add E701 and E704 to flake8 ignore list, see:
- https://github.com/psf/black/blob/main/docs/guides/using_black_with_other_tools.md#e701--e704
- psf/black#3887 (E704)
- psf/black#4173 (E701)
Black changes witnessed (mainly) include:
- addition of blank line between module docstrings and imports
- removal of blank lines between class declarations and docstrings
- prefer splitting assignment statements on right-hand side
- wrap conditional expressions that span multiple lines in parens
- put `...` in stubs on same line
- add E701 and E704 to flake8 ignore list, see:
- https://github.com/psf/black/blob/main/docs/guides/using_black_with_other_tools.md#e701--e704
- psf/black#3887 (E704)
- psf/black#4173 (E701)
This required disabling E704 in flake8. That seems to be expected: psf/black#3887
This required disabling E704 in flake8. That seems to be expected: psf/black#3887
This preview style change #3796 violates E704 as implemented by flake8 / pycodestyle.
Note that the change itself is PEP 8 compliant. E704 is disabled by default in pycodestyle for this reason. ruff intentionally does not implement E704, instead explicitly deferring to Black on this question.
At a minimum we should update https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#flake8 , but figured I'd open an issue to discuss.
The text was updated successfully, but these errors were encountered: