Skip to content
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

Fix rendering of class attributes pointing to external classes, fix #464 #465

Merged
merged 2 commits into from
Nov 14, 2022
Merged

Fix rendering of class attributes pointing to external classes, fix #464 #465

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
824af0e
fix rendering of class attributes pointing to external classes, fix #464
mhils Nov 14, 2022
52acc97
[autofix.ci] apply automated fixes
autofix-ci[bot] Nov 14, 2022
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: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
([#107](https://github.com/mitmproxy/pdoc/issues/107), @mhils)
- Improve the conversion of reStructuredText to Markdown for function and method references.
([#463](https://github.com/mitmproxy/pdoc/pull/463), @vsajip)
- Static class attributes that point to a class are now rendered as variables, not as separate classes.
([#465](https://github.com/mitmproxy/pdoc/pull/465), @mhils)

## 2022-11-10: pdoc 12.2.2

Expand Down
1 change: 1 addition & 0 deletions pdoc/doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@ def members(self) -> dict[str, Doc]:
inspect.isclass(obj)
and obj is not empty
and not isinstance(obj, GenericAlias)
and obj.__qualname__.rpartition(".")[2] == qualname.rpartition(".")[2]
):
# `dict[str,str]` is a GenericAlias instance. We want to render type aliases as variables though.
doc = Class(self.modulename, qualname, obj, taken_from)
Expand Down
151 changes: 118 additions & 33 deletions test/testdata/misc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,21 @@ <h2>API Documentation</h2>
</ul>

</li>
<li>
<a class="class" href="#ClassAsAttribute">ClassAsAttribute</a>
<ul class="memberlist">
<li>
<a class="function" href="#ClassAsAttribute.__init__">ClassAsAttribute</a>
</li>
<li>
<a class="variable" href="#ClassAsAttribute.static_attr_to_class">static_attr_to_class</a>
</li>
<li>
<a class="variable" href="#ClassAsAttribute.static_attr_to_instance">static_attr_to_instance</a>
</li>
</ul>

</li>
</ul>


Expand Down Expand Up @@ -680,39 +695,48 @@ <h1 class="modulename">
</span><span id="L-385"><a href="#L-385"><span class="linenos">385</span></a> <span class="bp">self</span><span class="o">.</span><span class="n">x</span> <span class="o">=</span> <span class="n">x</span>
</span><span id="L-386"><a href="#L-386"><span class="linenos">386</span></a>
</span><span id="L-387"><a href="#L-387"><span class="linenos">387</span></a>
</span><span id="L-388"><a href="#L-388"><span class="linenos">388</span></a><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="L-389"><a href="#L-389"><span class="linenos">389</span></a> <span class="s2">&quot;Issue226&quot;</span><span class="p">,</span>
</span><span id="L-390"><a href="#L-390"><span class="linenos">390</span></a> <span class="s2">&quot;var_with_default_obj&quot;</span><span class="p">,</span>
</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a> <span class="s2">&quot;var_with_default_func&quot;</span><span class="p">,</span>
</span><span id="L-392"><a href="#L-392"><span class="linenos">392</span></a> <span class="s2">&quot;func_with_defaults&quot;</span><span class="p">,</span>
</span><span id="L-393"><a href="#L-393"><span class="linenos">393</span></a> <span class="s2">&quot;ClassmethodLink&quot;</span><span class="p">,</span>
</span><span id="L-394"><a href="#L-394"><span class="linenos">394</span></a> <span class="s2">&quot;GenericParent&quot;</span><span class="p">,</span>
</span><span id="L-395"><a href="#L-395"><span class="linenos">395</span></a> <span class="s2">&quot;NonGenericChild&quot;</span><span class="p">,</span>
</span><span id="L-396"><a href="#L-396"><span class="linenos">396</span></a> <span class="s2">&quot;Child&quot;</span><span class="p">,</span>
</span><span id="L-397"><a href="#L-397"><span class="linenos">397</span></a> <span class="s2">&quot;only_annotated&quot;</span><span class="p">,</span>
</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a> <span class="s2">&quot;_Private&quot;</span><span class="p">,</span>
</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a> <span class="s2">&quot;LambdaAttr&quot;</span><span class="p">,</span>
</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a> <span class="s2">&quot;foo&quot;</span><span class="p">,</span>
</span><span id="L-401"><a href="#L-401"><span class="linenos">401</span></a> <span class="s2">&quot;bar&quot;</span><span class="p">,</span>
</span><span id="L-402"><a href="#L-402"><span class="linenos">402</span></a> <span class="s2">&quot;baz&quot;</span><span class="p">,</span>
</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a> <span class="s2">&quot;qux&quot;</span><span class="p">,</span>
</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a> <span class="s2">&quot;Indented&quot;</span><span class="p">,</span>
</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a> <span class="s2">&quot;fun_with_protected_decorator&quot;</span><span class="p">,</span>
</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a> <span class="s2">&quot;unhashable&quot;</span><span class="p">,</span>
</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a> <span class="s2">&quot;AbstractClass&quot;</span><span class="p">,</span>
</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a> <span class="s2">&quot;add_four&quot;</span><span class="p">,</span>
</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a> <span class="s2">&quot;add_five&quot;</span><span class="p">,</span>
</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a> <span class="s2">&quot;add_six&quot;</span><span class="p">,</span>
</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a> <span class="s2">&quot;linkify_links&quot;</span><span class="p">,</span>
</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a> <span class="s2">&quot;Issue352a&quot;</span><span class="p">,</span>
</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a> <span class="s2">&quot;Issue352b&quot;</span><span class="p">,</span>
</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a> <span class="s2">&quot;CustomCall&quot;</span><span class="p">,</span>
</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a> <span class="s2">&quot;Headings&quot;</span><span class="p">,</span>
</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a> <span class="s2">&quot;repr_not_syntax_highlightable&quot;</span><span class="p">,</span>
</span><span id="L-417"><a href="#L-417"><span class="linenos">417</span></a> <span class="s2">&quot;ClassDecorator&quot;</span><span class="p">,</span>
</span><span id="L-418"><a href="#L-418"><span class="linenos">418</span></a> <span class="s2">&quot;another_decorated_function&quot;</span><span class="p">,</span>
</span><span id="L-419"><a href="#L-419"><span class="linenos">419</span></a> <span class="s2">&quot;SubclassRef&quot;</span><span class="p">,</span>
</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a><span class="p">]</span>
</span><span id="L-388"><a href="#L-388"><span class="linenos">388</span></a><span class="k">class</span> <span class="nc">ClassAsAttribute</span><span class="p">:</span>
</span><span id="L-389"><a href="#L-389"><span class="linenos">389</span></a> <span class="n">static_attr_to_class</span> <span class="o">=</span> <span class="n">ClassDecorator</span>
</span><span id="L-390"><a href="#L-390"><span class="linenos">390</span></a> <span class="sd">&quot;&quot;&quot;this is a static attribute that point to a Class (not an instance)&quot;&quot;&quot;</span>
</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a>
</span><span id="L-392"><a href="#L-392"><span class="linenos">392</span></a> <span class="n">static_attr_to_instance</span> <span class="o">=</span> <span class="n">ClassDecorator</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
</span><span id="L-393"><a href="#L-393"><span class="linenos">393</span></a> <span class="sd">&quot;&quot;&quot;this is a static attribute that point to an instance&quot;&quot;&quot;</span>
</span><span id="L-394"><a href="#L-394"><span class="linenos">394</span></a>
</span><span id="L-395"><a href="#L-395"><span class="linenos">395</span></a>
</span><span id="L-396"><a href="#L-396"><span class="linenos">396</span></a><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
</span><span id="L-397"><a href="#L-397"><span class="linenos">397</span></a> <span class="s2">&quot;Issue226&quot;</span><span class="p">,</span>
</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a> <span class="s2">&quot;var_with_default_obj&quot;</span><span class="p">,</span>
</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a> <span class="s2">&quot;var_with_default_func&quot;</span><span class="p">,</span>
</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a> <span class="s2">&quot;func_with_defaults&quot;</span><span class="p">,</span>
</span><span id="L-401"><a href="#L-401"><span class="linenos">401</span></a> <span class="s2">&quot;ClassmethodLink&quot;</span><span class="p">,</span>
</span><span id="L-402"><a href="#L-402"><span class="linenos">402</span></a> <span class="s2">&quot;GenericParent&quot;</span><span class="p">,</span>
</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a> <span class="s2">&quot;NonGenericChild&quot;</span><span class="p">,</span>
</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a> <span class="s2">&quot;Child&quot;</span><span class="p">,</span>
</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a> <span class="s2">&quot;only_annotated&quot;</span><span class="p">,</span>
</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a> <span class="s2">&quot;_Private&quot;</span><span class="p">,</span>
</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a> <span class="s2">&quot;LambdaAttr&quot;</span><span class="p">,</span>
</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a> <span class="s2">&quot;foo&quot;</span><span class="p">,</span>
</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a> <span class="s2">&quot;bar&quot;</span><span class="p">,</span>
</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a> <span class="s2">&quot;baz&quot;</span><span class="p">,</span>
</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a> <span class="s2">&quot;qux&quot;</span><span class="p">,</span>
</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a> <span class="s2">&quot;Indented&quot;</span><span class="p">,</span>
</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a> <span class="s2">&quot;fun_with_protected_decorator&quot;</span><span class="p">,</span>
</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a> <span class="s2">&quot;unhashable&quot;</span><span class="p">,</span>
</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a> <span class="s2">&quot;AbstractClass&quot;</span><span class="p">,</span>
</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a> <span class="s2">&quot;add_four&quot;</span><span class="p">,</span>
</span><span id="L-417"><a href="#L-417"><span class="linenos">417</span></a> <span class="s2">&quot;add_five&quot;</span><span class="p">,</span>
</span><span id="L-418"><a href="#L-418"><span class="linenos">418</span></a> <span class="s2">&quot;add_six&quot;</span><span class="p">,</span>
</span><span id="L-419"><a href="#L-419"><span class="linenos">419</span></a> <span class="s2">&quot;linkify_links&quot;</span><span class="p">,</span>
</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a> <span class="s2">&quot;Issue352a&quot;</span><span class="p">,</span>
</span><span id="L-421"><a href="#L-421"><span class="linenos">421</span></a> <span class="s2">&quot;Issue352b&quot;</span><span class="p">,</span>
</span><span id="L-422"><a href="#L-422"><span class="linenos">422</span></a> <span class="s2">&quot;CustomCall&quot;</span><span class="p">,</span>
</span><span id="L-423"><a href="#L-423"><span class="linenos">423</span></a> <span class="s2">&quot;Headings&quot;</span><span class="p">,</span>
</span><span id="L-424"><a href="#L-424"><span class="linenos">424</span></a> <span class="s2">&quot;repr_not_syntax_highlightable&quot;</span><span class="p">,</span>
</span><span id="L-425"><a href="#L-425"><span class="linenos">425</span></a> <span class="s2">&quot;ClassDecorator&quot;</span><span class="p">,</span>
</span><span id="L-426"><a href="#L-426"><span class="linenos">426</span></a> <span class="s2">&quot;another_decorated_function&quot;</span><span class="p">,</span>
</span><span id="L-427"><a href="#L-427"><span class="linenos">427</span></a> <span class="s2">&quot;SubclassRef&quot;</span><span class="p">,</span>
</span><span id="L-428"><a href="#L-428"><span class="linenos">428</span></a> <span class="s2">&quot;ClassAsAttribute&quot;</span><span class="p">,</span>
</span><span id="L-429"><a href="#L-429"><span class="linenos">429</span></a><span class="p">]</span>
</span></pre></div>


Expand Down Expand Up @@ -2206,6 +2230,67 @@ <h6 id="heading-6">Heading 6</h6>



</div>
</section>
<section id="ClassAsAttribute">
<input id="ClassAsAttribute-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr class">

<span class="def">class</span>
<span class="name">ClassAsAttribute</span>:

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

</div>
<a class="headerlink" href="#ClassAsAttribute"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="ClassAsAttribute-389"><a href="#ClassAsAttribute-389"><span class="linenos">389</span></a><span class="k">class</span> <span class="nc">ClassAsAttribute</span><span class="p">:</span>
</span><span id="ClassAsAttribute-390"><a href="#ClassAsAttribute-390"><span class="linenos">390</span></a> <span class="n">static_attr_to_class</span> <span class="o">=</span> <span class="n">ClassDecorator</span>
</span><span id="ClassAsAttribute-391"><a href="#ClassAsAttribute-391"><span class="linenos">391</span></a> <span class="sd">&quot;&quot;&quot;this is a static attribute that point to a Class (not an instance)&quot;&quot;&quot;</span>
</span><span id="ClassAsAttribute-392"><a href="#ClassAsAttribute-392"><span class="linenos">392</span></a>
</span><span id="ClassAsAttribute-393"><a href="#ClassAsAttribute-393"><span class="linenos">393</span></a> <span class="n">static_attr_to_instance</span> <span class="o">=</span> <span class="n">ClassDecorator</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
</span><span id="ClassAsAttribute-394"><a href="#ClassAsAttribute-394"><span class="linenos">394</span></a> <span class="sd">&quot;&quot;&quot;this is a static attribute that point to an instance&quot;&quot;&quot;</span>
</span></pre></div>




<div id="ClassAsAttribute.__init__" class="classattr">
<div class="attr function">

<span class="name">ClassAsAttribute</span><span class="signature pdoc-code condensed">()</span>


</div>
<a class="headerlink" href="#ClassAsAttribute.__init__"></a>



</div>
<div id="ClassAsAttribute.static_attr_to_class" class="classattr">
<div class="attr variable">
<span class="name">static_attr_to_class</span><span class="default_value"> = &lt;class &#39;<a href="#ClassDecorator">misc.ClassDecorator</a>&#39;&gt;</span>


</div>
<a class="headerlink" href="#ClassAsAttribute.static_attr_to_class"></a>

<div class="docstring"><p>this is a static attribute that point to a Class (not an instance)</p>
</div>


</div>
<div id="ClassAsAttribute.static_attr_to_instance" class="classattr">
<div class="attr variable">
<span class="name">static_attr_to_instance</span><span class="default_value"> = &lt;<a href="#ClassDecorator">misc.ClassDecorator</a> object&gt;</span>


</div>
<a class="headerlink" href="#ClassAsAttribute.static_attr_to_instance"></a>

<div class="docstring"><p>this is a static attribute that point to an instance</p>
</div>


</div>
</section>
</main>
Expand Down
9 changes: 9 additions & 0 deletions test/testdata/misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,14 @@ def __init__(self, x: "SubClass"):
self.x = x


class ClassAsAttribute:
static_attr_to_class = ClassDecorator
"""this is a static attribute that point to a Class (not an instance)"""

static_attr_to_instance = ClassDecorator(None)
"""this is a static attribute that point to an instance"""


__all__ = [
"Issue226",
"var_with_default_obj",
Expand Down Expand Up @@ -417,4 +425,5 @@ def __init__(self, x: "SubClass"):
"ClassDecorator",
"another_decorated_function",
"SubclassRef",
"ClassAsAttribute",
]
6 changes: 5 additions & 1 deletion test/testdata/misc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,8 @@
<method def __init__(self, x: misc.SubclassRef.SubClass): ...>
<class misc.SubclassRef.SubClass
<method def __init__(): ...>>
<var x>>>
<var x>>
<class misc.ClassAsAttribute
<method def __init__(): ...>
<var static_attr_to_class = <class 'misc.ClassDecorator'> # this is a static att…>
<var static_attr_to_instance = <misc.ClassDecorator object> # this is a static att…>>>