upgrade to v1.16.13

Author: JorjMcKie

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: PyMuPDF
-Version: 1.16.12
+Version: 1.16.13
 Author: Ruikai Liu
 Author-email: [email protected]
 Maintainer: Jorj X. McKie
@@ -9,7 +9,7 @@ Home-page: https://github.com/pymupdf/PyMuPDF
 Download-url: https://github.com/pymupdf/PyMuPDF
 Summary: PyMuPDF is a Python binding for the PDF rendering library MuPDF
 Description:
-        Release date: March 10, 2020
+        Release date: March 15, 2020
 
         Authors
         =======
@@ -20,7 +20,7 @@ Description:
         Introduction
         ============
 
-        This is **version 1.16.12 of PyMuPDF**, a Python binding for `MuPDF <http://mupdf.com/>`_ - "a lightweight PDF and XPS viewer".
+        This is **version 1.16.13 of PyMuPDF**, a Python binding for `MuPDF <http://mupdf.com/>`_ - "a lightweight PDF and XPS viewer".
 
         MuPDF can access files in PDF, XPS, OpenXPS, epub, comic and fiction book formats, and it is known for both, its top performance and high rendering quality.
 

README.md

@@ -1,8 +1,8 @@
-# PyMuPDF 1.16.12
+# PyMuPDF 1.16.13
 
 ![logo](https://github.com/pymupdf/PyMuPDF/blob/master/demo/pymupdf.jpg)
 
-Release date: March 10, 2020
+Release date: March 15, 2020
 
 **Travis-CI:** [![Build Status](https://travis-ci.org/JorjMcKie/py-mupdf.svg?branch=master)](https://travis-ci.org/JorjMcKie/py-mupdf)
 
@@ -14,7 +14,7 @@ On **[PyPI](https://pypi.org/project/PyMuPDF)** since August 2016: [![](https://
 
 # Introduction
 
-This is **version 1.16.12 of PyMuPDF (formerly python-fitz)**, a Python binding with support for [MuPDF 1.16.*](http://mupdf.com/) - "a lightweight PDF, XPS, and E-book viewer".
+This is **version 1.16.13 of PyMuPDF (formerly python-fitz)**, a Python binding with support for [MuPDF 1.16.*](http://mupdf.com/) - "a lightweight PDF, XPS, and E-book viewer".
 
 MuPDF can access files in PDF, XPS, OpenXPS, CBZ, EPUB and FB2 (e-books) formats, and it is known for its top performance and high rendering quality.
 

docs/app4.rst

@@ -49,11 +49,13 @@ To see how these fonts can be used -- including the **CJK built-in** fonts -- lo
 
 .. _AdobeManual:
 
-Adobe PDF Reference 1.7
+Adobe PDF References
 ---------------------------
 
 This PDF Reference manual published by Adobe is frequently quoted throughout this documentation. It can be viewed and downloaded from `here <http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf>`_.
 
+There is a newer version of this, which be found `here <https://www.adobe.com/content/dam/acom/en/devnet/pdf/pdfs/PDF32000_2008.pdf>`_. Redaction annotation are an example, which is contained in this one, but not in the earlier version.
+
 ------------
 
 .. _SequenceTypes:

docs/changes.rst

@@ -1,6 +1,15 @@
 Change Logs
 ===============
 
+Changes in Version 1.16.13
+---------------------------
+
+* **Added** :meth:`Document.getPageXObjectList` which returns a list of **Form XObjects** of the page.
+* **Added** :meth:`Page.setMediaBox` for changing the physical PDF page size.
+* **Added** :ref:`Page` methods which have been internal before: :meth:`Page.cleanContents` (= :meth:`Page._cleanContents`), :meth:`Page.getContents` (= :meth:`Page._getContents`), :meth:`Page.getTransformation` (= :meth:`Page._getTransformation`).
+
+
+
 Changes in Version 1.16.12
 ---------------------------
 * **Fixed** issue `#447 <https://github.com/pymupdf/PyMuPDF/issues/447>`_

docs/conf.py

@@ -46,7 +46,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = "1.16.12"
+release = "1.16.13"
 
 # The short X.Y version
 version = release
@@ -128,7 +128,7 @@
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = "pymupdf.ico"
+html_favicon = "Pymupdf.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/document.rst

@@ -32,6 +32,7 @@ For addional details on **embedded files** refer to Appendix 3.
 :meth:`Document.fullcopyPage`           PDF only: duplicate a page
 :meth:`Document.getPageFontList`        PDF only: make a list of fonts on a page
 :meth:`Document.getPageImageList`       PDF only: make a list of images on a page
+:meth:`Document.getPageXObjectList`     PDF only: make a list of XObjects on a page
 :meth:`Document.getPagePixmap`          create a pixmap of a page by page number
 :meth:`Document.getPageText`            extract the text of a page by page number
 :meth:`Document.getSigFlags`            PDF only: determine signature state
@@ -260,30 +261,45 @@ For addional details on **embedded files** refer to Appendix 3.
 
       :rtype: :ref:`Pixmap`
 
+    .. method:: getPageXObjectList(pno)
+
+      PDF only: *(New in v1.16.13)* Return a list of all XObjects referenced by a page.
+
+      :arg int pno: page number, 0-based, *-inf < pno < pageCount*.
+
+      :rtype: list
+      :returns: a list of (non-image) XObjects. These objects typically represent pages *embedded* (not copied) from other PDFs. For example, meth:`Page.showPDFpage` will create this type of object. An item of this list has the following layout: **(xref, name, invoker, bbox)**, where
+
+        * **xref** (*int*) is the XObject's :data:`xref`
+        * **name** (*str*) is the symbolic name to reference the XObject
+        * **invoker** (*int*) the :data:`xref` of the invoking XObject or zero if the page directly invokes it
+        * **bbox** (*tuple*) the boundary box of the XObject's location on the page **in untransformed coordinates**. To get actual, non-rotated page coordinates, multiply with the page's transformation matrix :meth:`Page.getTransformation`.
+
+
     .. method:: getPageImageList(pno, full=False)
 
       PDF only: Return a list of all image descriptions referenced by a page.
 
-      :arg int pno: page number, 0-based in -inf < pno < pageCount.
-      :arg bool full: whether to also include the :data:`xref` of the *Form /XObject* where the item is referenced. This is zero if the item is part of page's /Resources.
+      :arg int pno: page number, 0-based, *-inf < pno < pageCount*.
+      :arg bool full: whether to also include the invoker's :data:`xref` (which is zero if this is the page).
 
       :rtype: list
 
       :returns: a list of images shown on this page. Each item looks like
 
-      **[xref, smask, width, height, bpc, colorspace, alt. colorspace, name, filter, form_xref],**
+      **(xref, smask, width, height, bpc, colorspace, alt. colorspace, name, filter, invoker)**
 
       Where
 
-        * **xref** (*int*) is the image object number,
-        * **smask** (*int* optional) is the object number of its soft-mask image (if present),
-        * **width** and **height** (*ints*) are the image dimensions,
-        * **bpc** (*int*) denotes the number of bits per component (a typical value is 8),
-        * **colorspace** (*str*)a string naming the colorspace (like **DeviceRGB**),
-        * **alt. colorspace** (*str* optional) is any alternate colorspace depending on the value of **colorspace**,
-        * **name** (*str*) is the symbolic name by which the **page references the image** in its content stream, and
-        * **filter** (*str* optional) is the decode filter of the image (:ref:`AdobeManual`, pp. 65).
-        * **form_xref** (*int* optional) the xref number of the *Form XObject*, which references the item. Zero if directly referenced by the page.
+        * **xref** (*int*) is the image object number
+        * **smask** (*int*) is the object number of its soft-mask image
+        * **width** and **height** (*ints*) are the image dimensions
+        * **bpc** (*int*) denotes the number of bits per component (normally 8)
+        * **colorspace** (*str*) a string naming the colorspace (like **DeviceRGB**)
+        * **alt. colorspace** (*str*) is any alternate colorspace depending on the value of **colorspace**
+        * **name** (*str*) is the symbolic name by which the image is referenced
+        * **filter** (*str*) is the decode filter of the image (:ref:`AdobeManual`, pp. 65).
+        * **invoker** (*int*) the :data:`xref` of the invoker. Zero if directly referenced by the page. Only present if *full=True*.
 
       See below how this information can be used to extract PDF images as separate files. Another demonstration::
 
@@ -294,30 +310,28 @@ For addional details on **embedded files** refer to Appendix 3.
         >>> pix
         fitz.Pixmap(DeviceRGB, fitz.IRect(0, 0, 261, 115), 0)
 
-      .. note:: This list has no duplicate entries: the combination of :data:`xref` and *name* is unique. But by themselves, each of the two may occur multiple times. The same image may well be referenced under different names within a page. Duplicate *name* entries on the other hand indicate the presence of "Form XObjects" on the page, e.g. generated by :meth:`Page.showPDFpage`.
-
     .. method:: getPageFontList(pno, full=False)
 
       PDF only: Return a list of all fonts referenced by the page.
 
       :arg int pno: page number, 0-based, -inf < pno < pageCount.
-      :arg bool full: whether to also include the :data:`xref` of the *Form /XObject* where the item is referenced. This is zero if the item is part of page's /Resources.
+      :arg bool full: whether to also include the invoker's :data:`xref` (which is zero if directly referenced by the page).
 
       :rtype: list
 
       :returns: a list of fonts referenced by this page. Each entry looks like
 
-      **[xref, ext, type, basefont, name, encoding, form_xref]**,
+      **(xref, ext, type, basefont, name, encoding, invoker)**,
 
-      Where
+      where
 
-          * **xref** (*int*) is the font object number (may be zero if the PDF uses one of the builtin fonts directly),
-          * **ext** (*str*) font file extension (e.g. "ttf", see :ref:`FontExtensions`),
-          * **type** (*str*) is the font type (like "Type1" or "TrueType" etc.),
+          * **xref** (*int*) is the font object number (may be zero if the PDF uses one of the builtin fonts directly)
+          * **ext** (*str*) font file extension (e.g. "ttf", see :ref:`FontExtensions`)
+          * **type** (*str*) is the font type (like "Type1" or "TrueType" etc.)
           * **basefont** (*str*) is the base font name,
-          * **name** (*str*) is the reference name (or label), by which **the page references the font** in its contents stream, and
-          * **encoding** (*str* optional) the font's character encoding if different from its built-in encoding (:ref:`AdobeManual`, p. 414):
-          * **form_xref** (*int* optional) the xref number of the *Form XObject*, which references the item. Zero if directly referenced by the page.
+          * **name** (*str*) is the symbolic name, by which the font is referenced
+          * **encoding** (*str*) the font's character encoding if different from its built-in encoding (:ref:`AdobeManual`, p. 414):
+          * **invoker** (*int* optional) the :data:`xref` of the invoker. Zero if directly referenced by the page. Only present if *full=True*.
 
       Example::
 

docs/glossary.rst

@@ -22,6 +22,19 @@ Glossary
 
         A Python sequence of 4 :data:`point_like` items.
 
+.. data:: inheritable
+
+        A number of values in a PDF can be specified once and then be inherited by objects further down in a parent-child relationship. The mediabox (physical size) of pages can for example be specified in nodes of the :data:`pagetree` and will then be taken as value for all *kids*, which do not specify their own value.
+
+.. data:: MediaBox
+
+        A PDF array of 4 floats specifying a physical page size (:data:`inheritable`).
+
+.. data:: CropBox
+
+        A PDF array of 4 floats specifying a page's visible area (:data:`inheritable`). This value is **not affected** if the page is rotated.
+
+
 .. data:: catalog
 
         A central PDF :data:`dictionary` -- also called "root" -- containing pointers to many other information.
@@ -57,9 +70,9 @@ Glossary
             /Annots[55 0 R]                   % value: array, one entry (indirect object)
             >>
 
-        */Contents*, */Type*, */MediaBox*, etc. are **keys**, *40 0 R*, */Page*, *[0 0 595.32 841.92]*, etc. are the respective **values**. The strings *<<* and *>>* are used to enclose object definitions.
+        *Contents*, *Type*, *MediaBox*, etc. are **keys**, *40 0 R*, *Page*, *[0 0 595.32 841.92]*, etc. are the respective **values**. The strings *"<<"* and *">>"* are used to enclose object definitions.
 
-        This example also shows the syntax of **nested** dictionary values: */Resources* has an object as its value, which in turn is a dictionary with keys like */ExtGState* (with the value *<</R7 26 0 R>>*, which is another dictionary), etc.
+        This example also shows the syntax of **nested** dictionary values: *Resources* has an object as its value, which in turn is a dictionary with keys like *ExtGState* (with the value *<</R7 26 0 R>>*, which is another dictionary), etc.
 
 .. data:: page