PyPDFForm 2.3.0__tar.gz → 2.3.2__tar.gz

{pypdfform-2.3.0 → pypdfform-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.3.0
+Version: 2.3.2
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT

{pypdfform-2.3.0 → pypdfform-2.3.2}/PyPDFForm/__init__.py

@@ -5,7 +5,7 @@ This package provides tools for filling PDF forms, drawing text and images,
 and manipulating PDF form elements programmatically.
 """
 
-__version__ = "2.3.0"
+__version__ = "2.3.2"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.3.0 → pypdfform-2.3.2}/PyPDFForm/template.py

@@ -39,21 +39,30 @@ from .utils import (extract_widget_property, find_pattern_match, handle_color,
 
 
 def set_character_x_paddings(
-    pdf_stream: bytes, widgets: Dict[str, WIDGET_TYPES]
+    pdf_stream: bytes,
+    widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
 ) -> Dict[str, WIDGET_TYPES]:
-    """Calculates and sets character spacing for comb text fields.
+    """Calculates and sets character spacing for comb text fields in PDF forms.
+
+    This function processes each widget in the PDF form and calculates the horizontal spacing
+    between characters for comb text fields (fixed-width text fields). The spacing is stored
+    in the widget's character_paddings property.
 
     Args:
-        pdf_stream: PDF form as bytes
-        widgets: Dictionary of widget middleware objects
+        pdf_stream (bytes): PDF form as bytes
+        widgets (Dict[str, WIDGET_TYPES]): Dictionary of widget middleware objects
+        use_full_widget_name (bool): Whether to use full widget names including parent names
 
     Returns:
-        Dict[str, WIDGET_TYPES]: Updated widgets with character paddings
+        Dict[str, WIDGET_TYPES]: Updated widget dictionary with character paddings set for comb fields
     """
 
     for _widgets in get_widgets_by_page(pdf_stream).values():
         for widget in _widgets:
             key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
+            if use_full_widget_name:
+                key = get_widget_full_key(widget)
             _widget = widgets[key]
 
             if isinstance(_widget, Text) and _widget.comb is True:
@@ -166,23 +175,35 @@ def dropdown_to_text(dropdown: Dropdown) -> Text:
 def update_text_field_attributes(
     template_stream: bytes,
     widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
 ) -> None:
-    """Updates text field properties based on PDF template settings.
+    """Update text field properties in a PDF form template.
 
-    Handles:
-    - Font detection and sizing
-    - Color properties
-    - Paragraph wrapping
-    - Auto font size adjustment
+    Processes text field widgets in the template to update their visual attributes including:
+    - Font properties (family, size, color)
+    - Text alignment and wrapping behavior
+    - Auto-sizing of text to fit within field bounds
+    - Multi-line text field formatting
 
     Args:
-        template_stream: PDF form as bytes
-        widgets: Dictionary of widget middleware objects
+        template_stream: Raw bytes of the PDF template containing form fields
+        widgets: Dictionary mapping field names to widget objects to update
+        use_full_widget_name: If True, uses full hierarchical widget names including parent keys.
+            When False (default), uses simple field names.
+
+    Returns:
+        None: Modifies widget objects in-place
+
+    Note:
+        This function modifies the widget objects in-place and does not return anything.
+        Changes include font properties, text alignment, and auto-wrapping settings.
     """
 
     for _widgets in get_widgets_by_page(template_stream).values():
         for _widget in _widgets:
             key = extract_widget_property(_widget, WIDGET_KEY_PATTERNS, None, str)
+            if use_full_widget_name:
+                key = get_widget_full_key(_widget)
 
             if isinstance(widgets[key], Text):
                 should_adjust_font_size = False

{pypdfform-2.3.0 → pypdfform-2.3.2}/PyPDFForm/wrapper.py

@@ -249,7 +249,13 @@ class PdfWrapper(FormWrapper):
             dict: Field names mapped to their sample values
         """
 
-        return {key: value.sample_value for key, value in self.widgets.items()}
+        result = {}
+        for key, value in self.widgets.items():
+            if getattr(self, "use_full_widget_name") and key != value.full_name:
+                continue
+            result[key] = value.sample_value
+
+        return result
 
     @property
     def version(self) -> Union[str, None]:
@@ -432,9 +438,13 @@ class PdfWrapper(FormWrapper):
             if isinstance(value, Dropdown):
                 self.widgets[key] = dropdown_to_text(value)
 
-        update_text_field_attributes(self.stream, self.widgets)
+        update_text_field_attributes(
+            self.stream, self.widgets, getattr(self, "use_full_widget_name")
+        )
         if self.read():
-            self.widgets = set_character_x_paddings(self.stream, self.widgets)
+            self.widgets = set_character_x_paddings(
+                self.stream, self.widgets, getattr(self, "use_full_widget_name")
+            )
 
         self.stream = remove_all_widgets(
             fill(self.stream, self.widgets, getattr(self, "use_full_widget_name"))
@@ -702,12 +712,13 @@ class PdfWrapper(FormWrapper):
             dict: A JSON Schema dictionary following Draft 7 format
         """
 
-        return {
-            "type": "object",
-            "properties": {
-                key: value.schema_definition for key, value in self.widgets.items()
-            },
-        }
+        result = {}
+        for key, value in self.widgets.items():
+            if getattr(self, "use_full_widget_name") and key != value.full_name:
+                continue
+            result[key] = value.schema_definition
+
+        return {"type": "object", "properties": result}
 
     @classmethod
     def register_font(

{pypdfform-2.3.0 → pypdfform-2.3.2}/PyPDFForm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.3.0
+Version: 2.3.2
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT

{pypdfform-2.3.0 → pypdfform-2.3.2}/pyproject.toml

@@ -106,7 +106,7 @@ select = [
     "YTT",
     "W",
 ]
-ignore = ["B009", "E501", "N999", "TC006"]
+ignore = ["B009", "E501", "N999", "Q000", "TC006"]
 
 [tool.pyright]
 typeCheckingMode = "basic"

{pypdfform-2.3.0 → pypdfform-2.3.2}/tests/test_use_full_widget_name.py

@@ -14,7 +14,7 @@ def test_init(sample_template_with_full_key):
 def test_sample_data(sample_template_with_full_key):
     obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
     assert "Gain de 2 classes.0" in obj.sample_data
-    assert obj.sample_data["Gain de 2 classes.0"] == obj.sample_data["0"]
+    assert "0" not in obj.sample_data
 
 
 def test_fill(sample_template_with_full_key):
@@ -44,6 +44,4 @@ def test_commit_widget_key_updates(sample_template_with_full_key):
 def test_schema(sample_template_with_full_key):
     obj = PdfWrapper(sample_template_with_full_key, use_full_widget_name=True)
     assert "Gain de 2 classes.0" in obj.schema["properties"]
-    assert (
-        obj.schema["properties"]["Gain de 2 classes.0"] == obj.schema["properties"]["0"]
-    )
+    assert "0" not in obj.schema