Fix documentation and cleaner style

Author: larsoner

docs/release_notes.rst

@@ -10,6 +10,7 @@ Current Development Version
 Major Updates
 
 * Support for Python 2.6 has been dropped (#206, #217).
+* Decorator-based skipping via ``--ignore-decorators`` has been added (#204).
 
 1.1.1 - October 4th, 2016
 -------------------------

docs/snippets/cli.rst

@@ -36,6 +36,11 @@ Usage
                             search only dirs that exactly match <pattern> regular
                             expression; default is --match-dir='[^\.].*', which
                             matches all dirs that don't start with a dot
+      --ignore-decorators=<decorators>
+                            ignore any functions or methods that are decorated by
+                            a function with a name fitting the <decorators>
+                            regular expression; default is --ignore-decorators=''
+                            which does not ignore any decorated functions.
 
 
 Return Code

src/pydocstyle/checker.py

@@ -9,7 +9,6 @@
 
 from . import violations
 from .config import IllegalConfiguration
-# TODO: handle
 from .parser import (Package, Module, Class, NestedClass, Definition, AllError,
                      Method, Function, NestedFunction, Parser, StringIO)
 from .utils import log, is_blank
@@ -50,10 +49,11 @@ def check_source(self, source, filename, ignore_decorators):
             for this_check in self.checks:
                 terminate = False
                 if isinstance(definition, this_check._check_for):
-                    if definition.skipped_error_codes != 'all' and \
-                            not any(ignore_decorators is not None and
-                                    len(ignore_decorators.findall(dec.name))
-                                    for dec in definition.decorators):
+                    skipping_all = (definition.skipped_error_codes == 'all')
+                    decorator_skip = ignore_decorators is not None and any(
+                        len(ignore_decorators.findall(dec.name)) > 0
+                        for dec in definition.decorators)
+                    if not skipping_all and not decorator_skip:
                         error = this_check(None, definition,
                                            definition.docstring)
                     else:

src/pydocstyle/config.py

@@ -114,7 +114,7 @@ def parse(self):
 
         self._run_conf = self._create_run_config(self._options)
 
-        config = self._create_check_config(self._options, use_dafaults=False)
+        config = self._create_check_config(self._options, use_defaults=False)
         self._override_by_cli = config
 
     @check_initialized
@@ -141,7 +141,7 @@ def _get_matches(config):
             match_dir_func = re(config.match_dir + '$').match
             return match_func, match_dir_func
 
-        def _get_ignore_dec(config):
+        def _get_ignore_decorators(config):
             """Return the `ignore_decorators` as None or regex."""
             if config.ignore_decorators:  # not None and not ''
                 ignore_decorators = re(config.ignore_decorators)
@@ -154,7 +154,7 @@ def _get_ignore_dec(config):
                 for root, dirs, filenames in os.walk(name):
                     config = self._get_config(root)
                     match, match_dir = _get_matches(config)
-                    ignore_dec = _get_ignore_dec(config)
+                    ignore_decorators = _get_ignore_decorators(config)
 
                     # Skip any dirs that do not match match_dir
                     dirs[:] = [dir for dir in dirs if match_dir(dir)]
@@ -163,13 +163,13 @@ def _get_ignore_dec(config):
                         if match(filename):
                             full_path = os.path.join(root, filename)
                             yield (full_path, list(config.checked_codes),
-                                   ignore_dec)
+                                   ignore_decorators)
             else:
                 config = self._get_config(name)
                 match, _ = _get_matches(config)
-                ignore_dec = _get_ignore_dec(config)
+                ignore_decorators = _get_ignore_decorators(config)
                 if match(name):
-                    yield (name, list(config.checked_codes), ignore_dec)
+                    yield (name, list(config.checked_codes), ignore_decorators)
 
     # --------------------------- Private Methods -----------------------------
 
@@ -313,9 +313,8 @@ def _merge_configuration(self, parent_config, child_options):
 
         kwargs = dict(checked_codes=error_codes)
         for key in ('match', 'match_dir', 'ignore_decorators'):
-            kwargs[key] = getattr(child_options, key) \
-                if getattr(child_options, key) is not None \
-                else getattr(parent_config, key)
+            kwargs[key] = \
+                getattr(child_options, key) or getattr(parent_config, key)
         return CheckConfiguration(**kwargs)
 
     def _parse_args(self, args=None, values=None):
@@ -331,23 +330,23 @@ def _create_run_config(options):
         return RunConfiguration(**values)
 
     @classmethod
-    def _create_check_config(cls, options, use_dafaults=True):
+    def _create_check_config(cls, options, use_defaults=True):
         """Create a `CheckConfiguration` object from `options`.
 
-        If `use_dafaults`, any of the match options that are `None` will
+        If `use_defaults`, any of the match options that are `None` will
         be replaced with their default value and the default convention will be
         set for the checked codes.
 
         """
         checked_codes = None
 
-        if cls._has_exclusive_option(options) or use_dafaults:
+        if cls._has_exclusive_option(options) or use_defaults:
             checked_codes = cls._get_checked_errors(options)
 
         kwargs = dict(checked_codes=checked_codes)
         for key in ('match', 'match_dir', 'ignore_decorators'):
             kwargs[key] = getattr(cls, 'DEFAULT_{0}_RE'.format(key.upper())) \
-                if getattr(options, key) is None and use_dafaults \
+                if getattr(options, key) is None and use_defaults \
                 else getattr(options, key)
         return CheckConfiguration(**kwargs)
 
@@ -530,7 +529,7 @@ def _create_option_parser(cls):
                help=("ignore any functions or methods that are decorated "
                      "by a function with a name fitting the <decorators> "
                      "regular expression; default is --ignore-decorators='{0}'"
-                     "which does not ignore any decorated functions."
+                     " which does not ignore any decorated functions."
                      .format(cls.DEFAULT_IGNORE_DECORATORS_RE)))
         return parser