If a module starts with a single leading underscore, it is considered private.

Author: Nurdok

src/pydocstyle/parser.py

@@ -103,11 +103,14 @@ class Module(Definition):
     _fields = ('name', '_source', 'start', 'end', 'decorators', 'docstring',
                'children', 'parent', '_all', 'future_imports',
                'skipped_error_codes')
-    is_public = True
     _nest = staticmethod(lambda s: {'def': Function, 'class': Class}[s])
     module = property(lambda self: self)
     all = property(lambda self: self._all)
 
+    @property
+    def is_public(self):
+        return not self.name.startswith('_') or self.name.startswith('__')
+
     def __str__(self):
         return 'at module level'
 

src/tests/parser_test.py

@@ -276,3 +276,18 @@ def test_raise_from():
     parser = Parser()
     code = CodeSnippet("raise ValueError() from None")
     parser.parse(code, 'file_path')
+
+
+def test_module_publicity():
+    """Test that a module that has a single leading underscore is private."""
+    parser = Parser()
+    code = CodeSnippet("")
+
+    module = parser.parse(code, "filepath")
+    assert module.is_public
+
+    module = parser.parse(code, "_filepath")
+    assert not module.is_public
+
+    module = parser.parse(code, "__filepath")
+    assert module.is_public