Skip to content

Update Dependencies #788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhils merged 2 commits into from
Mar 18, 2025
Merged

Update Dependencies #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cef4157
update dependencies
mhils Mar 18, 2025
c3e22ae
[autofix.ci] apply automated fixes
autofix-ci[bot] Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .python-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.13.1
3.13.2
2 changes: 1 addition & 1 deletion pdoc/doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1095,7 +1095,7 @@ def __repr__(self):
default = f" = {self.default_value_str}"
else:
default = ""
return f'<var {self.qualname.rsplit(".")[-1]}{self.annotation_str}{default}{_docstr(self)}>'
return f"<var {self.qualname.rsplit('.')[-1]}{self.annotation_str}{default}{_docstr(self)}>"

@cached_property
def is_classvar(self) -> bool:
Expand Down
2 changes: 1 addition & 1 deletion pdoc/doc_ast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ def _parse(
try:
return ast.parse(_dedent(source))
except Exception as e:
warnings.warn(f"Error parsing source code: {e}\n" f"===\n" f"{source}\n" f"===")
warnings.warn(f"Error parsing source code: {e}\n===\n{source}\n===")
return ast.parse("")


Expand Down
2 changes: 1 addition & 1 deletion test/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def test_rst_extract_options():
"alpha": "beta",
"charlie": "delta:foxtrot",
}
assert content == ("\nrest of content\n" ":option ignored: as follows content\n")
assert content == ("\nrest of content\n:option ignored: as follows content\n")


def test_rst_include_trim_lines():
Expand Down
8 changes: 4 additions & 4 deletions test/testdata/ast_parsing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ <h1 class="modulename">

<label class="view-source-button" for="mod-ast_parsing-view-source"><span>View Source</span></label>

<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="k">class</span> <span class="nc">Foo</span><span class="p">:</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="k">class</span><span class="w"> </span><span class="nc">Foo</span><span class="p">:</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">no_docstring</span> <span class="o">=</span> <span class="mi">42</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">with_docstring</span> <span class="o">=</span> <span class="mi">43</span>
</span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;This is an attribute docstring.&quot;&quot;&quot;</span>
Expand All @@ -76,8 +76,8 @@ <h1 class="modulename">

</div>
<a class="headerlink" href="#Foo"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="Foo-2"><a href="#Foo-2"><span class="linenos">2</span></a><span class="k">class</span> <span class="nc">Foo</span><span class="p">:</span>
</span><span id="Foo-3"><a href="#Foo-3"><span class="linenos">3</span></a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="Foo-2"><a href="#Foo-2"><span class="linenos">2</span></a><span class="k">class</span><span class="w"> </span><span class="nc">Foo</span><span class="p">:</span>
</span><span id="Foo-3"><a href="#Foo-3"><span class="linenos">3</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
</span><span id="Foo-4"><a href="#Foo-4"><span class="linenos">4</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">no_docstring</span> <span class="o">=</span> <span class="mi">42</span>
</span><span id="Foo-5"><a href="#Foo-5"><span class="linenos">5</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">with_docstring</span> <span class="o">=</span> <span class="mi">43</span>
</span><span id="Foo-6"><a href="#Foo-6"><span class="linenos">6</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;This is an attribute docstring.&quot;&quot;&quot;</span>
Expand Down
16 changes: 8 additions & 8 deletions test/testdata/collections_abc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,21 @@ <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="sd">&quot;&quot;&quot;Test that we remove &#39;collections.abc&#39; from type signatures.&quot;&quot;&quot;</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a>
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Awaitable</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a><span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Container</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">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Awaitable</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">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Container</span>
</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="nf">func</span><span class="p">(</span><span class="n">bar</span><span class="p">:</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">]:</span>
</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">func</span><span class="p">(</span><span class="n">bar</span><span class="p">:</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">]:</span>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a> <span class="k">return</span> <span class="n">bar</span>
</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">class</span> <span class="nc">Class</span><span class="p">(</span><span class="n">Container</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="k">class</span><span class="w"> </span><span class="nc">Class</span><span class="p">(</span><span class="n">Container</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="sd"> For subclasses, we currently display the full classname.</span>
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a><span class="sd"> Mostly because it&#39;s easier, but it also makes a bit more sense here.</span>
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a>
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a> <span class="k">def</span> <span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a> <span class="k">return</span> <span class="n">item</span> <span class="o">==</span> <span class="s2">&quot;Bar&quot;</span>
</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a>
</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a>
Expand All @@ -94,7 +94,7 @@ <h1 class="modulename">

</div>
<a class="headerlink" href="#func"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="func-8"><a href="#func-8"><span class="linenos">8</span></a><span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">bar</span><span class="p">:</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">]:</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="func-8"><a href="#func-8"><span class="linenos">8</span></a><span class="k">def</span><span class="w"> </span><span class="nf">func</span><span class="p">(</span><span class="n">bar</span><span class="p">:</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Awaitable</span><span class="p">[</span><span class="kc">None</span><span class="p">]:</span>
</span><span id="func-9"><a href="#func-9"><span class="linenos">9</span></a> <span class="k">return</span> <span class="n">bar</span>
</span></pre></div>

Expand All @@ -113,13 +113,13 @@ <h1 class="modulename">

</div>
<a class="headerlink" href="#Class"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="Class-12"><a href="#Class-12"><span class="linenos">12</span></a><span class="k">class</span> <span class="nc">Class</span><span class="p">(</span><span class="n">Container</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="Class-12"><a href="#Class-12"><span class="linenos">12</span></a><span class="k">class</span><span class="w"> </span><span class="nc">Class</span><span class="p">(</span><span class="n">Container</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
</span><span id="Class-13"><a href="#Class-13"><span class="linenos">13</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="Class-14"><a href="#Class-14"><span class="linenos">14</span></a><span class="sd"> For subclasses, we currently display the full classname.</span>
</span><span id="Class-15"><a href="#Class-15"><span class="linenos">15</span></a><span class="sd"> Mostly because it&#39;s easier, but it also makes a bit more sense here.</span>
</span><span id="Class-16"><a href="#Class-16"><span class="linenos">16</span></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="Class-17"><a href="#Class-17"><span class="linenos">17</span></a>
</span><span id="Class-18"><a href="#Class-18"><span class="linenos">18</span></a> <span class="k">def</span> <span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
</span><span id="Class-18"><a href="#Class-18"><span class="linenos">18</span></a> <span class="k">def</span><span class="w"> </span><span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
</span><span id="Class-19"><a href="#Class-19"><span class="linenos">19</span></a> <span class="k">return</span> <span class="n">item</span> <span class="o">==</span> <span class="s2">&quot;Bar&quot;</span>
</span></pre></div>

Expand Down
Loading