Merge pull request #146 from Nurdok/nested-classes

Handle publicity of nested classes

Author: Nurdok

docs/release_notes.rst

@@ -9,6 +9,11 @@ New Features
 
 * Added support for Python 3.5 (#145).
 
+* Classes nested inside classes are no longer considered private. Nested
+  classes are considered public if their names are not prepended with an
+  underscore and if their parent class is public, recursively (#13, #146).
+
+
 Bug Fixes
 
 * Fixed an issue where a `NameError` was raised when parsing complex defintions

src/pep257.py

@@ -119,6 +119,7 @@ class Definition(Value):
     all = property(lambda self: self.module.all)
     _slice = property(lambda self: slice(self.start - 1, self.end))
     source = property(lambda self: ''.join(self._source[self._slice]))
+    is_class = False
 
     def __iter__(self):
         return chain([self], *self.children)
@@ -185,11 +186,16 @@ class Class(Definition):
 
     _nest = staticmethod(lambda s: {'def': Method, 'class': NestedClass}[s])
     is_public = Function.is_public
+    is_class = True
 
 
 class NestedClass(Class):
 
-    is_public = False
+    @property
+    def is_public(self):
+        return (not self.name.startswith('_') and
+                self.parent.is_class and
+                self.parent.is_public)
 
 
 class Decorator(Value):
@@ -335,9 +341,9 @@ def parse_decorators(self):
             Decorator(''.join(name), ''.join(arguments)))
 
     def parse_definitions(self, class_, all=False):
-        """Parse multiple defintions and yield them."""
+        """Parse multiple definitions and yield them."""
         while self.current is not None:
-            log.debug("parsing defintion list, current token is %r (%s)",
+            log.debug("parsing definition list, current token is %r (%s)",
                       self.current.kind, self.current.value)
             if all and self.current.value == '__all__':
                 self.parse_all()

src/tests/test_cases/nested_class.py

@@ -0,0 +1,32 @@
+"""A valid module docstring."""
+
+from .expected import Expectation
+
+expectation = Expectation()
+expect = expectation.expect
+
+expect('PublicClass', 'D101: Missing docstring in public class')
+
+
+class PublicClass(object):
+
+    expect('PublicNestedClass', 'D101: Missing docstring in public class')
+
+    class PublicNestedClass(object):
+
+        expect('PublicNestedClassInPublicNestedClass',
+               'D101: Missing docstring in public class')
+
+        class PublicNestedClassInPublicNestedClass(object):
+            pass
+
+        class _PrivateNestedClassInPublicNestedClass(object):
+            pass
+
+    class _PrivateNestedClass(object):
+
+        class PublicNestedClassInPrivateNestedClass(object):
+            pass
+
+        class _PrivateNestedClassInPrivateNestedClass(object):
+            pass

src/tests/test_definitions.py

@@ -138,7 +138,7 @@ def test_token_stream():
 
 def test_pep257():
     """Run domain-specific tests from test.py file."""
-    test_cases = ('test', 'unicode_literals')
+    test_cases = ('test', 'unicode_literals', 'nested_class')
     for test_case in test_cases:
         case_module = __import__('test_cases.{0}'.format(test_case),
                                  globals=globals(),