Merge remote-tracking branch 'PyCQA/master'

Author: Nurdok

docs/release_notes.rst

@@ -16,6 +16,7 @@ Major Updates
 New Features
 
 * Decorator-based skipping via ``--ignore-decorators`` has been added (#204).
+* Support for using pycodestyle style wildcards has been added (#72, #209).
 
 Bug Fixes
 

docs/snippets/cli.rst

@@ -17,11 +17,12 @@ Usage
       --count               print total number of errors to stdout
       --select=<codes>      choose the basic list of checked errors by specifying
                             which errors to check for (with a list of comma-
-                            separated error codes). for example:
-                            --select=D101,D202
+                            separated error codes or prefixes). for example:
+                            --select=D101,D2
       --ignore=<codes>      choose the basic list of checked errors by specifying
                             which errors to ignore (with a list of comma-separated
-                            error codes). for example: --ignore=D101,D202
+                            error codes or prefixes). for example:
+                            --ignore=D101,D2
       --convention=<name>   choose the basic list of checked errors by specifying
                             an existing convention. Possible conventions: pep257
       --add-select=<codes>  amend the list of errors to check for by specifying
@@ -42,6 +43,14 @@ Usage
                             regular expression; default is --ignore-decorators=''
                             which does not ignore any decorated functions.
 
+.. note::
+
+    When using any of the ``--select``, ``--ignore``, ``--add-select``, or
+    ``--add-ignore`` command line flags, it is possible to pass a prefix for an
+    error code. It will be expanded so that any code begining with that prefix
+    will match. For example, running the command ``pydocstyle --ignore=D4``
+    will ignore all docstring content issues as their error codes begining with
+    "D4" (i.e. D400, D401, D402, D403, and D404).
 
 Return Code
 ^^^^^^^^^^^

src/pydocstyle/config.py

@@ -375,27 +375,47 @@ def _get_config_file_in_folder(cls, path):
             if config.read(full_path) and cls._get_section_name(config):
                 return full_path
 
-    @staticmethod
-    def _get_exclusive_error_codes(options):
+    @classmethod
+    def _get_exclusive_error_codes(cls, options):
         """Extract the error codes from the selected exclusive option."""
         codes = set(ErrorRegistry.get_error_codes())
         checked_codes = None
 
         if options.ignore is not None:
-            checked_codes = codes - options.ignore
+            ignored = cls._expand_error_codes(options.ignore)
+            checked_codes = codes - ignored
         elif options.select is not None:
-            checked_codes = options.select
+            checked_codes = cls._expand_error_codes(options.select)
         elif options.convention is not None:
             checked_codes = getattr(conventions, options.convention)
 
         # To not override the conventions nor the options - copy them.
         return copy.deepcopy(checked_codes)
 
-    @staticmethod
-    def _set_add_options(checked_codes, options):
+    @classmethod
+    def _set_add_options(cls, checked_codes, options):
         """Set `checked_codes` by the `add_ignore` or `add_select` options."""
-        checked_codes |= options.add_select
-        checked_codes -= options.add_ignore
+        checked_codes |= cls._expand_error_codes(options.add_select)
+        checked_codes -= cls._expand_error_codes(options.add_ignore)
+
+    @staticmethod
+    def _expand_error_codes(code_parts):
+        """Return an expanded set of error codes to ignore."""
+        codes = set(ErrorRegistry.get_error_codes())
+        expanded_codes = set()
+
+        try:
+            for part in code_parts:
+                if len(part) < 4:
+                    for code in codes:
+                        if code.startswith(part):
+                            expanded_codes.add(code)
+                else:
+                    expanded_codes.add(part)
+        except TypeError as e:
+            raise IllegalConfiguration(e)
+
+        return expanded_codes
 
     @classmethod
     def _get_checked_errors(cls, options):
@@ -494,13 +514,13 @@ def _create_option_parser(cls):
         option('--select', metavar='<codes>', default=None,
                help='choose the basic list of checked errors by '
                     'specifying which errors to check for (with a list of '
-                    'comma-separated error codes). '
-                    'for example: --select=D101,D202')
+                    'comma-separated error codes or prefixes). '
+                    'for example: --select=D101,D2')
         option('--ignore', metavar='<codes>', default=None,
                help='choose the basic list of checked errors by '
                     'specifying which errors to ignore (with a list of '
-                    'comma-separated error codes). '
-                    'for example: --ignore=D101,D202')
+                    'comma-separated error codes or prefixes). '
+                    'for example: --ignore=D101,D2')
         option('--convention', metavar='<name>', default=None,
                help='choose the basic list of checked errors by specifying an '
                     'existing convention. Possible conventions: {}'

src/tests/test_integration.py

@@ -233,6 +233,12 @@ def foo():
     assert 'D100' not in out
     assert 'D103' not in out
 
+    env.write_config(ignore='D10')
+    _, err, code = env.invoke()
+    assert code == 0
+    assert 'D100' not in err
+    assert 'D103' not in err
+
 
 def test_verbose(env):
     """Test that passing --verbose prints more information."""
@@ -282,14 +288,17 @@ def test_select_config(env):
     """Test choosing error codes with `select` in the config file."""
     with env.open('example.py', 'wt') as example:
         example.write(textwrap.dedent("""\
-            def foo():
-                pass
+            class Foo(object):
+                "Doc string"
+                def foo():
+                    pass
         """))
 
-    env.write_config(select="D100")
+    env.write_config(select="D100,D3")
     out, err, code = env.invoke()
     assert code == 1
     assert 'D100' in out
+    assert 'D300' in out
     assert 'D103' not in out
 
 
@@ -298,15 +307,17 @@ def test_add_select_cli(env):
     with env.open('example.py', 'wt') as example:
         example.write(textwrap.dedent("""\
             class Foo(object):
+                "Doc string"
                 def foo():
                     pass
         """))
 
     env.write_config(select="D100")
-    out, err, code = env.invoke(args="--add-select=D101")
+    out, err, code = env.invoke(args="--add-select=D204,D3")
     assert code == 1
     assert 'D100' in out
-    assert 'D101' in out
+    assert 'D204' in out
+    assert 'D300' in out
     assert 'D103' not in out
 
 
@@ -327,6 +338,41 @@ def foo():
     assert 'D103' not in out
 
 
+def test_wildcard_add_ignore_cli(env):
+    """Test choosing error codes with --add-ignore in the CLI."""
+    with env.open('example.py', 'wt') as example:
+        example.write(textwrap.dedent("""\
+            class Foo(object):
+                "Doc string"
+                def foo():
+                    pass
+        """))
+
+    env.write_config(select="D203,D300")
+    out, err, code = env.invoke(args="--add-ignore=D30")
+    assert code == 1
+    assert 'D203' in out
+    assert 'D300' not in out
+
+
+def test_bad_wildcard_add_ignore_cli(env):
+    """Test adding a non-existent error codes with --add-ignore."""
+    with env.open('example.py', 'wt') as example:
+        example.write(textwrap.dedent("""\
+            class Foo(object):
+                "Doc string"
+                def foo():
+                    pass
+        """))
+
+    env.write_config(select="D203,D300")
+    out, err, code = env.invoke(args="--add-ignore=D3004")
+    assert code == 1
+    assert 'D203' in out
+    assert 'D300' in out
+    assert 'D3034' not in out
+
+
 def test_conflicting_select_ignore_config(env):
     """Test that select and ignore are mutually exclusive."""
     env.write_config(select="D100", ignore="D101")