Utilities

A set of small, helper utilities for dealing with Python packages.

Reference

exception packaging.utils.InvalidName

An invalid distribution name; users should refer to the packaging user guide.

exception packaging.utils.InvalidWheelFilename

An invalid wheel filename was found, users should refer to PEP 427.

exception packaging.utils.InvalidSdistFilename

An invalid sdist filename was found, users should refer to the packaging user guide.

packaging.utils.canonicalize_version(version, *, strip_trailing_zero=True)
packaging.utils.canonicalize_version(version, *, strip_trailing_zero=True)

Return a canonical form of a version as a string.

>>> canonicalize_version('1.0.1')
'1.0.1'

Per PEP 625, versions may have multiple canonical forms, differing only by trailing zeros.

>>> canonicalize_version('1.0.0')
'1'
>>> canonicalize_version('1.0.0', strip_trailing_zero=False)
'1.0.0'

Invalid versions are returned unaltered.

>>> canonicalize_version('foo bar baz')
'foo bar baz'
Parameters:
  • version (Version | str)

  • strip_trailing_zero (bool)

Return type:

str