pip._vendor.distlib.metadata.Metadata Class Reference

Inheritance diagram for pip._vendor.distlib.metadata.Metadata:

Collaboration diagram for pip._vendor.distlib.metadata.Metadata:

Public Member Functions
	__init__ (self, path=None, fileobj=None, mapping=None, scheme='default')
	__getattribute__ (self, key)
	__setattr__ (self, key, value)
	name_and_version (self)
	provides (self)
	provides (self, value)
	get_requirements (self, reqts, extras=None, env=None)
	dictionary (self)
	dependencies (self)
	dependencies (self, value)
	validate (self)
	todict (self)
	write (self, path=None, fileobj=None, legacy=False, skip_unknown=True)
	add_requirements (self, requirements)
	__repr__ (self)

Public Attributes
	scheme
	METADATA_VERSION
	GENERATOR
	name
	version
	DEPENDENCY_KEYS
	metadata_version

Static Public Attributes
	METADATA_VERSION_MATCHER = re.compile(r'^\d+(\.\d+)*$')
	NAME_MATCHER = re.compile('^[0-9A-Z]([0-9A-Z_.-]*[0-9A-Z])?$', re.I)
	FIELDNAME_MATCHER = re.compile('^[A-Z]([0-9A-Z-]*[0-9A-Z])?$', re.I)
	VERSION_MATCHER = PEP440_VERSION_RE
	SUMMARY_MATCHER = re.compile('.{1,2047}')
str	METADATA_VERSION = '2.0'
str	GENERATOR = 'distlib (%s)' % __version__
dict	MANDATORY_KEYS
tuple	INDEX_KEYS
tuple	DEPENDENCY_KEYS
dict	SYNTAX_VALIDATORS
	common_keys = set(('name', 'version', 'license', 'keywords', 'summary'))
tuple	none_list = (None, list)
tuple	none_dict = (None, dict)
dict	mapped_keys
dict	LEGACY_MAPPING

Protected Member Functions
	_validate_value (self, key, value, scheme=None)
	_validate_mapping (self, mapping, scheme)
	_from_legacy (self)
	_to_legacy (self)

Protected Attributes
	_legacy
	_data

Detailed Description

The metadata of a release. This implementation uses 2.1
metadata where possible. If not possible, it wraps a LegacyMetadata
instance which handles the key-value metadata format.

Member Function Documentation

get_requirements()

pip._vendor.distlib.metadata.Metadata.get_requirements	(		self,
			reqts,
			extras = None,
			env = None
	)

Base method to get dependencies, given a set of extras
to satisfy and an optional environment context.
:param reqts: A list of sometimes-wanted dependencies,
              perhaps dependent on extras and environment.
:param extras: A list of optional components being requested.
:param env: An optional environment for marker evaluation.

Member Data Documentation

DEPENDENCY_KEYS

tuple pip._vendor.distlib.metadata.Metadata.DEPENDENCY_KEYS

static

Initial value:

=  ('extras run_requires test_requires build_requires '
                       'dev_requires provides meta_requires obsoleted_by '
                       'supports_environments')

INDEX_KEYS

tuple pip._vendor.distlib.metadata.Metadata.INDEX_KEYS

static

Initial value:

=  ('name version license summary description author '
                  'author_email keywords platform home_page classifiers '
                  'download_url')

LEGACY_MAPPING

dict pip._vendor.distlib.metadata.Metadata.LEGACY_MAPPING

static

Initial value:

=  {
        'name': 'Name',
        'version': 'Version',
        ('extensions', 'python.details', 'license'): 'License',
        'summary': 'Summary',
        'description': 'Description',
        ('extensions', 'python.project', 'project_urls', 'Home'): 'Home-page',
        ('extensions', 'python.project', 'contacts', 0, 'name'): 'Author',
        ('extensions', 'python.project', 'contacts', 0, 'email'): 'Author-email',
        'source_url': 'Download-URL',
        ('extensions', 'python.details', 'classifiers'): 'Classifier',
    }

MANDATORY_KEYS

dict pip._vendor.distlib.metadata.Metadata.MANDATORY_KEYS

static

Initial value:

=  {
        'name': (),
        'version': (),
        'summary': ('legacy',),
    }

mapped_keys

dict pip._vendor.distlib.metadata.Metadata.mapped_keys

static

Initial value:

=  {
        'run_requires': ('Requires-Dist', list),
        'build_requires': ('Setup-Requires-Dist', list),
        'dev_requires': none_list,
        'test_requires': none_list,
        'meta_requires': none_list,
        'extras': ('Provides-Extra', list),
        'modules': none_list,
        'namespaces': none_list,
        'exports': none_dict,
        'commands': none_dict,
        'classifiers': ('Classifier', list),
        'source_url': ('Download-URL', None),
        'metadata_version': ('Metadata-Version', None),
    }

SYNTAX_VALIDATORS

dict pip._vendor.distlib.metadata.Metadata.SYNTAX_VALIDATORS

static

Initial value:

=  {
        'metadata_version': (METADATA_VERSION_MATCHER, ()),
        'name': (NAME_MATCHER, ('legacy',)),
        'version': (VERSION_MATCHER, ('legacy',)),
        'summary': (SUMMARY_MATCHER, ('legacy',)),
        'dynamic': (FIELDNAME_MATCHER, ('legacy',)),
    }

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/distlib/metadata.py