PyPDFForm 2.2.6__tar.gz → 2.3.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.2.6
+Version: 2.3.0
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -49,15 +49,6 @@ Dynamic: license-file
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important Announcements
-
-Hello fellow Python developers! With the release of v2.0.0, there are some important changes I'm making to the library:
-
-* Since I started developing the library, versioning releases has been quite unorthodox, and there isn't any convention I followed. Starting with v2.0.0, PyPDFForm will version releases following the conventions defined by [Semantic Versioning](https://semver.org/).
-* PyPDFForm now renders PDF form widgets! Ever since its ancestral stage, the library has only been able to render the data you filled into a PDF form. Now if you fill a PDF form using `PdfWrapper`, the result will render the whole widget instead of just the value that got filled. If you would like to disable this behavior, please refer to the docs [here](https://chinapandaman.github.io/PyPDFForm/fill/#disable-rendering-widgets).
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

{pypdfform-2.2.6 → pypdfform-2.3.0}/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.2.6"
+__version__ = "2.3.0"
 
 from .wrapper import FormWrapper, PdfWrapper
 

{pypdfform-2.2.6 → pypdfform-2.3.0}/PyPDFForm/filler.py

@@ -38,7 +38,7 @@ from .patterns import (WIDGET_KEY_PATTERNS, simple_flatten_generic,
                        simple_flatten_radio, simple_update_checkbox_value,
                        simple_update_dropdown_value, simple_update_radio_value,
                        simple_update_text_value)
-from .template import get_widgets_by_page
+from .template import get_widget_full_key, get_widgets_by_page
 from .utils import (checkbox_radio_to_draw, extract_widget_property,
                     stream_to_io)
 from .watermark import create_watermarks_and_draw, merge_watermarks_with_pdf
@@ -220,6 +220,7 @@ def get_drawn_stream(to_draw: dict, stream: bytes, action: str) -> bytes:
 def fill(
     template_stream: bytes,
     widgets: Dict[str, WIDGET_TYPES],
+    use_full_widget_name: bool,
 ) -> bytes:
     """Fills a PDF form using watermark technique for complex rendering.
 
@@ -231,6 +232,7 @@ def fill(
     Args:
         template_stream: Input PDF form as bytes
         widgets: Dictionary mapping field names to widget middleware
+        use_full_widget_name: If True, uses the full widget name as the key in the widgets dictionary
 
     Returns:
         bytes: Filled PDF form as bytes
@@ -253,6 +255,8 @@ def fill(
         line_borders_to_draw[page] = []
         for widget_dict in widget_dicts:
             key = extract_widget_property(widget_dict, WIDGET_KEY_PATTERNS, None, str)
+            if use_full_widget_name:
+                key = get_widget_full_key(widget_dict)
             text_needs_to_be_drawn = False
             to_draw = x = y = None
 
@@ -329,10 +333,8 @@ def enable_adobe_mode(reader: PdfReader, writer: PdfWriter, adobe_mode: bool) ->
         writer.root_object.update(
             {NameObject(AcroForm): IndirectObject(len(writer.root_object), 0, writer)}
         )
-    writer.root_object[AcroForm][NameObject(NeedAppearances)] = BooleanObject(  # noqa
-        True
-    )
-    writer.root_object[AcroForm][NameObject(Fields)] = ArrayObject()  # noqa
+    writer.root_object[AcroForm][NameObject(NeedAppearances)] = BooleanObject(True)
+    writer.root_object[AcroForm][NameObject(Fields)] = ArrayObject()
 
 
 def simple_fill(
@@ -366,7 +368,7 @@ def simple_fill(
     radio_button_tracker = {}
 
     for page in out.pages:
-        for annot in page.get(Annots, []):  # noqa
+        for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
             key = extract_widget_property(
                 annot.get_object(), WIDGET_KEY_PATTERNS, None, str

{pypdfform-2.2.6 → pypdfform-2.3.0}/PyPDFForm/patterns.py

@@ -149,7 +149,7 @@ def simple_update_checkbox_value(annot: DictionaryObject, check: bool = False) -
         check: Whether the checkbox should be checked (True) or unchecked (False)
     """
 
-    for each in annot[AP][N]:  # noqa
+    for each in annot[AP][N]:
         if (check and str(each) != Off) or (not check and str(each) == Off):
             annot[NameObject(AS)] = NameObject(each)
             annot[NameObject(V)] = NameObject(each)
@@ -169,12 +169,12 @@ def simple_update_radio_value(annot: DictionaryObject) -> None:
     """
 
     if Opt in annot[Parent]:
-        del annot[Parent][Opt]  # noqa
+        del annot[Parent][Opt]
 
-    for each in annot[AP][N]:  # noqa
+    for each in annot[AP][N]:
         if str(each) != Off:
             annot[NameObject(AS)] = NameObject(each)
-            annot[NameObject(Parent)][NameObject(V)] = NameObject(each)  # noqa
+            annot[NameObject(Parent)][NameObject(V)] = NameObject(each)
             break
 
 
@@ -191,7 +191,7 @@ def simple_update_dropdown_value(annot: DictionaryObject, widget: Dropdown) -> N
     """
 
     if Parent in annot and T not in annot:
-        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(  # noqa
+        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(
             widget.choices[widget.value]
         )
         annot[NameObject(AP)] = TextStringObject(widget.choices[widget.value])
@@ -214,9 +214,7 @@ def simple_update_text_value(annot: DictionaryObject, widget: Text) -> None:
     """
 
     if Parent in annot and T not in annot:
-        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(  # noqa
-            widget.value
-        )
+        annot[NameObject(Parent)][NameObject(V)] = TextStringObject(widget.value)
         annot[NameObject(AP)] = TextStringObject(widget.value)
     else:
         annot[NameObject(V)] = TextStringObject(widget.value)
@@ -234,8 +232,8 @@ def simple_flatten_radio(annot: DictionaryObject) -> None:
         annot: PDF radio button annotation dictionary to flatten
     """
 
-    annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(  # noqa
-        int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) | READ_ONLY  # noqa
+    annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+        int(annot[NameObject(Parent)].get(NameObject(Ff), 0)) | READ_ONLY
     )
 
 
@@ -251,12 +249,12 @@ def simple_flatten_generic(annot: DictionaryObject) -> None:
     """
 
     if Parent in annot and Ff not in annot:
-        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(  # noqa
-            int(annot.get(NameObject(Ff), 0)) | READ_ONLY  # noqa
+        annot[NameObject(Parent)][NameObject(Ff)] = NumberObject(
+            int(annot.get(NameObject(Ff), 0)) | READ_ONLY
         )
     else:
         annot[NameObject(Ff)] = NumberObject(
-            int(annot.get(NameObject(Ff), 0)) | READ_ONLY  # noqa
+            int(annot.get(NameObject(Ff), 0)) | READ_ONLY
         )
 
 
@@ -272,9 +270,9 @@ def update_annotation_name(annot: DictionaryObject, val: str) -> None:
     """
 
     if Parent in annot and T not in annot:
-        annot[NameObject(Parent)][NameObject(T)] = TextStringObject(val)  # noqa
+        annot[NameObject(Parent)][NameObject(T)] = TextStringObject(val)
     else:
-        annot[NameObject(T)] = TextStringObject(val)  # noqa
+        annot[NameObject(T)] = TextStringObject(val)
 
 
 def update_created_text_field_alignment(annot: DictionaryObject, val: int) -> None:
@@ -303,9 +301,7 @@ def update_created_text_field_multiline(annot: DictionaryObject, val: bool) -> N
     """
 
     if val:
-        annot[NameObject(Ff)] = NumberObject(
-            int(annot[NameObject(Ff)]) | MULTILINE  # noqa
-        )
+        annot[NameObject(Ff)] = NumberObject(int(annot[NameObject(Ff)]) | MULTILINE)
 
 
 NON_ACRO_FORM_PARAM_TO_FUNC = {

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

@@ -246,15 +246,14 @@ def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     return result
 
 
-def get_widget_full_key(widget: dict) -> Union[str, None]:
+def get_widget_full_key(widget: dict) -> str:
     """Constructs a widget's full hierarchical key including parent names.
 
     Args:
         widget: PDF widget dictionary
 
     Returns:
-        Union[str, None]: Full key in format "parent.child" if parent exists,
-            otherwise None
+        str: Full key in format "parent.child" if parent exists, otherwise the widget's key
     """
 
     key = extract_widget_property(widget, WIDGET_KEY_PATTERNS, None, str)
@@ -264,9 +263,9 @@ def get_widget_full_key(widget: dict) -> Union[str, None]:
         and T in widget[Parent].get_object()
         and widget[Parent].get_object()[T] != key
     ):
-        return f"{widget[Parent].get_object()[T]}.{key}"
+        key = f"{get_widget_full_key(widget[Parent].get_object())}.{key}"
 
-    return None
+    return key
 
 
 def construct_widget(widget: dict, key: str) -> Union[WIDGET_TYPES, None]:
@@ -570,7 +569,7 @@ def update_widget_keys(
         new_key = new_keys[i]
         tracker = -1
         for page in out.pages:
-            for annot in page.get(Annots, []):  # noqa
+            for annot in page.get(Annots, []):
                 annot = cast(DictionaryObject, annot.get_object())
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str

{pypdfform-2.2.6 → pypdfform-2.3.0}/PyPDFForm/utils.py

@@ -104,10 +104,13 @@ def checkbox_radio_to_draw(
     return new_widget
 
 
-def preview_widget_to_draw(widget: WIDGET_TYPES, with_preview_text: bool) -> Text:
+def preview_widget_to_draw(
+    widget_name: str, widget: WIDGET_TYPES, with_preview_text: bool
+) -> Text:
     """Creates preview version of a widget showing field name/location.
 
     Args:
+        widget_name: Name of the widget to generate preview for
         widget: Widget to generate preview for
         with_preview_text: Whether to include field name in preview
 
@@ -117,7 +120,7 @@ def preview_widget_to_draw(widget: WIDGET_TYPES, with_preview_text: bool) -> Tex
 
     new_widget = Text(
         name=widget.name,
-        value="{" + f" {widget.name} " + "}" if with_preview_text else None,
+        value="{" + f" {widget_name} " + "}" if with_preview_text else None,
     )
     new_widget.font = DEFAULT_FONT
     new_widget.font_size = DEFAULT_FONT_SIZE

{pypdfform-2.2.6 → pypdfform-2.3.0}/PyPDFForm/watermark.py

@@ -380,7 +380,7 @@ def copy_watermark_widgets(
         watermark_file = PdfReader(stream_to_io(watermark))
         for j, page in enumerate(watermark_file.pages):
             widgets_to_copy_pdf[j] = []
-            for annot in page.get(Annots, []):  # noqa
+            for annot in page.get(Annots, []):
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str
                 )
@@ -393,7 +393,7 @@ def copy_watermark_widgets(
     for i, page in enumerate(out.pages):
         if i in widgets_to_copy:
             page[NameObject(Annots)] = (
-                (page[NameObject(Annots)] + ArrayObject(widgets_to_copy[i]))  # noqa
+                (page[NameObject(Annots)] + ArrayObject(widgets_to_copy[i]))
                 if Annots in page
                 else ArrayObject(widgets_to_copy[i])
             )

{pypdfform-2.2.6 → pypdfform-2.3.0}/PyPDFForm/widgets/base.py

@@ -83,7 +83,7 @@ class Widget:
                     )
                 self.acro_form_params[param] = value
             elif user_input in self.NONE_DEFAULTS:
-                self.acro_form_params[param] = None  # noqa
+                self.acro_form_params[param] = None
 
         for each in self.ALLOWED_NON_ACRO_FORM_PARAMS:
             if each in kwargs:
@@ -154,7 +154,7 @@ def handle_non_acro_form_params(pdf: bytes, key: str, params: list) -> bytes:
     out.append(pdf_file)
 
     for page in out.pages:
-        for annot in page.get(Annots, []):  # noqa
+        for annot in page.get(Annots, []):
             annot = cast(DictionaryObject, annot.get_object())
             _key = extract_widget_property(
                 annot.get_object(), WIDGET_KEY_PATTERNS, None, str

{pypdfform-2.2.6 → pypdfform-2.3.0}/PyPDFForm/widgets/signature.py

@@ -101,12 +101,12 @@ class SignatureWidget:
 
         input_pdf = PdfReader(stream_to_io(stream))
         page_count = len(input_pdf.pages)
-        pdf = PdfReader(stream_to_io(BEDROCK_PDF))  # noqa
+        pdf = PdfReader(stream_to_io(BEDROCK_PDF))
         out = PdfWriter()
         out.append(pdf)
 
         for page in out.pages:
-            for annot in page.get(Annots, []):  # noqa
+            for annot in page.get(Annots, []):
                 key = extract_widget_property(
                     annot.get_object(), WIDGET_KEY_PATTERNS, None, str
                 )

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

@@ -362,9 +362,10 @@ class PdfWrapper(FormWrapper):
             fill(
                 self.stream,
                 {
-                    key: preview_widget_to_draw(value, True)
+                    key: preview_widget_to_draw(key, value, True)
                     for key, value in self.widgets.items()
                 },
+                getattr(self, "use_full_widget_name"),
             )
         )
 
@@ -391,9 +392,10 @@ class PdfWrapper(FormWrapper):
                 fill(
                     self.stream,
                     {
-                        key: preview_widget_to_draw(value, False)
+                        key: preview_widget_to_draw(key, value, False)
                         for key, value in self.widgets.items()
                     },
+                    getattr(self, "use_full_widget_name"),
                 )
             ),
             color,
@@ -434,7 +436,9 @@ class PdfWrapper(FormWrapper):
         if self.read():
             self.widgets = set_character_x_paddings(self.stream, self.widgets)
 
-        self.stream = remove_all_widgets(fill(self.stream, self.widgets))
+        self.stream = remove_all_widgets(
+            fill(self.stream, self.widgets, getattr(self, "use_full_widget_name"))
+        )
 
         return self
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 2.2.6
+Version: 2.3.0
 Summary: The Python library for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
@@ -49,15 +49,6 @@ Dynamic: license-file
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important Announcements
-
-Hello fellow Python developers! With the release of v2.0.0, there are some important changes I'm making to the library:
-
-* Since I started developing the library, versioning releases has been quite unorthodox, and there isn't any convention I followed. Starting with v2.0.0, PyPDFForm will version releases following the conventions defined by [Semantic Versioning](https://semver.org/).
-* PyPDFForm now renders PDF form widgets! Ever since its ancestral stage, the library has only been able to render the data you filled into a PDF form. Now if you fill a PDF form using `PdfWrapper`, the result will render the whole widget instead of just the value that got filled. If you would like to disable this behavior, please refer to the docs [here](https://chinapandaman.github.io/PyPDFForm/fill/#disable-rendering-widgets).
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 

{pypdfform-2.2.6 → pypdfform-2.3.0}/README.md

@@ -8,15 +8,6 @@
     <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></a>
 </p>
 
-## Important Announcements
-
-Hello fellow Python developers! With the release of v2.0.0, there are some important changes I'm making to the library:
-
-* Since I started developing the library, versioning releases has been quite unorthodox, and there isn't any convention I followed. Starting with v2.0.0, PyPDFForm will version releases following the conventions defined by [Semantic Versioning](https://semver.org/).
-* PyPDFForm now renders PDF form widgets! Ever since its ancestral stage, the library has only been able to render the data you filled into a PDF form. Now if you fill a PDF form using `PdfWrapper`, the result will render the whole widget instead of just the value that got filled. If you would like to disable this behavior, please refer to the docs [here](https://chinapandaman.github.io/PyPDFForm/fill/#disable-rendering-widgets).
-
-Happy hacking!
-
 ## Introduction
 
 PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential