XmpPacket
Overview
XmpPacket is a class in Aspose.PDF FOSS for Python.
An in-memory XMP packet: an ordered collection of properties.
This class provides 18 methods for working with XmpPacket objects in Python programs.
Available methods include: add, get, get_array, get_bool, get_date, get_int, get_localized_text, get_real, parse, serialize, set_array, set_bool, and 6 additional methods.
All public members are accessible to any Python application after installing the Aspose.PDF FOSS for Python package.
Properties: fields, namespace_provider, qualifiers.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
fields | list[XmpField | XmpArray | XmpProperty] | Read/Write | Gets or sets the fields. |
qualifiers | list[XmpField] | Read/Write | Gets or sets the qualifiers. |
namespace_provider | XmpNamespaceProvider | None | Read/Write | Gets or sets the namespace provider. |
Methods
| Signature | Description |
|---|---|
add(value: XmpField | XmpArray | XmpProperty) | Calls add(value) on this XmpPacket instance. |
parse(data: str | bytes, provider: XmpNamespaceProvider | None) → XmpPacket | Parse an XMP packet (bytes or text) into an :class:XmpPacket. |
serialize() → bytes | Serialize this packet to XMP packet bytes (see :func:serialize_xmp). |
to_bytes() → bytes | Calls to_bytes on this XmpPacket instance. |
get(prefix_or_uri: str, name: str) → XmpField | None | Return the first property matching name under prefix_or_uri. |
set_value(prefix: str, name: str, value: Any, uri: str) → XmpField | Set (or add) a simple property and return the affected :class:XmpField. |
set_date(prefix: str, name: str, value: datetime | str, uri: str) → XmpField | Set a date property, storing an ISO-8601 string (XMP date form). |
get_date(prefix_or_uri: str, name: str) → datetime | None | Return a date property as a :class:~datetime.datetime, or None. |
set_localized_text(prefix: str, name: str, text: str, uri: str, lang: str) → XmpField | Set a language-alternative (rdf:Alt) text property, e.g. |
get_localized_text(prefix_or_uri: str, name: str, lang: str) → str | None | Return the lang (or x-default) alternative of a text property. |
set_array(prefix: str, name: str, values: Iterable[Any], uri: str, kind: str) → XmpField | Set an array property (Seq/Bag/Alt) from values. |
get_array(prefix_or_uri: str, name: str) → list[str] | None | Return an array property’s items as a list of strings, or None. |
set_bool(prefix: str, name: str, value: bool, uri: str) → XmpField | Set a Boolean property (XMP encodes it as "True"/"False"). |
get_bool(prefix_or_uri: str, name: str) → bool | None | Return a Boolean property, or None if absent / not a boolean. |
set_int(prefix: str, name: str, value: int, uri: str) → XmpField | Set an Integer property. |
get_int(prefix_or_uri: str, name: str) → int | None | Return an Integer property, or None if absent / not an integer. |
set_real(prefix: str, name: str, value: float, uri: str) → XmpField | Set a Real (floating-point) property. |
get_real(prefix_or_uri: str, name: str) → float | None | Return a Real property, or None if absent / not a number. |