Merge branch 'main' into markdown-export

Author: JorjMcKie

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -46,14 +46,9 @@ body:
     attributes:
       label: PyMuPDF version
       options:
+        - 1.26.1
         - 1.26.0
-        - 1.25.5
-        - 1.25.4
-        - 1.25.3
-        - 1.25.2
-        - 1.25.1
-        - 1.25.0
-        - 1.24.x or earlier
+        - 1.25.x or earlier
         - Built from source
       description: |
         * For example from `pymupdf.VersionBind`.

.github/workflows/test.yml

@@ -58,5 +58,7 @@ jobs:
       #
       - uses: actions/upload-artifact@v4
         with:
-          path: ./wheelhouse/pymupdf*.whl
+          path: |
+              wheelhouse/pymupdf*.whl
+              wheelhouse/pymupdf*.tar.gz
           name: artifact-${{ matrix.os }}

changes.txt

@@ -2,6 +2,27 @@ Change Log
 ==========
 
 
+**Changes in version 1.26.1**
+
+* Use MuPDF-1.26.2.
+
+* Fixed issues:
+
+  * **Fixed** `4520 <https://github.com/pymupdf/PyMuPDF/issues/4520>`_: show_pdf_page does not like empty pages created by new_page
+  * **Fixed** `4524 <https://github.com/pymupdf/PyMuPDF/issues/4524>`_: fitz.get_text ignores 'pages' kwarg
+  * **Fixed** `4412 <https://github.com/pymupdf/PyMuPDF/issues/4412>`_: Regression? Spurious error? in insert_pdf in v1.25.4
+
+* Other:
+
+  * Partial fix for `4503 <https://github.com/pymupdf/PyMuPDF/issues/4503>`_: Undetected character styles
+  * New method `Document.rewrite_images()`, useful for reducing file size, changing image formats, or converting color spaces.
+  * `Page.get_text()`: restrict positional args to match docs.
+  * Removed bogus definition of class `Shape`.
+  * Removed release date from module, docs and changelog.
+    * `pymupdf.pymupdf_date` and `pymupdf.VersionDate` are now both None.
+    * They will be removed in a future release.
+
+
 **Changes in version 1.26.0 (2025-05-22)**
 
 * Use MuPDF-1.26.1.

docs/page.rst

@@ -2329,14 +2329,36 @@ This is an overview of homologous methods on the :ref:`Document` and on the :ref
 ====================================== =====================================
 **Document Level**                     **Page Level**
 ====================================== =====================================
-*Document.get_page_fonts(pno)*         :meth:`Page.get_fonts`
-*Document.get_page_images(pno)*        :meth:`Page.get_images`
-*Document.get_page_pixmap(pno, ...)*   :meth:`Page.get_pixmap`
-*Document.get_page_text(pno, ...)*     :meth:`Page.get_text`
-*Document.search_page_for(pno, ...)*   :meth:`Page.search_for`
+:meth:`Document.get_page_fonts`        :meth:`Page.get_fonts`
+:meth:`Document.get_page_images`       :meth:`Page.get_images`
+:meth:`Document.get_page_pixmap`       :meth:`Page.get_pixmap`
+:meth:`Document.get_page_text`         :meth:`Page.get_text`
+:meth:`Document.search_page_for`       :meth:`Page.search_for`
 ====================================== =====================================
 
-The page number "pno" is a 0-based integer `-∞ < pno < page_count`.
+.. note::
+
+   Most document methods (left column) exist for convenience reasons, and are just wrappers for: *Document[pno].<page method>*. So they **load and discard the page** on each execution.
+
+   However, the first two methods work differently. They only need a page's object definition statement - the page itself will **not** be loaded. So e.g. :meth:`Page.get_fonts` is a wrapper the other way round and defined as follows: `page.get_fonts` == `page.parent.get_page_fonts(page.number)`.
+
+
+When calling the :ref:`Document` equivalent methods then the page number is sent through as a parameter, e.g.:
+
+`Document.get_page_images(pno)` or `Document.get_page_text(pno)`
+
+.. tip::
+
+   The page number parameter, ``pno``, is a 0-based integer `-∞ < pno < page_count`.
+
+
+
+
+
+Tables and Related Classes
+------------------------------------
+
+The `TableFinder` class is returned by :meth:`Page.find_tables` and has related classes as follows:
 
 .. note::
 
@@ -2351,7 +2373,7 @@ The page number "pno" is a 0-based integer `-∞ < pno < page_count`.
 
    .. attribute:: tables
 
-      A list of `Table` objects, each of which represents a table found on the page. Empty list if no table found.
+      A list of :class:`Table` objects, each of which represents a table found on the page. An empty list if no tables are found.
 
    .. attribute:: page
 
@@ -2361,93 +2383,124 @@ The page number "pno" is a 0-based integer `-∞ < pno < page_count`.
 
       A list of tuples `(x0, y0, x1, y1)` representing the bounding boxes of all table cells (in any tables) found on the page. Note that cells may also be ``None`` objects, which are created to enforce a complete rows x columns structure for the affected table.
 
+      :type: :ref:`Page`
+
 
 .. class:: Table
 
-   An object representing a table found on the page. Attributes of interest:
+   An object representing a table found on the page.
 
-   .. attribute:: bbox
 
-      The bounding box of the table given as a tuple `(x0, y0, x1, y1)`. This is the rectangle that contains all cells of the table.   
+   .. attribute:: page
+
+      A back-reference to the owning page.
+
+      :type: :ref:`Page`
 
    .. attribute:: cells
 
-      A list of tuples `(x0, y0, x1, y1)` representing the bounding boxes of the cells in the table. Note that cells may also be ``None`` objects, which will happen to prevent gaps in a rows x columns structure.
+      An array of `Rect` objects for each cell in the table.
 
-   .. attribute:: rows
+      :type: list
 
-      A list of :ref:`TableRow` objects, each of which represents a row in the table. The order of rows is the same as in the original table. If the table has no rows, this will be an empty list.
 
-   .. attribute:: col_count
+   .. attribute:: header
+
+      A `TableHeader` object.
+
+      :type: `TableHeader`
+
+
+   .. attribute:: bbox
+
+      The bounding box of all cells of the table header.
+
+
+      :type: :ref:`Rect`
+
 
-      The number of columns in the table (integer).
 
    .. attribute:: row_count
 
-      The number of rows in the table (integer).
+      Number of rows in the table.
 
-   .. method:: extract
+      :type: int
 
-      Returns a (row-major) list of lists representing the plain text of the table cells. Each sublist contains the text of one row, and each item in that sublist is the text of one cell in that row. So, `Table.extract()[i][j]` will return the text of the cell in row ``i`` and column ``j``. If a cell is empty, the corresponding item will be an empty string. If the corresponding boundary box is ``None``, the item will also be ``None``.
 
-   .. method:: to_markdown(clean=False, fill_empty=True)
+   .. attribute:: col_count
 
-      Returns a string in `GitHub Markdown format <https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables>`_ representing the table. The string will contain a header line with column names, followed by a separator line, and then the rows of the table. The text of each cell will be enclosed in pipe characters `|`, and each row will be separated by a newline character `\n`. **Line breaks inside a cell** are being replaced by the HTML `<br>` tag. Bold, italic, mono-spaced and strikethrough text will be styled according to the corresponding Markdown syntax.
+      Number of columns in the table.
 
-      - Bold text will be enclosed in double asterisks ``"**"``.
+      :type: int
 
-      - Italic text will be enclosed in single underscore ``"_"``.
 
-      - Mono-spaced text will be enclosed in backticks ``"`"``.
+   .. attribute:: rows
 
-      - Strikethrough text will be enclosed in double tildes ``"~~"``.
-      
-      :arg bool clean: if ``True``, any hyphen "-" in the text is replaced by a ``"&#45;"`` character.
-      
-      :arg bool fill_empty: if ``True``, empty cells will be filled with a copy of neighboring cells in an effort to indicate potential column and row spans.
+      An array of `TableRow` objects for each row in the table.
 
-         * For each row and starting with index 1, the cell content will be replaced with the content of its left neighbor if it is ``None``.
+      :type: list
 
-         * For each column and starting with index 1, the cell content will be replaced with the content of its upper neighbor if it is ``None``.
 
+   .. method:: extract()
 
-   .. method:: to_pandas()
+      Extracts table cell text data into a list.
 
-      Returns a `pandas.DataFrame <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`_ representing the table. The DataFrame offers a plethora of functions, among them conversion to 20+ file formats (CSV, markdown, JSON, Excel, HD5 etc.). Where necessary, the table can be refined in multiple ways (e.g. deleting empty rows or columns) and mutliple DataFrames can be joined.
+      :type: list
 
+   .. method:: to_markdown(clean=False, fill_empty=True)
 
-.. class:: TableHeader
+      Extracts table data into Markdown text format.
 
-   .. attribute:: names
 
-      A list of strings representing the column names of the `Table`. This is usually the text content of the top row cells, but may instead be content identified above the detected table. The respective situation is encoded in the following attribute.
+      :arg bool clean: If ``True`` then markdown syntax is removed from cell content.
+      :arg bool fill_empty: If ``True`` then cell content `None` is replaced by the values above (columns) or left (rows) in an effort to approximate row and columns spans.
 
-   .. attribute:: is_external
 
-      Whether the header is part of the originally detected table (``False``) or was identified above the table (``True``). If ``True``, the header is not part of the table, but is used to identify the columns in the table. In this case, the header text will be used as column names in the extracted data.
+      :type: string
 
-   .. attribute:: bbox
 
-      The bounding box of the header given as a tuple `(x0, y0, x1, y1)`. This is the rectangle that contains all cells of the header. If the header is not part of the table, this will be the rectangle that contains all cells of the header text, otherwise it is equal of the top row's boundary box.
+   .. method:: to_pandas()
 
-   .. attribute:: cells
+      Return a `pandas DataFrame <https://pypi.org/project/pandas/>`_ `DataFrame <https://pandas.pydata.org/docs/reference/frame.html>`_ version of the table.
 
-      A list of tuples of boundary boxes `(x0, y0, x1, y1)` of the cells in the header. Note that cells may also be ``None``, which will happen to prevent any gaps in a rows x columns structure. If the header is not part of the table, this will be the bounding boxes of the header text.
+      :type: pandas DataFrame
 
 
-.. class:: TableRow
+.. class:: TableHeader
 
-   An object defining a row in a `Table` found on the page. Attributes of interest:
+   Dedicated class for table headers.
 
    .. attribute:: bbox
 
-      The bounding box of the row given as a tuple `(x0, y0, x1, y1)`. This is the rectangle that contains all cells of the row.
+      The bounding box of the union of cells belonging to the table header, given as a tuple (x0, y0, x1, y1). This rectangle contains all table header cells.
+
+      :type: :ref:`Rect`
 
    .. attribute:: cells
 
-      A list of tuples of boundary boxes `(x0, y0, x1, y1)` of the cells in this row. Note that cells may also be ``None`` objects, which will happen to prevent gaps in a rows x columns structure.
+      A list of tuples for each bbox of a column header.
+
+      :type: list
+
+   .. attribute:: names
+
+      A list of strings with column header text.
+
+      :type: list
+
+   .. attribute:: external
+
+      A boolean indicating whether the header is outside the table cells.
+
+      :type: `bool`
+
+
+.. class:: TableRow
+
+   Dedicated class for table rows.
 
 
+----
 
 
 .. rubric:: Footnotes

docs/vars.rst

@@ -77,10 +77,8 @@ Constants
 
 .. py:data:: pymupdf_date
 
-    ISO timestamp *YYYY-MM-DD HH:MM:SS* when these bindings were built.
-
-    :type: string
-
+    Disabled (set to None) in 1.26.1.
+    
 .. py:data:: version
 
     (pymupdf_version, mupdf_version, timestamp) -- combined version information where `timestamp` is the generation point in time formatted as "YYYYMMDDhhmmss".
@@ -97,7 +95,7 @@ Constants
 
 .. py:data:: VersionDate
 
-    Legacy equivalent to `mupdf_version`.
+    Disabled (set to None) in 1.26.1.
 
 
 .. _PermissionCodes:

docs/version.rst

@@ -1,6 +1,6 @@
 ----
 
-This documentation covers **PyMuPDF v1.26.0** features as of **2025-05-22 00:00:01**.
+This documentation covers **PyMuPDF v1.26.1**.
 
 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|.