Don't print fully documented file stats (HunterMcGushion#85)

* Don't print fully documented file stats

* Print empty files after all?

* 'continue' statement

* -v 4 as discussed with @killthekitten

* also print present docstrings in -v 4

* fix test

Author: MiWeiss

README.md

@@ -87,6 +87,7 @@ docstr-coverage some_project/src
   - 1 - Print overall statistics
   - 2 - Also print individual statistics for each file
   - 3 - Also print missing docstrings (function names, class names, etc.)
+  - 4 - Also print information about present docstrings
 - _--fail-under=<int|float>, -F <int|float>_ - Fail if under a certain percentage of coverage (default: 100.0)
 - _--docstr-ignore-file=\<filepath\>, -d \<filepath\>_ - Filepath containing list of patterns to ignore. Patterns are (file-pattern, name-pattern) pairs
   - File content example:

docstr_coverage/cli.py

@@ -156,7 +156,7 @@ def _assert_valid_key_value(k, v):
 @click.option(
     "-v",
     "--verbose",
-    type=click.Choice(["0", "1", "2", "3"]),
+    type=click.Choice(["0", "1", "2", "3", "4"]),
     default="3",
     help="Verbosity level",
     show_default=True,

docstr_coverage/printers.py

@@ -63,15 +63,29 @@ def _print_file_statistics(self, results):
         results: ResultCollection
             The information about docstr presence to be printed to stdout."""
         for file_path, file in results.files():
+            if self.verbosity < 4 and file.count_aggregate().missing == 0:
+                # Don't print fully documented files
+                continue
+
             # File Header
             print_line('\nFile: "{}"'.format(file_path))
 
             # List of missing docstrings
             if self.verbosity >= 3:
-                if file.status == FileStatus.EMPTY:
+                if file.status == FileStatus.EMPTY and self.verbosity > 3:
                     print_line(" - File is empty")
                 for expected_docstr in file._expected_docstrings:
-                    if not expected_docstr.has_docstring and not expected_docstr.ignore_reason:
+                    if expected_docstr.has_docstring and self.verbosity > 3:
+                        print_line(
+                            " - Found docstring for `{0}`".format(expected_docstr.node_identifier)
+                        )
+                    elif expected_docstr.ignore_reason and self.verbosity > 3:
+                        print_line(
+                            " - Ignored `{0}`: reason: `{1}`".format(
+                                expected_docstr.node_identifier, expected_docstr.ignore_reason
+                            )
+                        )
+                    elif not expected_docstr.has_docstring and not expected_docstr.ignore_reason:
                         if expected_docstr.node_identifier == "module docstring":
                             print_line(" - No module docstring")
                         else:

tests/test_coverage.py

@@ -160,7 +160,7 @@ def test_should_report_when_no_docs_in_a_file():
 def test_logging_empty_file(caplog, expected):
     with caplog.at_level(logging.DEBUG):
         result = analyze([EMPTY_FILE_PATH])
-        LegacyPrinter(verbosity=3).print(result)
+        LegacyPrinter(verbosity=4).print(result)
         _file_results, _total_results = result.to_legacy()
 
     if platform.system() == "Windows":