Merge pull request #227 from jdufresne/remove-all-warning

Remove warning when __all__ is a list

Author: Nurdok

docs/snippets/publicity.rst

@@ -25,6 +25,11 @@ a class called ``_Foo`` is considered private. A method ``bar`` in ``_Foo`` is
 also considered private since its parent is a private class, even though its
 name does not begin with a single underscore.
 
+Modules are parsed to look if ``__all__`` is defined. If so, only those top
+level constructs are considered public. The parser looks for ``__all__``
+defined as a literal list or tuple. As the parser doesn't execute the module,
+any mutation of ``__all__`` will not be considered.
+
 
 How publicity affects error reports
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -38,4 +43,4 @@ However, it is important to note that while docstring are optional for private
 construct, they are still required to adhere to your style guide. So if a
 private module `_foo.py` does not have a docstring, it will not generate a
 D100 error, but if it *does* have a docstring, that docstring might generate
-other errors.
+other errors.

src/pydocstyle/parser.py

@@ -382,18 +382,6 @@ def parse_all(self):
         self.consume(tk.OP)
         if self.current.value not in '([':
             raise AllError('Could not evaluate contents of __all__. ')
-        if self.current.value == '[':
-            sys.stdout.write(
-                "{0} WARNING: __all__ is defined as a list, this means "
-                "pydocstyle cannot reliably detect contents of the __all__ "
-                "variable, because it can be mutated. Change __all__ to be "
-                "an (immutable) tuple, to remove this warning. Note, "
-                "pydocstyle uses __all__ to detect which definitions are "
-                "public, to warn if public definitions are missing "
-                "docstrings. If __all__ is a (mutable) list, pydocstyle "
-                "cannot reliably assume its contents. pydocstyle will "
-                "proceed assuming __all__ is not mutated.\n"
-                .format(self.filename))
         self.consume(tk.OP)
 
         self.all = []

src/tests/test_definitions.py

@@ -296,3 +296,8 @@ def test_pep257(test_case):
         assert isinstance(error, Error)
     results = set([(e.definition.name, e.message) for e in results])
     assert case_module.expectation.expected == results
+
+
+def test_parser_no_warning(capsys):
+    parse(StringIO(source_alt), 'file_alt.py')
+    assert capsys.readouterr() == ('', '')