Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/pikepdf/codec.py: 72%
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: 2026 James R. Barlow
2# SPDX-License-Identifier: MPL-2.0
4"""Implement pdfdoc codec.
6PdfDocEncoding character mapping codec following the standard Python codec pattern.
7See PDF Reference Manual 1.7, Table D.2 for the encoding specification.
8"""
10from __future__ import annotations
12import codecs
13from typing import Any
15# PdfDocEncoding decoding table: maps byte values 0x00-0xFF to Unicode characters.
16# Undefined positions use \ufffe which causes charmap_decode to raise
17# UnicodeDecodeError.
18# fmt: off
19decoding_table = (
20 '\x00' # 0x00 -> NULL
21 '\x01' # 0x01 -> START OF HEADING
22 '\x02' # 0x02 -> START OF TEXT
23 '\x03' # 0x03 -> END OF TEXT
24 '\x04' # 0x04 -> END OF TRANSMISSION
25 '\x05' # 0x05 -> ENQUIRY
26 '\x06' # 0x06 -> ACKNOWLEDGE
27 '\x07' # 0x07 -> BELL
28 '\x08' # 0x08 -> BACKSPACE
29 '\t' # 0x09 -> HORIZONTAL TABULATION
30 '\n' # 0x0A -> LINE FEED
31 '\x0b' # 0x0B -> VERTICAL TABULATION
32 '\x0c' # 0x0C -> FORM FEED
33 '\r' # 0x0D -> CARRIAGE RETURN
34 '\x0e' # 0x0E -> SHIFT OUT
35 '\x0f' # 0x0F -> SHIFT IN
36 '\x10' # 0x10 -> DATA LINK ESCAPE
37 '\x11' # 0x11 -> DEVICE CONTROL ONE
38 '\x12' # 0x12 -> DEVICE CONTROL TWO
39 '\x13' # 0x13 -> DEVICE CONTROL THREE
40 '\x14' # 0x14 -> DEVICE CONTROL FOUR
41 '\x15' # 0x15 -> NEGATIVE ACKNOWLEDGE
42 '\x16' # 0x16 -> SYNCHRONOUS IDLE
43 '\x17' # 0x17 -> END OF TRANSMISSION BLOCK
44 '\u02d8' # 0x18 -> BREVE
45 '\u02c7' # 0x19 -> CARON
46 '\u02c6' # 0x1A -> MODIFIER LETTER CIRCUMFLEX ACCENT
47 '\u02d9' # 0x1B -> DOT ABOVE
48 '\u02dd' # 0x1C -> DOUBLE ACUTE ACCENT
49 '\u02db' # 0x1D -> OGONEK
50 '\u02da' # 0x1E -> RING ABOVE
51 '\u02dc' # 0x1F -> SMALL TILDE
52 ' ' # 0x20 -> SPACE
53 '!' # 0x21 -> EXCLAMATION MARK
54 '"' # 0x22 -> QUOTATION MARK
55 '#' # 0x23 -> NUMBER SIGN
56 '$' # 0x24 -> DOLLAR SIGN
57 '%' # 0x25 -> PERCENT SIGN
58 '&' # 0x26 -> AMPERSAND
59 "'" # 0x27 -> APOSTROPHE
60 '(' # 0x28 -> LEFT PARENTHESIS
61 ')' # 0x29 -> RIGHT PARENTHESIS
62 '*' # 0x2A -> ASTERISK
63 '+' # 0x2B -> PLUS SIGN
64 ',' # 0x2C -> COMMA
65 '-' # 0x2D -> HYPHEN-MINUS
66 '.' # 0x2E -> FULL STOP
67 '/' # 0x2F -> SOLIDUS
68 '0' # 0x30 -> DIGIT ZERO
69 '1' # 0x31 -> DIGIT ONE
70 '2' # 0x32 -> DIGIT TWO
71 '3' # 0x33 -> DIGIT THREE
72 '4' # 0x34 -> DIGIT FOUR
73 '5' # 0x35 -> DIGIT FIVE
74 '6' # 0x36 -> DIGIT SIX
75 '7' # 0x37 -> DIGIT SEVEN
76 '8' # 0x38 -> DIGIT EIGHT
77 '9' # 0x39 -> DIGIT NINE
78 ':' # 0x3A -> COLON
79 ';' # 0x3B -> SEMICOLON
80 '<' # 0x3C -> LESS-THAN SIGN
81 '=' # 0x3D -> EQUALS SIGN
82 '>' # 0x3E -> GREATER-THAN SIGN
83 '?' # 0x3F -> QUESTION MARK
84 '@' # 0x40 -> COMMERCIAL AT
85 'A' # 0x41 -> LATIN CAPITAL LETTER A
86 'B' # 0x42 -> LATIN CAPITAL LETTER B
87 'C' # 0x43 -> LATIN CAPITAL LETTER C
88 'D' # 0x44 -> LATIN CAPITAL LETTER D
89 'E' # 0x45 -> LATIN CAPITAL LETTER E
90 'F' # 0x46 -> LATIN CAPITAL LETTER F
91 'G' # 0x47 -> LATIN CAPITAL LETTER G
92 'H' # 0x48 -> LATIN CAPITAL LETTER H
93 'I' # 0x49 -> LATIN CAPITAL LETTER I
94 'J' # 0x4A -> LATIN CAPITAL LETTER J
95 'K' # 0x4B -> LATIN CAPITAL LETTER K
96 'L' # 0x4C -> LATIN CAPITAL LETTER L
97 'M' # 0x4D -> LATIN CAPITAL LETTER M
98 'N' # 0x4E -> LATIN CAPITAL LETTER N
99 'O' # 0x4F -> LATIN CAPITAL LETTER O
100 'P' # 0x50 -> LATIN CAPITAL LETTER P
101 'Q' # 0x51 -> LATIN CAPITAL LETTER Q
102 'R' # 0x52 -> LATIN CAPITAL LETTER R
103 'S' # 0x53 -> LATIN CAPITAL LETTER S
104 'T' # 0x54 -> LATIN CAPITAL LETTER T
105 'U' # 0x55 -> LATIN CAPITAL LETTER U
106 'V' # 0x56 -> LATIN CAPITAL LETTER V
107 'W' # 0x57 -> LATIN CAPITAL LETTER W
108 'X' # 0x58 -> LATIN CAPITAL LETTER X
109 'Y' # 0x59 -> LATIN CAPITAL LETTER Y
110 'Z' # 0x5A -> LATIN CAPITAL LETTER Z
111 '[' # 0x5B -> LEFT SQUARE BRACKET
112 '\\' # 0x5C -> REVERSE SOLIDUS
113 ']' # 0x5D -> RIGHT SQUARE BRACKET
114 '^' # 0x5E -> CIRCUMFLEX ACCENT
115 '_' # 0x5F -> LOW LINE
116 '`' # 0x60 -> GRAVE ACCENT
117 'a' # 0x61 -> LATIN SMALL LETTER A
118 'b' # 0x62 -> LATIN SMALL LETTER B
119 'c' # 0x63 -> LATIN SMALL LETTER C
120 'd' # 0x64 -> LATIN SMALL LETTER D
121 'e' # 0x65 -> LATIN SMALL LETTER E
122 'f' # 0x66 -> LATIN SMALL LETTER F
123 'g' # 0x67 -> LATIN SMALL LETTER G
124 'h' # 0x68 -> LATIN SMALL LETTER H
125 'i' # 0x69 -> LATIN SMALL LETTER I
126 'j' # 0x6A -> LATIN SMALL LETTER J
127 'k' # 0x6B -> LATIN SMALL LETTER K
128 'l' # 0x6C -> LATIN SMALL LETTER L
129 'm' # 0x6D -> LATIN SMALL LETTER M
130 'n' # 0x6E -> LATIN SMALL LETTER N
131 'o' # 0x6F -> LATIN SMALL LETTER O
132 'p' # 0x70 -> LATIN SMALL LETTER P
133 'q' # 0x71 -> LATIN SMALL LETTER Q
134 'r' # 0x72 -> LATIN SMALL LETTER R
135 's' # 0x73 -> LATIN SMALL LETTER S
136 't' # 0x74 -> LATIN SMALL LETTER T
137 'u' # 0x75 -> LATIN SMALL LETTER U
138 'v' # 0x76 -> LATIN SMALL LETTER V
139 'w' # 0x77 -> LATIN SMALL LETTER W
140 'x' # 0x78 -> LATIN SMALL LETTER X
141 'y' # 0x79 -> LATIN SMALL LETTER Y
142 'z' # 0x7A -> LATIN SMALL LETTER Z
143 '{' # 0x7B -> LEFT CURLY BRACKET
144 '|' # 0x7C -> VERTICAL LINE
145 '}' # 0x7D -> RIGHT CURLY BRACKET
146 '~' # 0x7E -> TILDE
147 '\ufffe' # 0x7F -> UNDEFINED
148 '\u2022' # 0x80 -> BULLET
149 '\u2020' # 0x81 -> DAGGER
150 '\u2021' # 0x82 -> DOUBLE DAGGER
151 '\u2026' # 0x83 -> HORIZONTAL ELLIPSIS
152 '\u2014' # 0x84 -> EM DASH
153 '\u2013' # 0x85 -> EN DASH
154 '\u0192' # 0x86 -> LATIN SMALL LETTER F WITH HOOK
155 '\u2044' # 0x87 -> FRACTION SLASH
156 '\u2039' # 0x88 -> SINGLE LEFT-POINTING ANGLE QUOTATION MARK
157 '\u203a' # 0x89 -> SINGLE RIGHT-POINTING ANGLE QUOTATION MARK
158 '\u2212' # 0x8A -> MINUS SIGN
159 '\u2030' # 0x8B -> PER MILLE SIGN
160 '\u201e' # 0x8C -> DOUBLE LOW-9 QUOTATION MARK
161 '\u201c' # 0x8D -> LEFT DOUBLE QUOTATION MARK
162 '\u201d' # 0x8E -> RIGHT DOUBLE QUOTATION MARK
163 '\u2018' # 0x8F -> LEFT SINGLE QUOTATION MARK
164 '\u2019' # 0x90 -> RIGHT SINGLE QUOTATION MARK
165 '\u201a' # 0x91 -> SINGLE LOW-9 QUOTATION MARK
166 '\u2122' # 0x92 -> TRADE MARK SIGN
167 '\ufb01' # 0x93 -> LATIN SMALL LIGATURE FI
168 '\ufb02' # 0x94 -> LATIN SMALL LIGATURE FL
169 '\u0141' # 0x95 -> LATIN CAPITAL LETTER L WITH STROKE
170 '\u0152' # 0x96 -> LATIN CAPITAL LIGATURE OE
171 '\u0160' # 0x97 -> LATIN CAPITAL LETTER S WITH CARON
172 '\u0178' # 0x98 -> LATIN CAPITAL LETTER Y WITH DIAERESIS
173 '\u017d' # 0x99 -> LATIN CAPITAL LETTER Z WITH CARON
174 '\u0131' # 0x9A -> LATIN SMALL LETTER DOTLESS I
175 '\u0142' # 0x9B -> LATIN SMALL LETTER L WITH STROKE
176 '\u0153' # 0x9C -> LATIN SMALL LIGATURE OE
177 '\u0161' # 0x9D -> LATIN SMALL LETTER S WITH CARON
178 '\u017e' # 0x9E -> LATIN SMALL LETTER Z WITH CARON
179 '\ufffe' # 0x9F -> UNDEFINED
180 '\u20ac' # 0xA0 -> EURO SIGN
181 '\xa1' # 0xA1 -> INVERTED EXCLAMATION MARK
182 '\xa2' # 0xA2 -> CENT SIGN
183 '\xa3' # 0xA3 -> POUND SIGN
184 '\xa4' # 0xA4 -> CURRENCY SIGN
185 '\xa5' # 0xA5 -> YEN SIGN
186 '\xa6' # 0xA6 -> BROKEN BAR
187 '\xa7' # 0xA7 -> SECTION SIGN
188 '\xa8' # 0xA8 -> DIAERESIS
189 '\xa9' # 0xA9 -> COPYRIGHT SIGN
190 '\xaa' # 0xAA -> FEMININE ORDINAL INDICATOR
191 '\xab' # 0xAB -> LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
192 '\xac' # 0xAC -> NOT SIGN
193 '\ufffe' # 0xAD -> UNDEFINED (soft hyphen not in PDFDocEncoding)
194 '\xae' # 0xAE -> REGISTERED SIGN
195 '\xaf' # 0xAF -> MACRON
196 '\xb0' # 0xB0 -> DEGREE SIGN
197 '\xb1' # 0xB1 -> PLUS-MINUS SIGN
198 '\xb2' # 0xB2 -> SUPERSCRIPT TWO
199 '\xb3' # 0xB3 -> SUPERSCRIPT THREE
200 '\xb4' # 0xB4 -> ACUTE ACCENT
201 '\xb5' # 0xB5 -> MICRO SIGN
202 '\xb6' # 0xB6 -> PILCROW SIGN
203 '\xb7' # 0xB7 -> MIDDLE DOT
204 '\xb8' # 0xB8 -> CEDILLA
205 '\xb9' # 0xB9 -> SUPERSCRIPT ONE
206 '\xba' # 0xBA -> MASCULINE ORDINAL INDICATOR
207 '\xbb' # 0xBB -> RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
208 '\xbc' # 0xBC -> VULGAR FRACTION ONE QUARTER
209 '\xbd' # 0xBD -> VULGAR FRACTION ONE HALF
210 '\xbe' # 0xBE -> VULGAR FRACTION THREE QUARTERS
211 '\xbf' # 0xBF -> INVERTED QUESTION MARK
212 '\xc0' # 0xC0 -> LATIN CAPITAL LETTER A WITH GRAVE
213 '\xc1' # 0xC1 -> LATIN CAPITAL LETTER A WITH ACUTE
214 '\xc2' # 0xC2 -> LATIN CAPITAL LETTER A WITH CIRCUMFLEX
215 '\xc3' # 0xC3 -> LATIN CAPITAL LETTER A WITH TILDE
216 '\xc4' # 0xC4 -> LATIN CAPITAL LETTER A WITH DIAERESIS
217 '\xc5' # 0xC5 -> LATIN CAPITAL LETTER A WITH RING ABOVE
218 '\xc6' # 0xC6 -> LATIN CAPITAL LETTER AE
219 '\xc7' # 0xC7 -> LATIN CAPITAL LETTER C WITH CEDILLA
220 '\xc8' # 0xC8 -> LATIN CAPITAL LETTER E WITH GRAVE
221 '\xc9' # 0xC9 -> LATIN CAPITAL LETTER E WITH ACUTE
222 '\xca' # 0xCA -> LATIN CAPITAL LETTER E WITH CIRCUMFLEX
223 '\xcb' # 0xCB -> LATIN CAPITAL LETTER E WITH DIAERESIS
224 '\xcc' # 0xCC -> LATIN CAPITAL LETTER I WITH GRAVE
225 '\xcd' # 0xCD -> LATIN CAPITAL LETTER I WITH ACUTE
226 '\xce' # 0xCE -> LATIN CAPITAL LETTER I WITH CIRCUMFLEX
227 '\xcf' # 0xCF -> LATIN CAPITAL LETTER I WITH DIAERESIS
228 '\xd0' # 0xD0 -> LATIN CAPITAL LETTER ETH
229 '\xd1' # 0xD1 -> LATIN CAPITAL LETTER N WITH TILDE
230 '\xd2' # 0xD2 -> LATIN CAPITAL LETTER O WITH GRAVE
231 '\xd3' # 0xD3 -> LATIN CAPITAL LETTER O WITH ACUTE
232 '\xd4' # 0xD4 -> LATIN CAPITAL LETTER O WITH CIRCUMFLEX
233 '\xd5' # 0xD5 -> LATIN CAPITAL LETTER O WITH TILDE
234 '\xd6' # 0xD6 -> LATIN CAPITAL LETTER O WITH DIAERESIS
235 '\xd7' # 0xD7 -> MULTIPLICATION SIGN
236 '\xd8' # 0xD8 -> LATIN CAPITAL LETTER O WITH STROKE
237 '\xd9' # 0xD9 -> LATIN CAPITAL LETTER U WITH GRAVE
238 '\xda' # 0xDA -> LATIN CAPITAL LETTER U WITH ACUTE
239 '\xdb' # 0xDB -> LATIN CAPITAL LETTER U WITH CIRCUMFLEX
240 '\xdc' # 0xDC -> LATIN CAPITAL LETTER U WITH DIAERESIS
241 '\xdd' # 0xDD -> LATIN CAPITAL LETTER Y WITH ACUTE
242 '\xde' # 0xDE -> LATIN CAPITAL LETTER THORN
243 '\xdf' # 0xDF -> LATIN SMALL LETTER SHARP S
244 '\xe0' # 0xE0 -> LATIN SMALL LETTER A WITH GRAVE
245 '\xe1' # 0xE1 -> LATIN SMALL LETTER A WITH ACUTE
246 '\xe2' # 0xE2 -> LATIN SMALL LETTER A WITH CIRCUMFLEX
247 '\xe3' # 0xE3 -> LATIN SMALL LETTER A WITH TILDE
248 '\xe4' # 0xE4 -> LATIN SMALL LETTER A WITH DIAERESIS
249 '\xe5' # 0xE5 -> LATIN SMALL LETTER A WITH RING ABOVE
250 '\xe6' # 0xE6 -> LATIN SMALL LETTER AE
251 '\xe7' # 0xE7 -> LATIN SMALL LETTER C WITH CEDILLA
252 '\xe8' # 0xE8 -> LATIN SMALL LETTER E WITH GRAVE
253 '\xe9' # 0xE9 -> LATIN SMALL LETTER E WITH ACUTE
254 '\xea' # 0xEA -> LATIN SMALL LETTER E WITH CIRCUMFLEX
255 '\xeb' # 0xEB -> LATIN SMALL LETTER E WITH DIAERESIS
256 '\xec' # 0xEC -> LATIN SMALL LETTER I WITH GRAVE
257 '\xed' # 0xED -> LATIN SMALL LETTER I WITH ACUTE
258 '\xee' # 0xEE -> LATIN SMALL LETTER I WITH CIRCUMFLEX
259 '\xef' # 0xEF -> LATIN SMALL LETTER I WITH DIAERESIS
260 '\xf0' # 0xF0 -> LATIN SMALL LETTER ETH
261 '\xf1' # 0xF1 -> LATIN SMALL LETTER N WITH TILDE
262 '\xf2' # 0xF2 -> LATIN SMALL LETTER O WITH GRAVE
263 '\xf3' # 0xF3 -> LATIN SMALL LETTER O WITH ACUTE
264 '\xf4' # 0xF4 -> LATIN SMALL LETTER O WITH CIRCUMFLEX
265 '\xf5' # 0xF5 -> LATIN SMALL LETTER O WITH TILDE
266 '\xf6' # 0xF6 -> LATIN SMALL LETTER O WITH DIAERESIS
267 '\xf7' # 0xF7 -> DIVISION SIGN
268 '\xf8' # 0xF8 -> LATIN SMALL LETTER O WITH STROKE
269 '\xf9' # 0xF9 -> LATIN SMALL LETTER U WITH GRAVE
270 '\xfa' # 0xFA -> LATIN SMALL LETTER U WITH ACUTE
271 '\xfb' # 0xFB -> LATIN SMALL LETTER U WITH CIRCUMFLEX
272 '\xfc' # 0xFC -> LATIN SMALL LETTER U WITH DIAERESIS
273 '\xfd' # 0xFD -> LATIN SMALL LETTER Y WITH ACUTE
274 '\xfe' # 0xFE -> LATIN SMALL LETTER THORN
275 '\xff' # 0xFF -> LATIN SMALL LETTER Y WITH DIAERESIS
276)
277# fmt: on
279# Build encoding table from decoding table
280encoding_table = codecs.charmap_build(decoding_table)
282# Set of all Unicode code points that can be encoded in pdfdoc.
283# Derived from the decoding table, excluding undefined positions.
284PDFDOC_ENCODABLE = frozenset(ord(ch) for ch in decoding_table if ch != '\ufffe')
287class PdfDocCodec(codecs.Codec):
288 """Implement PdfDocEncoding character map used inside PDFs."""
290 def encode(self, input: str, errors: str = 'strict') -> tuple[bytes, int]:
291 """Encode string to PdfDocEncoding bytes."""
292 return codecs.charmap_encode(input, errors, encoding_table)
294 def decode(self, input: Any, errors: str = 'strict') -> tuple[str, int]:
295 """Decode PdfDocEncoding bytes to string."""
296 return codecs.charmap_decode(input, errors, decoding_table) # type: ignore[arg-type]
299class PdfDocIncrementalEncoder(codecs.IncrementalEncoder):
300 """Implement PdfDocEncoding incremental encoder."""
302 def encode(self, input: str, final: bool = False) -> bytes:
303 """Encode string incrementally."""
304 return codecs.charmap_encode(input, self.errors, encoding_table)[0]
307class PdfDocIncrementalDecoder(codecs.IncrementalDecoder):
308 """Implement PdfDocEncoding incremental decoder."""
310 def decode(self, input: Any, final: bool = False) -> str:
311 """Decode bytes incrementally."""
312 return codecs.charmap_decode(input, self.errors, decoding_table)[0] # type: ignore[arg-type]
315class PdfDocStreamWriter(PdfDocCodec, codecs.StreamWriter):
316 """Implement PdfDocEncoding stream writer."""
318 pass
321class PdfDocStreamReader(PdfDocCodec, codecs.StreamReader):
322 """Implement PdfDocEncoding stream reader."""
324 pass
327def find_pdfdoc(encoding: str) -> codecs.CodecInfo | None:
328 """Register pdfdoc codec with Python.
330 Both pdfdoc and pdfdoc_pikepdf are registered. Use "pdfdoc_pikepdf" if pikepdf's
331 codec is required. If another third party package installs a codec named pdfdoc,
332 the first imported by Python will be registered and will service all encoding.
333 Unfortunately, Python's codec infrastructure does not give a better mechanism
334 for resolving conflicts.
335 """
336 if encoding in ('pdfdoc', 'pdfdoc_pikepdf'):
337 return codecs.CodecInfo(
338 name=encoding,
339 encode=PdfDocCodec().encode,
340 decode=PdfDocCodec().decode,
341 incrementalencoder=PdfDocIncrementalEncoder,
342 incrementaldecoder=PdfDocIncrementalDecoder,
343 streamwriter=PdfDocStreamWriter,
344 streamreader=PdfDocStreamReader,
345 )
346 return None
349codecs.register(find_pdfdoc)
351__all__ = [
352 'PdfDocCodec',
353 'PdfDocStreamWriter',
354 'PdfDocStreamReader',
355 'PDFDOC_ENCODABLE',
356]