Add support for Python 3.14 (#843)

* add support for Python 3.14

* adjust tests

Author: mhils

.github/workflows/docs.yml

@@ -23,7 +23,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v6
         with:
-          python-version: '3.13'
+          python-version: '3.14'
 
       # ADJUST THIS: install all dependencies (including pdoc)
       - run: pip install -e .

.github/workflows/main.yml

@@ -37,20 +37,22 @@ jobs:
       matrix:
         include:
           - os: windows-latest
-            py: 3.13.0
+            py: 3.14.0
             args: --cov-fail-under=100
           - os: macos-latest
-            py: 3.13.0
+            py: 3.14.0
             args: --cov-fail-under=100
           - os: ubuntu-latest
-            py: 3.13.0
+            py: 3.14.0
             args: --cov-fail-under=100
           - os: ubuntu-latest
-            py: 3.12.4
+            py: 3.13.7
           - os: ubuntu-latest
-            py: 3.11.5
+            py: 3.12.11
           - os: ubuntu-latest
-            py: 3.10.13
+            py: 3.11.13
+          - os: ubuntu-latest
+            py: 3.10.18
     runs-on: ${{ matrix.os }}
     steps:
       - uses: mhils/workflows/checkout@8a2bdd081227cbdd6f5d3bbb54a759607feac0b6

.python-version

@@ -1 +1 @@
-3.13.2
+3.14.0

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 - pdoc has a new logo. 🐍
   ([#838](https://github.com/mitmproxy/pdoc/pull/838), @mhils)
+- Add support for Python 3.14.
+  ([#843](https://github.com/mitmproxy/pdoc/pull/843), @mhils)
 - Drop support for Python 3.9, which as reached
   [end of life](https://devguide.python.org/versions/).
   ([#842](https://github.com/mitmproxy/pdoc/pull/842), @mhils)

pdoc/doc_types.py

@@ -183,24 +183,22 @@ def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
         # https://github.com/python/cpython/blob/4f51fa9e2d3ea9316e674fb9a9f3e3112e83661c/Lib/typing.py#L684-L707
         if t.__forward_arg__ in recursive_guard:  # pragma: no cover
             return t
-        if not t.__forward_evaluated__ or localns is not globalns:
-            if globalns is None and localns is None:  # pragma: no cover
-                globalns = localns = {}
-            elif globalns is None:  # pragma: no cover
-                globalns = localns
-            elif localns is None:  # pragma: no cover
-                localns = globalns
-            __forward_module__ = getattr(t, "__forward_module__", None)
-            if __forward_module__ is not None:
-                globalns = getattr(
-                    sys.modules.get(__forward_module__, None), "__dict__", globalns
-                )
-            (type_,) = (eval(t.__forward_code__, globalns, localns),)
-            t.__forward_value__ = _eval_type(
-                type_, globalns, localns, recursive_guard | {t.__forward_arg__}
+
+        if globalns is None and localns is None:  # pragma: no cover
+            globalns = localns = {}
+        elif globalns is None:  # pragma: no cover
+            globalns = localns
+        elif localns is None:  # pragma: no cover
+            localns = globalns
+        __forward_module__ = getattr(t, "__forward_module__", None)
+        if __forward_module__ is not None:
+            globalns = getattr(
+                sys.modules.get(__forward_module__, None), "__dict__", globalns
             )
-            t.__forward_evaluated__ = True
-        return t.__forward_value__
+        (type_,) = (eval(t.__forward_code__, globalns, localns),)
+        return _eval_type(
+            type_, globalns, localns, recursive_guard | {t.__forward_arg__}
+        )
 
     # https://github.com/python/cpython/blob/main/Lib/typing.py#L333-L343
     # fmt: off

pyproject.toml

@@ -27,6 +27,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Typing :: Typed",
 ]
 

test/test_snapshot.py

@@ -136,6 +136,7 @@ def outfile(self, format: str) -> Path:
     Snapshot("misc_py310", min_version=(3, 10)),
     Snapshot("misc_py312", min_version=(3, 12)),
     Snapshot("misc_py313", min_version=(3, 13)),
+    Snapshot("misc_py313", min_version=(3, 14)),
     Snapshot("math_demo", render_options={"math": True}),
     Snapshot("math_misc", render_options={"math": True}),
     Snapshot("mermaid_demo", render_options={"mermaid": True}),

test/testdata/demo_eager.html

@@ -53,15 +53,14 @@ <h1 class="modulename">
                         <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="c1"># no from __future__ import annotations!</span>
 </span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span>
 </span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Literal</span>
-</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Union</span>
+</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a>
 </span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a>
-</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a>
-</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="k">def</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">int</span><span class="p">]:</span>
-</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="k">def</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span><span class="p">:</span>
+</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a>
 </span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a>
-</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a>
-</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="k">def</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">],</span> <span class="o">/</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">]:</span>
-</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a><span class="k">def</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">],</span> <span class="o">/</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">]:</span>
+</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
 </span></pre></div>
 
 
@@ -71,14 +70,14 @@ <h1 class="modulename">
 <div class="attr function">
 
         <span class="def">def</span>
-        <span class="name">foo</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">]</span></span><span class="return-annotation">) -> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">int</span><span class="p">]</span>:</span></span>
+        <span class="name">foo</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">x</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">]</span></span><span class="return-annotation">) -> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span>:</span></span>
 
                 <label class="view-source-button" for="foo-view-source"><span>View Source</span></label>
 
     </div>
     <a class="headerlink" href="#foo"></a>
-            <div class="pdoc-code codehilite"><pre><span></span><span id="foo-8"><a href="#foo-8"><span class="linenos">8</span></a><span class="k">def</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">int</span><span class="p">]:</span>
-</span><span id="foo-9"><a href="#foo-9"><span class="linenos">9</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+            <div class="pdoc-code codehilite"><pre><span></span><span id="foo-7"><a href="#foo-7"><span class="linenos">7</span></a><span class="k">def</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span><span class="p">:</span>
+</span><span id="foo-8"><a href="#foo-8"><span class="linenos">8</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
 </span></pre></div>
 
 
@@ -96,8 +95,8 @@ <h1 class="modulename">
 
     </div>
     <a class="headerlink" href="#bar"></a>
-            <div class="pdoc-code codehilite"><pre><span></span><span id="bar-12"><a href="#bar-12"><span class="linenos">12</span></a><span class="k">def</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">],</span> <span class="o">/</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">]:</span>
-</span><span id="bar-13"><a href="#bar-13"><span class="linenos">13</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+            <div class="pdoc-code codehilite"><pre><span></span><span id="bar-11"><a href="#bar-11"><span class="linenos">11</span></a><span class="k">def</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">],</span> <span class="o">/</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="s2">&quot;int&quot;</span><span class="p">]:</span>
+</span><span id="bar-12"><a href="#bar-12"><span class="linenos">12</span></a>    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
 </span></pre></div>
 
 

test/testdata/demo_eager.py

@@ -1,10 +1,9 @@
 # no from __future__ import annotations!
 from typing import List
 from typing import Literal
-from typing import Union
 
 
-def foo(x: Literal["r", "w"]) -> Union[str, int]:
+def foo(x: Literal["r", "w"]) -> str | int:
     raise NotImplementedError
 
 

test/testdata/demo_eager.txt

@@ -1,4 +1,4 @@
 <module demo_eager
-    <function def foo(x: Literal['r', 'w']) -> Union[str, int]: ...>
+    <function def foo(x: Literal['r', 'w']) -> str | int: ...>
     <function def bar(x: list[int], /) -> List[int]: ...>
 >