PyPDFForm 1.3.1__tar.gz → 1.3.3__tar.gz

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.3.1
+Version: 1.3.3
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -81,10 +81,6 @@ and it should look like [this](https://github.com/chinapandaman/PyPDFForm/raw/ma
 
 ## How to Contribute
 
-If you wish to improve this library, there is one specific way you can contribute 
-on top of the usual open source project norms such as issues and pull requests.
-
 It is difficult to make sure that the library supports all the PDF form creating tools out 
-there. So if you run into a case where the library does not work for certain PDF forms created by 
-certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
+there. So if you run into a case where the library does not work for certain PDF forms created by certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
 to make the library support the attached PDF form as well as the tool used to create it.

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/__init__.py

@@ -5,4 +5,4 @@ from .wrapper import Wrapper
 
 PyPDFForm = Wrapper
 
-__version__ = "1.3.1"
+__version__ = "1.3.3"

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/core/constants.py

@@ -17,5 +17,12 @@ TEXT_FIELD_ALIGNMENT_IDENTIFIER = "/Q"
 CHOICE_FIELD_IDENTIFIER = "/Ch"
 CHOICES_IDENTIFIER = "/Opt"
 
+FONT_SIZE_IDENTIFIER = "Tf"
+FONT_COLOR_IDENTIFIER = " rg"
+DEFAULT_FONT = "Helvetica"
+DEFAULT_FONT_SIZE = 12
+DEFAULT_FONT_COLOR = (0, 0, 0)
+PREVIEW_FONT_COLOR = (1, 0, 0)
+
 CHECKBOX_TO_DRAW = "\u2713"
 RADIO_TO_DRAW = "\u25CF"

PyPDFForm-1.3.3/PyPDFForm/core/font.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+"""Contains helpers for font."""
+
+import re
+from io import BytesIO
+
+import pdfrw
+from reportlab.pdfbase import pdfmetrics
+from reportlab.pdfbase.ttfonts import TTFError, TTFont
+
+from . import constants
+from .patterns import TEXT_FIELD_APPEARANCE_PATTERNS
+from .template import traverse_pattern
+
+
+def register_font(font_name: str, ttf_stream: bytes) -> bool:
+    """Registers a font from a ttf file stream."""
+
+    buff = BytesIO()
+    buff.write(ttf_stream)
+    buff.seek(0)
+
+    try:
+        pdfmetrics.registerFont(TTFont(name=font_name, filename=buff))
+        result = True
+    except TTFError:
+        result = False
+
+    buff.close()
+    return result
+
+
+def auto_detect_font(element: pdfrw.PdfDict) -> str:
+    """Returns the font of the text field if it is one of the standard fonts."""
+
+    result = constants.DEFAULT_FONT
+
+    for pattern in TEXT_FIELD_APPEARANCE_PATTERNS:
+        text_appearance = traverse_pattern(pattern, element)
+
+        if text_appearance:
+            text_appearance = (
+                text_appearance.replace("(", "").replace(")", "").split(" ")
+            )
+
+            for each in text_appearance:
+                if each.startswith("/"):
+                    text_segments = re.findall("[A-Z][^A-Z]*", each.replace("/", ""))
+
+                    for font in pdfmetrics.standardFonts:
+                        font_segments = re.findall(
+                            "[A-Z][^A-Z]*", font.replace("-", "")
+                        )
+                        if len(font_segments) != len(text_segments):
+                            continue
+
+                        found = True
+                        for i, val in enumerate(font_segments):
+                            if not val.startswith(text_segments[i]):
+                                found = False
+
+                        if found:
+                            return font
+
+    return result

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/core/font_size.py

@@ -6,8 +6,8 @@ from typing import Union
 
 import pdfrw
 
-from ..middleware.constants import GLOBAL_FONT_SIZE
 from . import constants, template
+from .constants import DEFAULT_FONT_SIZE
 
 
 def text_field_font_size(element: pdfrw.PdfDict) -> Union[float, int]:
@@ -17,7 +17,7 @@ def text_field_font_size(element: pdfrw.PdfDict) -> Union[float, int]:
     """
 
     if template.is_text_multiline(element):
-        return GLOBAL_FONT_SIZE
+        return DEFAULT_FONT_SIZE
 
     height = abs(
         float(element[constants.ANNOTATION_RECTANGLE_KEY][1])

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/core/template.py

@@ -148,13 +148,38 @@ def get_text_field_font_size(element: pdfrw.PdfDict) -> Union[float, int]:
     for pattern in TEXT_FIELD_APPEARANCE_PATTERNS:
         text_appearance = traverse_pattern(pattern, element)
         if text_appearance:
+            text_appearance = text_appearance.replace("(", "").replace(")", "")
             properties = text_appearance.split(" ")
-            if len(properties) > 1:
-                try:
-                    result = float(properties[1])
+            for i, val in enumerate(properties):
+                if val == constants.FONT_SIZE_IDENTIFIER:
+                    return float(properties[i - 1])
+
+    return result
+
+
+def get_text_field_font_color(
+    element: pdfrw.PdfDict,
+) -> Union[Tuple[float, float, float], None]:
+    """Returns the font color tuple of the text field if presented or black."""
+
+    result = (0, 0, 0)
+    for pattern in TEXT_FIELD_APPEARANCE_PATTERNS:
+        text_appearance = traverse_pattern(pattern, element)
+        if text_appearance:
+            if constants.FONT_COLOR_IDENTIFIER not in text_appearance:
+                return result
+
+            text_appearance = (
+                text_appearance.replace("(", "").replace(")", "").split(" ")
+            )
+            for i, val in enumerate(text_appearance):
+                if val == constants.FONT_COLOR_IDENTIFIER.replace(" ", ""):
+                    result = (
+                        float(text_appearance[i - 3]),
+                        float(text_appearance[i - 2]),
+                        float(text_appearance[i - 1]),
+                    )
                     break
-                except ValueError:
-                    pass
 
     return result
 
@@ -251,6 +276,12 @@ def get_draw_text_coordinates(
 ) -> Tuple[Union[float, int], Union[float, int]]:
     """Returns coordinates to draw text at given a PDF form text element."""
 
+    if element_middleware.preview:
+        return (
+            float(element[constants.ANNOTATION_RECTANGLE_KEY][0]),
+            float(element[constants.ANNOTATION_RECTANGLE_KEY][3]) + 5,
+        )
+
     element_value = element_middleware.value or ""
     length = (
         min(len(element_value), element_middleware.max_length)

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/core/utils.py

@@ -12,6 +12,7 @@ from ..middleware.constants import ELEMENT_TYPES
 from ..middleware.radio import Radio
 from ..middleware.text import Text
 from . import constants
+from . import font as font_core
 from . import font_size as font_size_core
 from . import template
 
@@ -43,10 +44,16 @@ def update_text_field_attributes(
             key = template.get_element_key(_element)
 
             if isinstance(elements[key], Text):
+                if elements[key].font is None:
+                    elements[key].font = font_core.auto_detect_font(_element)
                 if elements[key].font_size is None:
                     elements[key].font_size = template.get_text_field_font_size(
                         _element
                     ) or font_size_core.text_field_font_size(_element)
+                if elements[key].font_color is None:
+                    elements[key].font_color = template.get_text_field_font_color(
+                        _element
+                    )
                 if (
                     template.is_text_multiline(_element)
                     and elements[key].text_wrap_length is None
@@ -135,9 +142,9 @@ def checkbox_radio_to_draw(
         element_name=element.name,
         element_value="",
     )
-    new_element.font = "Helvetica"
+    new_element.font = constants.DEFAULT_FONT
     new_element.font_size = font_size
-    new_element.font_color = (0, 0, 0)
+    new_element.font_color = constants.DEFAULT_FONT_COLOR
 
     if isinstance(element, Checkbox):
         new_element.value = constants.CHECKBOX_TO_DRAW
@@ -147,6 +154,21 @@ def checkbox_radio_to_draw(
     return new_element
 
 
+def preview_element_to_draw(element: ELEMENT_TYPES) -> Text:
+    """Converts an element to a preview text element."""
+
+    new_element = Text(
+        element_name=element.name,
+        element_value="{" + f" {element.name} " + "}",
+    )
+    new_element.font = constants.DEFAULT_FONT
+    new_element.font_size = constants.DEFAULT_FONT_SIZE
+    new_element.font_color = constants.PREVIEW_FONT_COLOR
+    new_element.preview = True
+
+    return new_element
+
+
 def remove_all_elements(pdf: bytes) -> bytes:
     """Removes all elements from a pdfrw parsed PDF form."""
 

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/checkbox.py

@@ -21,3 +21,9 @@ class Checkbox(Element):
         """Json schema definition of the checkbox."""
 
         return {"type": "boolean"}
+
+    @property
+    def sample_value(self) -> bool:
+        """Sample value of the checkbox."""
+
+        return True

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/constants.py

@@ -8,10 +8,6 @@ from .dropdown import Dropdown
 from .radio import Radio
 from .text import Text
 
-GLOBAL_FONT = "Helvetica"
-GLOBAL_FONT_SIZE = 12
-GLOBAL_FONT_COLOR = (0, 0, 0)
-
 VERSION_IDENTIFIERS = [
     b"%PDF-1.0",
     b"%PDF-1.1",

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/dropdown.py

@@ -23,3 +23,9 @@ class Dropdown(Element):
         """Json schema definition of the dropdown."""
 
         return {"type": "integer", "maximum": len(self.choices) - 1}
+
+    @property
+    def sample_value(self) -> int:
+        """Sample value of the dropdown."""
+
+        return 0

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/element.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Contains element middleware."""
 
-from typing import Union
+from typing import Any, Union
 
 
 class Element:
@@ -28,3 +28,9 @@ class Element:
         """Json schema definition of the element."""
 
         raise NotImplementedError
+
+    @property
+    def sample_value(self) -> Any:
+        """Sample value of the element."""
+
+        raise NotImplementedError

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/radio.py

@@ -23,3 +23,9 @@ class Radio(Element):
         """Json schema definition of the radiobutton."""
 
         return {"type": "integer", "maximum": self.number_of_options - 1}
+
+    @property
+    def sample_value(self) -> int:
+        """Sample value of the radiobutton."""
+
+        return 0

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/template.py

@@ -67,9 +67,6 @@ def dropdown_to_text(dropdown: Dropdown) -> Text:
 
     result = Text(dropdown.name)
 
-    result.font = constants.GLOBAL_FONT
-    result.font_color = constants.GLOBAL_FONT_COLOR
-
     if dropdown.value is not None:
         result.value = (
             dropdown.choices[dropdown.value]

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/middleware/text.py

@@ -25,6 +25,7 @@ class Text(Element):
         self.character_paddings = None
         self.text_lines = None
         self.text_line_x_coordinates = None
+        self.preview = False
 
     @property
     def schema_definition(self) -> dict:
@@ -36,3 +37,9 @@ class Text(Element):
             result["maxLength"] = self.max_length
 
         return result
+
+    @property
+    def sample_value(self) -> str:
+        """Sample value of the text field."""
+
+        return self.name

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm/wrapper.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 
 from typing import BinaryIO, Dict, Union
 
+from .core import constants as core_constants
 from .core import filler, font
 from .core import image as image_core
 from .core import utils
@@ -32,17 +33,21 @@ class Wrapper:
 
         for each in self.elements.values():
             if isinstance(each, Text):
-                each.font = kwargs.get("global_font", constants.GLOBAL_FONT)
+                each.font = kwargs.get("global_font")
                 each.font_size = kwargs.get("global_font_size")
-                each.font_color = kwargs.get(
-                    "global_font_color", constants.GLOBAL_FONT_COLOR
-                )
+                each.font_color = kwargs.get("global_font_color")
 
     def read(self) -> bytes:
         """Reads the file stream of a PDF form."""
 
         return self.stream
 
+    @property
+    def sample_data(self) -> dict:
+        """Returns a valid sample data that can be filled into the PDF form."""
+
+        return {key: value.sample_value for key, value in self.elements.items()}
+
     @property
     def version(self) -> Union[str, None]:
         """Gets the version of the PDF."""
@@ -78,11 +83,23 @@ class Wrapper:
 
         return new_obj
 
+    @property
+    def preview(self) -> bytes:
+        """Inspects all supported elements' names for the PDF form."""
+
+        return filler.fill(
+            self.stream,
+            {
+                key: utils.preview_element_to_draw(value)
+                for key, value in self.elements.items()
+            },
+        )
+
     def fill(
         self,
         data: Dict[str, Union[str, bool, int]],
     ) -> Wrapper:
-        """Fill a PDF form."""
+        """Fills a PDF form."""
 
         for key, value in data.items():
             if key in self.elements:
@@ -114,9 +131,13 @@ class Wrapper:
 
         new_element = Text("new")
         new_element.value = text
-        new_element.font = kwargs.get("font", constants.GLOBAL_FONT)
-        new_element.font_size = kwargs.get("font_size", constants.GLOBAL_FONT_SIZE)
-        new_element.font_color = kwargs.get("font_color", constants.GLOBAL_FONT_COLOR)
+        new_element.font = kwargs.get("font", core_constants.DEFAULT_FONT)
+        new_element.font_size = kwargs.get(
+            "font_size", core_constants.DEFAULT_FONT_SIZE
+        )
+        new_element.font_color = kwargs.get(
+            "font_color", core_constants.DEFAULT_FONT_COLOR
+        )
 
         watermarks = watermark_core.create_watermarks_and_draw(
             self.stream,

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.3.1
+Version: 1.3.3
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li
@@ -81,10 +81,6 @@ and it should look like [this](https://github.com/chinapandaman/PyPDFForm/raw/ma
 
 ## How to Contribute
 
-If you wish to improve this library, there is one specific way you can contribute 
-on top of the usual open source project norms such as issues and pull requests.
-
 It is difficult to make sure that the library supports all the PDF form creating tools out 
-there. So if you run into a case where the library does not work for certain PDF forms created by 
-certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
+there. So if you run into a case where the library does not work for certain PDF forms created by certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
 to make the library support the attached PDF form as well as the tool used to create it.

{PyPDFForm-1.3.1 → PyPDFForm-1.3.3}/README.md

@@ -68,10 +68,6 @@ and it should look like [this](https://github.com/chinapandaman/PyPDFForm/raw/ma
 
 ## How to Contribute
 
-If you wish to improve this library, there is one specific way you can contribute 
-on top of the usual open source project norms such as issues and pull requests.
-
 It is difficult to make sure that the library supports all the PDF form creating tools out 
-there. So if you run into a case where the library does not work for certain PDF forms created by 
-certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
+there. So if you run into a case where the library does not work for certain PDF forms created by certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
 to make the library support the attached PDF form as well as the tool used to create it.

PyPDFForm-1.3.1/PyPDFForm/core/font.py

@@ -1,24 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Contains helpers for font."""
-
-from io import BytesIO
-
-from reportlab.pdfbase import pdfmetrics
-from reportlab.pdfbase.ttfonts import TTFError, TTFont
-
-
-def register_font(font_name: str, ttf_stream: bytes) -> bool:
-    """Registers a font from a ttf file stream."""
-
-    buff = BytesIO()
-    buff.write(ttf_stream)
-    buff.seek(0)
-
-    try:
-        pdfmetrics.registerFont(TTFont(name=font_name, filename=buff))
-        result = True
-    except TTFError:
-        result = False
-
-    buff.close()
-    return result