File size: 1,868 Bytes
d40299b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | Metadata
========
.. currentmodule:: packaging.metadata
Both `source distributions`_ and `binary distributions`_
(*sdists* and *wheels*, respectively) contain files recording the
`core metadata`_ for the distribution. This information is used for
everything from recording the name of the distribution to the
installation dependencies.
Usage
-----
.. doctest::
>>> from packaging.metadata import parse_email
>>> metadata = "Metadata-Version: 2.6\nName: packaging\nVersion: 24.0"
>>> raw, unparsed = parse_email(metadata)
>>> raw["metadata_version"]
'2.6'
>>> raw["name"]
'packaging'
>>> raw["version"]
'24.0'
>>> from packaging.metadata import Metadata
>>> parsed = Metadata.from_raw(raw)
>>> parsed.name
'packaging'
>>> parsed.version
<Version('24.0')>
Reference
---------
High Level Interface
''''''''''''''''''''
.. autoclass:: packaging.metadata.Metadata
:members:
Low Level Interface
'''''''''''''''''''
.. autoclass:: packaging.metadata.RawMetadata
:members:
:undoc-members:
.. autofunction:: packaging.metadata.parse_email
.. autoclass:: packaging.metadata.RFC822Message
.. autoclass:: packaging.metadata.RFC822Policy
Exceptions
''''''''''
.. autoclass:: packaging.metadata.InvalidMetadata
:members:
.. note::
``packaging.metadata.ExceptionGroup`` is a backward-compatible re-export
of :class:`packaging.errors.ExceptionGroup` and is omitted here to avoid
duplicate documentation. See :mod:`packaging.errors` for the canonical
documentation.
.. _source distributions: https://packaging.python.org/en/latest/specifications/source-distribution-format/
.. _binary distributions: https://packaging.python.org/en/latest/specifications/binary-distribution-format/
.. _core metadata: https://packaging.python.org/en/latest/specifications/core-metadata/
|