feat(mathy_pydoc): cleanup return type annotations

Author: justindujardin

libraries/mathy_pydoc_markdown/mathy_pydoc/loader.py

@@ -46,8 +46,20 @@
 optional_replace = r"\1Optional[\2]\3"
 
 # _ForwardRef('MathyEnvState') -> MathyEnvState
-fwd_ref_match = r"\_ForwardRef\(\'(.*)\'\)"
-fwd_ref_replace = r"\1"
+fwd_ref_match = r"(.*)\_ForwardRef\(\'(.*)\'\)(.*)"
+fwd_ref_replace = r"\1\2\3"
+
+
+def cleanup_type(type_string: str) -> str:
+    # Optional[T] gets expanded to Union[T, NoneType], so change it back
+    while re.search(optional_match, type_string) is not None:
+        type_string = re.sub(optional_match, optional_replace, type_string)
+
+    # _ForwardRef('MathyEnvState') -> MathyEnvState
+    while re.search(fwd_ref_match, type_string) is not None:
+        type_string = re.sub(fwd_ref_match, fwd_ref_replace, type_string)
+
+    return type_string
 
 
 def trim(docstring):
@@ -180,18 +192,16 @@ def get_callable_placeholder(
             default_value = str(p.default)
 
         if annotation is not None:
-            # Optional[T] gets expanded to Union[T, NoneType], so change it back
-            while re.search(optional_match, annotation) is not None:
-                annotation = re.sub(optional_match, optional_replace, annotation)
-
-            annotation = re.sub(fwd_ref_match, fwd_ref_replace, annotation)
+            annotation = cleanup_type(annotation)
         params.append(CallableArg(p.name, annotation, default_value))
 
     return_annotation = None
     if sig.return_annotation is not inspect._empty:  # type: ignore
         return_annotation = inspect.formatannotation(
             sig.return_annotation, base_module="mathy"
         )
+    if return_annotation is not None:
+        return_annotation = cleanup_type(return_annotation)
     return CallablePlaceholder(
         simple=str(sig), name=name, args=params, return_type=return_annotation
     )

libraries/mathy_pydoc_markdown/setup.py

@@ -21,13 +21,23 @@
 import setuptools
 import io
 
-from mathy_pydoc import about
+from pathlib import Path
+
+package_name = "mathy_pydoc"
+root = Path(__file__).parent.resolve()
+
+# Read in package meta from about.py
+about_path = root / package_name / "about.py"
+with about_path.open("r", encoding="utf8") as f:
+    about = {}
+    exec(f.read(), about)
+
 
 with io.open("README.md", encoding="utf8") as fp:
     readme = fp.read()
 
 setuptools.setup(
-    name="mathy_pydoc",
+    name=package_name,
     description=about["__summary__"],
     author=about["__author__"],
     author_email=about["__email__"],
@@ -50,11 +60,6 @@
     ],
     keywords="markdown pydoc generator docs documentation",
     packages=["mathy_pydoc"],
-    install_requires=[
-        "MkDocs>=0.16.0",
-        "Markdown>=2.6.11",
-        "PyYAML>=3.12",
-        "six>=0.11.0",
-    ],
+    install_requires=["Markdown>=2.6.11", "PyYAML>=3.12", "six>=0.11.0",],
     entry_points=dict(console_scripts=["mathy_pydoc=mathy_pydoc.__main__:main"]),
 )

libraries/mathy_pydoc_markdown/testmodule/__init__.py

@@ -7,7 +7,7 @@ def a_function_with_types(
     inputs: List[Dict[str, Any]],
     auxiliary: Tuple[Optional[str]],
     final: int = 3,
-) -> List[str]:
+) -> List[Optional[str]]:
     """Sweet typed function"""
     pass