Skip to content

Commit defb3b6

Browse files
committed
refactor: create -> compose
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
1 parent 7ba97c5 commit defb3b6

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/utils.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Reference
7171
>>> canonicalize_version('1.4.0.0.0')
7272
'1.4'
7373

74-
.. function:: create_wheel_filename(name, version, build, tags)
74+
.. function:: compose_wheel_filename(name, version, build, tags)
7575

7676
Combines a project name, version, build tag, and tag set
7777
to make a properly formatted wheel filename.
@@ -90,12 +90,12 @@ Reference
9090

9191
.. doctest::
9292

93-
>>> from packaging.utils import create_wheel_filename
93+
>>> from packaging.utils import compose_wheel_filename
9494
>>> from packaging.tags import Tag
9595
>>> from packaging.version import Version
9696
>>> version = Version("1.0")
9797
>>> tags = {Tag("py3", "none", "any")}
98-
>>> "foo_bar-1.0-py3-none-any.whl" == create_wheel_filename("foo-bar", version, None, tags)
98+
>>> "foo_bar-1.0-py3-none-any.whl" == compose_wheel_filename("foo-bar", version, None, tags)
9999
True
100100

101101
.. function:: parse_wheel_filename(filename)
@@ -133,7 +133,7 @@ Reference
133133
>>> not build
134134
True
135135

136-
.. function:: create_sdist_filename(name, version)
136+
.. function:: compose_sdist_filename(name, version)
137137

138138
Combines the project name and a version to make a valid sdist filename.
139139

@@ -142,9 +142,9 @@ Reference
142142

143143
.. doctest::
144144

145-
>>> from packaging.utils import create_sdist_filename
145+
>>> from packaging.utils import compose_sdist_filename
146146
>>> from packaging.version import Version
147-
>>> "foo_bar-1.0.tar.gz" == create_sdist_filename("foo-bar", Version("1.0"))
147+
>>> "foo_bar-1.0.tar.gz" == compose_sdist_filename("foo-bar", Version("1.0"))
148148
True
149149

150150
.. function:: parse_sdist_filename(filename)

src/packaging/utils.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
"NormalizedName",
2525
"canonicalize_name",
2626
"canonicalize_version",
27-
"create_sdist_filename",
28-
"create_wheel_filename",
27+
"compose_sdist_filename",
28+
"compose_wheel_filename",
2929
"is_normalized_name",
3030
"parse_sdist_filename",
3131
"parse_wheel_filename",
@@ -116,7 +116,7 @@ def _compress_tag_set(tags: AbstractSet[Tag]) -> str:
116116
return "-".join(_join_tag_attr(tags, x) for x in ("interpreter", "abi", "platform"))
117117

118118

119-
def create_wheel_filename(
119+
def compose_wheel_filename(
120120
name: str, version: Version, build: BuildTag | None, tags: AbstractSet[Tag]
121121
) -> str:
122122
norm_name = canonicalize_name(name).replace("-", "_")
@@ -175,7 +175,7 @@ def parse_wheel_filename(
175175
return (name, version, build, tags)
176176

177177

178-
def create_sdist_filename(name: str, version: Version) -> str:
178+
def compose_sdist_filename(name: str, version: Version) -> str:
179179
norm_name = canonicalize_name(name).replace("-", "_")
180180
return f"{norm_name}-{version}.tar.gz"
181181

tests/test_utils.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
InvalidWheelFilename,
1515
canonicalize_name,
1616
canonicalize_version,
17-
create_sdist_filename,
18-
create_wheel_filename,
17+
compose_sdist_filename,
18+
compose_wheel_filename,
1919
is_normalized_name,
2020
parse_sdist_filename,
2121
parse_wheel_filename,
@@ -149,10 +149,10 @@ def test_canonicalize_version_no_strip_trailing_zero(version: str) -> None:
149149
),
150150
],
151151
)
152-
def test_create_wheel_filename(
152+
def test_compose_wheel_filename(
153153
filename: str, name: str, version: Version, build: BuildTag | None, tags: set[Tag]
154154
) -> None:
155-
assert create_wheel_filename(name, version, build, tags) == filename
155+
assert compose_wheel_filename(name, version, build, tags) == filename
156156

157157

158158
@pytest.mark.parametrize(
@@ -233,8 +233,8 @@ def test_parse_wheel_invalid_filename(filename: str) -> None:
233233
("foo_bar-1.0.tar.gz", "foo-bar", Version("1.0")),
234234
],
235235
)
236-
def test_create_sdist_filename(filename: str, name: str, version: Version) -> None:
237-
assert create_sdist_filename(name, version) == filename
236+
def test_compose_sdist_filename(filename: str, name: str, version: Version) -> None:
237+
assert compose_sdist_filename(name, version) == filename
238238

239239

240240
@pytest.mark.parametrize(

0 commit comments

Comments
 (0)