Skip to content

Commit d8c0f25

Browse files
authored
Explain the no_longer_updated METADATA field (#8037)
1 parent 8f77471 commit d8c0f25

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ supported:
190190
[removing obsolete third-party libraries](#third-party-library-removal-policy).
191191
It contains the first version of the corresponding library that ships
192192
its own `py.typed` file.
193+
* `no_longer_updated` (optional): This field is set to `true` before removing
194+
stubs for other reasons than the upstream library shipping with type
195+
information.
193196
* `stubtest` (default: `true`): Whether stubtest should be run against this
194197
package. Please avoid setting this to `false`, and add a comment if you have
195198
to.
@@ -529,7 +532,7 @@ if it consisted of several smaller commits.
529532

530533
## Third-party library removal policy
531534

532-
Third-party packages are generally removed from typeshed when one of the
535+
Third-party stubs are generally removed from typeshed when one of the
533536
following criteria is met:
534537

535538
* The upstream package ships a `py.typed` file for at least six months, or
@@ -543,6 +546,18 @@ If a package ships its own `py.typed` file, please follow these steps:
543546
["removal" label](https://github.com/python/typeshed/labels/removal).
544547
3. Open a PR that sets the `obsolete_since` field in the `METADATA.toml`
545548
file to the first version of the package that shipped `py.typed`.
549+
4. After at least six months, open a PR to remove the stubs.
550+
551+
If third-party stubs should be removed for other reasons, please follow these
552+
steps:
553+
554+
1. Open an issue explaining why the stubs should be removed.
555+
2. A maintainer will add the
556+
["removal" label](https://github.com/python/typeshed/labels/removal).
557+
3. Open a PR that sets the `no_longer_updated` field in the `METADATA.toml`
558+
file to `true`.
559+
4. When a new version of the package was automatically uploaded to PyPI
560+
(which usually takes up to 3 hours), open a PR to remove the stubs.
546561

547562
## Maintainer guidelines
548563

tests/check_consistent.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,15 @@
1919
import tomli
2020

2121
consistent_files = [{"stdlib/@python2/builtins.pyi", "stdlib/@python2/__builtin__.pyi"}]
22-
metadata_keys = {"version", "requires", "extra_description", "obsolete_since", "stubtest", "stubtest_apt_dependencies"}
22+
metadata_keys = {
23+
"version",
24+
"requires",
25+
"extra_description",
26+
"obsolete_since",
27+
"no_longer_updated",
28+
"stubtest",
29+
"stubtest_apt_dependencies",
30+
}
2331
allowed_files = {"README.md"}
2432

2533

0 commit comments

Comments
 (0)