pdoc 14.6.1__tar.gz → 15.0.0__tar.gz

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

@@ -5,6 +5,28 @@
 ## Unreleased: pdoc next
 
 
+## 2024-10-11: pdoc 15.0.0
+
+- Remove support for Python 3.8, which has reached end-of-life on 2024-10-07.
+  ([#747](https://github.com/mitmproxy/pdoc/pull/747), @mhils)
+- Inherited members are now hidden by default if the base class is not part of the documentation.
+  Please make yourself heard in https://github.com/mitmproxy/pdoc/issues/715 if you relied on the old behavior.
+  ([#748](https://github.com/mitmproxy/pdoc/pull/748), @mhils)
+- Python 3.13: `@deprecated` decorators are now rendered with visual emphasis.
+  ([#750](https://github.com/mitmproxy/pdoc/pull/750), @mhils)
+- Improve mocking of `sys.stdin`, `sys.stdout`, and `sys.stderr` to fix runtime errors with some packages.
+  ([#751](https://github.com/mitmproxy/pdoc/pull/751), @mhils)
+
+## 2024-09-11: pdoc 14.7.0
+
+- Do not shorten `current_module.func` to `func` in docstrings when linking.
+  This prevents logical errors in code examples with imports.
+  ([#740](https://github.com/mitmproxy/pdoc/pull/740), @mhils)
+- Add support for Python 3.13.
+  ([#730](https://github.com/mitmproxy/pdoc/pull/730), @mhils)
+- pdoc now strips `collections.abc.` from type annotations to make them more concise.
+  ([#736](https://github.com/mitmproxy/pdoc/pull/736), @mhils)
+
 ## 2024-08-27: pdoc 14.6.1
 
 - Fix a bug where entire modules would be excluded by `--no-include-undocumented`.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 14.6.1
+Version: 15.0.0
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0
@@ -16,30 +16,18 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Jinja2>=2.11.0
 Requires-Dist: pygments>=2.12.0
-Requires-Dist: MarkupSafe
-Requires-Dist: astunparse; python_version < "3.9"
-Provides-Extra: dev
-Requires-Dist: tox; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: types-pygments; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-timeout; extra == "dev"
-Requires-Dist: hypothesis; extra == "dev"
-Requires-Dist: pygments>=2.14.0; extra == "dev"
-Requires-Dist: pdoc-pyo3-sample-library==1.0.11; extra == "dev"
+Requires-Dist: MarkupSafe>=1.1.1
 
 <p align="center">
 <a href="https://pdoc.dev/"><img alt="pdoc" src="https://pdoc.dev/logo.svg" width="200" height="100" /></a>
@@ -64,7 +52,7 @@ API Documentation for Python Projects.
 pip install pdoc
 ```
 
-pdoc is compatible with Python 3.8 and newer.
+pdoc is compatible with Python 3.9 and newer.
 
 
 # Usage

{pdoc-14.6.1 → pdoc-15.0.0}/README.md

@@ -21,7 +21,7 @@ API Documentation for Python Projects.
 pip install pdoc
 ```
 
-pdoc is compatible with Python 3.8 and newer.
+pdoc is compatible with Python 3.9 and newer.
 
 
 # Usage

{pdoc-14.6.1 → pdoc-15.0.0}/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.1"  # this is read from setup.py
+__version__ = "15.0.0"  # this is read from setup.py
 
 from pathlib import Path
 from typing import overload

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/__main__.py

@@ -7,7 +7,6 @@ import subprocess
 import sys
 import warnings
 
-from pdoc._compat import BooleanOptionalAction
 import pdoc.doc
 import pdoc.extract
 import pdoc.render
@@ -57,7 +56,7 @@ renderopts.add_argument(
 )
 renderopts.add_argument(
     "--include-undocumented",
-    action=BooleanOptionalAction,
+    action=argparse.BooleanOptionalAction,
     default=True,
     help="Show classes/functions/variables that do not have a docstring.",
 )
@@ -98,25 +97,25 @@ renderopts.add_argument(
 )
 renderopts.add_argument(
     "--math",
-    action=BooleanOptionalAction,
+    action=argparse.BooleanOptionalAction,
     default=False,
     help="Include MathJax from a CDN to enable math formula rendering.",
 )
 renderopts.add_argument(
     "--mermaid",
-    action=BooleanOptionalAction,
+    action=argparse.BooleanOptionalAction,
     default=False,
     help="Include Mermaid.js from a CDN to enable Mermaid diagram rendering.",
 )
 renderopts.add_argument(
     "--search",
-    action=BooleanOptionalAction,
+    action=argparse.BooleanOptionalAction,
     default=True,
     help="Enable search functionality if multiple modules are documented.",
 )
 renderopts.add_argument(
     "--show-source",
-    action=BooleanOptionalAction,
+    action=argparse.BooleanOptionalAction,
     default=True,
     help='Display "View Source" buttons.',
 )

pdoc-15.0.0/pdoc/_compat.py

@@ -0,0 +1,60 @@
+# fmt: off
+import sys
+
+if sys.version_info >= (3, 12):
+    from ast import TypeAlias as ast_TypeAlias
+else:  # pragma: no cover
+    class ast_TypeAlias:
+        pass
+
+if sys.version_info >= (3, 12):
+    from typing import TypeAliasType
+else:  # pragma: no cover
+    class TypeAliasType:
+        """Placeholder class for TypeAliasType"""
+
+if sys.version_info >= (3, 10):
+    from typing import TypeAlias
+else:  # pragma: no cover
+    class TypeAlias:
+        pass
+
+if sys.version_info >= (3, 10):
+    from types import UnionType  # type: ignore
+else:  # pragma: no cover
+    class UnionType:
+        pass
+
+
+if (3, 9) <= sys.version_info < (3, 9, 8) or (3, 10) <= sys.version_info < (3, 10, 1):  # pragma: no cover
+    import inspect
+    import types
+
+    def formatannotation(annotation) -> str:
+        """
+        https://github.com/python/cpython/pull/29212
+        """
+        if isinstance(annotation, types.GenericAlias):
+            return str(annotation)
+        return inspect.formatannotation(annotation)
+else:
+    from inspect import formatannotation
+
+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__ = [
+    "ast_TypeAlias",
+    "TypeAliasType",
+    "TypeAlias",
+    "UnionType",
+    "formatannotation",
+    "is_typeddict",
+]

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

@@ -23,6 +23,7 @@ from abc import abstractmethod
 from collections.abc import Callable
 import dataclasses
 import enum
+from functools import cache
 from functools import cached_property
 from functools import singledispatchmethod
 from functools import wraps
@@ -48,7 +49,6 @@ from pdoc import doc_pyi
 from pdoc import extract
 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
@@ -1132,9 +1132,11 @@ class Variable(Doc[None]):
         if self.default_value is empty:
             return ""
         if isinstance(self.default_value, TypeAliasType):
-            return formatannotation(self.default_value.__value__)
+            formatted = formatannotation(self.default_value.__value__)
+            return _remove_collections_abc(formatted)
         elif self.annotation == TypeAlias:
-            return formatannotation(self.default_value)
+            formatted = formatannotation(self.default_value)
+            return _remove_collections_abc(formatted)
 
         # This is not perfect, but a solid attempt at preventing accidental leakage of secrets.
         # If you have input on how to improve the heuristic, please send a pull request!
@@ -1166,7 +1168,8 @@ class Variable(Doc[None]):
     def annotation_str(self) -> str:
         """The variable's type annotation as a pretty-printed str."""
         if self.annotation is not empty:
-            return f": {formatannotation(self.annotation)}"
+            formatted = formatannotation(self.annotation)
+            return f": {_remove_collections_abc(formatted)}"
         else:
             return ""
 
@@ -1202,6 +1205,7 @@ class _PrettySignature(inspect.Signature):
         for param in self.parameters.values():
             formatted = str(param)
             formatted = _remove_memory_addresses(formatted)
+            formatted = _remove_collections_abc(formatted)
 
             kind = param.kind
 
@@ -1238,7 +1242,8 @@ class _PrettySignature(inspect.Signature):
 
     def _return_annotation_str(self) -> str:
         if self.return_annotation is not empty:
-            return formatannotation(self.return_annotation)
+            formatted = formatannotation(self.return_annotation)
+            return _remove_collections_abc(formatted)
         else:
             return ""
 
@@ -1333,3 +1338,8 @@ _Enum_default_docstrings = tuple(
 def _remove_memory_addresses(x: str) -> str:
     """Remove memory addresses from repr() output"""
     return re.sub(r" at 0x[0-9a-fA-F]+(?=>)", "", x)
+
+
+def _remove_collections_abc(x: str) -> str:
+    """Remove 'collections.abc' from type signatures."""
+    return re.sub(r"(?!\.)\bcollections\.abc\.", "", x)

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

@@ -10,6 +10,7 @@ import ast
 from collections.abc import Iterable
 from collections.abc import Iterator
 from dataclasses import dataclass
+from functools import cache
 import inspect
 from itertools import tee
 from itertools import zip_longest
@@ -23,8 +24,6 @@ import warnings
 import pdoc
 
 from ._compat import ast_TypeAlias
-from ._compat import ast_unparse
-from ._compat import cache
 
 if TYPE_CHECKING:
     import pdoc.doc_types
@@ -81,7 +80,7 @@ def parse(obj):
 @cache
 def unparse(tree: ast.AST):
     """`ast.unparse`, but cached."""
-    return ast_unparse(tree)
+    return ast.unparse(tree)
 
 
 @dataclass
@@ -240,12 +239,11 @@ def _parse_class(source: str) -> ast.ClassDef:
     Returns an empty ast.ClassDef if source is empty.
     """
     tree = _parse(source)
-    assert len(tree.body) <= 1
-    if tree.body:
+    if tree.body and len(tree.body) == 1:
         t = tree.body[0]
-        assert isinstance(t, ast.ClassDef)
-        return t
-    return ast.ClassDef(body=[], decorator_list=[])  # type: ignore
+        if isinstance(t, ast.ClassDef):
+            return t
+    return ast.ClassDef(name="PdocStub", body=[], decorator_list=[])  # type: ignore
 
 
 @cache
@@ -256,8 +254,7 @@ def _parse_function(source: str) -> ast.FunctionDef | ast.AsyncFunctionDef:
     Returns an empty ast.FunctionDef if source is empty.
     """
     tree = _parse(source)
-    assert len(tree.body) <= 1
-    if tree.body:
+    if tree.body and len(tree.body) == 1:
         t = tree.body[0]
         if isinstance(t, (ast.FunctionDef, ast.AsyncFunctionDef)):
             return t
@@ -265,7 +262,9 @@ 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=[])  # type: ignore
+    return ast.FunctionDef(
+        name="pdoc_stub", args=ast.arguments(), body=[], decorator_list=[]
+    )  # type: ignore
 
 
 def _parse(

{pdoc-14.6.1 → pdoc-15.0.0}/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
 
+from functools import cache
 import importlib.util
 from pathlib import Path
 import sys
@@ -17,8 +18,6 @@ import warnings
 
 from pdoc import doc
 
-from ._compat import cache
-
 overload_docstr = typing.overload(lambda: None).__doc__
 
 

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/doc_types.py

@@ -14,6 +14,7 @@ import operator
 import sys
 import types
 from types import BuiltinFunctionType
+from types import GenericAlias
 from types import ModuleType
 import typing
 from typing import TYPE_CHECKING
@@ -24,7 +25,6 @@ from typing import get_origin
 import warnings
 
 from . import extract
-from ._compat import GenericAlias
 from ._compat import UnionType
 from .doc_ast import type_checking_sections
 

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/docstrings.py

@@ -14,6 +14,7 @@ accompanied by matching snapshot tests in `test/testdata/`.
 from __future__ import annotations
 
 import base64
+from functools import cache
 import inspect
 import mimetypes
 import os
@@ -23,8 +24,6 @@ from textwrap import dedent
 from textwrap import indent
 import warnings
 
-from ._compat import cache
-
 
 @cache
 def convert(docstring: str, docformat: str, source_file: Path | None) -> str:

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/extract.py

@@ -201,11 +201,13 @@ def mock_some_common_side_effects():
 
     Note that this function must not be used for security purposes, it's easily bypassable.
     """
-    with patch("subprocess.Popen", new=_PdocDefusedPopen), patch(
-        "os.startfile", new=_noop, create=True
-    ), patch("sys.stdout", new=io.StringIO()), patch(
-        "sys.stderr", new=io.StringIO()
-    ), patch("sys.stdin", new=io.StringIO()):
+    with (
+        patch("subprocess.Popen", new=_PdocDefusedPopen),
+        patch("os.startfile", new=_noop, create=True),
+        patch("sys.stdout", new=io.TextIOWrapper(io.BytesIO())),
+        patch("sys.stderr", new=io.TextIOWrapper(io.BytesIO())),
+        patch("sys.stdin", new=io.TextIOWrapper(io.BytesIO())),
+    ):
         yield
 
 

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/render.py

@@ -177,7 +177,7 @@ _default_searchpath = [
 
 env = Environment(
     loader=FileSystemLoader(_default_searchpath),
-    extensions=[DefaultMacroExtension],
+    extensions=["jinja2.ext.loopcontrols", DefaultMacroExtension],
     autoescape=True,
     trim_blocks=True,
     lstrip_blocks=True,

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/render_helpers.py

@@ -4,6 +4,7 @@ from collections.abc import Collection
 from collections.abc import Iterable
 from collections.abc import Mapping
 from contextlib import contextmanager
+from functools import cache
 import html
 import inspect
 import os
@@ -28,8 +29,6 @@ from markupsafe import Markup
 import pdoc.markdown2
 
 from . import docstrings
-from ._compat import cache
-from ._compat import removesuffix
 
 lexer = pygments.lexers.PythonLexer()
 """
@@ -307,11 +306,17 @@ def module_candidates(identifier: str, current_module: str) -> Iterable[str]:
 
 
 @pass_context
-def linkify(context: Context, code: str, namespace: str = "") -> str:
+def linkify(
+    context: Context, code: str, namespace: str = "", shorten: bool = True
+) -> str:
     """
     Link all identifiers in a block of text. Identifiers referencing unknown modules or modules that
     are not rendered at the moment will be ignored.
     A piece of text is considered to be an identifier if it either contains a `.` or is surrounded by `<code>` tags.
+
+    If `shorten` is True, replace identifiers with short forms where possible.
+    For example, replace "current_module.Foo" with "Foo". This is useful for annotations
+    (which are verbose), but undesired for docstrings (where we want to preserve intent).
     """
 
     def linkify_repl(m: re.Match):
@@ -322,7 +327,7 @@ def linkify(context: Context, code: str, namespace: str = "") -> str:
         plain_text = text.replace(
             '</span><span class="o">.</span><span class="n">', "."
         )
-        identifier = removesuffix(plain_text, "()")
+        identifier = plain_text.removesuffix("()")
         mod: pdoc.doc.Module = context["module"]
 
         # Check if this is a relative reference. These cannot be local and need to be resolved.
@@ -381,12 +386,15 @@ def linkify(context: Context, code: str, namespace: str = "") -> str:
                     and (target_object is doc.obj or target_object is None)
                     and context["is_public"](doc).strip()
                 ):
-                    if module == mod:
-                        url_text = qualname
+                    if shorten:
+                        if module == mod:
+                            url_text = qualname
+                        else:
+                            url_text = doc.fullname
+                        if plain_text.endswith("()"):
+                            url_text += "()"
                     else:
-                        url_text = doc.fullname
-                    if plain_text.endswith("()"):
-                        url_text += "()"
+                        url_text = plain_text
                     return f'<a href="{relative_link(context["module"].modulename, doc.modulename)}#{qualname}">{url_text}</a>'
 
         # No matches found.
@@ -453,7 +461,7 @@ def link(context: Context, spec: tuple[str, str], text: str | None = None) -> st
     if mod.modulename == modulename:
         fullname = qualname
     else:
-        fullname = removesuffix(f"{modulename}.{qualname}", ".")
+        fullname = f"{modulename}.{qualname}".removesuffix(".")
 
     if qualname:
         qualname = f"#{qualname}"

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/templates/content.css

@@ -308,6 +308,13 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
     margin-left: 2rem;
 }
 
+.pdoc .decorator-deprecated {
+    color: #842029;
+}
+.pdoc .decorator-deprecated ~ span {
+    filter: grayscale(1) opacity(0.8);
+}
+
 .pdoc .name {
     color: var(--name);
     font-weight: bold;

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

@@ -162,7 +162,7 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
 {% enddefaultmacro %}
 {% defaultmacro decorators(doc) %}
     {% for d in doc.decorators if not d.startswith("@_") %}
-        <div class="decorator">{{ d }}</div>
+        <div class="decorator decorator-{{ d[1:].partition("(")[0] }}">{{ d }}</div>
     {% endfor %}
 {% enddefaultmacro %}
 {% defaultmacro function(fn) -%}
@@ -209,7 +209,7 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
 {% enddefaultmacro %}
 {% defaultmacro docstring(var) %}
     {% if var.docstring %}
-        <div class="docstring">{{ var.docstring | replace("@public", "") | to_markdown | to_html | linkify(namespace=var.qualname) }}</div>
+        <div class="docstring">{{ var.docstring | replace("@public", "") | to_markdown | to_html | linkify(namespace=var.qualname, shorten=False) }}</div>
     {% endif %}
 {% enddefaultmacro %}
 {% defaultmacro nav_members(members) %}
@@ -266,6 +266,10 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
 {# fmt: off #}
 {% defaultmacro inherited(cls) %}
     {% for base, members in cls.inherited_members.items() %}
+        {% if base[0] not in all_modules %}
+            {# hide inherited members from modules that are not in the documentation, https://github.com/mitmproxy/pdoc/issues/715 #}
+            {% continue %}
+        {% endif %}
         {% set m = None %}{# workaround for https://github.com/pallets/jinja/issues/1427 #}
         {% set member_html %}
             {% for m in members if is_public(m) | trim %}

{pdoc-14.6.1 → pdoc-15.0.0}/pdoc/web.py

@@ -10,6 +10,7 @@ from __future__ import annotations
 
 from collections.abc import Iterable
 from collections.abc import Iterator
+from functools import cache
 import http.server
 import traceback
 from typing import Mapping
@@ -19,8 +20,6 @@ import webbrowser
 from pdoc import doc
 from pdoc import extract
 from pdoc import render
-from pdoc._compat import cache
-from pdoc._compat import removesuffix
 
 
 class DocHandler(http.server.BaseHTTPRequestHandler):
@@ -52,7 +51,7 @@ class DocHandler(http.server.BaseHTTPRequestHandler):
             self.send_header("content-type", "application/javascript")
             self.end_headers()
             return self.server.render_search_index()
-        elif "." in removesuffix(path, ".html"):
+        elif "." in path.removesuffix(".html"):
             # See https://github.com/mitmproxy/pdoc/issues/615: All module separators should be normalized to "/".
             # We could redirect here, but that would create the impression of a working link, which will fall apart
             # when pdoc prerenders to static HTML. So we rather fail early.
@@ -60,7 +59,7 @@ class DocHandler(http.server.BaseHTTPRequestHandler):
             self.end_headers()
             return "Not Found: Please normalize all module separators to '/'."
         else:
-            module_name = removesuffix(path.lstrip("/"), ".html").replace("/", ".")
+            module_name = path.lstrip("/").removesuffix(".html").replace("/", ".")
             if module_name not in self.server.all_modules:
                 self.send_response(404)
                 self.send_header("content-type", "text/html")

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 14.6.1
+Version: 15.0.0
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0
@@ -16,30 +16,18 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Jinja2>=2.11.0
 Requires-Dist: pygments>=2.12.0
-Requires-Dist: MarkupSafe
-Requires-Dist: astunparse; python_version < "3.9"
-Provides-Extra: dev
-Requires-Dist: tox; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: types-pygments; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-timeout; extra == "dev"
-Requires-Dist: hypothesis; extra == "dev"
-Requires-Dist: pygments>=2.14.0; extra == "dev"
-Requires-Dist: pdoc-pyo3-sample-library==1.0.11; extra == "dev"
+Requires-Dist: MarkupSafe>=1.1.1
 
 <p align="center">
 <a href="https://pdoc.dev/"><img alt="pdoc" src="https://pdoc.dev/logo.svg" width="200" height="100" /></a>
@@ -64,7 +52,7 @@ API Documentation for Python Projects.
 pip install pdoc
 ```
 
-pdoc is compatible with Python 3.8 and newer.
+pdoc is compatible with Python 3.9 and newer.
 
 
 # Usage

pdoc-15.0.0/pdoc.egg-info/requires.txt

@@ -0,0 +1,3 @@
+Jinja2>=2.11.0
+pygments>=2.12.0
+MarkupSafe>=1.1.1

{pdoc-14.6.1 → pdoc-15.0.0}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "pdoc"
 description = "API Documentation for Python Projects"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = { text="MIT-0" }
 authors = [{name = "Maximilian Hils", email = "pdoc@maximilianhils.com"}]
 dynamic = ["version"]
@@ -10,8 +10,7 @@ dynamic = ["version"]
 dependencies = [
     "Jinja2 >= 2.11.0",
     "pygments >= 2.12.0",
-    "MarkupSafe",
-    "astunparse; python_version<'3.9'",
+    "MarkupSafe >= 1.1.1",
 ]
 
 classifiers = [
@@ -23,11 +22,11 @@ classifiers = [
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Typing :: Typed",
 ]
 
@@ -40,18 +39,18 @@ Issues = "https://github.com/mitmproxy/pdoc/issues"
 [project.scripts]
 pdoc = "pdoc.__main__:cli"
 
-[project.optional-dependencies]
-dev = [
-    "tox",
-    "ruff",
-    "mypy",
-    "types-pygments",
-    "pytest",
-    "pytest-cov",
-    "pytest-timeout",
-    "hypothesis",
-    "pygments >= 2.14.0",
-    "pdoc-pyo3-sample-library==1.0.11",
+[tool.uv]
+dev-dependencies = [
+    "tox>=4.21.2",
+    "tox-uv>=1.13.0",
+    "ruff>=0.6.9",
+    "mypy>=1.11.2",
+    "types-pygments>=2.18.0.20240506",
+    "pytest>=8.3.3",
+    "pytest-cov>=5.0.0",
+    "pytest-timeout>=2.3.1",
+    "hypothesis>=6.113.0",
+    "pdoc-pyo3-sample-library>=1.0.11",
 ]
 
 [build-system]
@@ -109,17 +108,17 @@ isort = { force-single-line = true, force-sort-within-sections = true }
 legacy_tox_ini = """
 [tox]
 envlist = lint, py
-skipsdist = True
 toxworkdir = {env:TOX_WORK_DIR:.tox}
+runner = uv-venv-lock-runner
 
 [testenv]
-deps =
-    -r requirements-dev.txt
-    -e .
 commands =
     pdoc --version
     pytest --cov=pdoc --cov-report term-missing {posargs:-m "not slow"}
 
+[testenv:old-dependencies]
+uv_resolution = lowest
+
 [testenv:lint]
 commands =
     ruff check . {posargs}

{pdoc-14.6.1 → pdoc-15.0.0}/test/test_doc.py

@@ -1,7 +1,6 @@
 import builtins
 import dataclasses
 from pathlib import Path
-import sys
 import types
 from unittest.mock import patch
 
@@ -120,13 +119,15 @@ def test_builtin_source():
     assert m.source_lines is None
 
 
-@pytest.mark.skipif(sys.version_info < (3, 9), reason="3.9+ only")
 def test_raising_getdoc():
-    class Foo:
-        @classmethod
-        @property
-        def __doc__(self):
-            raise RuntimeError
+    class FooMeta(type):
+        def __getattribute__(cls, name):
+            if name == "__doc__":
+                raise RuntimeError
+            return super().__getattribute__(name)
+
+    class Foo(metaclass=FooMeta):
+        pass
 
     x = Class(Foo.__module__, Foo.__qualname__, Foo, (Foo.__module__, Foo.__qualname__))
     with pytest.warns(UserWarning, match="inspect.getdoc(.+) raised an exception"):

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

@@ -50,7 +50,9 @@ def test_eval_fail_import_nonexistent(monkeypatch):
         lambda _: "import typing\nif typing.TYPE_CHECKING:\n\timport nonexistent_module",
     )
     a = types.ModuleType("a")
-    with pytest.warns(UserWarning, match="No module named 'nonexistent_module'"):
+    with pytest.warns(
+        UserWarning, match="No module named 'nonexistent_module'|Import of xyz failed"
+    ):
         assert safe_eval_type("xyz", a.__dict__, None, a, "a") == "xyz"
 
 

{pdoc-14.6.1 → pdoc-15.0.0}/test/test_extract.py

@@ -5,6 +5,7 @@ import sys
 import pytest
 
 from pdoc.extract import invalidate_caches
+from pdoc.extract import mock_some_common_side_effects
 from pdoc.extract import module_mtime
 from pdoc.extract import parse_spec
 from pdoc.extract import walk_specs
@@ -137,3 +138,11 @@ def test_invalidate_caches(monkeypatch):
     monkeypatch.setattr(importlib, "reload", raise_)
     with pytest.warns(UserWarning, match="Error reloading"):
         invalidate_caches("pdoc.render_helpers")
+
+
+def test_mock_sideeffects():
+    """https://github.com/mitmproxy/pdoc/issues/745"""
+    with mock_some_common_side_effects():
+        import sys
+
+        sys.stdout.reconfigure(encoding="utf-8")

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

@@ -96,8 +96,9 @@ class Snapshot:
 
 snapshots = [
     Snapshot("ast_parsing"),
+    Snapshot("collections_abc", min_version=(3, 9)),
     Snapshot("demo", min_version=(3, 9)),
-    Snapshot("enums", min_version=(3, 12)),
+    Snapshot("enums", min_version=(3, 13)),
     Snapshot("flavors_google"),
     Snapshot("flavors_numpy"),
     Snapshot("flavors_rst"),
@@ -135,16 +136,9 @@ snapshots = [
         with_output_directory=True,
     ),
     Snapshot("misc"),
-    Snapshot(
-        "misc_py39",
-        min_version=(3, 9),
-    ),
     Snapshot("misc_py310", min_version=(3, 10)),
-    Snapshot("misc_py311", min_version=(3, 11)),
-    Snapshot(
-        "misc_py312",
-        min_version=(3, 12),
-    ),
+    Snapshot("misc_py312", min_version=(3, 12)),
+    Snapshot("misc_py313", min_version=(3, 13)),
     Snapshot("math_demo", render_options={"math": True}),
     Snapshot("math_misc", render_options={"math": True}),
     Snapshot("mermaid_demo", render_options={"mermaid": True}, min_version=(3, 9)),
@@ -164,6 +158,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("typed_dict", min_version=(3, 13)),
     Snapshot("type_stubs", ["type_stubs"], min_version=(3, 10)),
     Snapshot(
         "visibility",

pdoc-14.6.1/pdoc/_compat.py

@@ -1,148 +0,0 @@
-# fmt: off
-import sys
-
-if sys.version_info >= (3, 9):
-    from functools import cache
-else:  # pragma: no cover
-    from functools import lru_cache
-
-    cache = lru_cache(maxsize=None)
-
-if sys.version_info >= (3, 9):
-    from ast import unparse as ast_unparse
-else:  # pragma: no cover
-    from astunparse import unparse as _unparse
-
-    def ast_unparse(t):  # type: ignore
-        return _unparse(t).strip("\t\n \"'")
-
-if sys.version_info >= (3, 12):
-    from ast import TypeAlias as ast_TypeAlias
-else:  # pragma: no cover
-    class ast_TypeAlias:
-        pass
-
-if sys.version_info >= (3, 12):
-    from typing import TypeAliasType
-else:  # pragma: no cover
-    class TypeAliasType:
-        """Placeholder class for TypeAliasType"""
-
-if sys.version_info >= (3, 10):
-    from typing import TypeAlias
-else:  # pragma: no cover
-    class TypeAlias:
-        pass
-
-if sys.version_info >= (3, 9):
-    from types import GenericAlias
-else:  # pragma: no cover
-    from typing import _GenericAlias as GenericAlias
-
-if sys.version_info >= (3, 10):
-    from types import UnionType  # type: ignore
-else:  # pragma: no cover
-    class UnionType:
-        pass
-
-if sys.version_info >= (3, 9):
-    removesuffix = str.removesuffix
-else:  # pragma: no cover
-    def removesuffix(x: str, suffix: str):
-        if x.endswith(suffix):
-            x = x[: -len(suffix)]
-        return x
-
-if sys.version_info >= (3, 9):
-    removeprefix = str.removeprefix
-else:  # pragma: no cover
-    def removeprefix(x: str, prefix: str):
-        if x.startswith(prefix):
-            x = x[len(prefix):]
-        return x
-
-
-if (3, 9) <= sys.version_info < (3, 9, 8) or (3, 10) <= sys.version_info < (3, 10, 1):  # pragma: no cover
-    import inspect
-    import types
-
-    def formatannotation(annotation) -> str:
-        """
-        https://github.com/python/cpython/pull/29212
-        """
-        if isinstance(annotation, types.GenericAlias):
-            return str(annotation)
-        return inspect.formatannotation(annotation)
-else:
-    from inspect import formatannotation
-
-if sys.version_info >= (3, 9):
-    from argparse import BooleanOptionalAction
-else:  # pragma: no cover
-    # https://github.com/python/cpython/pull/27672
-    from argparse import Action
-
-    class BooleanOptionalAction(Action):  # pragma: no cover
-        def __init__(self,
-                     option_strings,
-                     dest,
-                     default=None,
-                     type=None,
-                     choices=None,
-                     required=False,
-                     help=None,
-                     metavar=None):
-
-            _option_strings = []
-            for option_string in option_strings:
-                _option_strings.append(option_string)
-
-                if option_string.startswith('--'):
-                    option_string = '--no-' + option_string[2:]
-                    _option_strings.append(option_string)
-
-            if help is not None and default is not None:
-                help += " (default: %(default)s)"
-
-            super().__init__(
-                option_strings=_option_strings,
-                dest=dest,
-                nargs=0,
-                default=default,
-                type=type,
-                choices=choices,
-                required=required,
-                help=help,
-                metavar=metavar)
-
-        def __call__(self, parser, namespace, values, option_string=None):
-            if option_string in self.option_strings:
-                setattr(namespace, self.dest, not option_string.startswith('--no-'))
-
-        def format_usage(self):
-            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",
-    "ast_TypeAlias",
-    "TypeAliasType",
-    "TypeAlias",
-    "GenericAlias",
-    "UnionType",
-    "removesuffix",
-    "formatannotation",
-    "BooleanOptionalAction",
-    "is_typeddict",
-]

pdoc-14.6.1/pdoc.egg-info/requires.txt

@@ -1,18 +0,0 @@
-Jinja2>=2.11.0
-pygments>=2.12.0
-MarkupSafe
-
-[:python_version < "3.9"]
-astunparse
-
-[dev]
-tox
-ruff
-mypy
-types-pygments
-pytest
-pytest-cov
-pytest-timeout
-hypothesis
-pygments>=2.14.0
-pdoc-pyo3-sample-library==1.0.11