Skip to content

Commit

Permalink
Ending type-hints for hatchling part (#626)
Browse files Browse the repository at this point in the history
* Ending type-hints for hatchling part

* fix type-hint error

* fix load plugin from script type

* fix type checking 800245f
  • Loading branch information
ofek committed Dec 6, 2022
1 parent 01fc1c2 commit e3ec32e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions dev/plugins/metadata-hook/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,19 @@
<span class=linenos data-linenos="35 "></span> <span class=n>PLUGIN_NAME</span> <span class=o>=</span> <span class=s1>''</span>
<span class=linenos data-linenos="36 "></span> <span class=sd>"""The name used for selection."""</span>
<span class=linenos data-linenos="37 "></span>
<span class=linenos data-linenos="38 "></span> <span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>root</span><span class=p>,</span> <span class=n>config</span><span class=p>):</span>
<span class=linenos data-linenos="38 "></span> <span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>root</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>config</span><span class=p>:</span> <span class=nb>dict</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<span class=linenos data-linenos="39 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__root</span> <span class=o>=</span> <span class=n>root</span>
<span class=linenos data-linenos="40 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__config</span> <span class=o>=</span> <span class=n>config</span>
<span class=linenos data-linenos="41 "></span>
<span class=linenos data-linenos="42 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="43 "></span> <span class=k>def</span> <span class=nf>root</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="43 "></span> <span class=k>def</span> <span class=nf>root</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="44 "></span> <span class=sd>"""</span>
<span class=linenos data-linenos="45 "></span><span class=sd> The root of the project tree.</span>
<span class=linenos data-linenos="46 "></span><span class=sd> """</span>
<span class=linenos data-linenos="47 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__root</span>
<span class=linenos data-linenos="48 "></span>
<span class=linenos data-linenos="49 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="50 "></span> <span class=k>def</span> <span class=nf>config</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="50 "></span> <span class=k>def</span> <span class=nf>config</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>:</span>
<span class=linenos data-linenos="51 "></span> <span class=sd>"""</span>
<span class=linenos data-linenos="52 "></span><span class=sd> The hook configuration.</span>
<span class=linenos data-linenos="53 "></span>
Expand All @@ -86,7 +86,7 @@
<span class=linenos data-linenos="66 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__config</span>
<span class=linenos data-linenos="67 "></span>
<span class=linenos data-linenos="68 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="69 "></span> <span class=k>def</span> <span class=nf>update</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>metadata</span><span class=p>:</span> <span class=nb>dict</span><span class=p>):</span>
<span class=linenos data-linenos="69 "></span> <span class=k>def</span> <span class=nf>update</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>metadata</span><span class=p>:</span> <span class=nb>dict</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<span class=linenos data-linenos="70 "></span> <span class=sd>"""</span>
<span class=linenos data-linenos="71 "></span><span class=sd> This updates the metadata mapping of the `project` table in-place.</span>
<span class=linenos data-linenos="72 "></span><span class=sd> """</span>
Expand All @@ -96,16 +96,16 @@
<span class=linenos data-linenos="76 "></span><span class=sd> This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.</span>
<span class=linenos data-linenos="77 "></span><span class=sd> """</span>
<span class=linenos data-linenos="78 "></span> <span class=k>return</span> <span class=p>[]</span>
</code></pre></div> </details> <div class="doc doc-children"> <div class="doc doc-object doc-attribute"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.PLUGIN_NAME> <code class="highlight language-python"><span class=n>PLUGIN_NAME</span> <span class=o>=</span> <span class=s1>''</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.PLUGIN_NAME title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>The name used for selection.</p> </div> </div> <div class="doc doc-object doc-function"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.root> <code class="highlight language-python"><span class=n>root</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.root title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>The root of the project tree.</p> <details class=quote> <summary>Source code in <code>hatchling/metadata/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="42 "></span><span class=nd>@property</span>
<span class=linenos data-linenos="43 "></span><span class=k>def</span> <span class=nf>root</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
</code></pre></div> </details> <div class="doc doc-children"> <div class="doc doc-object doc-attribute"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.PLUGIN_NAME> <code class="highlight language-python"><span class=n>PLUGIN_NAME</span> <span class=o>=</span> <span class=s1>''</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.PLUGIN_NAME title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>The name used for selection.</p> </div> </div> <div class="doc doc-object doc-function"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.root> <code class="highlight language-python"><span class=n>root</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>str</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.root title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>The root of the project tree.</p> <details class=quote> <summary>Source code in <code>hatchling/metadata/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="42 "></span><span class=nd>@property</span>
<span class=linenos data-linenos="43 "></span><span class=k>def</span> <span class=nf>root</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="44 "></span> <span class=sd>"""</span>
<span class=linenos data-linenos="45 "></span><span class=sd> The root of the project tree.</span>
<span class=linenos data-linenos="46 "></span><span class=sd> """</span>
<span class=linenos data-linenos="47 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__root</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.config> <code class="highlight language-python"><span class=n>config</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.config title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>The hook configuration.</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_1 name=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1 type=radio><input id=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_2 name=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_1><span class=twemoji><svg viewbox="0 0 16 16" xmlns=http://www.w3.org/2000/svg><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0v-2.5zm7.5-.188V4.25c0 .138.112.25.25.25h2.688a.252.252 0 0 0-.011-.013l-2.914-2.914a.272.272 0 0 0-.013-.011zM5.72 6.72a.75.75 0 0 0 0 1.06l1.47 1.47-1.47 1.47a.75.75 0 1 0 1.06 1.06l2-2a.75.75 0 0 0 0-1.06l-2-2a.75.75 0 0 0-1.06 0zM3.28 7.78a.75.75 0 0 0-1.06-1.06l-2 2a.75.75 0 0 0 0 1.06l2 2a.75.75 0 0 0 1.06-1.06L1.81 9.25l1.47-1.47z" fill-rule=evenodd></path></svg></span> pyproject.toml</label><label for=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_2><span class=twemoji><svg viewbox="0 0 16 16" xmlns=http://www.w3.org/2000/svg><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0v-2.5zm7.5-.188V4.25c0 .138.112.25.25.25h2.688a.252.252 0 0 0-.011-.013l-2.914-2.914a.272.272 0 0 0-.013-.011zM5.72 6.72a.75.75 0 0 0 0 1.06l1.47 1.47-1.47 1.47a.75.75 0 1 0 1.06 1.06l2-2a.75.75 0 0 0 0-1.06l-2-2a.75.75 0 0 0-1.06 0zM3.28 7.78a.75.75 0 0 0-1.06-1.06l-2 2a.75.75 0 0 0 0 1.06l2 2a.75.75 0 0 0 1.06-1.06L1.81 9.25l1.47-1.47z" fill-rule=evenodd></path></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.metadata.hooks.&lt;PLUGIN_NAME&gt;]</span><span class=w></span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.config> <code class="highlight language-python"><span class=n>config</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>dict</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.config title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>The hook configuration.</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_1 name=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1 type=radio><input id=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_2 name=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_1><span class=twemoji><svg viewbox="0 0 16 16" xmlns=http://www.w3.org/2000/svg><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0v-2.5zm7.5-.188V4.25c0 .138.112.25.25.25h2.688a.252.252 0 0 0-.011-.013l-2.914-2.914a.272.272 0 0 0-.013-.011zM5.72 6.72a.75.75 0 0 0 0 1.06l1.47 1.47-1.47 1.47a.75.75 0 1 0 1.06 1.06l2-2a.75.75 0 0 0 0-1.06l-2-2a.75.75 0 0 0-1.06 0zM3.28 7.78a.75.75 0 0 0-1.06-1.06l-2 2a.75.75 0 0 0 0 1.06l2 2a.75.75 0 0 0 1.06-1.06L1.81 9.25l1.47-1.47z" fill-rule=evenodd></path></svg></span> pyproject.toml</label><label for=hatchling.metadata.plugin.interface.MetadataHookInterface.config--__tabbed_1_2><span class=twemoji><svg viewbox="0 0 16 16" xmlns=http://www.w3.org/2000/svg><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0v-2.5zm7.5-.188V4.25c0 .138.112.25.25.25h2.688a.252.252 0 0 0-.011-.013l-2.914-2.914a.272.272 0 0 0-.013-.011zM5.72 6.72a.75.75 0 0 0 0 1.06l1.47 1.47-1.47 1.47a.75.75 0 1 0 1.06 1.06l2-2a.75.75 0 0 0 0-1.06l-2-2a.75.75 0 0 0-1.06 0zM3.28 7.78a.75.75 0 0 0-1.06-1.06l-2 2a.75.75 0 0 0 0 1.06l2 2a.75.75 0 0 0 1.06-1.06L1.81 9.25l1.47-1.47z" fill-rule=evenodd></path></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.metadata.hooks.&lt;PLUGIN_NAME&gt;]</span><span class=w></span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[metadata.hooks.&lt;PLUGIN_NAME&gt;]</span><span class=w></span>
</code></pre></div> </div> </div> </div> <details class=quote> <summary>Source code in <code>hatchling/metadata/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="49 "></span><span class=nd>@property</span>
<span class=linenos data-linenos="50 "></span><span class=k>def</span> <span class=nf>config</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="50 "></span><span class=k>def</span> <span class=nf>config</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>:</span>
<span class=linenos data-linenos="51 "></span> <span class=sd>"""</span>
<span class=linenos data-linenos="52 "></span><span class=sd> The hook configuration.</span>
<span class=linenos data-linenos="53 "></span>
Expand All @@ -122,8 +122,8 @@
<span class=linenos data-linenos="64 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="65 "></span><span class=sd> """</span>
<span class=linenos data-linenos="66 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__config</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.update> <code class="highlight language-python"><span class=n>update</span><span class=p>(</span><span class=n>metadata</span><span class=p>:</span> <span class=nb>dict</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.update title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>This updates the metadata mapping of the <code>project</code> table in-place.</p> <details class=quote> <summary>Source code in <code>hatchling/metadata/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="68 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="69 "></span><span class=k>def</span> <span class=nf>update</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>metadata</span><span class=p>:</span> <span class=nb>dict</span><span class=p>):</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 class="doc doc-heading" id=hatchling.metadata.plugin.interface.MetadataHookInterface.update> <code class="highlight language-python"><span class=n>update</span><span class=p>(</span><span class=n>metadata</span><span class=p>:</span> <span class=nb>dict</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a class=headerlink href=#hatchling.metadata.plugin.interface.MetadataHookInterface.update title="Permanent link"></a></h3> <div class="doc doc-contents"> <p>This updates the metadata mapping of the <code>project</code> table in-place.</p> <details class=quote> <summary>Source code in <code>hatchling/metadata/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="68 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="69 "></span><span class=k>def</span> <span class=nf>update</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>metadata</span><span class=p>:</span> <span class=nb>dict</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<span class=linenos data-linenos="70 "></span> <span class=sd>"""</span>
<span class=linenos data-linenos="71 "></span><span class=sd> This updates the metadata mapping of the `project` table in-place.</span>
<span class=linenos data-linenos="72 "></span><span class=sd> """</span>
Expand Down
2 changes: 1 addition & 1 deletion dev/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit e3ec32e

Please sign in to comment.