Skip to content

Remove stubs for characteristic? #8012

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.

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

Closed
AlexWaygood opened this issue Jun 2, 2022 · 4 comments · Fixed by #8040
Closed

Remove stubs for characteristic? #8012

AlexWaygood opened this issue Jun 2, 2022 · 4 comments · Fixed by #8040
Labels
stubs: removal Pending removal of third-party distributions

Comments

@AlexWaygood
Copy link
Member

The characteristic library hasn't had any changes since October 2020. It also has a big warning on its GitHub homepage saying:

No Maintenance Intended
Warning
Characteristic is unmaintained. Please have a look at its successor attrs.

It doesn't seem like we've had any issues or PRs relating to these stubs for a long time. Should we remove them?

(Side note: I'm not sure what our policy is for removing stubs for unmaintained libraries that don't have type hints -- we don't have anything in CONTRIBUTING.md.)

@AlexWaygood AlexWaygood added the stubs: removal Pending removal of third-party distributions label Jun 2, 2022
@JelleZijlstra
Copy link
Member

I don't think we should necessarily remove stubs for unmaintained packages, since people may still use them and providing types could provide a valuable service. Even if the package only declares support for Python 3.3-3.4, it may still work fine on newer versions.

In this case though, I think it's fine to remove, since there's been little interest in the stubs since they were contributed in #771, and the package has been unmaintained for so long.

@srittau
Copy link
Collaborator

srittau commented Jun 2, 2022

Third-party packages are generally removed from typeshed when one of the
following criteria is met:

[...]

  • the package does not support any of the Python versions supported by
    typeshed.

That said, I have no objections with removing it. The types package remains, after all, we just can't update it easily. Cc @hynek as author.

We could add another field, similar to obsolete_since to METADATA.toml to add a comment to a final upload.

@AlexWaygood
Copy link
Member Author

I don't think we should necessarily remove stubs for unmaintained packages

I wasn't suggesting going on a blitz to remove all unmaintained packages from typeshed — I was just looking at the source code for this one for another reason, and was struck by the warning on the GitHub homepage :)

In this case though, I think it's fine to remove, since there's been little interest in the stubs since they were contributed in #771, and the package has been unmaintained for so long.

The types package remains, after all, we just can't update it easily.

+1 to both of these thoughts.

@hynek
Copy link
Member

hynek commented Jun 7, 2022

For me the question is mostly about how useful those stubs are at all? Since it's attrs-like, you rather need a plugin for it to be useful with mypy?

The last release is 8 years ago, I had no idea that stubs actually exist, and it has only 30k downloads per month (which is suspect are only mirrors). So I have no hard feelings if y'all dropped them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stubs: removal Pending removal of third-party distributions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants