xhtml2pdf 0.2.24__tar.gz → 0.2.26__tar.gz

{xhtml2pdf-0.2.24/xhtml2pdf.egg-info → xhtml2pdf-0.2.26}/PKG-INFO

@@ -1,218 +1,15 @@
 Metadata-Version: 2.4
 Name: xhtml2pdf
-Version: 0.2.24
+Version: 0.2.26
 Summary: PDF generator using HTML and CSS
 Author-email: Dirk Holtwick <dirk.holtwick@gmail.com>
 Maintainer-email: Luis Zarate <luisza14@gmail.com>, Timo Brembeck <opensource@timo.brembeck.email>
-License: 
-                                         Apache License
-                                   Version 2.0, January 2004
-                                http://www.apache.org/licenses/
-        
-           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-        
-           1. Definitions.
-        
-              "License" shall mean the terms and conditions for use, reproduction,
-              and distribution as defined by Sections 1 through 9 of this document.
-        
-              "Licensor" shall mean the copyright owner or entity authorized by
-              the copyright owner that is granting the License.
-        
-              "Legal Entity" shall mean the union of the acting entity and all
-              other entities that control, are controlled by, or are under common
-              control with that entity. For the purposes of this definition,
-              "control" means (i) the power, direct or indirect, to cause the
-              direction or management of such entity, whether by contract or
-              otherwise, or (ii) ownership of fifty percent (50%) or more of the
-              outstanding shares, or (iii) beneficial ownership of such entity.
-        
-              "You" (or "Your") shall mean an individual or Legal Entity
-              exercising permissions granted by this License.
-        
-              "Source" form shall mean the preferred form for making modifications,
-              including but not limited to software source code, documentation
-              source, and configuration files.
-        
-              "Object" form shall mean any form resulting from mechanical
-              transformation or translation of a Source form, including but
-              not limited to compiled object code, generated documentation,
-              and conversions to other media types.
-        
-              "Work" shall mean the work of authorship, whether in Source or
-              Object form, made available under the License, as indicated by a
-              copyright notice that is included in or attached to the work
-              (an example is provided in the Appendix below).
-        
-              "Derivative Works" shall mean any work, whether in Source or Object
-              form, that is based on (or derived from) the Work and for which the
-              editorial revisions, annotations, elaborations, or other modifications
-              represent, as a whole, an original work of authorship. For the purposes
-              of this License, Derivative Works shall not include works that remain
-              separable from, or merely link (or bind by name) to the interfaces of,
-              the Work and Derivative Works thereof.
-        
-              "Contribution" shall mean any work of authorship, including
-              the original version of the Work and any modifications or additions
-              to that Work or Derivative Works thereof, that is intentionally
-              submitted to Licensor for inclusion in the Work by the copyright owner
-              or by an individual or Legal Entity authorized to submit on behalf of
-              the copyright owner. For the purposes of this definition, "submitted"
-              means any form of electronic, verbal, or written communication sent
-              to the Licensor or its representatives, including but not limited to
-              communication on electronic mailing lists, source code control systems,
-              and issue tracking systems that are managed by, or on behalf of, the
-              Licensor for the purpose of discussing and improving the Work, but
-              excluding communication that is conspicuously marked or otherwise
-              designated in writing by the copyright owner as "Not a Contribution."
-        
-              "Contributor" shall mean Licensor and any individual or Legal Entity
-              on behalf of whom a Contribution has been received by Licensor and
-              subsequently incorporated within the Work.
-        
-           2. Grant of Copyright License. Subject to the terms and conditions of
-              this License, each Contributor hereby grants to You a perpetual,
-              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-              copyright license to reproduce, prepare Derivative Works of,
-              publicly display, publicly perform, sublicense, and distribute the
-              Work and such Derivative Works in Source or Object form.
-        
-           3. Grant of Patent License. Subject to the terms and conditions of
-              this License, each Contributor hereby grants to You a perpetual,
-              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-              (except as stated in this section) patent license to make, have made,
-              use, offer to sell, sell, import, and otherwise transfer the Work,
-              where such license applies only to those patent claims licensable
-              by such Contributor that are necessarily infringed by their
-              Contribution(s) alone or by combination of their Contribution(s)
-              with the Work to which such Contribution(s) was submitted. If You
-              institute patent litigation against any entity (including a
-              cross-claim or counterclaim in a lawsuit) alleging that the Work
-              or a Contribution incorporated within the Work constitutes direct
-              or contributory patent infringement, then any patent licenses
-              granted to You under this License for that Work shall terminate
-              as of the date such litigation is filed.
-        
-           4. Redistribution. You may reproduce and distribute copies of the
-              Work or Derivative Works thereof in any medium, with or without
-              modifications, and in Source or Object form, provided that You
-              meet the following conditions:
-        
-              (a) You must give any other recipients of the Work or
-                  Derivative Works a copy of this License; and
-        
-              (b) You must cause any modified files to carry prominent notices
-                  stating that You changed the files; and
-        
-              (c) You must retain, in the Source form of any Derivative Works
-                  that You distribute, all copyright, patent, trademark, and
-                  attribution notices from the Source form of the Work,
-                  excluding those notices that do not pertain to any part of
-                  the Derivative Works; and
-        
-              (d) If the Work includes a "NOTICE" text file as part of its
-                  distribution, then any Derivative Works that You distribute must
-                  include a readable copy of the attribution notices contained
-                  within such NOTICE file, excluding those notices that do not
-                  pertain to any part of the Derivative Works, in at least one
-                  of the following places: within a NOTICE text file distributed
-                  as part of the Derivative Works; within the Source form or
-                  documentation, if provided along with the Derivative Works; or,
-                  within a display generated by the Derivative Works, if and
-                  wherever such third-party notices normally appear. The contents
-                  of the NOTICE file are for informational purposes only and
-                  do not modify the License. You may add Your own attribution
-                  notices within Derivative Works that You distribute, alongside
-                  or as an addendum to the NOTICE text from the Work, provided
-                  that such additional attribution notices cannot be construed
-                  as modifying the License.
-        
-              You may add Your own copyright statement to Your modifications and
-              may provide additional or different license terms and conditions
-              for use, reproduction, or distribution of Your modifications, or
-              for any such Derivative Works as a whole, provided Your use,
-              reproduction, and distribution of the Work otherwise complies with
-              the conditions stated in this License.
-        
-           5. Submission of Contributions. Unless You explicitly state otherwise,
-              any Contribution intentionally submitted for inclusion in the Work
-              by You to the Licensor shall be under the terms and conditions of
-              this License, without any additional terms or conditions.
-              Notwithstanding the above, nothing herein shall supersede or modify
-              the terms of any separate license agreement you may have executed
-              with Licensor regarding such Contributions.
-        
-           6. Trademarks. This License does not grant permission to use the trade
-              names, trademarks, service marks, or product names of the Licensor,
-              except as required for reasonable and customary use in describing the
-              origin of the Work and reproducing the content of the NOTICE file.
-        
-           7. Disclaimer of Warranty. Unless required by applicable law or
-              agreed to in writing, Licensor provides the Work (and each
-              Contributor provides its Contributions) on an "AS IS" BASIS,
-              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-              implied, including, without limitation, any warranties or conditions
-              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-              PARTICULAR PURPOSE. You are solely responsible for determining the
-              appropriateness of using or redistributing the Work and assume any
-              risks associated with Your exercise of permissions under this License.
-        
-           8. Limitation of Liability. In no event and under no legal theory,
-              whether in tort (including negligence), contract, or otherwise,
-              unless required by applicable law (such as deliberate and grossly
-              negligent acts) or agreed to in writing, shall any Contributor be
-              liable to You for damages, including any direct, indirect, special,
-              incidental, or consequential damages of any character arising as a
-              result of this License or out of the use or inability to use the
-              Work (including but not limited to damages for loss of goodwill,
-              work stoppage, computer failure or malfunction, or any and all
-              other commercial damages or losses), even if such Contributor
-              has been advised of the possibility of such damages.
-        
-           9. Accepting Warranty or Additional Liability. While redistributing
-              the Work or Derivative Works thereof, You may choose to offer,
-              and charge a fee for, acceptance of support, warranty, indemnity,
-              or other liability obligations and/or rights consistent with this
-              License. However, in accepting such obligations, You may act only
-              on Your own behalf and on Your sole responsibility, not on behalf
-              of any other Contributor, and only if You agree to indemnify,
-              defend, and hold each Contributor harmless for any liability
-              incurred by, or claims asserted against, such Contributor by reason
-              of your accepting any such warranty or additional liability.
-        
-           END OF TERMS AND CONDITIONS
-        
-           APPENDIX: How to apply the Apache License to your work.
-        
-              To apply the Apache License to your work, attach the following
-              boilerplate notice, with the fields enclosed by brackets "[]"
-              replaced with your own identifying information. (Don't include
-              the brackets!)  The text should be enclosed in the appropriate
-              comment syntax for the file format. We also recommend that a
-              file or class name and description of purpose be included on the
-              same "printed page" as the copyright notice for easier
-              identification within third-party archives.
-        
-           Copyright [yyyy] [name of copyright owner]
-        
-           Licensed under the Apache License, Version 2.0 (the "License");
-           you may not use this file except in compliance with the License.
-           You may obtain a copy of the License at
-        
-               http://www.apache.org/licenses/LICENSE-2.0
-        
-           Unless required by applicable law or agreed to in writing, software
-           distributed under the License is distributed on an "AS IS" BASIS,
-           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-           See the License for the specific language governing permissions and
-           limitations under the License.
-        
+License-Expression: Apache-2.0
 Project-URL: Repository, https://github.com/xhtml2pdf/xhtml2pdf
 Project-URL: Bug tracker, https://github.com/xhtml2pdf/xhtml2pdf/issues
 Project-URL: Documentation, https://xhtml2pdf.readthedocs.io/
 Project-URL: Changelog, https://xhtml2pdf.readthedocs.io/en/latest/release-notes.html
 Keywords: PDF,HTML,HTML,XML,CSS
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Environment :: Other Environment
@@ -242,20 +39,23 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-License-File: AUTHORS.rst
 Requires-Dist: arabic-reshaper>=3.0.0
 Requires-Dist: html5lib>=1.1
 Requires-Dist: Pillow>=8.1.1
-Requires-Dist: pyHanko>=0.37.0
-Requires-Dist: pyhanko-certvalidator>=0.32.1
 Requires-Dist: pypdf>=3.1.0
 Requires-Dist: reportlab<6,>=4.4.9
 Requires-Dist: svglib>=1.2.1
+Provides-Extra: signing
+Requires-Dist: pyHanko>=0.37.0; extra == "signing"
+Requires-Dist: pyhanko-certvalidator>=0.32.1; extra == "signing"
+Provides-Extra: all
+Requires-Dist: xhtml2pdf[signing]; extra == "all"
 Provides-Extra: pycairo
 Requires-Dist: reportlab[pycairo]<6,>=4.4.9; extra == "pycairo"
 Provides-Extra: renderpm
 Requires-Dist: xhtml2pdf[pycairo]; extra == "renderpm"
 Provides-Extra: test
+Requires-Dist: xhtml2pdf[signing]; extra == "test"
 Requires-Dist: tomli>=2.0.1; python_version < "3.11" and extra == "test"
 Requires-Dist: tox; extra == "test"
 Requires-Dist: coverage>=5.3; extra == "test"
@@ -360,7 +160,7 @@ Quick start
 
 .. code:: bash
 
-    pip install xhtml2pdf
+    pip install xhtml2pdf[all]
 
 .. code:: python
 
@@ -462,10 +262,13 @@ Installation
 
 .. code:: bash
 
-    pip install xhtml2pdf
+    pip install xhtml2pdf[all]
 
 Python 3.10 and newer is tested and supported. Every mandatory requirement is
-listed in ``pyproject.toml`` and installed with xhtml2pdf.
+listed in ``pyproject.toml`` and installed with xhtml2pdf; ``all`` adds the
+optional ones: pyHanko, for digital signatures, which is also the
+``signing`` extra on its own. ``pip install xhtml2pdf`` leaves it out:
+asking for a signature then raises an ``ImportError`` that names the extra.
 
 ReportLab needs a rendering backend to turn vector graphics into bitmaps (for
 charts and SVG rasterised into the page). The supported one is `cairo

{xhtml2pdf-0.2.24 → xhtml2pdf-0.2.26}/README.rst

@@ -86,7 +86,7 @@ Quick start
 
 .. code:: bash
 
-    pip install xhtml2pdf
+    pip install xhtml2pdf[all]
 
 .. code:: python
 
@@ -188,10 +188,13 @@ Installation
 
 .. code:: bash
 
-    pip install xhtml2pdf
+    pip install xhtml2pdf[all]
 
 Python 3.10 and newer is tested and supported. Every mandatory requirement is
-listed in ``pyproject.toml`` and installed with xhtml2pdf.
+listed in ``pyproject.toml`` and installed with xhtml2pdf; ``all`` adds the
+optional ones: pyHanko, for digital signatures, which is also the
+``signing`` extra on its own. ``pip install xhtml2pdf`` leaves it out:
+asking for a signature then raises an ``ImportError`` that names the extra.
 
 ReportLab needs a rendering backend to turn vector graphics into bitmaps (for
 charts and SVG rasterised into the page). The supported one is `cairo

{xhtml2pdf-0.2.24 → xhtml2pdf-0.2.26}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 
@@ -15,9 +15,9 @@ maintainers = [
 description = "PDF generator using HTML and CSS"
 keywords = ["PDF", "HTML", "HTML", "XML", "CSS"]
 readme = "README.rst"
-license = {file = "LICENSE.txt"}
+license = "Apache-2.0"
+license-files = ["LICENSE.txt"]
 classifiers = [
-    "License :: OSI Approved :: Apache Software License",
     "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Environment :: Other Environment",
@@ -50,11 +50,9 @@ dependencies = [
     "arabic-reshaper>=3.0.0",
     "html5lib>=1.1",
     "Pillow>=8.1.1",
-    "pyHanko>=0.37.0",
-    "pyhanko-certvalidator>=0.32.1",
     "pypdf>=3.1.0",
     "reportlab>=4.4.9,<6",
-    "svglib>=1.2.1"
+    "svglib>=1.2.1",
 ]
 dynamic = ["version"]
 
@@ -65,6 +63,15 @@ Documentation = "https://xhtml2pdf.readthedocs.io/"
 Changelog = "https://xhtml2pdf.readthedocs.io/en/latest/release-notes.html"
 
 [project.optional-dependencies]
+# Digital signatures (the `signature` argument and the CLI's signing options).
+signing = [
+    "pyHanko>=0.37.0",
+    "pyhanko-certvalidator>=0.32.1",
+]
+# Every optional feature that needs nothing outside Python.
+all = [
+    "xhtml2pdf[signing]",
+]
 pycairo = [
     "reportlab[pycairo]>=4.4.9,<6",
 ]
@@ -76,6 +83,7 @@ renderpm = [
     "xhtml2pdf[pycairo]",
 ]
 test = [
+    "xhtml2pdf[signing]",
     "tomli>=2.0.1; python_version<'3.11'",
     "tox",
     "coverage>=5.3"
@@ -115,6 +123,7 @@ legacy_tox_ini = """
     envlist = py{3.10,3.11,3.12,3.13,3.14}-rl{4,5}, py3.10-rlmin
 
     [testenv]
+    extras = signing
     deps =
         coverage[toml]
         rl4: reportlab>=4.4.9,<5

xhtml2pdf-0.2.26/tests/test_block_margins.py

@@ -0,0 +1,88 @@
+"""
+The vertical margins of a block without padding, a border or a background.
+
+Such a block draws nothing of its own: its top margin goes above the first
+thing it holds and its bottom margin below the last, each collapsing with
+the margin of that child and of the blocks around it, the larger one
+winning (CSS 2.1, 8.3.1).
+"""
+
+from io import BytesIO
+from unittest import TestCase
+
+from pypdf import PdfReader
+
+from xhtml2pdf import pisa
+
+#: Every line is this tall, so a gap between two baselines minus it is the
+#: margin between their blocks.
+LINE = 15.0
+
+
+def baselines(body: str) -> dict[str, float]:
+    """The baseline of each run of text, by its text, down from the top."""
+    html = (
+        "<html><head><style>body { font-size: 11pt; line-height: 15pt }"
+        " p { margin: 0 }</style></head><body>" + body + "</body></html>"
+    )
+    output = BytesIO()
+    result = pisa.CreatePDF(html, dest=output)
+    assert not result.err
+    found: dict[str, float] = {}
+
+    def visit(text, cm, tm, _font, _size) -> None:
+        if text.strip():
+            found[text.strip()] = -(tm[4] * cm[1] + tm[5] * cm[3] + cm[5])
+
+    PdfReader(BytesIO(output.getvalue())).pages[0].extract_text(visitor_text=visit)
+    return found
+
+
+class BlockMarginTest(TestCase):
+    @staticmethod
+    def gap(lines: dict[str, float], above: str, below: str) -> float:
+        return round(lines[below] - lines[above] - LINE, 1)
+
+    def test_the_margins_of_a_block_around_a_paragraph_without_margins(self) -> None:
+        lines = baselines(
+            "<div style='margin-bottom: 1in'><p>first</p></div>"
+            "<p>second</p>"
+            "<div style='margin-top: 1in'><p>third</p></div>"
+        )
+        self.assertEqual(72, self.gap(lines, "first", "second"))
+        self.assertEqual(72, self.gap(lines, "second", "third"))
+
+    def test_nested_top_margins_collapse_to_the_largest(self) -> None:
+        lines = baselines(
+            "<p>before</p>"
+            "<div style='margin-top: 20pt'><div style='margin-top: 10pt'>"
+            "<p style='margin-top: 5pt'>inside</p></div></div>"
+        )
+        self.assertEqual(20, self.gap(lines, "before", "inside"))
+
+    def test_a_last_child_margin_larger_than_its_block_wins(self) -> None:
+        lines = baselines(
+            "<div style='margin-bottom: 30pt'><p style='margin-bottom: 40pt'>last</p>"
+            "</div><p>after</p>"
+        )
+        self.assertEqual(40, self.gap(lines, "last", "after"))
+
+    def test_the_text_of_a_block_takes_its_margins_once(self) -> None:
+        lines = baselines(
+            "<p>start</p>"
+            "<div style='margin: 30pt 0 40pt 0'>leading"
+            "<p style='margin: 5pt 0'>inner</p>trailing</div>"
+            "<p>end</p>"
+        )
+        self.assertEqual(30, self.gap(lines, "start", "leading"))
+        self.assertEqual(5, self.gap(lines, "leading", "inner"))
+        self.assertEqual(5, self.gap(lines, "inner", "trailing"))
+        self.assertEqual(40, self.gap(lines, "trailing", "end"))
+
+    def test_a_child_does_not_inherit_the_margins_of_its_block(self) -> None:
+        lines = baselines(
+            "<div style='margin-bottom: 20pt'><div><p>one</p></div>"
+            "<div><p>two</p></div></div><p>after</p>"
+        )
+        self.assertEqual(0, self.gap(lines, "one", "two"))
+        self.assertEqual(20, self.gap(lines, "two", "after"))

xhtml2pdf-0.2.26/tests/test_block_width.py

@@ -0,0 +1,86 @@
+"""
+The CSS width of a <div>, a <p> or any other block.
+
+It is the width of the block's content box, a length or a share of the
+block that contains it. An auto margin takes what the box leaves of the
+line, so margin: 0 auto centres the block.
+"""
+
+from io import BytesIO
+from unittest import TestCase
+
+from pypdf import PdfReader
+from reportlab.pdfgen.canvas import Canvas
+
+from xhtml2pdf import pisa
+from xhtml2pdf.builders.block import BlockBox
+from xhtml2pdf.document import pisaStory
+
+AVAIL = 500.0
+TEXT = " ".join(f"word{n}" for n in range(60))
+
+
+def box(html: str) -> BlockBox:
+    """The block box the HTML makes, laid out AVAIL points wide."""
+    context = pisaStory(html)
+    assert context.err == 0
+    (found,) = [f for f in context.story if isinstance(f, BlockBox)]
+    found.wrapOn(Canvas(BytesIO()), AVAIL, 10000)
+    return found
+
+
+class BlockWidthTest(TestCase):
+    def test_a_percentage_of_the_containing_block(self) -> None:
+        found = box(f"<div style='width: 50%'>{TEXT}</div>")
+        self.assertAlmostEqual(250, found._inner)
+        self.assertAlmostEqual(0, found._left)
+
+    def test_a_length(self) -> None:
+        found = box(f"<p style='width: 200pt'>{TEXT}</p>")
+        self.assertAlmostEqual(200, found._inner)
+
+    def test_the_width_is_the_content_box(self) -> None:
+        found = box(
+            f"<div style='width: 200pt; padding: 10pt; border: 2pt solid'>{TEXT}</div>"
+        )
+        self.assertAlmostEqual(200, found._inner)
+        self.assertAlmostEqual(AVAIL - 224, found._right)
+
+    def test_auto_margins_centre_it(self) -> None:
+        found = box(f"<div style='width: 300pt; margin: 0 auto'>{TEXT}</div>")
+        self.assertAlmostEqual(100, found._left)
+        self.assertAlmostEqual(100, found._right)
+
+    def test_an_auto_left_margin_puts_it_on_the_right(self) -> None:
+        found = box(f"<div style='width: 300pt; margin-left: auto'>{TEXT}</div>")
+        self.assertAlmostEqual(200, found._left)
+
+    def test_a_percentage_is_of_the_block_not_of_what_its_margin_leaves(self) -> None:
+        found = box(f"<div style='width: 50%; margin-left: 20pt'>{TEXT}</div>")
+        self.assertAlmostEqual(20, found._left)
+        self.assertAlmostEqual(250, found._inner)
+
+    def test_a_width_wider_than_the_line_is_held_to_it(self) -> None:
+        found = box(f"<div style='width: 900pt'>{TEXT}</div>")
+        self.assertAlmostEqual(AVAIL, found._inner)
+
+    def test_the_text_wraps_at_the_width(self) -> None:
+        def lines(style: str) -> int:
+            output = BytesIO()
+            result = pisa.CreatePDF(
+                f"<html><body><div style='{style}'>{TEXT}</div></body></html>",
+                dest=output,
+            )
+            self.assertEqual(0, result.err)
+            heights: set[float] = set()
+
+            def visit(text, cm, tm, _font, _size) -> None:
+                if text.strip():
+                    heights.add(round(tm[5] * cm[3] + cm[5], 1))
+
+            PdfReader(BytesIO(output.getvalue())).pages[0].extract_text(
+                visitor_text=visit
+            )
+            return len(heights)
+
+        self.assertGreater(lines("width: 40%"), 2 * lines(""))

{xhtml2pdf-0.2.24 → xhtml2pdf-0.2.26}/tests/test_flex.py

@@ -13,6 +13,7 @@ from unittest import TestCase
 from pypdf import PdfReader
 
 from xhtml2pdf import pisa
+from xhtml2pdf.builders.block import BlockBox
 from xhtml2pdf.builders.flex import FlexContainer
 from xhtml2pdf.document import pisaStory
 from xhtml2pdf.xhtml2pdf_reportlab import PmlParagraph, PmlTable
@@ -155,10 +156,13 @@ class FlexPropertiesTest(TestCase):
         self.assertEqual(("length", 12.0), second.height)
 
     def test_a_block_does_not_hand_its_width_to_what_is_inside_it(self) -> None:
-        container = _container(
+        # The block's width makes it a box, with the container inside.
+        context = pisaStory(
             "<div style='width: 300pt'><div style='display:flex'>"
             "<div>a</div></div></div>"
         )
+        (box,) = [f for f in context.story if isinstance(f, BlockBox)]
+        (container,) = [f for f in box.content if isinstance(f, FlexContainer)]
         self.assertEqual("auto", container.css_width.kind)
         self.assertEqual("auto", container.items[0].width.kind)
 

xhtml2pdf-0.2.26/tests/test_font_isolation.py

@@ -0,0 +1,90 @@
+"""
+Each document draws with the fonts it declares, whatever others in the
+process declare.
+
+Two documents may name a font-family the same and embed different files,
+one after the other or at the same time in different threads: each gets
+its own files, regular, bold and italic.
+"""
+
+import hashlib
+import io
+import threading
+from pathlib import Path
+from unittest import TestCase
+
+from pypdf import PdfReader
+
+from xhtml2pdf import pisa
+from xhtml2pdf.config.resources import ResourceAccessPolicy
+
+FONTS = Path(__file__).parent / "samples" / "font"
+NOTO = {
+    ("normal", "normal"): FONTS / "Noto_Sans" / "NotoSans-Regular.ttf",
+    ("bold", "normal"): FONTS / "Noto_Sans" / "NotoSans-Bold.ttf",
+    ("normal", "italic"): FONTS / "Noto_Sans" / "NotoSans-Italic.ttf",
+}
+MARKAZI = {
+    ("normal", "normal"): FONTS / "Arabic_font" / "MarkaziText-Regular.ttf",
+    ("bold", "normal"): FONTS / "Arabic_font" / "MarkaziText-Bold.ttf",
+}
+POLICY = ResourceAccessPolicy(allow_local_outside_base=True)
+
+
+def render(faces: dict) -> set[tuple[str, str]]:
+    """The embedded fonts of the document: (name, digest of the file)."""
+    css = "".join(
+        f"@font-face {{ font-family: Shared; font-weight: {weight};"
+        f' font-style: {style}; src: url("{path}"); }}'
+        for (weight, style), path in faces.items()
+    )
+    html = (
+        f"<html><head><style>{css} body {{ font-family: Shared }}</style></head>"
+        "<body><p>plain <b>bold</b> <i>italic</i></p></body></html>"
+    )
+    output = io.BytesIO()
+    result = pisa.CreatePDF(html, dest=output, resource_policy=POLICY)
+    assert not result.err
+    embedded = set()
+    for page in PdfReader(io.BytesIO(output.getvalue())).pages:
+        for font in page["/Resources"]["/Font"].values():
+            font = font.get_object()
+            descriptor = font.get("/FontDescriptor")
+            if descriptor is None:
+                continue
+            data = descriptor.get_object()["/FontFile2"].get_object().get_data()
+            name = str(font["/BaseFont"]).split("+")[-1]
+            embedded.add((name, hashlib.md5(data).hexdigest()))
+    return embedded
+
+
+class FontIsolationTest(TestCase):
+    def test_a_second_document_embeds_its_own_file_for_the_same_family(self) -> None:
+        noto = render(NOTO)
+        markazi = render(MARKAZI)
+        self.assertEqual(
+            {"NotoSans", "NotoSans-Bold", "NotoSans-Italic"}, {name for name, _ in noto}
+        )
+        self.assertEqual(
+            {"MarkaziText-Regular", "MarkaziText-Bold"}, {name for name, _ in markazi}
+        )
+
+    def test_documents_rendered_at_once_in_threads_keep_their_fonts(self) -> None:
+        expected = {"noto": render(NOTO), "markazi": render(MARKAZI)}
+        found: list[tuple[str, set]] = []
+
+        def work(kind: str) -> None:
+            faces = NOTO if kind == "noto" else MARKAZI
+            found.extend((kind, render(faces)) for _ in range(3))
+
+        threads = [
+            threading.Thread(target=work, args=("noto" if n % 2 else "markazi",))
+            for n in range(6)
+        ]
+        for thread in threads:
+            thread.start()
+        for thread in threads:
+            thread.join()
+        self.assertEqual(18, len(found))
+        for kind, embedded in found:
+            self.assertEqual(expected[kind], embedded, kind)