shippinglabel.sdist

Utilities for working with source distributions.

New in version 0.9.0.

NotAnSdistError(filename[, msg])	Raised when something other than a source distribution is passed to parse_sdist_filename().
ParsedSdistFilename(project, version, extension)	Represents a parsed sdist filename.
parse_sdist_filename(filename)	Parse a sdist filename into its components.

exception NotAnSdistError(filename, msg='')

Bases: ValueError

Raised when something other than a source distribution is passed to parse_sdist_filename().

filename

Type:    str

The invalid filename

namedtuple ParsedSdistFilename(project, version, extension)

Bases: NamedTuple

Represents a parsed sdist filename.

Fields

0.  project (str) – The name of the project.

1.  version (str) – The version number of the project.

2.  extension (str) – The file extension of the sdist, e.g. .tar.gz.

parse_sdist_filename(filename)

Parse a sdist filename into its components.

Parameters

filename (Union[str, Path, PathLike]) – An sdist path or filename.

Raises

• packaging.utils.InvalidSdistFilename if the filename is invalid.

  Changed in version 1.0.0: Previously raised wheel_filename.InvalidFilenameError

• shippinglabel.sdist.NotAnSdistError if the file is not an sdist.

Return type

ParsedSdistFilename

See also

packaging.utils.parse_sdist_filename()