pdoc 14.6.0__tar.gz → 14.6.1__tar.gz

{pdoc-14.6.0 → pdoc-14.6.1}/CHANGELOG.md

@@ -4,6 +4,17 @@
 
 ## Unreleased: pdoc next
 
+
+## 2024-08-27: pdoc 14.6.1
+
+- Fix a bug where entire modules would be excluded by `--no-include-undocumented`.
+  To exclude modules, see https://pdoc.dev/docs/pdoc.html#exclude-submodules-from-being-documented.
+  ([#728](https://github.com/mitmproxy/pdoc/pull/728), @mhils)
+- Fix a bug where pdoc would crash when importing pyi files.
+  ([#732](https://github.com/mitmproxy/pdoc/pull/732), @mhils)
+- Fix a bug where subclasses of TypedDict subclasses would not render correctly.
+  ([#729](https://github.com/mitmproxy/pdoc/pull/729), @mhils)
+
 ## 2024-07-24: pdoc 14.6.0
 
 - If `example.data.Data` is also exposed as `example.Data`, pdoc now links to `example.Data` in documentation.

{pdoc-14.6.0/pdoc.egg-info → pdoc-14.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 14.6.0
+Version: 14.6.1
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0

{pdoc-14.6.0 → pdoc-14.6.1}/pdoc/__init__.py

@@ -481,7 +481,7 @@ You can find an example in [`examples/library-usage`](https://github.com/mitmpro
 from __future__ import annotations
 
 __docformat__ = "markdown"  # explicitly disable rST processing in the examples above.
-__version__ = "14.6.0"  # this is read from setup.py
+__version__ = "14.6.1"  # this is read from setup.py
 
 from pathlib import Path
 from typing import overload

{pdoc-14.6.0 → pdoc-14.6.1}/pdoc/_compat.py

@@ -123,6 +123,16 @@ else:  # pragma: no cover
             return ' | '.join(self.option_strings)
 
 
+if sys.version_info >= (3, 10):
+    from typing import is_typeddict
+else:  # pragma: no cover
+    def is_typeddict(tp):
+        try:
+            return tp.__orig_bases__[-1].__name__ == "TypedDict"
+        except Exception:
+            return False
+
+
 __all__ = [
     "cache",
     "ast_unparse",
@@ -134,4 +144,5 @@ __all__ = [
     "removesuffix",
     "formatannotation",
     "BooleanOptionalAction",
+    "is_typeddict",
 ]

{pdoc-14.6.0 → pdoc-14.6.1}/pdoc/doc.py

@@ -37,6 +37,7 @@ import types
 from typing import Any
 from typing import ClassVar
 from typing import Generic
+from typing import TypedDict
 from typing import TypeVar
 from typing import Union
 from typing import get_origin
@@ -49,6 +50,7 @@ from pdoc._compat import TypeAlias
 from pdoc._compat import TypeAliasType
 from pdoc._compat import cache
 from pdoc._compat import formatannotation
+from pdoc._compat import is_typeddict
 from pdoc.doc_types import GenericAlias
 from pdoc.doc_types import NonUserDefinedCallables
 from pdoc.doc_types import empty
@@ -655,14 +657,21 @@ class Class(Namespace[type]):
     @cached_property
     def _bases(self) -> tuple[type, ...]:
         orig_bases = _safe_getattr(self.obj, "__orig_bases__", ())
-        old_python_typeddict_workaround = (
-            sys.version_info < (3, 12)
-            and orig_bases
-            and _safe_getattr(orig_bases[-1], "__name__", None) == "TypedDict"
-        )
-        if old_python_typeddict_workaround:  # pragma: no cover
-            # TypedDicts on Python <3.12 have a botched __mro__. We need to fix it.
-            return (self.obj, *orig_bases[:-1])
+
+        if is_typeddict(self.obj):
+            if sys.version_info < (3, 12):  # pragma: no cover
+                # TypedDicts on Python <3.12 have a botched __mro__. We need to fix it.
+                return (self.obj, *orig_bases[:-1])
+            else:
+                # TypedDict on Python >=3.12 removes intermediate classes from __mro__,
+                # so we use orig_bases to recover the full mro.
+                while orig_bases and orig_bases[-1] is not TypedDict:
+                    parent_bases = _safe_getattr(orig_bases[-1], "__orig_bases__", ())
+                    if (
+                        len(parent_bases) != 1 or parent_bases in orig_bases
+                    ):  # sanity check that things look right
+                        break  # pragma: no cover
+                    orig_bases = (*orig_bases, parent_bases[0])
 
         # __mro__ and __orig_bases__ differ between Python versions and special cases like TypedDict/NamedTuple.
         # This here is a pragmatic approximation of what we want.

{pdoc-14.6.0 → pdoc-14.6.1}/pdoc/doc_ast.py

@@ -245,7 +245,7 @@ def _parse_class(source: str) -> ast.ClassDef:
         t = tree.body[0]
         assert isinstance(t, ast.ClassDef)
         return t
-    return ast.ClassDef(body=[], decorator_list=[])
+    return ast.ClassDef(body=[], decorator_list=[])  # type: ignore
 
 
 @cache
@@ -265,7 +265,7 @@ def _parse_function(source: str) -> ast.FunctionDef | ast.AsyncFunctionDef:
             # we have a lambda function,
             # to simplify the API return the ast.FunctionDef stub.
             pass
-    return ast.FunctionDef(body=[], decorator_list=[])
+    return ast.FunctionDef(body=[], decorator_list=[])  # type: ignore
 
 
 def _parse(

{pdoc-14.6.0 → pdoc-14.6.1}/pdoc/doc_pyi.py

@@ -6,6 +6,7 @@ This makes it possible to add type hints for native modules such as modules writ
 
 from __future__ import annotations
 
+import importlib.util
 from pathlib import Path
 import sys
 import traceback
@@ -45,13 +46,28 @@ def find_stub_file(module_name: str) -> Path | None:
 
 
 def _import_stub_file(module_name: str, stub_file: Path) -> types.ModuleType:
-    """Import the type stub outside of the normal import machinery."""
-    code = compile(stub_file.read_text(), str(stub_file), "exec")
-    m = types.ModuleType(module_name)
-    m.__file__ = str(stub_file)
-    eval(code, m.__dict__, m.__dict__)
+    """
+    Import the type stub outside of the normal import machinery.
 
-    return m
+    Note that currently, for objects imported by the stub file, the _original_ module
+    is used and not the corresponding stub file.
+    """
+    sys.path_hooks.append(
+        importlib.machinery.FileFinder.path_hook(
+            (importlib.machinery.SourceFileLoader, [".pyi"])
+        )
+    )
+    try:
+        loader = importlib.machinery.SourceFileLoader(module_name, str(stub_file))
+        spec = importlib.util.spec_from_file_location(
+            module_name, stub_file, loader=loader
+        )
+        assert spec is not None
+        m = importlib.util.module_from_spec(spec)
+        loader.exec_module(m)
+        return m
+    finally:
+        sys.path_hooks.pop()
 
 
 def _prepare_module(ns: doc.Namespace) -> None:

{pdoc-14.6.0 → pdoc-14.6.1}/pdoc/templates/default/module.html.jinja2

@@ -244,7 +244,7 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
     {% elif "@public" in doc.docstring %}
         {# show members explicitly marked as @public #}
         true
-    {% elif not include_undocumented and not doc.docstring %}
+    {% elif not include_undocumented and not doc.docstring and doc.kind != "module" %}
         {# hide members that are undocumented if include_undocumented has been toggled off. #}
     {% elif doc.name == "__init__" and (doc.docstring or (doc.kind == "function" and doc.signature_without_self.parameters)) %}
         {# show constructors that have a docstring or at least one extra argument #}

{pdoc-14.6.0 → pdoc-14.6.1/pdoc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 14.6.0
+Version: 14.6.1
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0

{pdoc-14.6.0 → pdoc-14.6.1}/test/test_doc_types.py

@@ -79,5 +79,7 @@ def test_recurse(monkeypatch):
     monkeypatch.setitem(sys.modules, "a", a)
     monkeypatch.setitem(sys.modules, "b", b)
 
-    with pytest.warns(UserWarning, match="Recursion error when importing a"):
+    with pytest.warns(
+        UserWarning, match="Recursion error when importing a|Import of xyz failed"
+    ):
         assert safe_eval_type("xyz", a.__dict__, None, a, "a") == "xyz"

{pdoc-14.6.0 → pdoc-14.6.1}/test/test_snapshot.py

@@ -164,7 +164,7 @@ snapshots = [
     Snapshot("pyo3_sample_library", specs=["pdoc_pyo3_sample_library"]),
     Snapshot("top_level_reimports", ["top_level_reimports"]),
     Snapshot("type_checking_imports", ["type_checking_imports.main"]),
-    Snapshot("type_stub", min_version=(3, 10)),
+    Snapshot("type_stubs", ["type_stubs"], min_version=(3, 10)),
     Snapshot(
         "visibility",
         render_options={