Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# SPDX-FileCopyrightText: 2022 James R. Barlow
2# SPDX-License-Identifier: MPL-2.0
4"""PDF metadata handling.
6This module provides XMP and DocumentInfo metadata access for PDF files.
7"""
9from __future__ import annotations
11from pikepdf.models.metadata._constants import (
12 DEFAULT_NAMESPACES,
13 LANG_ALTS,
14 XMP_CONTAINERS,
15 XMP_EMPTY,
16 XMP_NS_DC,
17 XMP_NS_PDF,
18 XMP_NS_PDFA_EXTENSION,
19 XMP_NS_PDFA_ID,
20 XMP_NS_PDFA_PROPERTY,
21 XMP_NS_PDFA_SCHEMA,
22 XMP_NS_PDFUA_ID,
23 XMP_NS_PDFX_ID,
24 XMP_NS_PHOTOSHOP,
25 XMP_NS_PRISM,
26 XMP_NS_PRISM2,
27 XMP_NS_PRISM3,
28 XMP_NS_RDF,
29 XMP_NS_XML,
30 XMP_NS_XMP,
31 XMP_NS_XMP_MM,
32 XMP_NS_XMP_RIGHTS,
33 XPACKET_BEGIN,
34 XPACKET_END,
35 AltList,
36 XmpContainer,
37)
38from pikepdf.models.metadata._converters import (
39 DOCINFO_MAPPING,
40 AuthorConverter,
41 Converter,
42 DateConverter,
43 DocinfoMapping,
44 decode_pdf_date,
45 encode_pdf_date,
46)
47from pikepdf.models.metadata._core import PdfMetadata
48from pikepdf.models.metadata._xmp import XmpDocument
50__all__ = [
51 # Main classes
52 'PdfMetadata',
53 'XmpDocument',
54 # Converters
55 'Converter',
56 'AuthorConverter',
57 'DateConverter',
58 'DocinfoMapping',
59 'DOCINFO_MAPPING',
60 'decode_pdf_date',
61 'encode_pdf_date',
62 # Namespace constants
63 'XMP_NS_DC',
64 'XMP_NS_PDF',
65 'XMP_NS_PDFA_ID',
66 'XMP_NS_PDFA_EXTENSION',
67 'XMP_NS_PDFA_PROPERTY',
68 'XMP_NS_PDFA_SCHEMA',
69 'XMP_NS_PDFUA_ID',
70 'XMP_NS_PDFX_ID',
71 'XMP_NS_PHOTOSHOP',
72 'XMP_NS_PRISM',
73 'XMP_NS_PRISM2',
74 'XMP_NS_PRISM3',
75 'XMP_NS_RDF',
76 'XMP_NS_XML',
77 'XMP_NS_XMP',
78 'XMP_NS_XMP_MM',
79 'XMP_NS_XMP_RIGHTS',
80 # Other exports
81 'DEFAULT_NAMESPACES',
82 'LANG_ALTS',
83 'XPACKET_BEGIN',
84 'XPACKET_END',
85 'XMP_CONTAINERS',
86 'XMP_EMPTY',
87 'AltList',
88 'XmpContainer',
89]