rename: SourceDistributionFilename

Signed-off-by: Henry Schreiner <henryfs@princeton.edu>

Author: henryiii

src/packaging/filenames.py

@@ -18,7 +18,7 @@
     "InvalidWheelFilename",
     "InvalidWheelFilename",
     "NormalizedName",
-    "SourceFilename",
+    "SourceDistributionFilename",
     "WheelFilename",
     "canonicalize_name",
     "canonicalize_version",
@@ -397,7 +397,7 @@ def from_filename(cls, filename: str, /, *, strict: bool) -> WheelFilename:
         return self
 
 
-class SourceFilename:
+class SourceDistributionFilename:
     """Represents a source distribution filename and its parsed components.
 
     Instances preserve the original name and version strings for round-tripping,
@@ -443,8 +443,8 @@ def to_filename(self) -> str:
         characters are replaced with ``_`` and characters are lower cased. The
         version is an instance of :class:`~packaging.version.Version`.
 
-        >>> from packaging.filenames import SourceFilename
-        >>> SourceFilename("foo-bar", "1.0").to_filename()
+        >>> from packaging.filenames import SourceDistributionFilename
+        >>> SourceDistributionFilename("foo-bar", "1.0").to_filename()
         'foo_bar-1.0.tar.gz'
 
         .. versionadded:: 26.1
@@ -464,7 +464,7 @@ def __str__(self) -> str:
         return self.to_filename()
 
     @classmethod
-    def from_filename(cls, filename: str, /, *, strict: bool) -> SourceFilename:
+    def from_filename(cls, filename: str, /, *, strict: bool) -> SourceDistributionFilename:
         """
         This function takes the filename of a sdist file (as specified
         in the `Source distribution format`_ documentation), and parses
@@ -476,8 +476,8 @@ def from_filename(cls, filename: str, /, *, strict: bool) -> SourceFilename:
             with an sdist extension (``.zip`` or ``.tar.gz``), or if it does not
             contain a dash separating the name and the version of the distribution.
 
-        >>> from packaging.filenames import SourceFilename
-        >>> fn = SourceFilename.from_filename("foo-1.0.tar.gz", strict=True)
+        >>> from packaging.filenames import SourceDistributionFilename
+        >>> fn = SourceDistributionFilename.from_filename("foo-1.0.tar.gz", strict=True)
         >>> fn.name
         'foo'
         >>> fn.version

src/packaging/utils.py

@@ -12,7 +12,7 @@
     InvalidSdistFilename,
     InvalidWheelFilename,
     NormalizedName,
-    SourceFilename,
+    SourceDistributionFilename,
     WheelFilename,
     canonicalize_name,
     canonicalize_version,
@@ -105,5 +105,5 @@ def parse_sdist_filename(filename: str) -> tuple[NormalizedName, Version]:
 
     .. _Source distribution format: https://packaging.python.org/specifications/source-distribution-format/#source-distribution-file-name
     """
-    fname = SourceFilename.from_filename(filename, strict=False)
+    fname = SourceDistributionFilename.from_filename(filename, strict=False)
     return (fname.name, fname.version)

tests/test_filenames.py

@@ -7,7 +7,7 @@
 from packaging.filenames import (
     InvalidFilename,
     InvalidWheelFilename,
-    SourceFilename,
+    SourceDistributionFilename,
     WheelFilename,
 )
 from packaging.tags import Tag
@@ -45,7 +45,7 @@
 def test_sdist_not_strict_passes(
     name: str, version: str, expected_filename: str
 ) -> None:
-    fn = SourceFilename(name, version)
+    fn = SourceDistributionFilename(name, version)
     assert str(fn) == expected_filename
     assert fn.original_name == name
     assert fn.original_version == version
@@ -94,7 +94,7 @@ def test_sdist_not_strict_passes(
 )
 def test_sdist_from_filename_invalid(filename: str, error_message: str) -> None:
     with pytest.raises(InvalidFilename) as e:
-        SourceFilename.from_filename(filename, strict=True)
+        SourceDistributionFilename.from_filename(filename, strict=True)
 
     assert str(e.value) == f"{error_message}: {filename!r}"
 
@@ -319,11 +319,11 @@ def test_parse_and_create_filename() -> None:
     ],
 )
 def test_compose_sdist_filename(filename: str, name: str, version: Version) -> None:
-    assert SourceFilename(name, str(version)).to_filename() == filename
+    assert SourceDistributionFilename(name, str(version)).to_filename() == filename
 
 
 def test_sdist_from_filename_strict_valid() -> None:
-    fn = SourceFilename.from_filename("foo_bar-1.0.tar.gz", strict=True)
+    fn = SourceDistributionFilename.from_filename("foo_bar-1.0.tar.gz", strict=True)
     assert fn.name == "foo-bar"
     assert fn.version == Version("1.0")
 
@@ -344,11 +344,11 @@ def test_wheel_repr() -> None:
 
 
 def test_sdist_version_property_invalid() -> None:
-    fn = SourceFilename("foo", "not-a-version")
+    fn = SourceDistributionFilename("foo", "not-a-version")
     with pytest.raises(InvalidFilename, match="invalid version"):
         _ = fn.version
 
 
 def test_sdist_repr() -> None:
-    fn = SourceFilename("foo", "1.0")
-    assert repr(fn) == "SourceFilename(name='foo', version='1.0')"
+    fn = SourceDistributionFilename("foo", "1.0")
+    assert repr(fn) == "SourceDistributionFilename(name='foo', version='1.0')"