Merge branch 'master' into master

.all-contributorsrc

@@ -741,6 +741,25 @@
       "name": "CpDong",
       "avatar_url": "https://avatars.githubusercontent.com/u/93034081?v=4",
       "profile": "https://github.com/Bubbu0129",
+      "contributions": [
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "CY-Qiu",
+      "name": "CY-Qiu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/23075447?v=4",
+      "profile": "https://github.com/CY-Qiu",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "Markovvn1",
+      "name": "Markovvn1",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32509100?v=4",
+      "profile": "https://github.com/Markovvn1",
       "contributions": [
         "code"
       ]

.github/workflows/continuous-integration-workflow.yml

@@ -12,7 +12,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
         platform: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
@@ -30,7 +30,7 @@ jobs:
         run: sudo apt-get install qpdf
       - name: Install Python dependencies ⚙️
         run: |
-          python -m pip install --upgrade pip setuptools
+          python -m pip install --upgrade pip setuptools wheel
           pip install --upgrade . -r test/requirements.txt -r docs/requirements.txt -r contributors/requirements.txt
       - name: Statically checking code 🔎
         if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'

CHANGELOG.md

@@ -18,12 +18,17 @@ This can also be enabled programmatically with `warnings.simplefilter('default',
 
 ## [2.6.1] - not released yet
 ### Added
+* the `x` parameter of [`FPDF.image()`](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image) now accepts a value of `"C"` / `Align.C` / `"R"` / `Align.R` to horizontally position the image centered or aligned right
 * support for `[]()` links when `markdown=True`
-* support for `line-height` attribute of paragraph (`<p>`) in `write_html()`
+* support for `line-height` attribute of paragraph (`<p>`) in `write_html()` - thanks to @Bubbu0129
 ### Changed
+* `add_link()` creates a link to the current page by default, and now accepts optional parameters: `x`, `y`, `page` & `zoom`.
+  Hence calling `set_link()` is not needed anymore after creating a link with `add_link()`.
 * `write_html()`now generates warnings for unclosed HTML tags, unless `warn_on_tags_not_matching=False` is set
 ### Fixed
 * image (`<img>`) without `height` attribute overlaps with the following content [#632](https://github.com/PyFPDF/fpdf2/issues/632)
+* a `ValueError: Incoherent hierarchy` could be raised when using `write_html()` with some headings hierarchy
+* performance issue with adding large images with `FlateDecode` image filter
 
 ## [2.6.0] - 2022-11-20
 ### Added

README.md

@@ -78,7 +78,7 @@ pip install git+https://github.com/PyFPDF/fpdf2.git@master
  * Usage examples with [Django](https://www.djangoproject.com/), [Flask](https://flask.palletsprojects.com), [streamlit](https://streamlit.io/), AWS lambdas... : [Usage in web APIs](https://pyfpdf.github.io/fpdf2/UsageInWebAPI.html)
  * 1000+ unit tests running under Linux & Windows, with `qpdf`-based PDF diffing, timing & memory usage checks, and a high code coverage
 
-Our 300+ reference PDF test files, generated by `fpdf2`, are validated using 3 different checkers:
+Our 350+ reference PDF test files, generated by `fpdf2`, are validated using 3 different checkers:
 
 [![QPDF logo](https://pyfpdf.github.io/fpdf2/qpdf-logo.svg)](https://github.com/qpdf/qpdf)
 [![PDF Checker logo](https://pyfpdf.github.io/fpdf2/pdfchecker-logo.png)](https://www.datalogics.com/products/pdf-tools/pdf-checker/)
@@ -219,7 +219,11 @@ This library could only exist thanks to the dedication of many volunteers around
       <td align="center"><a href="https://github.com/seanpmulholland"><img src="https://avatars.githubusercontent.com/u/79894395?v=4?s=100" width="100px;" alt="Sean"/><br /><sub><b>Sean</b></sub></a><br /><a href="https://github.com/PyFPDF/fpdf2/commits?author=seanpmulholland" title="Code">💻</a></td>
       <td align="center"><a href="https://github.com/andersonhc"><img src="https://avatars.githubusercontent.com/u/948125?v=4?s=100" width="100px;" alt="Anderson Herzogenrath da Costa"/><br /><sub><b>Anderson Herzogenrath da Costa</b></sub></a><br /><a href="#question-andersonhc" title="Answering Questions">💬</a> <a href="https://github.com/PyFPDF/fpdf2/commits?author=andersonhc" title="Code">💻</a></td>
       <td align="center"><a href="https://github.com/yiweelan"><img src="https://avatars.githubusercontent.com/u/117787188?v=4?s=100" width="100px;" alt="Yi Wei Lan"/><br /><sub><b>Yi Wei Lan</b></sub></a><br /><a href="https://github.com/PyFPDF/fpdf2/commits?author=yiweelan" title="Tests">⚠️</a></td>
-      <td align="center"><a href="https://github.com/Bubbu0129"><img src="https://avatars.githubusercontent.com/u/93034081?v=4?s=100" width="100px;" alt="CpDong"/><br /><sub><b>CpDong</b></sub></a><br /><a href="https://github.com/PyFPDF/fpdf2/commits?author=Bubbu0129" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/Bubbu0129"><img src="https://avatars.githubusercontent.com/u/93034081?v=4?s=100" width="100px;" alt="CpDong"/><br /><sub><b>CpDong</b></sub></a><br /><a href="https://github.com/PyFPDF/fpdf2/commits?author=Bubbu0129" title="Code">💻</a> <a href="https://github.com/PyFPDF/fpdf2/issues?q=author%3ABubbu0129" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/CY-Qiu"><img src="https://avatars.githubusercontent.com/u/23075447?v=4?s=100" width="100px;" alt="CY-Qiu"/><br /><sub><b>CY-Qiu</b></sub></a><br /><a href="https://github.com/PyFPDF/fpdf2/issues?q=author%3ACY-Qiu" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center"><a href="https://github.com/Markovvn1"><img src="https://avatars.githubusercontent.com/u/32509100?v=4?s=100" width="100px;" alt="Markovvn1"/><br /><sub><b>Markovvn1</b></sub></a><br /><a href="https://github.com/PyFPDF/fpdf2/commits?author=Markovvn1" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

docs/CombineWithPdfrw.md

@@ -15,21 +15,24 @@ with numerous examples and a very clean set of classes modelling the PDF interna
 import sys
 from fpdf import FPDF
 from pdfrw import PageMerge, PdfReader, PdfWriter
+from pdfrw.pagemerge import RectXObj
 
 IN_FILEPATH = sys.argv[1]
 OUT_FILEPATH = sys.argv[2]
 ON_PAGE_INDEX = 1
 UNDERNEATH = False  # if True, new content will be placed underneath page (painted first)
 
+reader = PdfReader(IN_FILEPATH)
+area = RectXObj(reader.pages[0])
+
 def new_content():
-    fpdf = FPDF()
+    fpdf = FPDF(format=(area.w, area.h))
     fpdf.add_page()
     fpdf.set_font("helvetica", size=36)
     fpdf.text(50, 50, "Hello!")
     reader = PdfReader(fdata=bytes(fpdf.output()))
     return reader.pages[0]
 
-reader = PdfReader(IN_FILEPATH)
 writer = PdfWriter()
 writer.pagearray = reader.Root.Pages.Kids
 PageMerge(writer.pagearray[ON_PAGE_INDEX]).add(new_content(), prepend=UNDERNEATH).render()
@@ -42,13 +45,17 @@ writer.write(OUT_FILEPATH)
 import sys
 from fpdf import FPDF
 from pdfrw import PdfReader, PdfWriter
+from pdfrw.pagemerge import RectXObj
 
 IN_FILEPATH = sys.argv[1]
 OUT_FILEPATH = sys.argv[2]
 NEW_PAGE_INDEX = 1  # set to None to append at the end
 
+reader = PdfReader(IN_FILEPATH)
+area = RectXObj(reader.pages[0])
+
 def new_page():
-    fpdf = FPDF()
+    fpdf = FPDF(format=(area.w, area.h))
     fpdf.add_page()
     fpdf.set_font("helvetica", size=36)
     fpdf.text(50, 50, "Hello!")

docs/Links.md

@@ -70,8 +70,7 @@ pdf.add_page()
 # Displaying a full-width cell with centered text:
 pdf.cell(w=pdf.epw, txt="Welcome on first page!", align="C")
 pdf.add_page()
-link = pdf.add_link()
-pdf.set_link(link, page=1)
+link = pdf.add_link(page=1)
 pdf.cell(txt="Internal link to first page", border=1, link=link)
 pdf.output("internal_link.pdf")
 ```

docs/Logging.md

@@ -9,19 +9,61 @@ Here is an example of setup code to display them:
 ```python
 import logging
 
-logging.basicConfig(format="%(asctime)s %(filename)s [%(levelname)s] %(message)s",
+logging.basicConfig(format="%(asctime)s %(name)s [%(levelname)s] %(message)s",
                     datefmt="%H:%M:%S", level=logging.DEBUG)
 ```
 
 Example output using the [Tutorial](Tutorial.md) first code snippet:
 
-    14:09:56 fpdf.py [DEBUG] Final doc sections size summary:
-    14:09:56 fpdf.py [DEBUG] - header.size: 9.0B
-    14:09:56 fpdf.py [DEBUG] - pages.size: 306.0B
-    14:09:56 fpdf.py [DEBUG] - resources.fonts.size: 101.0B
-    14:09:56 fpdf.py [DEBUG] - resources.images.size: 0.0B
-    14:09:56 fpdf.py [DEBUG] - resources.dict.size: 104.0B
-    14:09:56 fpdf.py [DEBUG] - info.size: 54.0B
-    14:09:56 fpdf.py [DEBUG] - catalog.size: 103.0B
-    14:09:56 fpdf.py [DEBUG] - xref.size: 169.0B
-    14:09:56 fpdf.py [DEBUG] - trailer.size: 60.0B
+    19:25:24 fpdf.output [DEBUG] Final size summary of the biggest document sections:
+    19:25:24 fpdf.output [DEBUG] - pages: 223.0B
+    19:25:24 fpdf.output [DEBUG] - fonts: 102.0B
+
+## fonttools verbose logs
+
+Since `fpdf2` v2.5.7, verbose **INFO** logs are generated by `fonttools`,
+a library we use to parse font files:
+
+```
+fontTools.subset [INFO] maxp pruned
+fontTools.subset [INFO] cmap pruned
+fontTools.subset [INFO] post pruned
+fontTools.subset [INFO] EBDT dropped
+fontTools.subset [INFO] EBLC dropped
+fontTools.subset [INFO] GDEF dropped
+fontTools.subset [INFO] GPOS dropped
+fontTools.subset [INFO] GSUB dropped
+fontTools.subset [INFO] DSIG dropped
+fontTools.subset [INFO] name pruned
+fontTools.subset [INFO] glyf pruned
+fontTools.subset [INFO] Added gid0 to subset
+fontTools.subset [INFO] Added first four glyphs to subset
+fontTools.subset [INFO] Closing glyph list over 'glyf': 25 glyphs before
+fontTools.subset [INFO] Glyph names: ['.notdef', 'b', 'braceleft', 'braceright', 'd', 'e', 'eight', 'five', 'four', 'glyph1', 'glyph2', 'h', 'l', 'n', 'nine', 'o', 'one', 'r', 'seven', 'six', 'space', 'three', 'two', 'w', 'zero']
+fontTools.subset [INFO] Glyph IDs:   [0, 1, 2, 3, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 69, 71, 72, 75, 79, 81, 82, 85, 90, 94, 96]
+fontTools.subset [INFO] Closed glyph list over 'glyf': 25 glyphs after
+fontTools.subset [INFO] Glyph names: ['.notdef', 'b', 'braceleft', 'braceright', 'd', 'e', 'eight', 'five', 'four', 'glyph1', 'glyph2', 'h', 'l', 'n', 'nine', 'o', 'one', 'r', 'seven', 'six', 'space', 'three', 'two', 'w', 'zero']
+fontTools.subset [INFO] Glyph IDs:   [0, 1, 2, 3, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 69, 71, 72, 75, 79, 81, 82, 85, 90, 94, 96]
+fontTools.subset [INFO] Retaining 25 glyphs
+fontTools.subset [INFO] head subsetting not needed
+fontTools.subset [INFO] hhea subsetting not needed
+fontTools.subset [INFO] maxp subsetting not needed
+fontTools.subset [INFO] OS/2 subsetting not needed
+fontTools.subset [INFO] hmtx subsetted
+fontTools.subset [INFO] cmap subsetted
+fontTools.subset [INFO] fpgm subsetting not needed
+fontTools.subset [INFO] prep subsetting not needed
+fontTools.subset [INFO] cvt  subsetting not needed
+fontTools.subset [INFO] loca subsetting not needed
+fontTools.subset [INFO] post subsetted
+fontTools.subset [INFO] name subsetting not needed
+fontTools.subset [INFO] glyf subsetted
+fontTools.subset [INFO] head pruned
+fontTools.subset [INFO] OS/2 Unicode ranges pruned: [0]
+fontTools.subset [INFO] glyf pruned
+```
+
+You can easily suppress those logs with this single line of code:
+```python
+logging.getLogger('fontTools.subset').level = logging.WARN
+```

docs/Tutorial-de.md

@@ -199,8 +199,7 @@ Der Anfang des Satzes wird in "normalem" Stil geschrieben, dann mit der Methode
 
 Um einen internen Link hinzuzufügen, der auf die zweite Seite verweist, nutzen wir die Methode
  [`add_link()`](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link), die einen anklickbaren Bereich erzeugt, 
- den wir "link" nennen und der auf eine andere Stelle innerhalb des Dokuments verweist. Auf der zweiten Seite verwenden wir
- [`set_link()`](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link), um den Zielbereich für den soeben erstellten Link zu definieren.
+ den wir "link" nennen und der auf eine andere Stelle innerhalb des Dokuments verweist.
 
 Um einen externen Link mit Hilfe eines Bildes zu erstellen, verwenden wir [`image()`](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image). Es besteht die Möglichkeit, der Methode ein Linkziel als eines ihrer Argumente zu übergeben. Der Link kann sowohl einer interner als auch ein externer sein.
 

docs/Tutorial-es.md

@@ -243,9 +243,7 @@ En la primera página del ejemplo usamos
 Para agregar un enlace interno apuntando a la segunda página, usamos el método
  [add_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link)
 , el cual crea un área clicable a la que nombramos "link" que redirige a
- otro lugar dentro del documento. En la segunda página usamos
- [set_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link)
- para definir el área de destino para el enlace que acabamos de crear.
+ otro lugar dentro del documento.
 
 Para crear un enlace externo usando una imagen, usamos
  [image()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image)

docs/Tutorial-fr.md

@@ -151,7 +151,7 @@ En revanche, son principal inconvénient est que nous ne pouvons pas justifier l
 
 Dans la première page de l'exemple, nous avons utilisé [write()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.write) à cette fin. Le début de la phrase est écrit en style normal, puis en utilisant la méthode [set_font()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_font), nous sommes passés au soulignement et avons terminé la phrase.
 
-Pour ajouter un lien interne pointant vers la deuxième page, nous avons utilisé la méthode [add_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link), qui crée une zone cliquable que nous avons nommée `link` et qui dirige vers un autre endroit du document. Sur la deuxième page, nous avons utilisé [set_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link) pour définir la zone de destination du lien que nous venons de créer.
+Pour ajouter un lien interne pointant vers la deuxième page, nous avons utilisé la méthode [add_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link), qui crée une zone cliquable que nous avons nommée `link` et qui dirige vers une autre page du document.
 
 Pour créer le lien externe à l'aide d'une image, nous avons utilisé [image()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image). Cette méthode a la possibilité de transmettre un lien comme l'un de ses arguments. Le lien peut être interne ou externe.
 

docs/Tutorial-gr.md

@@ -155,9 +155,7 @@ pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')
 Στην πρώτη σελίδα του παραδείγματος χρησιμοποιήσαμε την μέθοδο [write()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.write) για αυτό το σκοπό. Το πρώτο κομμάτι της πρότασης είναι γραμμένο ως απλό κείμενο, ενώ στη συνέχεια, αφού χρησιμοποιήσαμε την μέθοδο [set_font()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_font), αλλάξαμε το στυλ κειμένου σε υπογράμμιση και κλείσαμε την πρόταση.
 
 Για να προσθέσουμε έναν εσωτερικό σύνδεσμο ο οποίος θα κατευθύνει στην επόμενη σελίδα, χρησιμοποιήσαμε την μέθοδο 
- [add_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link), η οποία δημιουργεί μία επιφανεία με όνομα "link". Αν κλικάρουμε την επιφάνεια αυτή μεταφερόμαστε σε μία άλλη τοποθεσία του αρχείου. Στην δεύτερη σελίδα χρησιμοποιήσαμε την μέθοδο
- [set_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link)
- για να ορίσουμε τον προορισμό του συνδέσμου που μόλις δημιουργήσαμε.
+ [add_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link), η οποία δημιουργεί μία επιφανεία με όνομα "link". Αν κλικάρουμε την επιφάνεια αυτή μεταφερόμαστε σε μία άλλη τοποθεσία του αρχείου.
 
 Για να δημιουργήσουμε έναν εξωτερικό σύνδεσμο μέσω μιας εικόνας, θα χρησιμοποιήσουμε την μέθοδο [image()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image). Αυτή η μέθοδος μας δίνει την επιλογή να περάσουμε έναν σύνδεσμο ως τιμή σε μία από τις παραμέτρους της. Ο σύνδεσμος μπορεί να είναι εσωτερικός ή εξωτερικός.
 

docs/Tutorial-he.md

@@ -153,7 +153,7 @@ pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')
 
 בעמוד הראשון של הדוגמא השתמשנו [()write](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.write) למטרה זו. תחילת המשפט נכתב בסגנון טקסט רגיל ואז על ידי שימוש במתודה [()set_font](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_font) החלפנו לטקסט עם קו תחתון לסיום המשפט.
 
-כדי להוסיף קישור פנימי שמוביל לעמוד השני השתמשנו במתודה [()add_link](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link) שוצרת איזור ניתן להקלקה שנתנו לו את השם "קישור" שמוביל לאיזור אחר באותו המסמך. בעמוד השני השתמשנו ב[()set_link](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link) על מנת להגדיר את האיזור אליו הקישור שיצרנו מוביל.
+כדי להוסיף קישור פנימי שמוביל לעמוד השני השתמשנו במתודה [()add_link](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link) שוצרת איזור ניתן להקלקה שנתנו לו את השם "קישור" שמוביל לאיזור אחר באותו המסמך.
 
 על מנת ליצור קישור חיצני באמצעות תמונה, השתמשנו במתודה [()image](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image). למתודה יש אופציה לקבל קישור כאחד הפרמטרים שלה. הקישור יכול להיות פנימי או חיצוני.
 

docs/Tutorial-it.md

@@ -183,9 +183,7 @@ Nella prima pagina dell'esempio, abbiamo usato
 
 Per aggiungere un link interno che puntasse alla seconda pagina, abbiamo utilizzato 
  [add_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.add_link)
-che crea un area cliccabile che abbiamo chiamato "link"  che redirige ad un altro punto del documento. Nella seconda pagina abbiamo usato
- [set_link()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link)
- per definire un'area di destinazione per il link creato in precedenza.
+che crea un area cliccabile che abbiamo chiamato "link"  che redirige ad un altro punto del documento.
 
 Per creare un link esterno utilizzando un'immagine, abbiamo usato
  [image()](https://pyfpdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.image)