Add test cases for global exclusion pre-commit option.

Author: stefmolin

numpydoc/tests/hooks/example_module.py

@@ -28,3 +28,7 @@ def do_something(self, *args, **kwargs):
     def process(self):
         """Process stuff."""
         pass
+
+
+class NewClass:
+    pass

numpydoc/tests/hooks/test_validate_hook.py

@@ -67,6 +67,8 @@ def test_validate_hook(example_module, config, capsys):
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
         | numpydoc/tests/hooks/example_module.py:28 | example_module.MyClass.process      | EX01    | No examples section found                          |
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass             | GL08    | The object does not have a docstring               |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
         """
     )
 
@@ -102,6 +104,8 @@ def test_validate_hook_with_ignore(example_module, capsys):
         |                                           |                                     |         | person (e.g. use "Generate" instead of             |
         |                                           |                                     |         | "Generates")                                       |
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass             | GL08    | The object does not have a docstring               |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
         """
     )
 
@@ -144,6 +148,8 @@ def test_validate_hook_with_toml_config(example_module, tmp_path, capsys):
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
         | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07    | Parameter "*args" has no description   |
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass             | GL08    | The object does not have a docstring   |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
         """
     )
 
@@ -181,6 +187,8 @@ def test_validate_hook_with_setup_cfg(example_module, tmp_path, capsys):
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
         | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07    | Parameter "*args" has no description   |
         +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass             | GL08    | The object does not have a docstring   |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
         """
     )
 
@@ -199,3 +207,84 @@ def test_validate_hook_help(capsys):
     out = capsys.readouterr().out
     assert "--ignore" in out
     assert "--config" in out
+
+
+def test_validate_hook_exclude_option_pyproject(example_module, tmp_path, capsys):
+    """
+    Test that a file is correctly processed with the config coming from
+    a pyproject.toml file and exclusions provided.
+    """
+
+    with open(tmp_path / "pyproject.toml", "w") as config_file:
+        config_file.write(
+            inspect.cleandoc(
+                r"""
+                [tool.numpydoc_validation]
+                checks = [
+                    "all",
+                    "EX01",
+                    "SA01",
+                    "ES01",
+                ]
+                override_SS05 = '^((Process|Assess|Access) )'
+                exclude = [
+                    '\.do_something$',
+                    '\.__init__$',
+                ]
+                """
+            )
+        )
+
+    expected = inspect.cleandoc(
+        """
+        +-------------------------------------------+------------------------------+---------+--------------------------------------+
+        | file                                      | item                         | check   | description                          |
+        +===========================================+==============================+=========+======================================+
+        | numpydoc/tests/hooks/example_module.py:4  | example_module.some_function | PR01    | Parameters {'name'} not documented   |
+        +-------------------------------------------+------------------------------+---------+--------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass      | GL08    | The object does not have a docstring |
+        +-------------------------------------------+------------------------------+---------+--------------------------------------+
+        """
+    )
+
+    return_code = main([example_module, "--config", str(tmp_path)])
+    assert return_code == 1
+    assert capsys.readouterr().err.rstrip() == expected
+
+
+def test_validate_hook_exclude_option_setup_cfg(example_module, tmp_path, capsys):
+    """
+    Test that a file is correctly processed with the config coming from
+    a setup.cfg file and exclusions provided.
+    """
+
+    with open(tmp_path / "setup.cfg", "w") as config_file:
+        config_file.write(
+            inspect.cleandoc(
+                """
+                [tool:numpydoc_validation]
+                checks = all,EX01,SA01,ES01
+                override_SS05 = ^((Process|Assess|Access) )
+                override_GL08 = ^(__init__)$
+                exclude = \\.NewClass$,
+                """
+            )
+        )
+
+    expected = inspect.cleandoc(
+        """
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
+        | file                                      | item                                | check   | description                            |
+        +===========================================+=====================================+=========+========================================+
+        | numpydoc/tests/hooks/example_module.py:4  | example_module.some_function        | PR01    | Parameters {'name'} not documented     |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR01    | Parameters {'**kwargs'} not documented |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
+        | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07    | Parameter "*args" has no description   |
+        +-------------------------------------------+-------------------------------------+---------+----------------------------------------+
+        """
+    )
+
+    return_code = main([example_module, "--config", str(tmp_path)])
+    assert return_code == 1
+    assert capsys.readouterr().err.rstrip() == expected