pip._vendor.distlib.metadata.LegacyMetadata Class Reference

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

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

Public Member Functions
	__init__ (self, path=None, fileobj=None, mapping=None, scheme='default')
	set_metadata_version (self)
	__getitem__ (self, name)
	__setitem__ (self, name, value)
	__delitem__ (self, name)
	__contains__ (self, name)
	__getattr__ (self, name)
	get_fullname (self, filesafe=False)
	is_field (self, name)
	is_multi_field (self, name)
	read (self, filepath)
	read_file (self, fileob)
	write (self, filepath, skip_unknown=False)
	write_file (self, fileobject, skip_unknown=False)
	update (self, other=None, **kwargs)
	set (self, name, value)
	get (self, name, default=_MISSING)
	check (self, strict=False)
	todict (self, skip_missing=False)
	add_requirements (self, requirements)
	keys (self)
	__iter__ (self)
	values (self)
	items (self)
	__repr__ (self)

Public Attributes
	requires_files
	scheme
	name
	version

Protected Member Functions
	_write_field (self, fileobj, name, value)
	_convert_name (self, name)
	_default_value (self, name)
	_remove_line_prefix (self, value)

Protected Attributes
	_fields
	_dependencies

Detailed Description

The legacy metadata of a release.

Supports versions 1.0, 1.1, 1.2, 2.0 and 1.3/2.1 (auto-detected). You can
instantiate the class with one of these arguments (or none):
- *path*, the path to a metadata file
- *fileobj* give a file-like object with metadata as content
- *mapping* is a dict-like object
- *scheme* is a version scheme name

Member Function Documentation

check()

pip._vendor.distlib.metadata.LegacyMetadata.check	(		self,
			strict = False
	)

Check if the metadata is compliant. If strict is True then raise if
no Name or Version are provided

get()

pip._vendor.distlib.metadata.LegacyMetadata.get	(		self,
			name,
			default = _MISSING
	)

Get a metadata field.

get_fullname()

pip._vendor.distlib.metadata.LegacyMetadata.get_fullname	(		self,
			filesafe = False
	)

Return the distribution name with version.

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

is_field()

pip._vendor.distlib.metadata.LegacyMetadata.is_field	(		self,
			name
	)

return True if name is a valid metadata key

read()

pip._vendor.distlib.metadata.LegacyMetadata.read	(		self,
			filepath
	)

Read the metadata values from a file path.

read_file()

pip._vendor.distlib.metadata.LegacyMetadata.read_file	(		self,
			fileob
	)

Read the metadata values from a file object.

set()

pip._vendor.distlib.metadata.LegacyMetadata.set	(		self,
			name,
			value
	)

Control then set a metadata field.

todict()

pip._vendor.distlib.metadata.LegacyMetadata.todict	(		self,
			skip_missing = False
	)

Return fields as a dict.

Field names will be converted to use the underscore-lowercase style
instead of hyphen-mixed case (i.e. home_page instead of Home-page).
This is as per https://www.python.org/dev/peps/pep-0566/#id17.

update()

pip._vendor.distlib.metadata.LegacyMetadata.update	(		self,
			other = None,
		**	kwargs
	)

Set metadata values from the given iterable `other` and kwargs.

Behavior is like `dict.update`: If `other` has a ``keys`` method,
they are looped over and ``self[key]`` is assigned ``other[key]``.
Else, ``other`` is an iterable of ``(key, value)`` iterables.

Keys that don't match a metadata field or that have an empty value are
dropped.

write()

pip._vendor.distlib.metadata.LegacyMetadata.write	(		self,
			filepath,
			skip_unknown = False
	)

Write the metadata fields to filepath.

write_file()

pip._vendor.distlib.metadata.LegacyMetadata.write_file	(		self,
			fileobject,
			skip_unknown = False
	)

Write the PKG-INFO format data to a file object.

---

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