packaging.metadata.Metadata Class Reference

Collaboration diagram for packaging.metadata.Metadata:

Public Member Functions
Metadata	from_raw (cls, RawMetadata data, *bool validate=True)
Metadata	from_email (cls, bytes|str data, *bool validate=True)

Static Public Attributes
_Validator	metadata_version = _Validator()
_Validator	name = _Validator()
_Validator	version = _Validator()
_Validator	dynamic
_Validator	platforms = _Validator()
_Validator	supported_platforms = _Validator(added="1.1")
_Validator	summary = _Validator()
_Validator	description = _Validator()
_Validator	description_content_type = _Validator(added="2.1")
_Validator	keywords = _Validator()
_Validator	home_page = _Validator()
_Validator	download_url = _Validator(added="1.1")
_Validator	author = _Validator()
_Validator	author_email = _Validator()
_Validator	maintainer = _Validator(added="1.2")
_Validator	maintainer_email = _Validator(added="1.2")
_Validator	license = _Validator()
_Validator	license_expression
_Validator	license_files = _Validator(added="2.4")
_Validator	classifiers = _Validator(added="1.1")
_Validator	requires_dist
_Validator	requires_python
_Validator	requires_external = _Validator(added="1.2")
_Validator	project_urls = _Validator(added="1.2")
_Validator	provides_extra
_Validator	provides_dist = _Validator(added="1.2")
_Validator	obsoletes_dist = _Validator(added="1.2")
_Validator	requires = _Validator(added="1.1")
_Validator	provides = _Validator(added="1.1")
_Validator	obsoletes = _Validator(added="1.1")

Static Protected Attributes
RawMetadata	_raw

Detailed Description

Representation of distribution metadata.

Compared to :class:`RawMetadata`, this class provides objects representing
metadata fields instead of only using built-in types. Any invalid metadata
will cause :exc:`InvalidMetadata` to be raised (with a
:py:attr:`~BaseException.__cause__` attribute as appropriate).

Member Function Documentation

from_email()

Metadata packaging.metadata.Metadata.from_email	(		cls,
		bytes | str	data,
		*bool	validate = True
	)

Parse metadata from email headers.

If *validate* is true, the metadata will be validated. All exceptions
related to validation will be gathered and raised as an :class:`ExceptionGroup`.

from_raw()

Metadata packaging.metadata.Metadata.from_raw	(		cls,
		RawMetadata	data,
		*bool	validate = True
	)

Create an instance from :class:`RawMetadata`.

If *validate* is true, all metadata will be validated. All exceptions
related to validation will be gathered and raised as an :class:`ExceptionGroup`.

Member Data Documentation

dynamic

_Validator packaging.metadata.Metadata.dynamic

static

Initial value:

=  _Validator(
        added="2.2",
    )

license_expression

_Validator packaging.metadata.Metadata.license_expression

static

Initial value:

=  _Validator(
        added="2.4"
    )

provides_extra

_Validator packaging.metadata.Metadata.provides_extra

static

Initial value:

=  _Validator(
        added="2.1",
    )

requires_dist

_Validator packaging.metadata.Metadata.requires_dist

static

Initial value:

=  _Validator(
        added="1.2"
    )

requires_python

_Validator packaging.metadata.Metadata.requires_python

static

Initial value:

=  _Validator(
        added="1.2"
    )

---

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

• docs/help/help-venv/lib/python3.12/site-packages/packaging/metadata.py