Rename requires to dependencies in METADATA files (#15594)

Author: lev-blit

CONTRIBUTING.md

@@ -163,7 +163,7 @@ supported:
   When the stubs are updated to a newer version
   of the library, the version of the stub should be bumped (note that
   previous versions are still available on PyPI).
-* `requires` (optional): A list of other stub packages or packages with type
+* `dependencies` (optional): A list of other stub packages or packages with type
   information that are imported by the stubs in this package. Only packages
   generated by typeshed or required by the upstream package are allowed to
   be listed here, for security reasons. See
@@ -202,9 +202,9 @@ This has the following keys:
   `--ignore_missing_stub` option to the stubtest call. See
   [tests/README.md](./tests/README.md) for more information. In most cases,
   this field should be identical to `partial_stub`.
-* `stubtest_requirements` (default: `[]`): A list of Python packages that need
+* `stubtest_dependencies` (default: `[]`): A list of Python packages that need
   to be installed for stubtest to run successfully. These packages are installed
-  in addition to the requirements in the `requires` field.
+  in addition to the dependencies in the `dependencies` field.
 * `apt_dependencies` (default: `[]`): A list of Ubuntu APT packages
   that need to be installed for stubtest to run successfully.
 * `brew_dependencies` (default: `[]`): A list of MacOS Homebrew packages

lib/ts_utils/metadata.py

@@ -84,7 +84,7 @@ class StubtestSettings:
     ignore_missing_stub: bool
     supported_platforms: list[str] | None  # None means all platforms
     ci_platforms: list[str]
-    stubtest_requirements: list[str]
+    stubtest_dependencies: list[str]
     mypy_plugins: list[str]
     mypy_plugins_config: dict[str, dict[str, Any]]
 
@@ -109,7 +109,7 @@ def read_stubtest_settings(distribution: str) -> StubtestSettings:
     ignore_missing_stub: object = data.get("ignore_missing_stub", False)
     supported_platforms: object = data.get("supported_platforms")
     ci_platforms: object = data.get("ci_platforms", DEFAULT_STUBTEST_PLATFORMS)
-    stubtest_requirements: object = data.get("stubtest_requirements", [])
+    stubtest_dependencies: object = data.get("stubtest_dependencies", [])
     mypy_plugins: object = data.get("mypy_plugins", [])
     mypy_plugins_config: object = data.get("mypy_plugins_config", {})
 
@@ -123,7 +123,7 @@ def read_stubtest_settings(distribution: str) -> StubtestSettings:
     assert _is_list_of_strings(brew_dependencies)
     assert _is_list_of_strings(choco_dependencies)
     assert _is_list_of_strings(extras)
-    assert _is_list_of_strings(stubtest_requirements)
+    assert _is_list_of_strings(stubtest_dependencies)
     assert _is_list_of_strings(mypy_plugins)
     assert _is_nested_dict(mypy_plugins_config)
 
@@ -151,7 +151,7 @@ def read_stubtest_settings(distribution: str) -> StubtestSettings:
         ignore_missing_stub=ignore_missing_stub,
         supported_platforms=supported_platforms,
         ci_platforms=ci_platforms,
-        stubtest_requirements=stubtest_requirements,
+        stubtest_dependencies=stubtest_dependencies,
         mypy_plugins=mypy_plugins,
         mypy_plugins_config=mypy_plugins_config,
     )
@@ -174,7 +174,7 @@ class StubMetadata:
 
     distribution: Annotated[str, "The name of the distribution on PyPI"]
     version_spec: Annotated[Specifier, "Upstream versions that the stubs are compatible with"]
-    requires: Annotated[list[Requirement], "The parsed requirements as listed in METADATA.toml"]
+    dependencies: Annotated[list[Requirement], "The parsed dependencies as listed in METADATA.toml"]
     extra_description: str | None
     stub_distribution: Annotated[str, "The name under which the distribution is uploaded to PyPI"]
     upstream_repository: Annotated[str, "The URL of the upstream repository"] | None
@@ -193,7 +193,7 @@ def is_obsolete(self) -> bool:
 _KNOWN_METADATA_FIELDS: Final = frozenset(
     {
         "version",
-        "requires",
+        "dependencies",
         "extra_description",
         "stub_distribution",
         "upstream_repository",
@@ -216,7 +216,7 @@ def is_obsolete(self) -> bool:
         "ignore_missing_stub",
         "supported_platforms",
         "ci_platforms",
-        "stubtest_requirements",
+        "stubtest_dependencies",
         "mypy_plugins",
         "mypy_plugins_config",
     }
@@ -235,7 +235,7 @@ def read_metadata(distribution: str) -> StubMetadata:
     This function does some basic validation,
     but does no parsing, transforming or normalization of the metadata.
     Use `read_dependencies` if you need to parse the dependencies
-    given in the `requires` field, for example.
+    given in the `dependencies` field, for example.
     """
     try:
         with metadata_path(distribution).open("rb") as f:
@@ -255,9 +255,9 @@ def read_metadata(distribution: str) -> StubMetadata:
     version_spec = Specifier(version)
     assert version_spec.operator in {"==", "~="}, f"Invalid 'version' field in METADATA.toml for {distribution!r}"
 
-    requires_s: object = data.get("requires", [])  # pyright: ignore[reportUnknownMemberType]
-    assert isinstance(requires_s, list)
-    requires = [parse_requires(distribution, req) for req in requires_s]
+    dependencies_s: object = data.get("dependencies", [])  # pyright: ignore[reportUnknownMemberType]
+    assert isinstance(dependencies_s, list)
+    dependencies = [parse_dependencies(distribution, dep) for dep in dependencies_s]
 
     extra_description: object = data.get("extra_description")  # pyright: ignore[reportUnknownMemberType]
     assert isinstance(extra_description, (str, type(None)))
@@ -336,7 +336,7 @@ def read_metadata(distribution: str) -> StubMetadata:
     return StubMetadata(
         distribution=distribution,
         version_spec=version_spec,
-        requires=requires,
+        dependencies=dependencies,
         extra_description=extra_description,
         stub_distribution=stub_distribution,
         upstream_repository=upstream_repository,
@@ -366,7 +366,7 @@ def update_metadata(distribution: str, **new_values: object) -> tomlkit.TOMLDocu
     return data
 
 
-def parse_requires(distribution: str, req: object) -> Requirement:
+def parse_dependencies(distribution: str, req: object) -> Requirement:
     assert isinstance(req, str), f"Invalid requirement {req!r} for {distribution!r}"
     return Requirement(req)
 
@@ -398,7 +398,7 @@ def read_dependencies(distribution: str) -> PackageDependencies:
     pypi_name_to_typeshed_name_mapping = get_pypi_name_to_typeshed_name_mapping()
     typeshed: list[Requirement] = []
     external: list[Requirement] = []
-    for dependency in read_metadata(distribution).requires:
+    for dependency in read_metadata(distribution).dependencies:
         if dependency.name in pypi_name_to_typeshed_name_mapping:
             req = Requirement(str(dependency))  # copy the requirement
             req.name = pypi_name_to_typeshed_name_mapping[dependency.name]

stubs/Authlib/METADATA.toml

@@ -1,3 +1,3 @@
 version = "1.6.9"
 upstream_repository = "https://github.com/authlib/authlib"
-requires = ["cryptography"]
+dependencies = ["cryptography"]

stubs/Deprecated/METADATA.toml

@@ -1,3 +1,3 @@
 version = "~=1.3.1"
 upstream_repository = "https://github.com/laurent-laporte-pro/deprecated"
-requires = []
+dependencies = []

stubs/Flask-Cors/METADATA.toml

@@ -1,4 +1,4 @@
 version = "6.0.*"
 upstream_repository = "https://github.com/corydolphin/flask-cors"
 # Requires a version of flask with a `py.typed` file
-requires = ["Flask>=2.0.0"]
+dependencies = ["Flask>=2.0.0"]

stubs/Flask-Migrate/METADATA.toml

@@ -1,4 +1,4 @@
 version = "4.1.*"
 upstream_repository = "https://github.com/miguelgrinberg/Flask-Migrate"
 # Requires versions of flask and Flask-SQLAlchemy with `py.typed` files
-requires = ["Flask-SQLAlchemy>=3.0.1", "Flask>=2.0.0"]
+dependencies = ["Flask-SQLAlchemy>=3.0.1", "Flask>=2.0.0"]

stubs/Flask-SocketIO/METADATA.toml

@@ -1,3 +1,3 @@
 version = "5.6.*"
-requires = ["Flask>=0.9"]
+dependencies = ["Flask>=0.9"]
 upstream_repository = "https://github.com/miguelgrinberg/flask-socketio"

stubs/JACK-Client/METADATA.toml

@@ -1,7 +1,7 @@
 version = "0.5.*"
 upstream_repository = "https://github.com/spatialaudio/jackclient-python"
 # Requires a version of numpy with a `py.typed` file
-requires = ["numpy>=1.20", "types-cffi"]
+dependencies = ["numpy>=1.20", "types-cffi"]
 
 [tool.stubtest]
 # darwin and win32 are equivalent

stubs/PyAutoGUI/METADATA.toml

@@ -1,3 +1,3 @@
 version = "0.9.*"
 upstream_repository = "https://github.com/asweigart/pyautogui"
-requires = ["types-PyScreeze"]
+dependencies = ["types-PyScreeze"]

stubs/PyScreeze/METADATA.toml

@@ -1,11 +1,11 @@
 version = "1.0.1"
 upstream_repository = "https://github.com/asweigart/pyscreeze"
-requires = ["Pillow>=10.3.0"]
+dependencies = ["Pillow>=10.3.0"]
 
 [tool.stubtest]
 # Linux has extra constants, win32 has different definitions
 ci_platforms = ["linux", "win32"]
 # PyScreeze has an odd setup.py file
 # that doesn't list Pillow as a dependency for py312+ yet:
 # https://github.com/asweigart/pyscreeze/blob/eeca245a135cf171c163b3691300138518efa64e/setup.py#L38-L46
-stubtest_requirements = ["Pillow"]
+stubtest_dependencies = ["Pillow"]