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

Jump to bottom

Option to ignore overloaded functions #97

Closed
ErwinJunge opened this issue Dec 17, 2021 · 2 comments · Fixed by #98
Closed

Option to ignore overloaded functions #97

ErwinJunge opened this issue Dec 17, 2021 · 2 comments · Fixed by #98
Assignees
@econchick
Labels
enhancement New feature or request needs triage Issue needs triaging

Comments

@ErwinJunge
Copy link
Contributor

Describe the feature you'd like

When decorating functions with @typing.overload, the stubs are marked as not covered when they don't have their own docstring. My suggestion is to add an option to ignore those stubs.

Is your feature request related to a problem?

We have overloaded functions in our codebase that we want to start using this package in and we only document the actual implementation and not the stubs.

Your Environment

  • interrogate version(s) (interrogate --version: 1.5.0
  • Operating System(s): linux
  • Python version(s): 3.6-3.10

Additional context

PR incoming.
@ErwinJunge ErwinJunge added enhancement New feature or request needs triage Issue needs triaging labels Dec 17, 2021
@ErwinJunge ErwinJunge mentioned this issue Dec 17, 2021
Merged
7 tasks
@amin-nejad
Copy link

Another option is to ignore flake8 rule D418 (doesn't allow docstrings for overloads) and just give the overloaded functions/methods docstrings. But agree it would be good to have the option to have interrogate ignore them for this purpose.

@jmahlik
Copy link

jmahlik commented May 18, 2023

Had to disable interrogate since I started making use of overloads.

@zackyancey zackyancey mentioned this issue Sep 26, 2023
Closed
7 tasks
frunika added a commit to frunika/Photobooth that referenced this issue Apr 10, 2024
@frunika
Bump interrogate from 1.5.0 to 1.7.0 (#5)
4521333 
Bumps [interrogate](https://github.com/econchick/interrogate) from 1.5.0
to 1.7.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/econchick/interrogate/releases">interrogate's
releases</a>.</em></p>
<blockquote>
<h2>1.7.0</h2>
<h1>Full Changelog</h1>
<h2>Added</h2>
<ul>
<li><code>tomli</code> dependency for Python versions &lt; 3.11, making
use of <code>tomllib</code> in the standard library with 3.11+ (<a
href="https://redirect.github.com/econchick/interrogate/issues/150">#150</a>).</li>
<li>Support for <code>pyi</code> file extensions (and leave room for
other file extensions to be added, like maybe <code>ipynb</code>).</li>
<li>Support for Google-style docstrings for class <code>__init__</code>
methods with new <code>--style [sphinx|google]</code> flag (<a
href="https://redirect.github.com/econchick/interrogate/issues/128">#128</a>).</li>
</ul>
<h2>Fixed</h2>
<ul>
<li>Include support for deleters when ignoring property decorators (<a
href="https://redirect.github.com/econchick/interrogate/issues/126">#126</a>).</li>
<li>Support floats for <code>--fail-under</code> values (<a
href="https://redirect.github.com/econchick/interrogate/issues/114">#114</a>).</li>
</ul>
<h2>Removed</h2>
<ul>
<li><code>toml</code> dependency for all Python versions (<a
href="https://redirect.github.com/econchick/interrogate/issues/150">#150</a>).</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/econchick/interrogate/blob/master/docs/changelog.rst">interrogate's
changelog</a>.</em></p>
<blockquote>
<h2>1.7.0 (2024-04-07)</h2>
<p>Added
^^^^^</p>
<ul>
<li><code>tomli</code> dependency for Python versions <!-- raw HTML
omitted -->`_).</li>
<li>Support for <code>pyi</code> file extensions (and leave room for
other file extensions to be added, like maybe <code>ipynb</code>).</li>
<li>Support for Google-style docstrings for class <code>__init__</code>
methods with new <code>--style [sphinx|google]</code> flag
(<code>[#128](econchick/interrogate#128)
&lt;https://github.com/econchick/interrogate/issues/128&gt;</code>_).</li>
</ul>
<p>Fixed
^^^^^</p>
<ul>
<li>Include support for deleters when ignoring property decorators
(<code>[#126](econchick/interrogate#126)
&lt;https://github.com/econchick/interrogate/issues/126&gt;</code>_).</li>
<li>Support floats for <code>--fail-under</code> values
(<code>[#114](econchick/interrogate#114)
&lt;https://github.com/econchick/interrogate/issues/114&gt;</code>_).</li>
</ul>
<p>Removed
^^^^^^^</p>
<ul>
<li><code>toml</code> dependency for all Python versions
(<code>[#150](econchick/interrogate#150)
&lt;https://github.com/econchick/interrogate/issues/150&gt;</code>_).</li>
</ul>
<p>.. short-log</p>
<h2>1.6.0 (2024-04-06)</h2>
<p>Added
^^^^^</p>
<ul>
<li>Add <code>--ignore-overloaded-functions</code> flag to ignore
overload decorators
(<code>[#97](econchick/interrogate#97)
&lt;https://github.com/econchick/interrogate/issues/97&gt;</code><em>) –
thank you <code>ErwinJunge
&lt;https://github.com/econchick/interrogate/pull/98&gt;</code></em>
(via <code>[#167](econchick/interrogate#167)
&lt;https://github.com/econchick/interrogate/pull/167&gt;</code><em>)
and <code>zackyancey
&lt;https://github.com/econchick/interrogate/pull/160&gt;</code></em>.</li>
<li>Support for Python 3.11 &amp; 3.12.</li>
</ul>
<p>Removed
^^^^^^^</p>
<ul>
<li>Support for Python 3.6 &amp; 3.7.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/econchick/interrogate/commit/4894019dc8876092bc9b6d56878798c550fad998"><code>4894019</code></a>
Release 1.7.0</li>
<li><a
href="https://github.com/econchick/interrogate/commit/6c8db6ffc256a25b68806038f2ab5d9897c9468f"><code>6c8db6f</code></a>
Testing out a PyPI GitHub workflow</li>
<li><a
href="https://github.com/econchick/interrogate/commit/06ecac0e4361df16a70b1e34e92cd4c1b259b85e"><code>06ecac0</code></a>
Merge pull request <a
href="https://redirect.github.com/econchick/interrogate/issues/173">#173</a>
from econchick/google-style</li>
<li><a
href="https://github.com/econchick/interrogate/commit/f77ef6f0b9bc946159c53ac0bd66f1f30631083d"><code>f77ef6f</code></a>
Add flag to support google code style</li>
<li><a
href="https://github.com/econchick/interrogate/commit/5461ebcf860fa360c00c77f5741c26b04cb87e8d"><code>5461ebc</code></a>
Merge pull request <a
href="https://redirect.github.com/econchick/interrogate/issues/172">#172</a>
from econchick/ext-flag</li>
<li><a
href="https://github.com/econchick/interrogate/commit/722d5239256a28eb16a54abcd7d11a6e5f21c62a"><code>722d523</code></a>
Add support for other file extensions (pyi to start)</li>
<li><a
href="https://github.com/econchick/interrogate/commit/1a28d80e5c05626892f50cd0644ab38615484da7"><code>1a28d80</code></a>
Merge pull request <a
href="https://redirect.github.com/econchick/interrogate/issues/171">#171</a>
from econchick/round-perc-covered</li>
<li><a
href="https://github.com/econchick/interrogate/commit/d3cddca06b01461edc4d0f46a84f09d6f2d2f173"><code>d3cddca</code></a>
Merge pull request <a
href="https://redirect.github.com/econchick/interrogate/issues/170">#170</a>
from econchick/include-deleters</li>
<li><a
href="https://github.com/econchick/interrogate/commit/4e7e96721f458988b504a61b5c746dfa9dd8e1ed"><code>4e7e967</code></a>
Merge pull request <a
href="https://redirect.github.com/econchick/interrogate/issues/170">#170</a>
from econchick/include-deleters</li>
<li><a
href="https://github.com/econchick/interrogate/commit/5dcb4dea10d1ebe53268588cddde1867989747a6"><code>5dcb4de</code></a>
Include deleters when ignoring property decorators</li>
<li>Additional commits viewable in <a
href="https://github.com/econchick/interrogate/compare/1.5.0...1.7.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=interrogate&package-manager=pip&previous-version=1.5.0&new-version=1.7.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@econchick econchick

Labels
enhancement New feature or request needs triage Issue needs triaging
Projects
None yet
Milestone
No milestone
4 participants
@ErwinJunge @econchick @jmahlik @amin-nejad