pip._vendor.distlib.metadata Namespace Reference

Classes
class	LegacyMetadata
class	Metadata
class	MetadataConflictError
class	MetadataInvalidError
class	MetadataMissingError
class	MetadataUnrecognizedVersionError

Functions
	_version2fieldlist (version)
	_best_version (fields)
	_get_name_and_version (name, version, for_filename=False)

Variables
	logger = logging.getLogger(__name__)
str	PKG_INFO_ENCODING = 'utf-8'
str	PKG_INFO_PREFERRED_VERSION = '1.1'
	_LINE_PREFIX_1_2 = re.compile('\n \\|')
	_LINE_PREFIX_PRE_1_2 = re.compile('\n ')
tuple	_241_FIELDS
tuple	_314_FIELDS
tuple	_314_MARKERS
tuple	_345_FIELDS
tuple	_345_MARKERS
tuple	_426_FIELDS
tuple	_426_MARKERS
tuple	_566_FIELDS
tuple	_566_MARKERS = ('Description-Content-Type',)
tuple	_643_MARKERS = ('Dynamic', 'License-File')
tuple	_643_FIELDS = _566_FIELDS + _643_MARKERS
	_ALL_FIELDS = set()
	EXTRA_RE = re.compile()
dict	_ATTR2FIELD
dict	_FIELD2ATTR = {field: attr for attr, field in _ATTR2FIELD.items()}
tuple	_PREDICATE_FIELDS = ('Requires-Dist', 'Obsoletes-Dist', 'Provides-Dist')
tuple	_VERSIONS_FIELDS = ('Requires-Python',)
tuple	_VERSION_FIELDS = ('Version',)
tuple	_LISTFIELDS
tuple	_LISTTUPLEFIELDS = ('Project-URL',)
tuple	_ELEMENTSFIELD = ('Keywords',)
tuple	_UNICODEFIELDS = ('Author', 'Maintainer', 'Summary', 'Description')
	_MISSING = object()
	_FILESAFE = re.compile('[^A-Za-z0-9.]+')
str	METADATA_FILENAME = 'pydist.json'
str	WHEEL_METADATA_FILENAME = 'metadata.json'
str	LEGACY_METADATA_FILENAME = 'METADATA'

Detailed Description

Implementation of the Metadata for Python packages PEPs.

Supports all metadata formats (1.0, 1.1, 1.2, 1.3/2.1 and 2.2).

Function Documentation

_best_version()

pip._vendor.distlib.metadata._best_version (   fields )

protected

Detect the best version depending on the fields used.

_get_name_and_version()

pip._vendor.distlib.metadata._get_name_and_version (   name,   version,   for_filename = False  )

protected

Return the distribution name with version.

If for_filename is true, return a filename-escaped form.

Variable Documentation

_241_FIELDS

tuple pip._vendor.distlib.metadata._241_FIELDS

protected

Initial value:

=  ('Metadata-Version', 'Name', 'Version', 'Platform',
               'Summary', 'Description',
               'Keywords', 'Home-page', 'Author', 'Author-email',
               'License')

_314_FIELDS

tuple pip._vendor.distlib.metadata._314_FIELDS

protected

Initial value:

=  ('Metadata-Version', 'Name', 'Version', 'Platform',
               'Supported-Platform', 'Summary', 'Description',
               'Keywords', 'Home-page', 'Author', 'Author-email',
               'License', 'Classifier', 'Download-URL', 'Obsoletes',
               'Provides', 'Requires')

_314_MARKERS

tuple pip._vendor.distlib.metadata._314_MARKERS

protected

Initial value:

=  ('Obsoletes', 'Provides', 'Requires', 'Classifier',
                'Download-URL')

_345_FIELDS

tuple pip._vendor.distlib.metadata._345_FIELDS

protected

Initial value:

=  ('Metadata-Version', 'Name', 'Version', 'Platform',
               'Supported-Platform', 'Summary', 'Description',
               'Keywords', 'Home-page', 'Author', 'Author-email',
               'Maintainer', 'Maintainer-email', 'License',
               'Classifier', 'Download-URL', 'Obsoletes-Dist',
               'Project-URL', 'Provides-Dist', 'Requires-Dist',
               'Requires-Python', 'Requires-External')

_345_MARKERS

tuple pip._vendor.distlib.metadata._345_MARKERS

protected

Initial value:

=  ('Provides-Dist', 'Requires-Dist', 'Requires-Python',
                'Obsoletes-Dist', 'Requires-External', 'Maintainer',
                'Maintainer-email', 'Project-URL')

_426_FIELDS

tuple pip._vendor.distlib.metadata._426_FIELDS

protected

Initial value:

=  ('Metadata-Version', 'Name', 'Version', 'Platform',
               'Supported-Platform', 'Summary', 'Description',
               'Keywords', 'Home-page', 'Author', 'Author-email',
               'Maintainer', 'Maintainer-email', 'License',
               'Classifier', 'Download-URL', 'Obsoletes-Dist',
               'Project-URL', 'Provides-Dist', 'Requires-Dist',
               'Requires-Python', 'Requires-External', 'Private-Version',
               'Obsoleted-By', 'Setup-Requires-Dist', 'Extension',
               'Provides-Extra')

_426_MARKERS

tuple pip._vendor.distlib.metadata._426_MARKERS

protected

Initial value:

=  ('Private-Version', 'Provides-Extra', 'Obsoleted-By',
                'Setup-Requires-Dist', 'Extension')

_566_FIELDS

tuple pip._vendor.distlib.metadata._566_FIELDS

protected

Initial value:

=  _426_FIELDS + ('Description-Content-Type',
                             'Requires', 'Provides', 'Obsoletes')

_ATTR2FIELD

dict pip._vendor.distlib.metadata._ATTR2FIELD

protected

Initial value:

=  {
    name.lower().replace("-", "_"): name for name in _ALL_FIELDS
}

_LISTFIELDS

tuple pip._vendor.distlib.metadata._LISTFIELDS

protected

Initial value:

=  ('Platform', 'Classifier', 'Obsoletes',
               'Requires', 'Provides', 'Obsoletes-Dist',
               'Provides-Dist', 'Requires-Dist', 'Requires-External',
               'Project-URL', 'Supported-Platform', 'Setup-Requires-Dist',
               'Provides-Extra', 'Extension', 'License-File')