tests++

mitmproxy · Jun 19, 2023 · a4c95c0 · a4c95c0
1 parent daa878b
commit a4c95c0
Show file tree

Hide file tree

Showing 6 changed files with 139 additions and 41 deletions.
diff --git a/test/testdata/misc.html b/test/testdata/misc.html
@@ -284,6 +284,15 @@ <h2>API Documentation</h2>
                 </ul>
 
             </li>
+            <li>
+                    <a class="class" href="#DocstringFromNew">DocstringFromNew</a>
+                            <ul class="memberlist">
+                        <li>
+                                <a class="function" href="#DocstringFromNew.__init__">DocstringFromNew</a>
+                        </li>
+                </ul>
+
+            </li>
     </ul>
 
 
@@ -739,47 +748,53 @@ <h1 class="modulename">
 </span><span id="L-432"><a href="#L-432"><span class="linenos">432</span></a>    <span class="k">pass</span>
 </span><span id="L-433"><a href="#L-433"><span class="linenos">433</span></a>
 </span><span id="L-434"><a href="#L-434"><span class="linenos">434</span></a>
-</span><span id="L-435"><a href="#L-435"><span class="linenos">435</span></a><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
-</span><span id="L-436"><a href="#L-436"><span class="linenos">436</span></a>    <span class="s2">&quot;Issue226&quot;</span><span class="p">,</span>
-</span><span id="L-437"><a href="#L-437"><span class="linenos">437</span></a>    <span class="s2">&quot;var_with_default_obj&quot;</span><span class="p">,</span>
-</span><span id="L-438"><a href="#L-438"><span class="linenos">438</span></a>    <span class="s2">&quot;var_with_default_func&quot;</span><span class="p">,</span>
-</span><span id="L-439"><a href="#L-439"><span class="linenos">439</span></a>    <span class="s2">&quot;func_with_defaults&quot;</span><span class="p">,</span>
-</span><span id="L-440"><a href="#L-440"><span class="linenos">440</span></a>    <span class="s2">&quot;ClassmethodLink&quot;</span><span class="p">,</span>
-</span><span id="L-441"><a href="#L-441"><span class="linenos">441</span></a>    <span class="s2">&quot;GenericParent&quot;</span><span class="p">,</span>
-</span><span id="L-442"><a href="#L-442"><span class="linenos">442</span></a>    <span class="s2">&quot;NonGenericChild&quot;</span><span class="p">,</span>
-</span><span id="L-443"><a href="#L-443"><span class="linenos">443</span></a>    <span class="s2">&quot;Child&quot;</span><span class="p">,</span>
-</span><span id="L-444"><a href="#L-444"><span class="linenos">444</span></a>    <span class="s2">&quot;only_annotated&quot;</span><span class="p">,</span>
-</span><span id="L-445"><a href="#L-445"><span class="linenos">445</span></a>    <span class="s2">&quot;_Private&quot;</span><span class="p">,</span>
-</span><span id="L-446"><a href="#L-446"><span class="linenos">446</span></a>    <span class="s2">&quot;LambdaAttr&quot;</span><span class="p">,</span>
-</span><span id="L-447"><a href="#L-447"><span class="linenos">447</span></a>    <span class="s2">&quot;foo&quot;</span><span class="p">,</span>
-</span><span id="L-448"><a href="#L-448"><span class="linenos">448</span></a>    <span class="s2">&quot;bar&quot;</span><span class="p">,</span>
-</span><span id="L-449"><a href="#L-449"><span class="linenos">449</span></a>    <span class="s2">&quot;baz&quot;</span><span class="p">,</span>
-</span><span id="L-450"><a href="#L-450"><span class="linenos">450</span></a>    <span class="s2">&quot;qux&quot;</span><span class="p">,</span>
-</span><span id="L-451"><a href="#L-451"><span class="linenos">451</span></a>    <span class="s2">&quot;Indented&quot;</span><span class="p">,</span>
-</span><span id="L-452"><a href="#L-452"><span class="linenos">452</span></a>    <span class="s2">&quot;fun_with_protected_decorator&quot;</span><span class="p">,</span>
-</span><span id="L-453"><a href="#L-453"><span class="linenos">453</span></a>    <span class="s2">&quot;unhashable&quot;</span><span class="p">,</span>
-</span><span id="L-454"><a href="#L-454"><span class="linenos">454</span></a>    <span class="s2">&quot;AbstractClass&quot;</span><span class="p">,</span>
-</span><span id="L-455"><a href="#L-455"><span class="linenos">455</span></a>    <span class="s2">&quot;add_four&quot;</span><span class="p">,</span>
-</span><span id="L-456"><a href="#L-456"><span class="linenos">456</span></a>    <span class="s2">&quot;add_five&quot;</span><span class="p">,</span>
-</span><span id="L-457"><a href="#L-457"><span class="linenos">457</span></a>    <span class="s2">&quot;add_six&quot;</span><span class="p">,</span>
-</span><span id="L-458"><a href="#L-458"><span class="linenos">458</span></a>    <span class="s2">&quot;linkify_links&quot;</span><span class="p">,</span>
-</span><span id="L-459"><a href="#L-459"><span class="linenos">459</span></a>    <span class="s2">&quot;Issue352a&quot;</span><span class="p">,</span>
-</span><span id="L-460"><a href="#L-460"><span class="linenos">460</span></a>    <span class="s2">&quot;Issue352b&quot;</span><span class="p">,</span>
-</span><span id="L-461"><a href="#L-461"><span class="linenos">461</span></a>    <span class="s2">&quot;CustomCall&quot;</span><span class="p">,</span>
-</span><span id="L-462"><a href="#L-462"><span class="linenos">462</span></a>    <span class="s2">&quot;Headings&quot;</span><span class="p">,</span>
-</span><span id="L-463"><a href="#L-463"><span class="linenos">463</span></a>    <span class="s2">&quot;repr_not_syntax_highlightable&quot;</span><span class="p">,</span>
-</span><span id="L-464"><a href="#L-464"><span class="linenos">464</span></a>    <span class="s2">&quot;ClassDecorator&quot;</span><span class="p">,</span>
-</span><span id="L-465"><a href="#L-465"><span class="linenos">465</span></a>    <span class="s2">&quot;another_decorated_function&quot;</span><span class="p">,</span>
-</span><span id="L-466"><a href="#L-466"><span class="linenos">466</span></a>    <span class="s2">&quot;SubclassRef&quot;</span><span class="p">,</span>
-</span><span id="L-467"><a href="#L-467"><span class="linenos">467</span></a>    <span class="s2">&quot;ClassAsAttribute&quot;</span><span class="p">,</span>
-</span><span id="L-468"><a href="#L-468"><span class="linenos">468</span></a>    <span class="s2">&quot;scheduler&quot;</span><span class="p">,</span>
-</span><span id="L-469"><a href="#L-469"><span class="linenos">469</span></a>    <span class="s2">&quot;__init__&quot;</span><span class="p">,</span>
-</span><span id="L-470"><a href="#L-470"><span class="linenos">470</span></a>    <span class="s2">&quot;dynamically_modify_docstring1&quot;</span><span class="p">,</span>
-</span><span id="L-471"><a href="#L-471"><span class="linenos">471</span></a>    <span class="s2">&quot;dynamically_modify_docstring2&quot;</span><span class="p">,</span>
-</span><span id="L-472"><a href="#L-472"><span class="linenos">472</span></a>    <span class="s2">&quot;dynamically_modify_docstring3&quot;</span><span class="p">,</span>
-</span><span id="L-473"><a href="#L-473"><span class="linenos">473</span></a>    <span class="s2">&quot;dynamically_modify_docstring4&quot;</span><span class="p">,</span>
-</span><span id="L-474"><a href="#L-474"><span class="linenos">474</span></a>    <span class="s2">&quot;MyDict&quot;</span><span class="p">,</span>
-</span><span id="L-475"><a href="#L-475"><span class="linenos">475</span></a><span class="p">]</span>
+</span><span id="L-435"><a href="#L-435"><span class="linenos">435</span></a><span class="k">class</span> <span class="nc">DocstringFromNew</span><span class="p">:</span>
+</span><span id="L-436"><a href="#L-436"><span class="linenos">436</span></a>    <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+</span><span id="L-437"><a href="#L-437"><span class="linenos">437</span></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;This is a class with a docstring inferred from `__new__`.&quot;&quot;&quot;</span>
+</span><span id="L-438"><a href="#L-438"><span class="linenos">438</span></a>
+</span><span id="L-439"><a href="#L-439"><span class="linenos">439</span></a>
+</span><span id="L-440"><a href="#L-440"><span class="linenos">440</span></a><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
+</span><span id="L-441"><a href="#L-441"><span class="linenos">441</span></a>    <span class="s2">&quot;Issue226&quot;</span><span class="p">,</span>
+</span><span id="L-442"><a href="#L-442"><span class="linenos">442</span></a>    <span class="s2">&quot;var_with_default_obj&quot;</span><span class="p">,</span>
+</span><span id="L-443"><a href="#L-443"><span class="linenos">443</span></a>    <span class="s2">&quot;var_with_default_func&quot;</span><span class="p">,</span>
+</span><span id="L-444"><a href="#L-444"><span class="linenos">444</span></a>    <span class="s2">&quot;func_with_defaults&quot;</span><span class="p">,</span>
+</span><span id="L-445"><a href="#L-445"><span class="linenos">445</span></a>    <span class="s2">&quot;ClassmethodLink&quot;</span><span class="p">,</span>
+</span><span id="L-446"><a href="#L-446"><span class="linenos">446</span></a>    <span class="s2">&quot;GenericParent&quot;</span><span class="p">,</span>
+</span><span id="L-447"><a href="#L-447"><span class="linenos">447</span></a>    <span class="s2">&quot;NonGenericChild&quot;</span><span class="p">,</span>
+</span><span id="L-448"><a href="#L-448"><span class="linenos">448</span></a>    <span class="s2">&quot;Child&quot;</span><span class="p">,</span>
+</span><span id="L-449"><a href="#L-449"><span class="linenos">449</span></a>    <span class="s2">&quot;only_annotated&quot;</span><span class="p">,</span>
+</span><span id="L-450"><a href="#L-450"><span class="linenos">450</span></a>    <span class="s2">&quot;_Private&quot;</span><span class="p">,</span>
+</span><span id="L-451"><a href="#L-451"><span class="linenos">451</span></a>    <span class="s2">&quot;LambdaAttr&quot;</span><span class="p">,</span>
+</span><span id="L-452"><a href="#L-452"><span class="linenos">452</span></a>    <span class="s2">&quot;foo&quot;</span><span class="p">,</span>
+</span><span id="L-453"><a href="#L-453"><span class="linenos">453</span></a>    <span class="s2">&quot;bar&quot;</span><span class="p">,</span>
+</span><span id="L-454"><a href="#L-454"><span class="linenos">454</span></a>    <span class="s2">&quot;baz&quot;</span><span class="p">,</span>
+</span><span id="L-455"><a href="#L-455"><span class="linenos">455</span></a>    <span class="s2">&quot;qux&quot;</span><span class="p">,</span>
+</span><span id="L-456"><a href="#L-456"><span class="linenos">456</span></a>    <span class="s2">&quot;Indented&quot;</span><span class="p">,</span>
+</span><span id="L-457"><a href="#L-457"><span class="linenos">457</span></a>    <span class="s2">&quot;fun_with_protected_decorator&quot;</span><span class="p">,</span>
+</span><span id="L-458"><a href="#L-458"><span class="linenos">458</span></a>    <span class="s2">&quot;unhashable&quot;</span><span class="p">,</span>
+</span><span id="L-459"><a href="#L-459"><span class="linenos">459</span></a>    <span class="s2">&quot;AbstractClass&quot;</span><span class="p">,</span>
+</span><span id="L-460"><a href="#L-460"><span class="linenos">460</span></a>    <span class="s2">&quot;add_four&quot;</span><span class="p">,</span>
+</span><span id="L-461"><a href="#L-461"><span class="linenos">461</span></a>    <span class="s2">&quot;add_five&quot;</span><span class="p">,</span>
+</span><span id="L-462"><a href="#L-462"><span class="linenos">462</span></a>    <span class="s2">&quot;add_six&quot;</span><span class="p">,</span>
+</span><span id="L-463"><a href="#L-463"><span class="linenos">463</span></a>    <span class="s2">&quot;linkify_links&quot;</span><span class="p">,</span>
+</span><span id="L-464"><a href="#L-464"><span class="linenos">464</span></a>    <span class="s2">&quot;Issue352a&quot;</span><span class="p">,</span>
+</span><span id="L-465"><a href="#L-465"><span class="linenos">465</span></a>    <span class="s2">&quot;Issue352b&quot;</span><span class="p">,</span>
+</span><span id="L-466"><a href="#L-466"><span class="linenos">466</span></a>    <span class="s2">&quot;CustomCall&quot;</span><span class="p">,</span>
+</span><span id="L-467"><a href="#L-467"><span class="linenos">467</span></a>    <span class="s2">&quot;Headings&quot;</span><span class="p">,</span>
+</span><span id="L-468"><a href="#L-468"><span class="linenos">468</span></a>    <span class="s2">&quot;repr_not_syntax_highlightable&quot;</span><span class="p">,</span>
+</span><span id="L-469"><a href="#L-469"><span class="linenos">469</span></a>    <span class="s2">&quot;ClassDecorator&quot;</span><span class="p">,</span>
+</span><span id="L-470"><a href="#L-470"><span class="linenos">470</span></a>    <span class="s2">&quot;another_decorated_function&quot;</span><span class="p">,</span>
+</span><span id="L-471"><a href="#L-471"><span class="linenos">471</span></a>    <span class="s2">&quot;SubclassRef&quot;</span><span class="p">,</span>
+</span><span id="L-472"><a href="#L-472"><span class="linenos">472</span></a>    <span class="s2">&quot;ClassAsAttribute&quot;</span><span class="p">,</span>
+</span><span id="L-473"><a href="#L-473"><span class="linenos">473</span></a>    <span class="s2">&quot;scheduler&quot;</span><span class="p">,</span>
+</span><span id="L-474"><a href="#L-474"><span class="linenos">474</span></a>    <span class="s2">&quot;__init__&quot;</span><span class="p">,</span>
+</span><span id="L-475"><a href="#L-475"><span class="linenos">475</span></a>    <span class="s2">&quot;dynamically_modify_docstring1&quot;</span><span class="p">,</span>
+</span><span id="L-476"><a href="#L-476"><span class="linenos">476</span></a>    <span class="s2">&quot;dynamically_modify_docstring2&quot;</span><span class="p">,</span>
+</span><span id="L-477"><a href="#L-477"><span class="linenos">477</span></a>    <span class="s2">&quot;dynamically_modify_docstring3&quot;</span><span class="p">,</span>
+</span><span id="L-478"><a href="#L-478"><span class="linenos">478</span></a>    <span class="s2">&quot;dynamically_modify_docstring4&quot;</span><span class="p">,</span>
+</span><span id="L-479"><a href="#L-479"><span class="linenos">479</span></a>    <span class="s2">&quot;MyDict&quot;</span><span class="p">,</span>
+</span><span id="L-480"><a href="#L-480"><span class="linenos">480</span></a>    <span class="s2">&quot;DocstringFromNew&quot;</span><span class="p">,</span>
+</span><span id="L-481"><a href="#L-481"><span class="linenos">481</span></a><span class="p">]</span>
 </span></pre></div>
 
 
@@ -2358,6 +2373,46 @@ <h5>Inherited Members</h5>
                                 </dl>
                             </div>
                 </section>
+                <section id="DocstringFromNew">
+                            <input id="DocstringFromNew-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">DocstringFromNew</span>:
+
+                <label class="view-source-button" for="DocstringFromNew-view-source"><span>View Source</span></label>
+
+    </div>
+    <a class="headerlink" href="#DocstringFromNew"></a>
+            <div class="pdoc-code codehilite"><pre><span></span><span id="DocstringFromNew-436"><a href="#DocstringFromNew-436"><span class="linenos">436</span></a><span class="k">class</span> <span class="nc">DocstringFromNew</span><span class="p">:</span>
+</span><span id="DocstringFromNew-437"><a href="#DocstringFromNew-437"><span class="linenos">437</span></a>    <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+</span><span id="DocstringFromNew-438"><a href="#DocstringFromNew-438"><span class="linenos">438</span></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;This is a class with a docstring inferred from `__new__`.&quot;&quot;&quot;</span>
+</span></pre></div>
+
+
+
+
+                            <div id="DocstringFromNew.__init__" class="classattr">
+                                        <input id="DocstringFromNew.__init__-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+<div class="attr function">
+
+        <span class="name">DocstringFromNew</span><span class="signature pdoc-code condensed">(<span class="param"><span class="o">*</span><span class="n">args</span>, </span><span class="param"><span class="o">**</span><span class="n">kwargs</span></span>)</span>
+
+                <label class="view-source-button" for="DocstringFromNew.__init__-view-source"><span>View Source</span></label>
+
+    </div>
+    <a class="headerlink" href="#DocstringFromNew.__init__"></a>
+            <div class="pdoc-code codehilite"><pre><span></span><span id="DocstringFromNew.__init__-437"><a href="#DocstringFromNew.__init__-437"><span class="linenos">437</span></a>    <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+</span><span id="DocstringFromNew.__init__-438"><a href="#DocstringFromNew.__init__-438"><span class="linenos">438</span></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;This is a class with a docstring inferred from `__new__`.&quot;&quot;&quot;</span>
+</span></pre></div>
+
+
+            <div class="docstring"><p>This is a class with a docstring inferred from <code>__new__</code>.</p>
+</div>
+
+
+                            </div>
+                </section>
     </main>
 </body>
 </html>
diff --git a/test/testdata/misc.py b/test/testdata/misc.py
@@ -432,6 +432,11 @@ class MyDict(dict):
     pass
 
 
+class DocstringFromNew:
+    def __new__(cls, *args, **kwargs):
+        """This is a class with a docstring inferred from `__new__`."""
+
+
 __all__ = [
     "Issue226",
     "var_with_default_obj",
@@ -472,4 +477,5 @@ class MyDict(dict):
     "dynamically_modify_docstring3",
     "dynamically_modify_docstring4",
     "MyDict",
+    "DocstringFromNew",
 ]
diff --git a/test/testdata/misc.txt b/test/testdata/misc.txt
@@ -132,4 +132,7 @@
         <method def clear(unknown): ...  # inherited from builtins.dict.clear, D.clear() -> None.  …>
         <method def copy(unknown): ...  # inherited from builtins.dict.copy, D.copy() -> a shallo…>
     >
+    <class misc.DocstringFromNew
+        <method def __init__(cls, *args, **kwargs): ...  # This is a class with…>
+    >
 >