Add `--ignore-overloaded-functions` flag to ignore overload decorators #98

ErwinJunge · 2021-12-17T16:36:48Z

Hey, I just made a Pull Request!

Description

Add --ignore-overloaded-functions flag to ignore overload decorators

Motivation and Context

Fixes #97

Have you tested this? If so, how?

I have included unittests and ran interrogate against a codebase with overloads.

Checklist for PR author(s)

Changes are covered by unit tests (no major decrease in code coverage %).
All tests pass.
Docstring coverage is 100% via tox -e docs or interrogate -c pyproject.toml (I mean, we should set a good example 😄).
Updates to documentation:
- Document any relevant additions/changes in README.rst.
- Manually update both the README.rst and docs/index.rst for any new/changed CLI flags.
- Any changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives. Find the appropriate next version in the project's __init__.py file.

Release note

Add ``--ignore-overloaded-functions`` flag to ignore overload decorators (`#97 <https://github.com/econchick/interrogate/issues/97>`_).

econchick · 2021-12-17T19:31:31Z

dang! thanks for the contribution @ErwinJunge ! I'm wrapping up a bunch of work stuff, but I'll review this over the next few days. Thanks!

ErwinJunge · 2021-12-17T19:44:19Z

Apparently I failed at running black 🤦

I've fixed the codestyle and forcepushed a new commit.

ErwinJunge · 2021-12-17T19:46:00Z

dang! thanks for the contribution @ErwinJunge ! I'm wrapping up a bunch of work stuff, but I'll review this over the next few days. Thanks!

For me this is work stuff :) I'm finishing up my week now and will pick this back up monday if there's any feedback.

ErwinJunge · 2021-12-22T10:48:47Z

@econchick friendly ping on the review :)

econchick

Hey @ErwinJunge ! So sorry for the delay - I actually caught covid last week 🤦🏻‍♀️

This looks great to me! I appreciate the thoroughness of this PR too - I'm sure you're annoyed at my testing suite 😅

I just have one request: Would you mind being more descriptive with the user-facing help text for the option? As in, something more specific like "Ignore @typing.overload-decorated functions." (in cli.py, README.rst, docs/index.rst, and the docstring in config.py). I'm sure someone who's familiar with typing understands what overloaded functions means, but for those that are not (yet) familiar, it may seem confusing that Python supports overloaded functions.

ErwinJunge · 2021-12-28T08:56:42Z

Hi @econchick , I'm sorry to hear about the covid and I hope you had a full recovery!

You're welcome for the PR. The test suite could indeed use some work, there were a lot of unrelated testing changes required to add my new thing. However, on the whole I'm mostly just happy there is a test suite! 😄

Thank you for the review and the improvement suggestion. I've implemented it in the update I've just pushed.

econchick

Thanks again @ErwinJunge ! I'm not sure when 1.6.0 will be released (but not longer than a week or two - want to see if I can get in another feature). But I'll ping this thread when I have.

If you happen to be at PyCon US in 2022, find me - I'll have stickers!

econchick · 2021-12-29T16:43:18Z

uff - @ErwinJunge , looks like that small change broke some tests 😬 If you don't have time to fix them in the next couple of days, I can try to dig in. (This indeed makes me want to rewrite the test suite 🤦🏻)

ErwinJunge · 2021-12-29T16:54:52Z

Tests updated in latest push.

Re: pycon US, thanks for the offer but I don't think that'll be likely :) I live in the Netherlands, and it's currently a bit hard to travel out of Europe 😅

ErwinJunge · 2021-12-30T07:48:49Z

@econchick those test failures look like the docstring coverage results are different on windows than they are on linux 😕 I don't have a windows box available to run those tests locally and can't imagine what would make the results different on windows so I don't think I'll be able to fix these.

ErwinJunge · 2022-01-05T09:22:49Z

@econchick do you have some input on the windows tests? Is there perhaps something I can do without having access to a windows box?

ErwinJunge · 2022-01-14T07:42:53Z

@econchick I took a closer look today and what's failing are the test expectation files in tests/functional/fixtures/windows/ I didn't update those (because I got all green on my machine 😅 ). However, I don't think I can update these, since I don't have access to a windows box to recreate them on. I tried copy-pasting the non-windows files and checking what changed using git diff, but that indicates the entire file is different (including stuff like the first line that definitely didn't change). There's some windows-specific magic going on that I can't replicate without access to a windows box. Can you regenerate those files and update the PR for me?

What I did for the linux files is this:

Add the below into a relevant test

    with open(expected_fixture, "w") as f:
        f.write(expected_out)

Sanity check the git diff. There might be added lines that shouldn't be there, remove those. Make sure there are only changed lines that make sense according to the python changes in the PR.
Once the diff is clean: commit :)

ErwinJunge · 2022-01-25T09:12:21Z

@econchick friendly ping on the above :) Please let me know if there's anything I can do to move this along.

ErwinJunge · 2022-03-28T13:06:36Z

👋 @econchick please don't forget about this one 🥺

conrad-stork · 2023-12-01T18:15:05Z

Hi All,

I found this pull request as I the same problem with interrogate. My question would be if there is any chance that this pull request is merged at some point? I think this could be very useful feature.

Tagging here: @ErwinJunge @econchick

Thanks and Best

for more information, see https://pre-commit.ci

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 < 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 `_).</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) <https://github.com/econchick/interrogate/issues/128></code>_).</li> </ul> <p>Fixed ^^^^^</p> <ul> <li>Include support for deleters when ignoring property decorators (<code>[#126](econchick/interrogate#126) <https://github.com/econchick/interrogate/issues/126></code>_).</li> <li>Support floats for <code>--fail-under</code> values (<code>[#114](econchick/interrogate#114) <https://github.com/econchick/interrogate/issues/114></code>_).</li> </ul> <p>Removed ^^^^^^^</p> <ul> <li><code>toml</code> dependency for all Python versions (<code>[#150](econchick/interrogate#150) <https://github.com/econchick/interrogate/issues/150></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) <https://github.com/econchick/interrogate/issues/97></code><em>) – thank you <code>ErwinJunge <https://github.com/econchick/interrogate/pull/98></code></em> (via <code>[#167](econchick/interrogate#167) <https://github.com/econchick/interrogate/pull/167></code><em>) and <code>zackyancey <https://github.com/econchick/interrogate/pull/160></code></em>.</li> <li>Support for Python 3.11 & 3.12.</li> </ul> <p>Removed ^^^^^^^</p> <ul> <li>Support for Python 3.6 & 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>

ErwinJunge force-pushed the overload-support branch from 633aad2 to 556c27d Compare December 17, 2021 19:43

econchick requested changes Dec 27, 2021

View reviewed changes

ErwinJunge force-pushed the overload-support branch from 556c27d to 168b74e Compare December 28, 2021 08:50

econchick approved these changes Dec 29, 2021

View reviewed changes

ErwinJunge force-pushed the overload-support branch from 168b74e to dc52dc9 Compare December 29, 2021 16:52

Add --ignore-overloaded-functions flag to ignore overload decorators

dc52dc9

zackyancey mentioned this pull request Sep 26, 2023

Fix windows tests for #98: ignoring @overload decorated functions #160

Closed

7 tasks

econchick and others added 2 commits April 6, 2024 14:27

Merge branch 'master' into overload-support

4c598ab

[pre-commit.ci] auto fixes from pre-commit.com hooks

61c34c7

for more information, see https://pre-commit.ci

econchick mentioned this pull request Apr 6, 2024

Add --ignore-overloaded-functions flag to ignore overload decorators (lint fixes) #167

Merged

econchick merged commit 61c34c7 into econchick:master Apr 6, 2024
8 of 20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `--ignore-overloaded-functions` flag to ignore overload decorators #98

Add `--ignore-overloaded-functions` flag to ignore overload decorators #98

ErwinJunge commented Dec 17, 2021

econchick commented Dec 17, 2021

ErwinJunge commented Dec 17, 2021

ErwinJunge commented Dec 17, 2021

ErwinJunge commented Dec 22, 2021

econchick left a comment

ErwinJunge commented Dec 28, 2021

econchick left a comment

econchick commented Dec 29, 2021

ErwinJunge commented Dec 29, 2021

ErwinJunge commented Dec 30, 2021

ErwinJunge commented Jan 5, 2022

ErwinJunge commented Jan 14, 2022

ErwinJunge commented Jan 25, 2022

ErwinJunge commented Mar 28, 2022

conrad-stork commented Dec 1, 2023 •

edited

Loading

Add --ignore-overloaded-functions flag to ignore overload decorators #98

Add --ignore-overloaded-functions flag to ignore overload decorators #98

Conversation

ErwinJunge commented Dec 17, 2021

Hey, I just made a Pull Request!

Description

Motivation and Context

Have you tested this? If so, how?

Checklist for PR author(s)

Release note

econchick commented Dec 17, 2021

ErwinJunge commented Dec 17, 2021

ErwinJunge commented Dec 17, 2021

ErwinJunge commented Dec 22, 2021

econchick left a comment

Choose a reason for hiding this comment

ErwinJunge commented Dec 28, 2021

econchick left a comment

Choose a reason for hiding this comment

econchick commented Dec 29, 2021

ErwinJunge commented Dec 29, 2021

ErwinJunge commented Dec 30, 2021

ErwinJunge commented Jan 5, 2022

ErwinJunge commented Jan 14, 2022

ErwinJunge commented Jan 25, 2022

ErwinJunge commented Mar 28, 2022

conrad-stork commented Dec 1, 2023 • edited Loading

Add `--ignore-overloaded-functions` flag to ignore overload decorators #98

Add `--ignore-overloaded-functions` flag to ignore overload decorators #98

conrad-stork commented Dec 1, 2023 •

edited

Loading