upload v1.16.14

Author: JorjMcKie

PKG-INFO

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

@@ -14,6 +14,8 @@ There is a parent-child relationship between an annotation and its page. If the
 =============================== ==============================================================
 **Attribute**                   **Short Description**
 =============================== ==============================================================
+:meth:`Annot.blendMode`         return the annotation's blend mode
+:meth:`Annot.setBlendMode`      set the annotation's blend mode
 :meth:`Annot.delete_responses`  delete all responding annotions
 :meth:`Annot.fileGet`           return attached file content
 :meth:`Annot.fileInfo`          return attached file information
@@ -88,21 +90,35 @@ There is a parent-child relationship between an annotation and its page. If the
 
    .. method:: setOpacity(value)
 
-      Change an annotation's transparency.
+      Set the annotation's transparency. Opacity can also be set in :meth:`Annot.update`.
 
       :arg float value: a float in range *[0, 1]*. Any value outside is assumed to be 1. E.g. a value of 0.5 sets the transparency to 50%.
 
       Three overlapping 'Circle' annotations with each opacity set to 0.5:
 
       .. image:: images/img-opacity.jpg
 
+   .. method:: blendMode()
+
+      *(New in v1.16.14)* Return the annotation's blend mode. See :ref:`AdobeManual`, page 520 for explanations.
+
+      :rtype: str
+      :returns: the blend mode or *None*.
+
+   .. method:: setBlendMode(blend_mode)
+
+      *(New in v1.16.14)* Set the annotation's blend mode. See :ref:`AdobeManual`, page 520 for explanations. The blend mode can also be set in :meth:`Annot.update`.
+
+      :arg str blend_mode: set the blend mode. Use :meth:`Annot.update` to reflect this in the visual appearance. For predefined values see :ref:`BlendModes`.
+
    .. method:: setName(name)
 
       *(New in version 1.16.0)* Change the name field of any annotation type. For 'FileAttachment' and 'Text' annotations, this is the icon name, for 'Stamp' annotations the text in the stamp. The visual result (if any) depends on your PDF viewer. See also :ref:`mupdficons`.
 
-
       :arg str name: the new name.
 
+      .. caution:: If you set the name of a 'Stamp' annotation, then this will **not change** the rectangle, nor will the text be layouted in any way. If you choose a standard text from :ref:`StampIcons` (the **exact** name piece after ``STAMP_``!), you should receive the original layout. An **arbitrary text** will not be changed to upper case, but be written as is, horizontally centered in **one line**. If its length exceeds the available width, it will be accordingly shortened. To ensure your own text will **not be shortened**, ensure that ``fitz.getTextLength(text, fontname="tiro", fontsize=20) / annot.rect.width <= 0.85``.
+
    .. method:: setRect(rect)
 
       Change the rectangle of an annotation. The annotation can be moved around and both sides of the rectangle can be independently scaled. However, the annotation appearance will never get rotated, flipped or sheared.
@@ -144,27 +160,30 @@ There is a parent-child relationship between an annotation and its page. If the
 
 
    .. index::
+      pair: blend_mode; update
       pair: fontsize; update
       pair: text_color; update
       pair: border_color; update
       pair: fill_color; update
       pair: rotate; update
 
-   .. method:: update(fontsize=0, text_color=None, border_color=None, fill_color=None, rotate=-1)
+   .. method:: update(opacity=None, blend_mode=None, fontsize=0, text_color=None, border_color=None, fill_color=None, rotate=-1)
 
       Synchronize the appearance of an annotation with its properties after any changes. 
 
-      You can safely omit this method only for the following changes:
+      You can safely omit this method **only** for the following changes:
 
          * :meth:`setRect`
          * :meth:`setFlags`
          * :meth:`fileUpd`
          * :meth:`setInfo` (except changes to *"content"*)
 
-      All arguments are optional and **are reserved for 'FreeText'** annotations -- because of implementation peculiarities of this annotation type. For other types they are ignored.
+      All arguments are optional. *(Changed in v1.16.14)* blend_mode and opacity are applicable to all annotation types. The other arguments **are reserved for 'FreeText'** annotations and ignored for other types.
 
       Color specifications may be made in the usual format used in PuMuPDF as sequences of floats ranging from 0.0 to 1.0 (including both). The sequence length must be 1, 3 or 4 (supporting GRAY, RGB and CMYK colorspaces respectively). For mono-color, just a float is also acceptable.
 
+      :arg float opacity: *(new in v1.16.14)* **valid for all annotation types:** change or set the annotation's transparency. Valid values are *0 <= opacity < 1*.
+      :arg str blend_mode: *(new in v1.16.14)* **valid for all annotation types:** change or set the annotation's blend mode. For valid values see :ref:`BlendModes`.
       :arg float fontsize: change font size of the text.
       :arg sequence,float text_color: change the text color.
       :arg sequence,float border_color: change the border color.

docs/changes.rst

@@ -1,6 +1,24 @@
 Change Logs
 ===============
 
+Changes in Version 1.16.14
+---------------------------
+
+* **Changed** text marker annotations to accept parameters beyond just quadrilaterals such that now **text lines between two given points can be marked**.
+
+* **Added** :meth:`Document.scrub` which **removes potentially sensitive data** from a PDF. Implements `#453 <https://github.com/pymupdf/PyMuPDF/issues/453>`_.
+
+* **Added** :meth:`Annot.blendMode` which returns the **blend mode** of annotations.
+
+* **Added** :meth:`Annot.setBlendMode` to set the annotation's blend mode. This resolves issue `#416 <https://github.com/pymupdf/PyMuPDF/issues/416>`_.
+* **Changed** :meth:`Annot.update` to accept additional parameters for setting blend mode and opacity.
+* **Added** advanced graphics features to **control the anti-aliasing values**, :meth:`Tools.set_aa_level`. Resolves `#467 <https://github.com/pymupdf/PyMuPDF/issues/467>`_
+
+* **Fixed** issue `#474 <https://github.com/pymupdf/PyMuPDF/issues/474>`_.
+* **Fixed** issue `#466 <https://github.com/pymupdf/PyMuPDF/issues/466>`_.
+
+
+
 Changes in Version 1.16.13
 ---------------------------
 

docs/conf.py

@@ -46,7 +46,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = "1.16.13"
+release = "1.16.14"
 
 # The short X.Y version
 version = release

docs/document.rst

@@ -50,6 +50,7 @@ For addional details on **embedded files** refer to Appendix 3.
 :meth:`Document.reload_page`            PDF only: provide a new copy of a page
 :meth:`Document.save`                   PDF only: save the document
 :meth:`Document.saveIncr`               PDF only: save the document incrementally
+:meth:`Document.scrub`                  PDF only: remove sensitive data
 :meth:`Document.searchPageFor`          search for a string on a page
 :meth:`Document.select`                 PDF only: select a subset of pages
 :meth:`Document.setMetadata`            PDF only: set the metadata
@@ -425,6 +426,23 @@ For addional details on **embedded files** refer to Appendix 3.
 
       Check whether the document can be saved incrementally. Use it to choose the right option without encountering exceptions.
 
+    .. method:: scrub(attached_files=True, clean_pages=True, embedded_files=True, hidden_text=True, javascript=True, metadata=True, redactions=True, remove_links=True, reset_fields=True, reset_responses=True, xml_metadata=True)
+
+      PDF only: *(New in v1.16.14)* Remove potentially sensitive data from the PDF. This function is inspired by the similar "Sanitize" function in Adobe Acrobat products. The process is configurable by a number of options, which are all *True* by default.
+
+      :arg bool attached_files: Search for 'FileAttachment' annotations and remove the file content.
+      :arg bool clean_pages: Remove any comments from page painting sources. If this option is set to *False*, then this is also done for *hidden_text* and *redactions*.
+      :arg bool embedded_files: Remove embedded files.
+      :arg bool hidden_text: Remove OCR-ed text and invisible text.
+      :arg bool javascript: Remove JavaScript sources.
+      :arg bool metadata: Remove PDF standard metadata.
+      :arg bool redactions: Apply redaction annotations.
+      :arg bool remove_links: Remove all links.
+      :arg bool reset_fields: Reset all form fields to their defaults.
+      :arg bool reset_responses: Remove all responses from all annotations.
+      :arg bool xml_metadata: Remove XML metadata.
+
+
     .. method:: save(outfile, garbage=0, clean=False, deflate=False, incremental=False, ascii=False, expand=0, linear=False, pretty=False, encryption=PDF_ENCRYPT_NONE, permissions=-1, owner_pw=None, user_pw=None)
 
       PDF only: Saves the document in its **current state**.

docs/images/img-markers.jpg

@@ -244,32 +244,37 @@ This is available for PDF documents only. There are basically two groups of meth
       .. image:: images/img-polyline.png
          :scale: 70
 
-   .. method:: addUnderlineAnnot(quads)
+   .. method:: addUnderlineAnnot(quads=None, start=None, stop=None, clip=None)
 
-   .. method:: addStrikeoutAnnot(quads)
+   .. method:: addStrikeoutAnnot(quads=None, start=None, stop=None, clip=None)
 
-   .. method:: addSquigglyAnnot(quads)
+   .. method:: addSquigglyAnnot(quads=None, start=None, stop=None, clip=None)
 
-   .. method:: addHighlightAnnot(quads)
+   .. method:: addHighlightAnnot(quads=None, start=None, stop=None, clip=None)
 
-      PDF only: These annotations are normally used for marking text which has previously been located (for example via :meth:`searchFor`). But the actual presence of text within the specified area(s) is neither checked nor required. So you are free to "mark" anything.
+      PDF only: These annotations are normally used for **marking text** which has previously been somehow located (for example via :meth:`searchFor`). But this is not required: you are free to "mark" just anything.
 
       Standard colors are chosen per annotation type: **yellow** for highlighting, **red** for strike out, **green** for underlining, and **magenta** for wavy underlining.
 
-      The methods convert the argument into a list of :ref:`Quad` objects. The **annotation** rectangle is calculated to envelop these quadrilaterals.
+      The methods convert the arguments into a list of :ref:`Quad` objects. The **annotation** rectangle is then calculated to envelop all these quadrilaterals.
 
-      .. note:: :meth:`searchFor` supports :ref:`Quad` objects as an output option. Hence the following two statements are sufficient to locate and mark every occurrence of string "pymupdf" with **one common** annotation::
+      .. note:: :meth:`searchFor` delivers a list of either rectangles or quadrilaterals. Such a list can be directly used as parameter for these annotation types and will deliver **one common** annotation for all occurrences of the search string::
 
            >>> quads = page.searchFor("pymupdf", hit_max=100, quads=True)
            >>> page.addHighlightAnnot(quads)
 
-      :arg rect_like,quad_like,list,tuple quads: Changed in version 1.14.20 the rectangles or quads containing the to-be-marked text (locations). A list or tuple must consist of :data:`rect_like` or :data:`quad_like` items (or even a mixture of either). You should prefer using quads, because this will automatically support non-horizontal text and avoid rectangle-to-quad conversion effort.
+      :arg rect_like,quad_like,list,tuple quads: *(Changed in v1.14.20)* the rectangles or quads containing the to-be-marked text (locations). A list or tuple must consist of :data:`rect_like` or :data:`quad_like` items (or even a mixture of either). You should prefer using quads, because this will automatically support non-horizontal text and avoid rectangle-to-quad conversion effort. *(Changed in v1.16.14)* **Set this parameter to** *None* if you want to use the following arguments.
+      :arg point_like start: *(New in v1.16.14)* start text marking at this point. Defaults to the top-left point of *clip*.
+      :arg point_like stop: *(New in v1.16.14)* stop text marking at this point. Defaults to the bottom-right point of *clip*.
+      :arg rect_like clip: *(New in v1.16.14)* only consider text lines intersecting this area. Defaults to the page rectangle.
 
-      :rtype: :ref:`Annot`
-      :returns: the created annotation. To change colors, set the "stroke" color accordingly (:meth:`Annot.setColors`) and then perform an :meth:`Annot.update`.
+      :rtype: :ref:`Annot` or *(changed in v1.16.14)* *None*
+      :returns: the created annotation. *(Changed in v1.16.14)* If *quads* is an empty list, **no annotation** is created. To change colors, set the "stroke" color accordingly (:meth:`Annot.setColors`) and then perform an :meth:`Annot.update`.
+
+      .. note:: Starting with v1.16.14 you can use parameters *start*, *stop* and *clip* to highlight consecutive lines between the points *start* and *stop*. Make use of *clip* to further reduce the selected line bboxes and thus deal with e.g. multi-column pages. The following multi-line highlight was created specifying the two red points and setting clip accordingly.
 
       .. image:: images/img-markers.jpg
-         :scale: 80
+         :scale: 100
 
    .. method:: addStampAnnot(rect, stamp=0)
 
@@ -281,9 +286,10 @@ This is available for PDF documents only. There are basically two groups of meth
 
       .. note::
 
-         * The stamp's text (e.g. "APPROVED") and its border line will automatically be sized and put centered in the given rectangle. :attr:`Annot.rect` is automatically calculated to fit and will usually be smaller than this parameter. The appearance can be changed using :meth:`Annot.setOpacity` and by setting the "stroke" color (no "fill" color supported).
-         
-         * This can conveniently be used to create watermark images: on a temporary PDF page create a stamp annotation with a low opacity value, make a pixmap from it with *alpha=True* (and potentially also rotate it), discard the temporary PDF page and use the pixmap with :meth:`insertImage` for your target PDF.
+         * The stamp's text and its border line will automatically be sized and be put horizontally and vertically centered in the given rectangle. :attr:`Annot.rect` is automatically calculated to fit the given **width** and will usually be smaller than this parameter.
+         * The font chosen is "Times Bold" and the text will be upper case.
+         * The appearance can be changed using :meth:`Annot.setOpacity` and by setting the "stroke" color (no "fill" color supported).
+         * This can be used to create watermark images: on a temporary PDF page create a stamp annotation with a low opacity value, make a pixmap from it with *alpha=True* (and potentially also rotate it), discard the temporary PDF page and use the pixmap with :meth:`insertImage` for your target PDF.
 
 
       .. image :: images/img-stampannot.jpg

docs/page.rst

@@ -377,6 +377,27 @@ Widget flags (*field_flags*)
     PDF_CH_FIELD_IS_COMMIT_ON_SEL_CHANGE  1 << 26
 
 
+.. _BlendModes:
+
+PDF Standard Blend Modes
+----------------------------
+
+For an explanation see :ref:`AdobeManual`, page 520::
+
+    PDF_BM_ColorBurn "ColorBurn"
+    PDF_BM_ColorDodge "ColorDodge"
+    PDF_BM_Darken "Darken"
+    PDF_BM_Difference "Difference"
+    PDF_BM_Exclusion "Exclusion"
+    PDF_BM_HardLight "HardLight
+    PDF_BM_Lighten "Lighten"
+    PDF_BM_Multiply "Multiply"
+    PDF_BM_Normal "Normal"
+    PDF_BM_Overlay "Overlay"
+    PDF_BM_Screen "Screen"
+    PDF_BM_SoftLight "Softlight"
+
+
 .. _StampIcons:
 
 Stamp Annotation Icons

docs/vars.rst

@@ -1,6 +1,6 @@
 Covered Version
 --------------------
 
-This documentation covers PyMuPDF v1.16.13 features as of **2020-03-15 05:29:04**.
+This documentation covers PyMuPDF v1.16.14 features as of **2020-03-25 11:44:22**.
 
 .. note:: The major and minor versions of **PyMuPDF** and **MuPDF** will always be the same. Only the third qualifier (patch level) may be different from that of MuPDF.