upload v1.17.1

Author: JorjMcKie

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: PyMuPDF
-Version: 1.17.0
+Version: 1.17.1
 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: May 18, 2020
+        Release date: June 20, 2020
 
         Authors
         =======
@@ -20,7 +20,7 @@ Description:
         Introduction
         ============
 
-        This is **version 1.17.0 of PyMuPDF**, a Python binding for `MuPDF <http://mupdf.com/>`_ - "a lightweight PDF and XPS viewer".
+        This is **version 1.17.1 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.17.0
+# PyMuPDF 1.17.1
 
 ![logo](https://github.com/pymupdf/PyMuPDF/blob/master/demo/pymupdf.jpg)
 
-Release date: May 18, 2020
+Release date: June 20, 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.17.0 of PyMuPDF (formerly python-fitz)**, a Python binding with support for [MuPDF 1.17.*](http://mupdf.com/) - "a lightweight PDF, XPS, and E-book viewer".
+This is **version 1.17.1 of PyMuPDF**, a Python binding with support for [MuPDF 1.17.*](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.
 
@@ -52,7 +52,7 @@ Have a look at the basic [demos](https://github.com/pymupdf/PyMuPDF-Utilities/tr
 
 Our **documentation**, written using Sphinx, is available in various formats from the following sources. It currently is a combination of a reference guide and a user manual. For a **quick start** look at the [tutorial](https://pymupdf.readthedocs.io/en/latest/tutorial/) and the [recipes](https://pymupdf.readthedocs.io/en/latest/faq/) chapters.
 
-* You can view it online at [Read the Docs](https://pymupdf.readthedocs.io/). This site also provides download options for zipped HTML and PDF.
+* You can view it online at [Read the Docs](https://readthedocs.org/projects/pymupdf/). This site also provides download options for zipped HTML and PDF.
 * Find a Windows help file [here](https://github.com/pymupdf/PyMuPDF-optional-material/tree/master/doc/PyMuPDF.chm).
 
 

docs/annot.rst

@@ -26,9 +26,10 @@ There is a parent-child relationship between an annotation and its page. If the
 :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.setOpacity`        change transparency
 :meth:`Annot.setRect`           change the rectangle
+:meth:`Annot.setRotation`       change rotation
 :meth:`Annot.update`            apply accumulated annot changes
 :attr:`Annot.border`            border details
 :attr:`Annot.colors`            border / background and fill colors
@@ -140,6 +141,21 @@ There is a parent-child relationship between an annotation and its page. If the
 
       :arg rect_like rect: the new rectangle of the annotation (finite and not empty). E.g. using a value of *annot.rect + (5, 5, 5, 5)* will shift the annot position 5 pixels to the right and downwards.
 
+      .. note:: You need not invoke :meth:`Annot.update` for activation of the effect.
+
+
+   .. method:: setRotation(angle)
+
+      Set the rotation of an annotation. This rotates the annotation rectangle around its center point. Then a **new rectangle** is calculated which replaces the existing one.
+
+      :arg int angle: rotation angle in degrees. Arbitrary values are possible, but will be replaced by equivalent values 0 <= angle < 360.
+
+      .. note::
+        * You **must invoke** :meth:`Annot.update` to activate the effect.
+        * For PDF_ANNOT_FREE_TEXT, only the four values 0, 90, 180 and 270 are possible and will only **rotate the text** inside the current rectangle (which remains unchanged). Other values are silently ignored and treated as 0.
+        * Otherwise, only the following `AnnotationTypes`_ can be rotated: 'Square', 'Circle', 'Caret', 'Text', 'FileAttachment', 'Ink', 'Line', 'Polyline', 'Polygon', and 'Stamp'. For all others the method is a no-op.
+
+
    .. method:: setBorder(border=None, width=0, style=None, dashes=None)
 
       PDF only: Change border width and dashing properties.
@@ -191,9 +207,9 @@ There is a parent-child relationship between an annotation and its page. If the
          * :meth:`setRect`
          * :meth:`setFlags`
          * :meth:`fileUpd`
-         * :meth:`setInfo` (except changes to *"content"*)
+         * :meth:`setInfo` (except any changes to *"content"*)
 
-      All arguments are optional. *(Changed in v1.16.14)* Blend mode and opacity are applicable to all annotation types. The other arguments are mostly special use, as described below.
+      All arguments are optional. *(Changed in v1.16.14)* Blend mode and opacity are applicable to **all annotation types**. The other arguments are mostly special use, as described below.
 
       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 and yields some shade of gray.
 
@@ -205,9 +221,9 @@ There is a parent-child relationship between an annotation and its page. If the
       :arg sequence,float fill_color: the fill color.
 
           * 'FreeText' annotations: If you set (or leave) this to *None*, then **no rectangle at all** will be drawn around the text, and the border color will be ignored. This will leave anything "under" the text visible.
-          * 'Line', 'Polyline', 'Polygon' annotations: use it for line end symbols to give them a fill color other than the one of the annotation *(changed in v1.16.16)*
+          * 'Line', 'Polyline', 'Polygon' annotations: use it to give applicable line end symbols a fill color other than that of the annotation *(changed in v1.16.16)*.
 
-      :arg int rotate: new rotation value. Default (-1) means no change. 'FreeText' annotations only.
+      :arg int rotate: new rotation value. Default (-1) means no change. Supports 'FreeText' and several other annotation types (see `Annot.setRotation`), [#f1]_. Only choose 0, 90, 180, or 270 degrees for 'FreeText'. Otherwise any integer is acceptable.
 
       :rtype: bool
 
@@ -258,6 +274,13 @@ There is a parent-child relationship between an annotation and its page. If the
 
       :rtype: :ref:`Page`
 
+   .. attribute:: rotation
+
+      The annot rotation.
+
+      :rtype: int
+      :returns: a value [-1, 359]. If rotation is not at all, -1 is returned (and implies a rotation angle of 0). Other possible values are normalized to some value value 0 <= angle < 360.
+
    .. attribute:: rect
 
       The rectangle containing the annotation.
@@ -387,3 +410,7 @@ This is how the circle annotation looks like before and after the change (pop-up
 
 .. |circle| image:: images/img-circle.png
 
+
+.. rubric:: Footnotes
+
+.. [#f1] Rotating an annotation generally also changes its rectangle. Depending on how the annotation was defined, the original rectangle in general is **not reconstructible** by setting the rotation value to zero. This information may be lost. 

docs/app4.rst

@@ -54,7 +54,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.
+There is a newer version of this, which can be found `here <https://www.adobe.com/content/dam/acom/en/devnet/pdf/pdfs/PDF32000_2008.pdf>`_. Redaction annotations are an example contained in this one, but not in the earlier version.
 
 ------------
 

docs/changes.rst

@@ -1,6 +1,14 @@
 Change Logs
 ===============
 
+Changes in Version 1.17.1
+---------------------------
+* **Fixed** issue `#520 <https://github.com/pymupdf/PyMuPDF/issues/520>`_.
+* **Fixed** issue `#525 <https://github.com/pymupdf/PyMuPDF/issues/525>`_. Vertices for 'Ink' annots should now be correct.
+* **Fixed** issue `#524 <https://github.com/pymupdf/PyMuPDF/issues/524>`_. It is now possible to query and set rotation for applicable annotation types.
+
+Also significantly improved inline documentation for better support of interactive help.
+
 Changes in Version 1.17.0
 ---------------------------
 This version is based on MuPDF v1.17. Following are highlights of new and changed features:

docs/conf.py

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

docs/functions.rst

@@ -1,18 +1,21 @@
 ============
 Functions
 ============
-The following are miscellaneous functions on a fairly low-level technical detail.
+The following are miscellaneous functions and attributes on a fairly low-level technical detail.
 
-Some functions provide detail access to PDF structures. Others are stripped-down, high performance versions of functions providing more information.
+Some functions provide detail access to PDF structures. Others are stripped-down, high performance versions of other functions which provide more information.
 
 Yet others are handy, general-purpose utilities.
 
 
 ==================================== ==============================================================
 **Function**                         **Short Description**
 ==================================== ==============================================================
-:attr:`Document.FontInfos`           PDF only: information on inserted fonts
 :meth:`Annot._cleanContents`         PDF only: clean the annot's :data:`contents` objects
+:meth:`Annot.setAPNMatrix`           PDF only: set the matrix of the appearance object
+:meth:`Annot.setAPNMatrix`           PDF only: set the matrix of the appearance object
+:attr:`Annot.APNMattrix`             PDF only: the matrix of the appearance object
+:attr:`Annot.APNBBox`                PDF only: bbox of the appearance object
 :meth:`ConversionHeader`             return header string for *getText* methods
 :meth:`ConversionTrailer`            return trailer string for *getText* methods
 :meth:`Document._delXmlMetadata`     PDF only: remove XML metadata
@@ -34,13 +37,14 @@ Yet others are handy, general-purpose utilities.
 :meth:`Document.extractImage`        PDF only: extract embedded image
 :meth:`Document.getCharWidths`       PDF only: return a list of glyph widths of a font
 :meth:`Document.isStream`            PDF only: check whether an :data:`xref` is a stream object
+:attr:`Document.FontInfos`           PDF only: information on inserted fonts
 :meth:`ImageProperties`              return a dictionary of basic image properties
 :meth:`getPDFnow`                    return the current timestamp in PDF format
 :meth:`getPDFstr`                    return PDF-compatible string
 :meth:`getTextlength`                return string length for a given font & fontsize
 :meth:`Page._cleanContents`          PDF only: clean the page's :data:`contents` objects
 :meth:`Page._getContents`            PDF only: return a list of content numbers
-:meth:`Page._setContents`            PDF only: set page's :data:`contents` object to specified :data:`xref`
+:meth:`Page._setContents`            PDF only: set page's :data:`contents` to some :data:`xref`
 :meth:`Page.getDisplayList`          create the page's display list
 :meth:`Page.getTextBlocks`           extract text blocks as a Python list
 :meth:`Page.getTextWords`            extract text words as a Python list

docs/images/img-redact-2.jpg

@@ -93,13 +93,13 @@ IRect is a rectangular bounding box similar to :ref:`Rect`, except that all corn
 
       :rtype: bool
 
-   .. method:: morph(pivot, matrix)
+   .. method:: morph(fixpoint, matrix)
 
       *(New in version 1.17.0)*
 
-      Return a new quad after applying a matrix to it using a pivotal point.
+      Return a new quad after applying a matrix to it using a fixed point.
 
-      :arg point_like pivot: the pivotal point.
+      :arg point_like fixpoint: the fixed point.
       :arg matrix_like matrix: the matrix.
       :returns: a new :ref:`Quad`. This a wrapper of the same-named quad method.