The XmpInformation Class

class pypdf.xmp.XmpInformation(stream: ContentStream)

Bases: XmpInformationProtocol, PdfObject

An object that represents Extensible Metadata Platform (XMP) metadata. Usually accessed by xmp_metadata().

Raises:

PdfReadError – if XML is invalid

classmethod create() → XmpInformation

Create a new XmpInformation object with minimal structure.

Returns:

A new XmpInformation instance with empty metadata fields.

write_to_stream(stream: IO[Any], encryption_key: None | str | bytes = None) → None

get_element(about_uri: str, namespace: str, name: str) → Iterator[Any]

get_nodes_in_namespace(about_uri: str, namespace: str) → Iterator[Any]

property dc_contributor: list[str] | None

Contributors to the resource (other than the authors).

property dc_coverage: str | None

Text describing the extent or scope of the resource.

property dc_creator: list[str] | None

A sorted array of names of the authors of the resource, listed in order of precedence.

property dc_date: list[datetime] | None

A sorted array of dates of significance to the resource. The dates and times are in UTC.

property dc_description: dict[str, str] | None

A language-keyed dictionary of textual descriptions of the content of the resource.

property dc_format: str | None

The mime-type of the resource.

property dc_identifier: str | None

Unique identifier of the resource.

property dc_language: list[str] | None

An unordered array specifying the languages used in the resource.

property dc_publisher: list[str] | None

An unordered array of publisher names.

property dc_relation: list[str] | None

An unordered array of text descriptions of relationships to other documents.

property dc_rights: dict[str, str] | None

A language-keyed dictionary of textual descriptions of the rights the user has to this resource.

property dc_source: str | None

Unique identifier of the work from which this resource was derived.

property dc_subject: list[str] | None

An unordered array of descriptive phrases or keywords that specify the topic of the content.

property dc_title: dict[str, str] | None

A language-keyed dictionary of the title of the resource.

property dc_type: list[str] | None

An unordered array of textual descriptions of the document type.

property pdf_keywords: str | None

An unformatted text string representing document keywords.

property pdf_pdfversion: str | None

The PDF file version, for example 1.0 or 1.3.

property pdf_producer: str | None

The name of the tool that saved the document as a PDF.

property xmp_create_date: datetime | None

The date and time the resource was originally created. Returned as a UTC datetime object.

property xmp_modify_date: datetime | None

The date and time the resource was last modified. Returned as a UTC datetime object.

property xmp_metadata_date: datetime | None

The date and time that any metadata for this resource was last changed. Returned as a UTC datetime object.

property xmp_creator_tool: str | None

The name of the first known tool used to create the resource.

property xmpmm_document_id: str | None

The common identifier for all versions and renditions of this resource.

property xmpmm_instance_id: str | None

An identifier for a specific incarnation of a document, updated each time a file is saved.

property pdfaid_part: str | None

The part of the PDF/A standard that the document conforms to (e.g., 1, 2, 3).

property pdfaid_conformance: str | None

The conformance level within the PDF/A standard (e.g., ‘A’, ‘B’, ‘U’).

property custom_properties: dict[Any, Any]

Retrieve custom metadata properties defined in the undocumented pdfx metadata schema.

Returns:

A dictionary of key/value items for custom metadata properties.