Add basic statistics

Author: lagru

src/docstub/_analysis.py

@@ -341,6 +341,11 @@ def __init__(
 
         self.known_imports = known_imports
 
+        self.stats = {
+            "successful_queries": 0,
+            "unknown_doctypes": [],
+        }
+
     def query(self, search_name):
         """Search for a known annotation name.
 
@@ -414,6 +419,11 @@ def query(self, search_name):
                 annotation_name.find(known_import.target) :
             ]
 
+        if annotation_name is not None:
+            self.stats["successful_queries"] += 1
+        else:
+            self.stats["unknown_doctypes"].append(search_name)
+
         return annotation_name, known_import
 
     def __repr__(self):

src/docstub/_cli.py

@@ -132,3 +132,19 @@ def main(source_dir, out_dir, config_path, verbose):
         with stub_path.open("w") as fo:
             logger.info("wrote %s", stub_path)
             fo.write(stub_content)
+
+    # Report basic statistics
+    successful_queries = inspector.stats["successful_queries"]
+    click.secho(f"{successful_queries} matched annotations", fg="green")
+
+    grammar_errors = stub_transformer.transformer.stats["grammar_errors"]
+    if grammar_errors:
+        click.secho(f"{grammar_errors} grammar violations", fg="red")
+
+    unknown_doctypes = inspector.stats["unknown_doctypes"]
+    if unknown_doctypes:
+        click.secho(f"{len(unknown_doctypes)} unknown doctypes:", fg="red")
+        click.echo("  " + "\n  ".join(set(unknown_doctypes)))
+
+    if unknown_doctypes or grammar_errors:
+        sys.exit(1)

src/docstub/_docstrings.py

@@ -153,6 +153,8 @@ def __init__(self, *, inspector, replace_doctypes, **kwargs):
         self._collected_imports = None
         super().__init__(**kwargs)
 
+        self.stats = {"grammar_errors": 0}
+
     def transform(self, doctype):
         """Turn a type description in a docstring into a type annotation.
 
@@ -174,6 +176,9 @@ def transform(self, doctype):
                 value=value, imports=frozenset(self._collected_imports)
             )
             return annotation
+        except (lark.exceptions.LexError, lark.exceptions.ParseError):
+            self.stats["grammar_errors"] += 1
+            raise
         finally:
             self._collected_imports = None