upload v1.17.6

Author: JorjMcKie

PKG-INFO

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

docs/changes.rst

@@ -1,6 +1,14 @@
 Change Logs
 ===============
 
+Changes in Version 1.17.6
+---------------------------
+* **Fixed** issue `#605 <https://github.com/pymupdf/PyMuPDF/issues/605>`_
+* **Fixed** issue `#600 <https://github.com/pymupdf/PyMuPDF/issues/600>`_ -- text should now be correctly positioned also for pages with a CropBox smaller than MediaBox.
+* **Added** text span dictionary key ``origin`` which contains the lower left coordinate of the first character in that span.
+* **Added** attribute :attr:`Font.buffer`, a *bytes* copy of the font file.
+* **Added** parameter *sanitize* to :meth:`Page.cleanContents`. Allows switching of sanitization, so only syntax cleaning will be done.
+
 Changes in Version 1.17.5
 ---------------------------
 * **Fixed** issue `#561 <https://github.com/pymupdf/PyMuPDF/issues/561>`_ -- second go: certain :ref:`TextWriter` usages with many alternating fonts did not work correctly.

docs/conf.py

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

docs/font.rst

@@ -69,13 +69,13 @@ A Font object also contains useful general information, like the font bbox, the
 
         *(New in v1.17.5)* Optionally, some new "reserved" fontnames become available if you install `pymupdf-fonts <https://pypi.org/project/pymupdf-fonts/>`_. **"Fira Mono"** is a nice mono-spaced sans font set and **FiraGO** is another non-serifed "universal" font, set which supports all European languages (including Cyrillic and Greek) plus Thai, Arabian, Hewbrew and Devanagari -- however none of the CJK languages. The size of a FiraGO font is only a quarter of the "Droid Sans Fallback" size (compressed 400 KB vs. 1.65 MB) -- **and** it provides the style variants bold, italic, bold-italic.
 
-        **"Space Mono"** is another nice and small fixed-width font from Google Fonts, which supports Latin Extended characters.
+        **"Space Mono"** is another nice and small fixed-width font from Google Fonts, which supports Latin Extended characters and comes with all 4 important font weights.
 
         The following table maps a fontname to the corresponding font:
 
-            =========== =========================== ==============
-            Fontname    Font                        Added in
-            =========== =========================== ==============
+            =========== =========================== ======= =============================
+            Fontname    Font                        New in  Comment
+            =========== =========================== ======= =============================
             figo        FiraGO Regular              v1.0.0
             figbo       FiraGO Bold                 v1.0.0
             figit       FiraGO Italic               v1.0.0
@@ -86,11 +86,11 @@ A Font object also contains useful general information, like the font bbox, the
             spacembo    Space Mono Bold             v1.0.1
             spacemit    Space Mono Italic           v1.0.1
             spacembi    Space Mono Bold-Italic      v1.0.1
-            math        Noto Sans Math Regular      v1.0.2
-            music       Noto Music Regular          v1.0.2
-            symbol1     Noto Sans Symbols Regular   v1.0.2
-            symbol2     Noto Sans Symbols2 Regular  v1.0.2
-            =========== =========================== ==============
+            math        Noto Sans Math Regular      v1.0.2  math symbols
+            music       Noto Music Regular          v1.0.2  musical symbols
+            symbol1     Noto Sans Symbols Regular   v1.0.2  replacemt for "symb"
+            symbol2     Noto Sans Symbols2 Regular  v1.0.2  extended symbol set
+            =========== =========================== ======= =============================
 
 
    .. method:: has_glyph(chr, language=None, script=0, fallback=False)
@@ -105,7 +105,9 @@ A Font object also contains useful general information, like the font bbox, the
 
    .. method:: valid_codepoints()
 
-      *(New in v1.17.5)* Return an array of unicodes which are supported by this font.
+      *(New in v1.17.5)*
+
+      Return an array of unicodes supported by this font.
 
       :returns: an *array.array* [#f2]_ of length :attr:`Font.glyph_count` (or less). I.e. *chr()* of every item in this array will be found in the font without using fallbacks. This is an example display of the supported glyphs:
 
@@ -176,6 +178,12 @@ A Font object also contains useful general information, like the font bbox, the
 
       :returns: a float representing the length of the string when stored in the PDF. Internally :meth:`glyph_advance` is used on a by-character level. If the font does not have a character, it will automatically be looked up in a fallback font.
 
+   .. attribute:: buffer
+
+      *(New in v1.17.6)*
+      
+      A *bytes* copy of the binary font file.
+
    .. attribute:: flags
 
       A dictionary with various font properties, each represented as bools.

docs/functions.rst

@@ -451,13 +451,17 @@ Yet others are handy, general-purpose utilities.
 
 -----
 
-   .. method:: Page.cleanContents()
+   .. method:: Page.cleanContents(sanitize=True)
 
-      Clean and concatenate all :data:`contents` objects associated with this page. "Cleaning" includes syntactical corrections, standardizations and "pretty printing" of the contents stream. Discrepancies between :data:`contents` and :data:`resources` objects will also be corrected. See :meth:`Page._getContents` for more details.
+      *(Changed in v1.17.6)*
+      
+      PDF only: Clean and concatenate all :data:`contents` objects associated with this page. "Cleaning" includes syntactical corrections, standardizations and "pretty printing" of the contents stream. Discrepancies between :data:`contents` and :data:`resources` objects will also be corrected if sanitize is true. See :meth:`Page.getContents` for more details.
 
       Changed in version 1.16.0 Annotations are no longer implicitely cleaned by this method. Use :meth:`Annot._cleanContents` separately.
 
-      .. warning:: This is a complex function which may generate large amounts of new data and render other data unused. It is **not recommended** using it together with the **incremental save** option. Also note that the resulting singleton new */Contents* object is **uncompressed**. So you should save to a **new file** using options *"deflate=True, garbage=3"*.
+      :arg bool sanitize: *(new in v1.17.6)* if true, synchronization between resources and their actual use in the contents object is snychronized. For example, if a font is not actually used for any text of the page, then it will be deleted from the ``/Resources/Font`` object.
+
+      .. warning:: This is a complex function which may generate large amounts of new data and render old data unused. It is **not recommended** using it together with the **incremental save** option. Also note that the resulting singleton new */Contents* object is **uncompressed**. So you should save to a **new file** using options *"deflate=True, garbage=3"*.
 
 -----
 
@@ -471,7 +475,7 @@ Yet others are handy, general-purpose utilities.
 
    .. method:: Annot._cleanContents()
 
-      Clean the :data:`contents` streams associated with the annotation. This is the same type of action which :meth:`Page._cleanContents` performs -- just restricted to this annotation.
+      Clean the :data:`contents` streams associated with the annotation. This is the same type of action which :meth:`Page.cleanContents` performs -- just restricted to this annotation.
 
 
 -----

docs/pixmap.rst

@@ -450,6 +450,6 @@ psd        gray, rgb, cmyk yes       .psd           Adobe Photoshop Document
 
 .. rubric:: Footnotes
 
-.. [#f1] If you need a **vector image** from the SVG, you must first convert it to a PDF. Try :meth:`Document.convertToPDF`. If this is not not good enough, look for other SVG-to-PDF conversion tools like the Python packages `svglib <https://pypi.org/project/svglib>`_, `CairoSVG <https://pypi.org/project/cairosvg>`_, `Uniconvertor <https://sk1project.net/modules.php?name=Products&product=uniconvertor&op=download>`_ or the Java solution `Apache Batik <https://github.com/apache/batik>`_. Have a look at our Wiki for more examples.
+.. [#f1] If you need a **vector image** from the SVG, you must first convert it to a PDF. Try :meth:`Document.convertToPDF`. If this is not good enough, look for other SVG-to-PDF conversion tools like the Python packages `svglib <https://pypi.org/project/svglib>`_, `CairoSVG <https://pypi.org/project/cairosvg>`_, `Uniconvertor <https://sk1project.net/modules.php?name=Products&product=uniconvertor&op=download>`_ or the Java solution `Apache Batik <https://github.com/apache/batik>`_. Have a look at our Wiki for more examples.
 
 .. [#f2] To also set the alpha property, add an additional step to this method by dropping or adding an alpha channel to the result.

docs/textpage.rst

@@ -204,11 +204,13 @@ Span Dictionary
 Spans contain the actual text. A line contains **more than one span only**, if it contains text with different font properties.
 
 *(Changed in version 1.14.17)* Spans now also have a *bbox* key (again).
+*(Changed in version 1.17.6)* Spans now also have an *origin* key.
 
 =============== =====================================================================
 **Key**             **Value**
 =============== =====================================================================
 bbox            span rectangle, formatted as *tuple(fitz.Rect)*
+origin          *tuple* coordinates of the first character's bottom left point
 font            font name *(str)*
 size            font size *(float)*
 flags           font characteristics *(int)*
@@ -219,7 +221,7 @@ chars           (only for :meth:`extractRAWDICT`) *list* of character dictionari
 
 *(New in version 1.16.0)*
 
-*"color"* is the text color encoded in sRGB format, e.g. 0xFF0000 for red.
+*"color"* is the text color encoded in sRGB (int) format, e.g. 0xFF0000 for red. There are functions for converting this integer back to formats (r, g, b) (PDF with float values from 0 to 1) :meth:`sRGB_to_pdf`, or (R, G, B), :meth:`sRGB_to_rgb` (with integer values from 0 to 255).
 
 *"flags"* is an integer, encoding bools of font properties:
 

docs/version.rst

@@ -1,6 +1,6 @@
 Covered Version
 --------------------
 
-This documentation covers PyMuPDF v1.17.5 features as of **2020-08-06 06:31:06**.
+This documentation covers PyMuPDF v1.17.6 features as of **2020-08-26 14:54:32**.
 
 .. note:: The major and minor versions of **PyMuPDF** and **MuPDF** will always be the same. Only the third qualifier (patch level) may deviate from that of MuPDF.

fitz/fitz.i

@@ -3051,7 +3051,7 @@ struct Page {
         """Get rectangle occupied by image 'name'.
 
         'name' is either an item of the image full list, or the referencing
-        name string."""
+        name string - elem[7] of the resp. item."""
         CheckParent(self)
         doc = self.parent
         if doc.isClosed or doc.isEncrypted:
@@ -3112,6 +3112,7 @@ struct Page {
         // Page.getTextPage
         //---------------------------------------------------------------------
         FITZEXCEPTION(_get_text_page, !result)
+        %pythonappend _get_text_page %{val.thisown = True%}
         struct TextPage *
         _get_text_page(int flags=0)
         {
@@ -4059,6 +4060,7 @@ struct Page {
 
         CheckParent(self)
         %}
+        %pythonappend getDisplayList %{val.thisown = True%}
         struct DisplayList *getDisplayList(int annots=1)
         {
             fz_display_list *dl = NULL;
@@ -4502,11 +4504,10 @@ except:
         // Page clean contents stream
         //---------------------------------------------------------------------
         PARENTCHECK(_cleanContents, """Clean page /Contents object(s).""")
-        PyObject *_cleanContents()
+        PyObject *_cleanContents(int sanitize=0)
         {
             pdf_page *page = pdf_page_from_fz_page(gctx, (fz_page *) $self);
-            if (!page)
-            {
+            if (!page) {
                 return_none;
             }
             pdf_filter_options filter = {
@@ -4519,7 +4520,8 @@ except:
                 1,     // instance forms
                 1,     // sanitize plus filtering
                 0      // do not ascii-escape binary data
-                }; 
+                };
+            filter.sanitize = sanitize;
             fz_try(gctx) {
                 pdf_filter_page_contents(gctx, page->doc, page, &filter);
             }
@@ -5139,8 +5141,10 @@ def insertFont(self, fontname="helv", fontfile=None, fontbuffer=None,
         def MediaBoxSize(self):
             return Point(self.MediaBox.width, self.MediaBox.height)
 
-        def cleanContents(self):
-            self._cleanContents()
+        def cleanContents(self, sanitize=True):
+            if not sanitize and not self._isWrapped:
+                self.wrapContents()
+            self._cleanContents(sanitize)
 
         getContents = _getContents
         %}
@@ -7545,7 +7549,7 @@ struct Annot
         //---------------------------------------------------------------------
         FITZEXCEPTION(_cleanContents, !result)
         PARENTCHECK(_cleanContents, """Clean appearance contents object.""")
-        PyObject *_cleanContents()
+        PyObject *_cleanContents(int sanitize=0)
         {
             pdf_annot *annot = (pdf_annot *) $self;
             pdf_filter_options filter = {
@@ -7556,9 +7560,10 @@ struct Annot
                 NULL,  // end page
                 1,     // recurse: true
                 1,     // instance forms
-                1,     // only sanitize, no filtering
+                1,     // sanitize,
                 0      // do not ascii-escape binary data
-                }; 
+                };
+            filter.sanitize = sanitize;
             fz_try(gctx) {
                 pdf_filter_annot_contents(gctx, annot->page->doc, annot, &filter);
             }
@@ -7926,6 +7931,7 @@ struct DisplayList {
             DEBUGMSG2;
         }
         FITZEXCEPTION(DisplayList, !result)
+        %pythonappend DisplayList %{self.thisown = True%}
         DisplayList(PyObject *mediabox)
         {
             fz_display_list *dl = NULL;
@@ -7964,9 +7970,10 @@ struct DisplayList {
         // DisplayList.getPixmap
         //---------------------------------------------------------------------
         FITZEXCEPTION(getPixmap, !result)
+        %pythonappend getPixmap %{val.thisown = True%}
         struct Pixmap *getPixmap(PyObject *matrix=NULL,
                                       struct Colorspace *colorspace=NULL,
-                                      int alpha=1,
+                                      int alpha=0,
                                       PyObject *clip=NULL)
         {
             fz_colorspace *cs = NULL;
@@ -7990,6 +7997,7 @@ struct DisplayList {
         // DisplayList.getTextPage
         //---------------------------------------------------------------------
         FITZEXCEPTION(getTextPage, !result)
+        %pythonappend getTextPage %{val.thisown = True%}
         struct TextPage *getTextPage(int flags = 3)
         {
             fz_display_list *this_dl = (fz_display_list *) $self;
@@ -8007,7 +8015,9 @@ struct DisplayList {
         %pythoncode %{
         def __del__(self):
             if not type(self) is DisplayList: return
-            self.__swig_destroy__(self)
+            if getattr(self, "thisown", False):
+                self.__swig_destroy__(self)
+            self.thisown = False
         %}
     }
 };
@@ -8025,6 +8035,7 @@ struct TextPage {
         }
 
         FITZEXCEPTION(TextPage, !result)
+        %pythonappend TextPage %{self.thisown = True%}
         TextPage(PyObject *mediabox)
         {
             fz_stext_page *tp = NULL;
@@ -8350,7 +8361,9 @@ struct TextPage {
 
             def __del__(self):
                 if not type(self) is TextPage: return
-                self.__swig_destroy__(self)
+                if getattr(self, "thisown", False):
+                    self.__swig_destroy__(self)
+                self.thisown = False
         %}
     }
 };
@@ -8448,10 +8461,10 @@ struct TextWriter
             self.used_fonts.add(font)
         %}
         PyObject *
-        append(PyObject *pos, char *text, struct Font *font=NULL, float fontsize=11, char *language=NULL, int wmode=0, int bidi_level=0)
+        append(PyObject *pos, char *text, struct Font *font=NULL, float fontsize=11, char *language=NULL, int wmode=0, int bidi_level=0, int markup_dir=0)
         {
             fz_text_language lang = fz_text_language_from_string(language);
-            fz_bidi_direction markup_dir = 0;
+            //fz_bidi_direction markup_dir = 0;
             fz_point p = JM_point_from_py(pos);
             fz_matrix trm = fz_make_matrix(fontsize, 0, 0, fontsize, p.x, p.y);
             fz_try(gctx) {
@@ -8505,6 +8518,10 @@ struct TextWriter
 
         new_cont_lines = ["q"]
 
+        cb = page.CropBoxPosition
+        if bool(cb):
+            new_cont_lines.append("1 0 0 1 %g %g cm" % (cb.x, cb.y))
+
         if morph:
             p = morph[0] * self.ictm
             delta = Matrix(1, 1).preTranslate(p.x, p.y)
@@ -8752,6 +8769,15 @@ struct Font
             return this_font->glyph_count;
         }
 
+        %pythoncode %{@property%}
+        PyObject *buffer()
+        {
+            fz_font *this_font = (fz_font *) $self;
+            unsigned char *data = NULL;
+            size_t len = fz_buffer_storage(gctx, this_font->buffer, &data);
+            return JM_BinFromCharSize(data, len);
+        }
+
         %pythoncode %{@property%}
         %pythonappend bbox%{val = Rect(val)%}
         PyObject *bbox()