- Added {class}
pikepdf.ObjectSet, which records the objects that a walk of a PDF's object graph has already visited. Objects in a PDF are shared and may refer back to their ancestors, so a search that only limits its depth can take exponential time on quite ordinary files.ObjectSet.add()reports whether an object is new, and tells apart direct objects and objects of differentPdf, which asetofobjgencannot. See {ref}walking-object-graphs. - Added {meth}
pikepdf.Object.is_same_object_as, which tests whether two references lead to the same object. Neitheris,==nor comparingobjgenanswers this reliably. - Added {meth}
pikepdf.Pdf.content_scopesand {meth}pikepdf.Page.content_scopes, which iterate over every content stream that pages can draw, each with the resource dictionary it uses: the page itself, form XObjects, annotation appearance streams, tiling patterns, Type 3 glyph procedures and soft masks, however they are nested or shared. This is the way to find every font, image or colour space a document uses. Each {class}pikepdf.ContentScopeis reported once for the document;pages=selects pages andkinds=selects what is reported. - Added {meth}
pikepdf.Page.get_resources, which returns the resources of a page or form XObject for reading. Unlike {attr}pikepdf.Page.resources, it finds resources inherited from the page tree, does not create an empty dictionary when there are none, and returnsNoneinstead of raising when/Resourcesis malformed. - Fixed comparing two objects with
==taking exponential time when the objects being compared share children, such as the same file opened twice. Each pair of objects is now compared once. - Fixed {meth}
pikepdf.Pdf.add_pages_fromhanging on a page with an action whose/Nextactions are shared or form a loop. - Fixed {meth}
pikepdf.Pdf.open_outlinereading only the first item at each level of an outline whose items are direct objects. Such items are now made indirect when the outline is saved, as the PDF specification requires. - Reading a stream that will not decode now raises
{exc}
~pikepdf.exceptions.DataDecodingErrorwith the reason, whether the stream's data was read from a file or set from memory. Previously a stream read from a file raised a {exc}~pikepdf.exceptions.PdfErrorthat said only "read_bytes called on unfilterable stream", and the reason was available only from {meth}pikepdf.Pdf.get_warnings.DataDecodingErroris aPdfError, so existing handlers are unaffected. {issue}182 - An exception raised by a JBIG2 decoder now reaches the caller of
{meth}
pikepdf.PdfImage.as_pil_image, {meth}pikepdf.PdfImage.extract_toand {meth}pikepdf.PdfImage.read_bytesunchanged, with its own type, message and traceback. Previously, for an image read from a file, it was replaced by a genericDataDecodingErrororPdfError. {issue}182 - Added {exc}
~pikepdf.exceptions.QpdfRuntimeError, raised for errors from qpdf that pikepdf has no more specific exception for. These were previously raised as a bareRuntimeError, whichexcept pikepdf.PikepdfErrordid not catch. The new exception derives from both {exc}~pikepdf.exceptions.PikepdfErrorandRuntimeError, so handlers written forRuntimeErrorstill work. {issue}240 - The empty name
/is now supported. The PDF 1.7 and 2.0 specifications define a lone slash as a valid name made of zero characters, butpikepdf.Name('/')raisedValueError, and dictionaries refused/as a key. This broke {meth}pikepdf.Pdf.add_pages_fromon files with an empty-named destination such as/Dests << / 3 0 R >>. Such names can now be created, used as dictionary keys, and migrated during page copying.bool(Name('/'))isFalse, like an empty {class}pikepdf.String.Name(''), which lacks the leading slash, is still rejected. PDF/A does not forbid empty names, and the PDF/A validator accepts them. Thanks to @sjudd for the report and @DSeaStar for the analysis. {issue}745 AcroFormField.get_inheritable_field_value_as_name()now returns a {class}pikepdf.Name, as documented, instead of astr. When the value is missing or not a name, it returns the empty nameName('/'), which is falsy, instead of''. Comparisons such as== '/Tx'are unaffected. {issue}748- Fixed an out-of-bounds read when opening a PDF from a Python file object
whose
readinto()reports more bytes than were requested. This now raisesValueError, as writing to such a stream already did. Non-blocking streams, whosereadinto()returnsNone, now raiseValueErrorinstead of hanging. Thanks to @Nayana-Naik73. {issue}747 - Fixed building from source on PyPy, which failed to compile since v10.0.
PyPy now reads Python file objects through
readinto(), like CPython, instead of copying the result ofread(). - {func}
pikepdf.openreads directly from the file descriptor when given a filename, instead of calling theseek()andreadinto()methods of a Python file object for every read. Opening and reading a large file with many objects is about four to five times faster, matching the speed of memory mapping (access_mode=AccessMode.mmap). Streams passed to {func}pikepdf.open, including plain file objects, are read through their methods as before. - Documented {class}
pikepdf.TokenFilterwith worked examples that shorten numbers and convert RGB colors to grayscale, and explained when to use a token filter instead of {func}pikepdf.parse_content_stream. The API reference no longer says that the parser should not be used to edit content streams. TheTokenFilter.handle_tokendocumentation now says correctly that exceptions it raises propagate to the caller. {issue}62
Other Useful Business Software
Endpoint Management with Remote Control Built In
Save 50% on your first year when you switch from your existing RMM to Splashtop AEM. Automate patching, track inventory, and jump directly into 1-click unattended remote sessions without switching tools.
Custom VMs From 1 to 96 vCPUs With 99.95% Uptime
Live migration and automatic failover keep workloads online through maintenance. One free e2-micro VM every month.
