Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Bugfix: Allow comments before module docstring noqa codes #446

Merged
merged 10 commits into from Jul 15, 2020
Merged

Bugfix: Allow comments before module docstring noqa codes #446

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e27fa48
Allow comments before module docstring noqa codes
bsamseth Jan 9, 2020
c4a2ac1
Add a note to the release notes
bsamseth Jan 9, 2020
7ceba2b
Break after first `noqa` is encountered
bsamseth Mar 6, 2020
05ed598
Merge branch 'master' into master
bsamseth Mar 6, 2020
5231051
added integration tests for comment files
Cielquan Jun 4, 2020
98690b3
Merge branch 'master' into master
Cielquan Jun 4, 2020
eb0e39d
fixed docstring in test_comment_plus_docstring_file
Cielquan Jun 4, 2020
87a3c04
added integration tests with noqa
Cielquan Jun 4, 2020
151b6a6
Merge branch 'master' into master
samj1912 Jul 5, 2020
f2812a3
Merge branch 'master' into master
samj1912 Jul 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/release_notes.rst
View file
Open in desktop
Expand Up @@ -11,6 +11,10 @@ New Features

* Skip function arguments prefixed with `_` in D417 check (#440).

Bug Fixes

* Fixed an issue where skipping errors on module level docstring via #noqa
failed when there where more prior comments (#446).

5.0.2 - January 8th, 2020
---------------------------
Expand Down
20 changes: 14 additions & 6 deletions src/pydocstyle/parser.py
View file
Open in desktop
Expand Up @@ -576,12 +576,20 @@ def parse_definition(self, class_):
def parse_skip_comment(self):
"""Parse a definition comment for noqa skips."""
skipped_error_codes = ''
if self.current.kind == tk.COMMENT:
if 'noqa: ' in self.current.value:
skipped_error_codes = ''.join(
self.current.value.split('noqa: ')[1:])
elif self.current.value.startswith('# noqa'):
skipped_error_codes = 'all'
while self.current.kind in (tk.COMMENT, tk.NEWLINE, tk.NL):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if a file only has comments and the stream gets exhausted? Will the current.kind access lead to Type Error because of self.current being None? Can we add a test for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tried all kinds of empty files, files with only comments etc. Nothing unexpected occurs. My understanding is that if the file has only comments, this code won't be called anyway.

As for adding a test for a file with all comments, I don't see that fitting in with the current testing setup. This is because the test case files are expected to have an expectation variable defined. Can't do that in an empty file. If you want such a test, how would you go about implementing it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add an integration test https://github.com/PyCQA/pydocstyle/blob/master/src/tests/test_integration.py#L333

See above for example. You can add tests with an empty file and check that the output code is 0

Copy link
Contributor

@Cielquan Cielquan Jun 4, 2020 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added two integration tests:

  1. Test that a file with only comments does only cause a D100.
  2. Test that a file with comments and docstring does not throw an error.

@samj1912 Is this ok?

EDIT: Added two more tests but with # noaq comments which tests the fixed behavior stated in the opening post.

if self.current.kind == tk.COMMENT:
if 'noqa: ' in self.current.value:
skipped_error_codes = ''.join(
bsamseth marked this conversation as resolved.
Show resolved Hide resolved
self.current.value.split('noqa: ')[1:])
elif self.current.value.startswith('# noqa'):
skipped_error_codes = 'all'
self.stream.move()
self.log.debug("parsing comments before docstring, token is %r (%s)",
self.current.kind, self.current.value)

if skipped_error_codes:
break

return skipped_error_codes

def check_current(self, kind=None, value=None):
Expand Down
1 change: 1 addition & 0 deletions src/tests/test_cases/noqa.py
View file
Open in desktop
@@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
# noqa: D400,D415
"""Test case for "# noqa" comments"""
from .expected import Expectation
Expand Down