feat(checker): update D202 for inner functions #395
Conversation
lewisacidic
force-pushed
the
feat/D202-inner
branch
from
a7f15ed
to
8931c7f
Compare
lewisacidic
force-pushed
the
feat/D202-inner
branch
from
8931c7f
to
410d677
Compare
|
Dirty-looking change to fix the compatibility clash with I didn't take long to look through the library for a nicer way to do this, just thought I would get the ball rolling. Would be nice to have, as I have to disable D202 for our projects otherwise. |
Changes D202: "No blank lines allowed after function docstring" to
allow space below function docstrings with inner functions.
i.e. allows:
```python
def outer():
"""Valid docstring."""
def inner():
pass
return pass
```
See comment from @cdeil in PyCQA#361.
feat(checker): add test case to test_definitions
docs(changelog): add change to release notes
lewisacidic
force-pushed
the
feat/D202-inner
branch
from
410d677
to
f8b9419
Compare
| @@ -199,7 +199,9 @@ def check_no_blank_before(self, function, docstring): # def | |||
| if blanks_before_count != 0: | |||
| yield violations.D201(blanks_before_count) | |||
| if not all(blanks_after) and blanks_after_count != 0: | |||
| yield violations.D202(blanks_after_count) | |||
| def_follows = after.split("\n")[2].lstrip().startswith('def') | |||
There was a problem hiding this comment.
To allow both classes and functions and avoid including variables that have a name starting with def you could use:
re(r"\s+(?:class|def)\s").match(after)This follows how python's re module is used in this file, where re is an alias for re.compile. It would be good to add a test for the class case too.
The check docstring could use updating to reflect the allowance of a single line if it is before a class/function definition. Same goes for the violation descriptions.
|
@lewisacidic are you still working on this? I see there's not much left to do (fix the docstring at the top of |
|
Oh sorry completely forgot about this - I'm really busy until end of next week. I could come back to it then, but feel free to finish off if you want! btw sorry for brutalizing this with force pushes... |
See psf/black#709 and PyCQA/pydocstyle#395 pydocstyle v5.0.0 (and thus flake8 D202) was relaxed to accept the blank lines added by black.
|
Can this be closed with #426 merged instead? |
Changes D202: No blank lines allowed after function docstring to allow
space below function docstrings with inner functions:
i.e. allows
See comment from @cdeil in #361.
Thanks for submitting a PR!
Please make sure to check for the following items:
If you've added an error code or changed an error code behavior,
you should probably add or change a test case file under
tests/test_cases/and addit to the list under
tests/test_definitions.py.If you've added or changed a command line option,
you should probably add or change a test in
tests/test_integration.py.Make sure to include the PR number after you open and get one.
Please don't get discouraged as it may take a while to get a review.