update v1.16.12

Author: JorjMcKie

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: PyMuPDF
-Version: 1.16.11
+Version: 1.16.12
 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: February 23, 2020
+        Release date: March 05, 2020
 
         Authors
         =======
@@ -20,7 +20,7 @@ Description:
         Introduction
         ============
 
-        This is **version 1.16.11 of PyMuPDF**, a Python binding for `MuPDF <http://mupdf.com/>`_ - "a lightweight PDF and XPS viewer".
+        This is **version 1.16.12 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.11
+# PyMuPDF 1.16.12
 
 ![logo](https://github.com/pymupdf/PyMuPDF/blob/master/demo/pymupdf.jpg)
 
-Release date: February 23, 2020
+Release date: March 10, 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.11 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.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".
 
 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/annot.rst

@@ -11,35 +11,36 @@ Quote from the :ref:`AdobeManual`: "An annotation associates an object such as a
 There is a parent-child relationship between an annotation and its page. If the page object becomes unusable (closed document, any document structure change, etc.), then so does every of its existing annotation objects -- an exception is raised saying that the object is "orphaned", whenever an annotation property or method is accessed.
 
 
-============================ ==============================================================
-**Attribute**                **Short Description**
-============================ ==============================================================
-:meth:`Annot.fileGet`        return attached file content
-:meth:`Annot.fileInfo`       return attached file information
-:meth:`Annot.fileUpd`        set attached file new content
-:meth:`Annot.getPixmap`      image of the annotation as a pixmap
-:meth:`Annot.setBorder`      change the border
-:meth:`Annot.setColors`      change the colors
-:meth:`Annot.setFlags`       change the flags
-:meth:`Annot.setInfo`        change various properties
-:meth:`Annot.setLineEnds`    set line ending styles
-:meth:`Annot.setOpacity`     change transparency
-:meth:`Annot.setName`        change the "Name" field (e.g. icon name)
-:meth:`Annot.setRect`        change the rectangle
-:meth:`Annot.update`         apply accumulated annot changes
-:attr:`Annot.border`         border details
-:attr:`Annot.colors`         border / background and fill colors
-:attr:`Annot.flags`          annotation flags
-:attr:`Annot.info`           various information
-:attr:`Annot.lineEnds`       start / end appearance of line-type annotations
-:attr:`Annot.next`           link to the next annotation
-:attr:`Annot.opacity`        the annot's transparency
-:attr:`Annot.parent`         page object of the annotation
-:attr:`Annot.rect`           rectangle containing the annotation
-:attr:`Annot.type`           type of the annotation
-:attr:`Annot.vertices`       point coordinates of Polygons, PolyLines, etc.
-:attr:`Annot.xref`           the PDF :data:`xref` number
-============================ ==============================================================
+=============================== ==============================================================
+**Attribute**                   **Short Description**
+=============================== ==============================================================
+:meth:`Annot.delete_responses`  delete all responding annotions
+:meth:`Annot.fileGet`           return attached file content
+:meth:`Annot.fileInfo`          return attached file information
+:meth:`Annot.fileUpd`           set attached file new content
+:meth:`Annot.getPixmap`         image of the annotation as a pixmap
+:meth:`Annot.setBorder`         change the border
+:meth:`Annot.setColors`         change the colors
+:meth:`Annot.setFlags`          change the flags
+:meth:`Annot.setInfo`           change various properties
+:meth:`Annot.setLineEnds`       set line ending styles
+:meth:`Annot.setOpacity`        change transparency
+:meth:`Annot.setName`           change the "Name" field (e.g. icon name)
+:meth:`Annot.setRect`           change the rectangle
+:meth:`Annot.update`            apply accumulated annot changes
+:attr:`Annot.border`            border details
+:attr:`Annot.colors`            border / background and fill colors
+:attr:`Annot.flags`             annotation flags
+:attr:`Annot.info`              various information
+:attr:`Annot.lineEnds`          start / end appearance of line-type annotations
+:attr:`Annot.next`              link to the next annotation
+:attr:`Annot.opacity`           the annot's transparency
+:attr:`Annot.parent`            page object of the annotation
+:attr:`Annot.rect`              rectangle containing the annotation
+:attr:`Annot.type`              type of the annotation
+:attr:`Annot.vertices`          point coordinates of Polygons, PolyLines, etc.
+:attr:`Annot.xref`              the PDF :data:`xref` number
+=============================== ==============================================================
 
 **Class API**
 
@@ -137,6 +138,11 @@ There is a parent-child relationship between an annotation and its page. If the
       :arg sequence fill: see above.
 
 
+   .. method:: delete_responses()
+
+      *(New in version 1.16.12)* Delete annotations referring to this one. This includes any 'Popup' annotations and all annotations responding to it.
+
+
    .. index::
       pair: fontsize; update
       pair: text_color; update

docs/changes.rst

@@ -1,6 +1,16 @@
 Change Logs
 ===============
 
+Changes in Version 1.16.12
+---------------------------
+* **Fixed** issue `#447 <https://github.com/pymupdf/PyMuPDF/issues/447>`_
+* **Fixed** issue `#461 <https://github.com/pymupdf/PyMuPDF/issues/461>`_.
+* **Fixed** issue `#397 <https://github.com/pymupdf/PyMuPDF/issues/397>`_.
+* **Added** JavaScript support to PDF form fields, thereby addressing `#454 <https://github.com/pymupdf/PyMuPDF/issues/454>`_.
+* **Added** a new annotation method :meth:`Annot.delete_responses`, which removes 'Popup' and response annotations referring to the current one.
+* **Added** a new form field method :meth:`Widget.reset`, which resets the field value to its default.
+* **Changed** and extended handling of redactions: images and XObjects are removed if *contained* in a redaction rectangle. Any partial overlaps will just be covered by the redaction background color. Now a text can be specified to be inserted in the rectangle area to **replace the deleted original** text. This resolves `#434 <https://github.com/pymupdf/PyMuPDF/issues/434>`_.
+
 Changes in Version 1.16.11
 ---------------------------
 * **Added** Support for redaction annotations via method :meth:`Page.addRedactAnnot` and :meth:`Page.apply_redactions`.

docs/colors.rst

@@ -37,7 +37,7 @@ As the color database may not be needed very often, one additional import statem
 
 Printing the Color Database
 ----------------------------
-If you want to actually see how the many available colors look like, use scripts `colordbRGB.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/colordbRGB.py>`_ or `colordbHSV.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/colordbHSV.py>`_ in the examples directory. They create PDFs (already existing in the same directory) with all these colors. Their only difference is sorting order: one takes the RGB values, the other one the Hue-Saturation-Values as sort criteria.
+If you want to actually see how the many available colors look like, use scripts `colordbRGB.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/colordbRGB.py>`_ or `colordbHSV.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/colordbHSV.py>`_ in the examples directory. They create PDFs (already existing in the same directory) with all these colors. Their only difference is sorting order: one takes the RGB values, the other one the Hue-Saturation-Values as sort criteria.
 This is a screen print of what these files look like.
 
 .. image:: images/img-colordb.png

docs/conf.py

@@ -39,14 +39,14 @@
 
 # General information about the project.
 project = "PyMuPDF"
-copyright = "2015-2019, Jorj X. McKie"
+copyright = "2015-2020, Jorj X. McKie"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = "1.16.11"
+release = "1.16.12"
 
 # The short X.Y version
 version = release
@@ -95,10 +95,10 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 # html_theme = "agogo"
-# html_theme = "sphinxdoc"
+html_theme = "sphinxdoc"
 # html_theme = "python_docs_theme"
 # html_theme = "sphinx_rtd_theme"
-html_theme = "classic"
+# html_theme = "classic"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -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

@@ -500,7 +500,7 @@ For addional details on **embedded files** refer to Appendix 3.
 
        1. If *from_page > to_page*, pages will be **copied in reverse order**. If *0 <= from_page == to_page*, then one page will be copied.
 
-       2. *docsrc* bookmarks **will not be copied**. It is easy however, to recover a table of contents for the resulting document. Look at the examples below and at program `PDFjoiner.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/PDFjoiner.py>`_ in the *examples* directory: it can join PDF documents and at the same time piece together respective parts of the tables of contents.
+       2. *docsrc* bookmarks **will not be copied**. It is easy however, to recover a table of contents for the resulting document. Look at the examples below and at program `PDFjoiner.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/PDFjoiner.py>`_ in the *examples* directory: it can join PDF documents and at the same time piece together respective parts of the tables of contents.
 
     .. index::
        pair: width; newPage (Document method)
@@ -894,7 +894,7 @@ Clear metadata information. If you do this out of privacy / data protection conc
 
 :meth:`setToC` Demonstration
 ----------------------------------
-This shows how to modify or add a table of contents. Also have a look at `csv2toc.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/csv2toc.py>`_ and `toc2csv.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/toc2csv.py>`_ in the examples directory.
+This shows how to modify or add a table of contents. Also have a look at `csv2toc.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/csv2toc.py>`_ and `toc2csv.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/toc2csv.py>`_ in the examples directory.
 
 >>> import fitz
 >>> doc = fitz.open("test.pdf")
@@ -927,7 +927,7 @@ This shows how to modify or add a table of contents. Also have a look at `csv2to
         t[2] += pages1                     # by old len(doc1)
 >>> doc1.setToC(toc1 + toc2)               # now result has total TOC
 
-Obviously, similar ways can be found in more general situations. Just make sure that hierarchy levels in a row do not increase by more than one. Inserting dummy bookmarks before and after *toc2* segments would heal such cases. A ready-to-use GUI (wxPython) solution can be found in script `PDFjoiner.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/PDFjoiner.py>`_ of the examples directory.
+Obviously, similar ways can be found in more general situations. Just make sure that hierarchy levels in a row do not increase by more than one. Inserting dummy bookmarks before and after *toc2* segments would heal such cases. A ready-to-use GUI (wxPython) solution can be found in script `PDFjoiner.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/PDFjoiner.py>`_ of the examples directory.
 
 **(2) More examples:**
 
@@ -965,4 +965,4 @@ Other Examples
 
 .. [#f1] Content streams describe what (e.g. text or images) appears where and how on a page. PDF uses a specialized mini language similar to PostScript to do this (pp. 985 in :ref:`AdobeManual`), which gets interpreted when a page is loaded.
 
-.. [#f2] However, you **can** use :meth:`Document.getToC` and :meth:`Page.getLinks` (which are available for all document types) and copy this information over to the output PDF. See demo `pdf-converter.py <https://github.com/pymupdf/PyMuPDF/blob/master/demo/pdf-converter.py>`_.
+.. [#f2] However, you **can** use :meth:`Document.getToC` and :meth:`Page.getLinks` (which are available for all document types) and copy this information over to the output PDF. See demo `pdf-converter.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/demo/pdf-converter.py>`_.

docs/faq.rst

@@ -763,7 +763,7 @@ If you see a table in a document, you are not normally looking at something like
 
 Extracting a tabular data from such a page area therefore means that you must find a way to **(1)** graphically indicate table and column borders, and **(2)** then extract text based on this information.
 
-The wxPython GUI script `wxTableExtract.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/wxTableExtract.py>`_ strives to exactly do that. You may want to have a look at it and adjust it to your liking.
+The wxPython GUI script `wxTableExtract.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/wxTableExtract.py>`_ strives to exactly do that. You may want to have a look at it and adjust it to your liking.
 
 ----------
 
@@ -1096,7 +1096,7 @@ The result looks like this:
 
 How to Use FreeText
 ~~~~~~~~~~~~~~~~~~~~~
-This script shows a couple of possibilities for 'FreeText' annotations::
+This script shows a couple of ways to deal with 'FreeText' annotations::
 
     # -*- coding: utf-8 -*-
     import fitz
@@ -1134,6 +1134,17 @@ The result looks like this:
 .. image:: images/img-freetext.jpg
    :scale: 80
 
+------------------------------
+
+Using Buttons and JavaScript
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Since MuPDF v1.16, 'FreeText' annotations no longer support bold or italic versions of the Times-Roman, Helvetica or Courier fonts.
+
+A big **thank you** to our user `@kurokawaikki <https://github.com/kurokawaikki>`_, who contributed the following script to **circumvent this restriction**.
+
+.. literalinclude:: make-bold.py
+   :language: python
+
 --------------------------
 
 How to Use Ink Annotations
@@ -1319,7 +1330,7 @@ PDF supports incorporating arbitrary data. This can be done in one of two ways:
 
 The basic differences between these options are **(1)** you need edit permission to embed a file, but only annotation permission to attach, **(2)** like all annotations, attachments are visible on a page, embedded files are not.
 
-There exist several example scripts: `embedded-list.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/embedded-list.py>`_, `new-annots.py <https://github.com/pymupdf/PyMuPDF/blob/master/demo/new-annots.py>`_.
+There exist several example scripts: `embedded-list.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/embedded-list.py>`_, `new-annots.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/demo/new-annots.py>`_.
 
 Also look at the sections above and at chapter :ref:`Appendix 3`.
 
@@ -1374,7 +1385,7 @@ How to Join PDFs
 ~~~~~~~~~~~~~~~~~~
 It is easy to join PDFs with method :meth:`Document.insertPDF`. Given open PDF documents, you can copy page ranges from one to the other. You can select the point where the copied pages should be placed, you can revert the page sequence and also change page rotation. This Wiki `article <https://github.com/pymupdf/PyMuPDF/wiki/Inserting-Pages-from-other-PDFs>`_ contains a full description.
 
-The GUI script `PDFjoiner.py <https://github.com/pymupdf/PyMuPDF/blob/master/examples/PDFjoiner.py>`_ uses this method to join a list of files while also joining the respective table of contents segments. It looks like this:
+The GUI script `PDFjoiner.py <https://github.com/pymupdf/PyMuPDF-Utilities/tree/master/examples/PDFjoiner.py>`_ uses this method to join a list of files while also joining the respective table of contents segments. It looks like this:
 
 .. image:: images/img-pdfjoiner.jpg
    :scale: 60