Point to precise line in parsed source for parsing problems (#10)

* Point to precise line in parsed source for grammar errors

* Refactor to new _get_docstring_node with tests

* Show file & context for unknown doctypes

* Improve escape_qualname

Collapse multiple replaced special chars to one "_" and add doctests.

* Don't prefix with _UnknownName_

Instead just alias to typing.Any. This should make it a bit easier to
addopt docstub gradually.

* Refactor to `doctype_to_annotation`

avoids confusion with the parent classes `transform` method.

* Fix tests for DoctypeTransformer

* Show unknown name in error message

* Don't swallow SystemExit or KeyboardInterrupt

* Expand docstring of accumulate_qualname

* Use bold red to underline reported errors

* Ignore path delimiter in doctest to support Windows

Otherwise, this fails on Windows which returns "file\\with\\..."

* Make arguments to DoctypeTransformer optional

This makes it easier to test the class.

* Test DoctypeTransformer for unknown names

* Use "Any" instead of "_GrammarError_"

* Don't print in DocstringAnnotations if ctx=None

Also add a few tests for that class and remove the currently unused
yields property.

* Add tests for Annotation class

* Extend doctest of ContextFormatter

Author: lagru

pyproject.toml

@@ -87,6 +87,7 @@ ignore = [
   "ISC001",   # Conflicts with formatter
   "RET504",   # Assignment before `return` statement facilitates debugging
   "PTH123",   # Using builtin open() instead of Path.open() is fine
+  "SIM108",   # Terniary operator is always more readable
 ]
 
 

src/docstub/_cli.py

@@ -124,6 +124,8 @@ def main(source_dir, out_dir, config_path, verbose):
                 stub_content = stub_transformer.python_to_stub(
                     py_content, module_path=source_path
                 )
+            except (SystemExit, KeyboardInterrupt):
+                raise
             except Exception as e:
                 logger.exception("failed creating stub for %s:\n\n%s", source_path, e)
                 continue