Skip to content

Commit a0fbe21

Browse files
committed
rename requires to dependencies
1 parent 8ffc436 commit a0fbe21

File tree

65 files changed

+74
-74
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+74
-74
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions

lib/ts_utils/metadata.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ class StubMetadata:
174174

175175
distribution: Annotated[str, "The name of the distribution on PyPI"]
176176
version_spec: Annotated[Specifier, "Upstream versions that the stubs are compatible with"]
177-
requires: Annotated[list[Requirement], "The parsed requirements as listed in METADATA.toml"]
177+
dependencies: Annotated[list[Requirement], "The parsed dependencies as listed in METADATA.toml"]
178178
extra_description: str | None
179179
stub_distribution: Annotated[str, "The name under which the distribution is uploaded to PyPI"]
180180
upstream_repository: Annotated[str, "The URL of the upstream repository"] | None
@@ -193,7 +193,7 @@ def is_obsolete(self) -> bool:
193193
_KNOWN_METADATA_FIELDS: Final = frozenset(
194194
{
195195
"version",
196-
"requires",
196+
"dependencies",
197197
"extra_description",
198198
"stub_distribution",
199199
"upstream_repository",
@@ -235,7 +235,7 @@ def read_metadata(distribution: str) -> StubMetadata:
235235
This function does some basic validation,
236236
but does no parsing, transforming or normalization of the metadata.
237237
Use `read_dependencies` if you need to parse the dependencies
238-
given in the `requires` field, for example.
238+
given in the `dependencies` field, for example.
239239
"""
240240
try:
241241
with metadata_path(distribution).open("rb") as f:
@@ -255,9 +255,9 @@ def read_metadata(distribution: str) -> StubMetadata:
255255
version_spec = Specifier(version)
256256
assert version_spec.operator in {"==", "~="}, f"Invalid 'version' field in METADATA.toml for {distribution!r}"
257257

258-
requires_s: object = data.get("requires", []) # pyright: ignore[reportUnknownMemberType]
259-
assert isinstance(requires_s, list)
260-
requires = [parse_requires(distribution, req) for req in requires_s]
258+
dependencies_s: object = data.get("dependencies", []) # pyright: ignore[reportUnknownMemberType]
259+
assert isinstance(dependencies_s, list)
260+
dependencies = [parse_dependencies(distribution, dep) for dep in dependencies_s]
261261

262262
extra_description: object = data.get("extra_description") # pyright: ignore[reportUnknownMemberType]
263263
assert isinstance(extra_description, (str, type(None)))
@@ -336,7 +336,7 @@ def read_metadata(distribution: str) -> StubMetadata:
336336
return StubMetadata(
337337
distribution=distribution,
338338
version_spec=version_spec,
339-
requires=requires,
339+
dependencies=dependencies,
340340
extra_description=extra_description,
341341
stub_distribution=stub_distribution,
342342
upstream_repository=upstream_repository,
@@ -366,7 +366,7 @@ def update_metadata(distribution: str, **new_values: object) -> tomlkit.TOMLDocu
366366
return data
367367

368368

369-
def parse_requires(distribution: str, req: object) -> Requirement:
369+
def parse_dependencies(distribution: str, req: object) -> Requirement:
370370
assert isinstance(req, str), f"Invalid requirement {req!r} for {distribution!r}"
371371
return Requirement(req)
372372

@@ -398,7 +398,7 @@ def read_dependencies(distribution: str) -> PackageDependencies:
398398
pypi_name_to_typeshed_name_mapping = get_pypi_name_to_typeshed_name_mapping()
399399
typeshed: list[Requirement] = []
400400
external: list[Requirement] = []
401-
for dependency in read_metadata(distribution).requires:
401+
for dependency in read_metadata(distribution).dependencies:
402402
if dependency.name in pypi_name_to_typeshed_name_mapping:
403403
req = Requirement(str(dependency)) # copy the requirement
404404
req.name = pypi_name_to_typeshed_name_mapping[dependency.name]

stubs/Authlib/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version = "1.6.9"
22
upstream_repository = "https://github.com/authlib/authlib"
3-
requires = ["cryptography"]
3+
dependencies = ["cryptography"]

stubs/Deprecated/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version = "~=1.3.1"
22
upstream_repository = "https://github.com/laurent-laporte-pro/deprecated"
3-
requires = []
3+
dependencies = []

stubs/Flask-Cors/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
version = "6.0.*"
22
upstream_repository = "https://github.com/corydolphin/flask-cors"
33
# Requires a version of flask with a `py.typed` file
4-
requires = ["Flask>=2.0.0"]
4+
dependencies = ["Flask>=2.0.0"]

stubs/Flask-Migrate/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
version = "4.1.*"
22
upstream_repository = "https://github.com/miguelgrinberg/Flask-Migrate"
33
# Requires versions of flask and Flask-SQLAlchemy with `py.typed` files
4-
requires = ["Flask-SQLAlchemy>=3.0.1", "Flask>=2.0.0"]
4+
dependencies = ["Flask-SQLAlchemy>=3.0.1", "Flask>=2.0.0"]

stubs/Flask-SocketIO/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version = "5.6.*"
2-
requires = ["Flask>=0.9"]
2+
dependencies = ["Flask>=0.9"]
33
upstream_repository = "https://github.com/miguelgrinberg/flask-socketio"

stubs/JACK-Client/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version = "0.5.*"
22
upstream_repository = "https://github.com/spatialaudio/jackclient-python"
33
# Requires a version of numpy with a `py.typed` file
4-
requires = ["numpy>=1.20", "types-cffi"]
4+
dependencies = ["numpy>=1.20", "types-cffi"]
55

66
[tool.stubtest]
77
# darwin and win32 are equivalent

stubs/PyAutoGUI/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version = "0.9.*"
22
upstream_repository = "https://github.com/asweigart/pyautogui"
3-
requires = ["types-PyScreeze"]
3+
dependencies = ["types-PyScreeze"]

stubs/PyScreeze/METADATA.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version = "1.0.1"
22
upstream_repository = "https://github.com/asweigart/pyscreeze"
3-
requires = ["Pillow>=10.3.0"]
3+
dependencies = ["Pillow>=10.3.0"]
44

55
[tool.stubtest]
66
# Linux has extra constants, win32 has different definitions

0 commit comments

Comments
 (0)