#250 - Added support for multi-lined config entries #281
Conversation
src/pydocstyle/config.py
Outdated
| @@ -7,9 +7,9 @@ | |||
| from re import compile as re | |||
|
|
|||
|
|
|||
| try: # Python 3.x | |||
| try: # Python 2.x | |||
| from ConfigParser import RawConfigParser | |||
There was a problem hiding this comment.
Honestly, I would just use the backport from Python 3. The Python 2 version fo ConfigParser is awful.
There was a problem hiding this comment.
@Nurdok , what say you?
There was a problem hiding this comment.
Since we crossed to chasm of package dependencies, I think you should use whichever package is best for the job, even if it adds a dependency.
src/pydocstyle/config.py
Outdated
| # Dealing with split-lined configurations. The part might begin | ||
| # with a whitespace and/or a comment marker. | ||
| part = part.strip() | ||
| if not part or part.startswith(('#', ';')): |
There was a problem hiding this comment.
For example, if you use the backport, this goes away.
| @@ -1 +1,2 @@ | |||
| snowballstemmer==1.2.1 | |||
| configparser==3.5.0 | |||
There was a problem hiding this comment.
You also need to add this to setup.py, only for Python 2.x.
src/tests/test_integration.py
Outdated
|
|
||
| select_string = ('D100,\n' | ||
| ' #D103,\n' | ||
| ' D204, D300') |
There was a problem hiding this comment.
Also add a line that has in-line comment, such as:
D301, # we want to select this
D302
setup.py
Outdated
| @@ -28,6 +28,7 @@ | |||
| install_requires=[ | |||
| 'snowballstemmer', | |||
| 'six', | |||
| 'configparser;python_version<"3.3"', | |||
There was a problem hiding this comment.
This will break on old enough versions of pip and setuptools which, if I remember correctly, is anyone using Ubuntu between 14.04 and 16.04
setup.py
Outdated
|
|
||
| # Do not update the version manually - it is managed by `bumpversion`. | ||
| version = '2.0.1rc' | ||
|
|
||
|
|
||
| REQUIRES = [ | ||
| 'snowballstemmer', |
There was a problem hiding this comment.
Indentation seems weird here.
Should be:
REQUIRES = [
'snowballstemmer',
'six',
]There was a problem hiding this comment.
Also, why is REQUIRED capital cased? It's not a constant.
src/tests/test_integration.py
Outdated
| @@ -277,6 +277,29 @@ def foo(): | |||
| assert 'file does not contain a pydocstyle section' not in err | |||
|
|
|||
|
|
|||
| def test_multiple_lined_config_file(env): | |||
| """Blah.""" | |||
| @@ -17,6 +17,7 @@ New Features | |||
| * Added support for Python 3.6 (#270). | |||
| * Specifying an invalid error code prefix (e.g., ``--select=D9``) will print | |||
| a warning message to ``stderr`` (#253, #279). | |||
| * Configuration files now support multiple-lined entries (#250, #281). | |||
There was a problem hiding this comment.
I would suggest "multiple line entries" here (not lined).
Thanks for submitting a PR!
Please make sure to check for the following items:
If you've added a 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.
Solves #250 .