typeshed-internal / stub_uploader

Scripts and actions to auto-upload typeshed stubs to PyPI
Apache License 2.0
21 stars 16 forks source link

Add a new metadata key "no_longer_updated" #48

Closed srittau closed 2 years ago

srittau commented 2 years ago

This key can be used to mark a package as obsolete, in cases other than the upstream package getting type annotations.

JelleZijlstra commented 2 years ago

This naming is pretty confusing ("obsolete" means the package itself is obsolete, "obsolete_since" that the type package is obsolete because the package itself now includes types).

Maybe "package_unmaintained" for the first case and "has_bundled_types_since" for the second?

srittau commented 2 years ago

I don't follow. In both cases the types package is what is obsolete, although obsolete_since would more correctly be called "obsolete since upstream version".

JelleZijlstra commented 2 years ago

The types package is obsolete in both cases, but the two have pretty different effects on users ("I should stop using this package" vs. "I should upgrade and remove the types package"). Also, for a typeshed contributor, it would be difficult to remember which is which.

srittau commented 2 years ago

I don't what to shuffle obsolete_since around, since it's/was actively used in typeshed. package_unmaintained would again limit what we can use the key for, I would like to keep this fairly general so we don't need to change it when we want to remove a types package for another reason. Maybe types_removed or to_be_removed?

srittau commented 2 years ago

Bumpity bump.

JelleZijlstra commented 2 years ago

Would be good to get some other opinions on naming (@AlexWaygood @hauntsaninja @Akuli?).

I'd be fine with to_be_removed though, and agree that it's awkward to rename the existing obsolete_since key.

AlexWaygood commented 2 years ago

The intent is to say that these stubs will no longer be updated, right? So how about no_longer_updated?

srittau commented 2 years ago

Current options:

Both sound fine to me. Let's not forget that this key is only briefly used, though. Basically, add the key, wait for the release, then we can remove the package. So I'd say the name is not super important as it will usually only be set for a day or two.

AlexWaygood commented 2 years ago

Current options:

  • to_be_removed
  • no_longer_updated

Both sound fine to me. Let's not forget that this key is only briefly used, though. Basically, add the key, wait for the release, then we can remove the package. So I'd say the name is not super important as it will usually only be set for a day or two.

I'm also happy with both -- I'd vote for no_longer_updated, but no strong objections from me to to_be_removed 👍

hauntsaninja commented 2 years ago

(this seems great to me!)