python-pdffiller 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

pdffiller/_version.py

@@ -3,4 +3,4 @@ __copyright__ = "Copyright 2025 SISMIC"
 __email__ = "jraphanel@sismic.fr"
 __license__ = "MIT"
 __title__ = "pdffiller"
-__version__ = "1.0.0"
+__version__ = "1.1.0"

pdffiller/cli/commands/fill_form.py

@@ -17,7 +17,7 @@ from pdffiller.exceptions import (
 )
 from pdffiller.io.output import PdfFillerOutput
 from pdffiller.pdf import Pdf
-from pdffiller.typing import Any, Dict, Union
+from pdffiller.typing import Any, Dict
 
 from ..exit_codes import ERROR_ENCOUNTERED
 
@@ -94,7 +94,7 @@ def fill_form(parser: PdfFillerArgumentParser, *args: Any) -> Any:
     if not opts.data and not opts.input_data:
         raise CommandLineError("no data file path given")
 
-    input_data: Dict[str, Union[str, int, float, bool]] = {}
+    input_data: Dict[str, str] = {}
     if opts.input_data:
         try:
             input_data = json.loads(opts.input_data)
@@ -132,7 +132,7 @@ def fill_form(parser: PdfFillerArgumentParser, *args: Any) -> Any:
         input_data = input_dict
 
     try:
-        pdf = Pdf(opts.file)
+        pdf = Pdf()
         pdf.fill(opts.file, opts.output, input_data, opts.flatten)
     except PdfFillerException as exp:
         output.error(str(exp))

pdffiller/pdf.py

@@ -14,25 +14,19 @@ from collections import OrderedDict
 
 from pypdf import PdfReader, PdfWriter
 from pypdf.errors import PyPdfError
-from pypdf.generic import (
-    ArrayObject,
-    DictionaryObject,
-    NameObject,
-    NumberObject,
-    TextStringObject,
-)
+from pypdf.generic import ArrayObject, DictionaryObject, NameObject
 
 from pdffiller.io.output import PdfFillerOutput
 
 from .typing import (
     Any,
-    Callable,
     cast,
     Dict,
     List,
     Optional,
     PathLike,
     StrByteType,
+    Tuple,
     Type,
     Union,
 )
@@ -179,7 +173,9 @@ class Pdf:
                 elif widget_type in ["list", "combo"] and value:
                     choices = [each[1:] for each in widget[PdfAttributes.Opt]]
                 if key not in loaded_widgets:
-                    new_widget = self.TYPE_TO_OBJECT[widget_type](key, i, value)
+                    new_widget = self.TYPE_TO_OBJECT[widget_type](
+                        key, i, value, self.is_readonly(widget_type, widget.get_object())
+                    )
                     if choices and isinstance(new_widget, CheckBoxWidget):
                         new_widget.choices = choices
                     elif isinstance(new_widget, TextWidget):
@@ -224,7 +220,7 @@ class Pdf:
         self,
         input_file: StrByteType,
         output_file: PathLike,
-        data: Dict[str, Union[str, int, float, bool]],
+        data: Dict[str, str],
         flatten: bool = True,
     ) -> "Pdf":
         """
@@ -244,68 +240,23 @@ class Pdf:
         Returns:
             Pdf: The `Pdf` object, allowing for method chaining.
         """
-        for key, value in data.items():
-            if key in self.widgets:
-                self.widgets[key].value = value
-
         reader = PdfReader(input_file)
-        if self.adobe_mode:
-            if (
-                PdfAttributes.AcroForm in cast(Any, reader.trailer[PdfAttributes.Root])
-                and PdfAttributes.XFA
-                in cast(Any, reader.trailer[PdfAttributes.Root])[PdfAttributes.AcroForm]
-            ):
-                del cast(Any, reader.trailer[PdfAttributes.Root])[PdfAttributes.AcroForm][
-                    PdfAttributes.XFA
-                ]
-
-        writer = PdfWriter(reader)
-        if self.adobe_mode:
-            writer.set_need_appearances_writer()
 
-        fillers: Dict[str, Callable[[DictionaryObject, Any], None]] = {
-            "checkbox": self._fill_checkbox,
-            "text": self._fill_text,
-            "radio": self._fill_radio,
-        }
+        self._init_helper(input_file)
+        fields: Dict[str, Union[str, List[str], Tuple[str, str, float]]] = {}
 
-        output = PdfFillerOutput()
-        for page in writer.pages:
-            widgets: Optional[ArrayObject] = page.annotations
-            if not widgets:
-                continue
-            for widget in widgets:
-                if (
-                    PdfAttributes.Subtype not in widget
-                    or widget[PdfAttributes.Subtype] != PdfAttributes.Widget
-                ):
-                    continue
+        for name, value in data.items():
+            widget = self.widgets.get(name)
+            fields[name] = value
+            if isinstance(widget, CheckBoxWidget):
+                if value and value[0] != "/":
+                    fields[name] = "/" + value
 
-                annotation = cast(DictionaryObject, widget.get_object())
-                if PdfAttributes.T not in widget:
-                    widget = widget[PdfAttributes.Parent]
-                widget_key: Optional[str] = self._get_widget_name(widget)
-                if not widget_key or widget_key not in self.widgets:
-                    continue
-
-                widget_type: Optional[str] = self._get_field_type(widget)
-                if not widget_type:
-                    continue
-
-                if widget_type != "radio":
-                    self.flatten_generic(annotation, flatten)
-                else:
-                    self.flatten_radio(annotation, flatten)
-
-                if widget_key not in data or widget_type not in fillers:
-                    continue
-
-                current_widget = self.widgets[widget_key]
-                if current_widget.value is None:
-                    continue
-
-                output.debug(f"Filling {current_widget.name} with {current_widget.value}")
-                fillers[widget_type](annotation, current_widget)
+        writer = PdfWriter(reader)
+        writer.update_page_form_field_values(None, fields, auto_regenerate=False, flatten=flatten)
+        if flatten:
+            writer.remove_annotations(None)
+        writer.compress_identical_objects(remove_identicals=True, remove_orphans=True)
 
         with open(output_file, "wb") as f:
             writer.write(f)
@@ -346,143 +297,36 @@ class Pdf:
         return None
 
     @staticmethod
-    def _fill_text(annotation: DictionaryObject, widget: TextWidget) -> None:
-        """
-        Updates the value of a text annotation, setting the text content.
-
-        This function modifies the value (V) and appearance (AP) of the text
-        annotation to reflect the new text content.
-
-        Args:
-            annotation (DictionaryObject): The text annotation dictionary.
-            widget (TextWidget): The Text widget object containing the text value.
-        """
-        if PdfAttributes.Parent in annotation and PdfAttributes.T not in annotation:
-            annotation[NameObject(PdfAttributes.Parent)] = TextStringObject(widget.value)
-            annotation[NameObject(PdfAttributes.AP)] = TextStringObject(widget.value)
-        else:
-            annotation[NameObject(PdfAttributes.V)] = TextStringObject(widget.value)
-            annotation[NameObject(PdfAttributes.AP)] = TextStringObject(widget.value)
-
-    @staticmethod
-    def _fill_checkbox(annotation: DictionaryObject, widget: CheckBoxWidget) -> None:
-        value: Union[bool, str, None] = widget.value
-        if value is None:
-            value = False
-        if not isinstance(value, bool):
-            annotation[NameObject(PdfAttributes.AS)] = NameObject("/" + widget.value)
-            annotation[NameObject(PdfAttributes.V)] = NameObject("/" + widget.value)
-            return
-
-        for each in cast(Any, annotation[PdfAttributes.AP])[PdfAttributes.N]:
-            if (value and str(each) != PdfAttributes.Off) or (
-                not value and str(each) == PdfAttributes.Off
-            ):
-                annotation[NameObject(PdfAttributes.AS)] = NameObject(each)
-                annotation[NameObject(PdfAttributes.V)] = NameObject(each)
-                return
-
-        if PdfAttributes.V in annotation:
-            del annotation[PdfAttributes.V]
-        if PdfAttributes.AS in annotation:
-            del annotation[PdfAttributes.AS]
-
-    @staticmethod
-    def _fill_radio(annotation: DictionaryObject, widget: RadioWidget) -> None:
-
-        for each in (
-            cast(Any, annotation[PdfAttributes.Kids])
-            if PdfAttributes.T in annotation
-            else cast(Any, annotation[PdfAttributes.Parent])[PdfAttributes.Kids]
-        ):
-            # determine the export value of each kid
-            keys = each[PdfAttributes.AP][PdfAttributes.N].keys()
-            if PdfAttributes.Off in keys:
-                keys.remove(PdfAttributes.Off)
-            export = list(keys)[0] or None
-
-            if f"/{widget.value}" == export:
-                annotation[NameObject(PdfAttributes.AS)] = NameObject(export)
-                cast(Any, annotation[NameObject(PdfAttributes.Parent)])[
-                    NameObject(PdfAttributes.V)
-                ] = NameObject(export)
-            else:
-                annotation[NameObject(PdfAttributes.AS)] = NameObject(PdfAttributes.Off)
-
-    @staticmethod
-    def flatten_radio(annot: DictionaryObject, val: bool) -> None:
+    def is_readonly(widget_type: str, annot: DictionaryObject) -> bool:
         """
-        Flattens a radio button annotation by setting or unsetting the ReadOnly flag,
-        making it non-editable or editable based on the `val` parameter.
+        Determines whether readonly flag is set or not.
 
-        This function modifies the Ff (flags) entry in the radio button's annotation
-        dictionary or its parent dictionary if `Parent` exists in `annot`, to set or
-        unset the ReadOnly flag, preventing or allowing the user from changing the
-        selected option.
+        This function evaluates if readonly is activating by checking Ff (flags) entry
+        in the annotation dictionary.
 
         Args:
-            annot (DictionaryObject): The radio button annotation dictionary.
-            val (bool): True to flatten (make read-only), False to unflatten (make editable).
+            widget_type (str): The widget type
+            annot (DictionaryObject): The annotation dictionary.
+        Returns:
+            True if read-only is set, else False
         """
-        if PdfAttributes.Parent in annot:
-            cast(Any, annot[NameObject(PdfAttributes.Parent)])[NameObject(PdfAttributes.Ff)] = (
-                NumberObject(
-                    (
-                        int(
-                            cast(Any, annot[NameObject(PdfAttributes.Parent)]).get(
-                                NameObject(PdfAttributes.Ff), 0
-                            )
+        if widget_type == "radio":
+            if PdfAttributes.Parent in annot:
+                return (
+                    int(
+                        cast(Any, annot[NameObject(PdfAttributes.Parent)]).get(
+                            NameObject(PdfAttributes.Ff), 0
                         )
-                        | PdfAttributes.READ_ONLY
-                        if val
-                        else int(
-                            cast(Any, annot[NameObject(PdfAttributes.Parent)]).get(
-                                NameObject(PdfAttributes.Ff), 0
-                            )
-                        )
-                        & ~PdfAttributes.READ_ONLY
                     )
+                    & PdfAttributes.READ_ONLY
+                    == PdfAttributes.READ_ONLY
                 )
+            return (
+                int(annot.get(NameObject(PdfAttributes.Ff), 0)) & PdfAttributes.READ_ONLY
+                == PdfAttributes.READ_ONLY
             )
-        else:
-            annot[NameObject(PdfAttributes.Ff)] = NumberObject(
-                (
-                    int(annot.get(NameObject(PdfAttributes.Ff), 0)) | PdfAttributes.READ_ONLY
-                    if val
-                    else int(annot.get(NameObject(PdfAttributes.Ff), 0)) & ~PdfAttributes.READ_ONLY
-                )
-            )
-
-    @staticmethod
-    def flatten_generic(annot: DictionaryObject, val: bool) -> None:
-        """
-        Flattens a generic annotation by setting or unsetting the ReadOnly flag,
-        making it non-editable or editable based on the `val` parameter.
 
-        This function modifies the Ff (flags) entry in the annotation dictionary to
-        set or unset the ReadOnly flag, preventing or allowing the user from
-        interacting with the form field.
-
-        Args:
-            annot (DictionaryObject): The annotation dictionary.
-            val (bool): True to flatten (make read-only), False to unflatten (make editable).
-        """
-        if PdfAttributes.Parent in annot and PdfAttributes.Ff not in annot:
-            cast(Any, annot[NameObject(PdfAttributes.Parent)])[NameObject(PdfAttributes.Ff)] = (
-                NumberObject(
-                    (
-                        int(annot.get(NameObject(PdfAttributes.Ff), 0)) | PdfAttributes.READ_ONLY
-                        if val
-                        else int(annot.get(NameObject(PdfAttributes.Ff), 0))
-                        & ~PdfAttributes.READ_ONLY
-                    )
-                )
-            )
-        else:
-            annot[NameObject(PdfAttributes.Ff)] = NumberObject(
-                (
-                    int(annot.get(NameObject(PdfAttributes.Ff), 0)) | PdfAttributes.READ_ONLY
-                    if val
-                    else int(annot.get(NameObject(PdfAttributes.Ff), 0)) & ~PdfAttributes.READ_ONLY
-                )
-            )
+        return (
+            int(annot.get(NameObject(PdfAttributes.Ff), 0)) & PdfAttributes.READ_ONLY
+            == PdfAttributes.READ_ONLY
+        )

pdffiller/widgets/base.py

@@ -20,7 +20,9 @@ class Widget:
     as name, value, and schema definition.
     """
 
-    def __init__(self, name: str, page_number: int, value: Optional[Any] = None) -> None:
+    def __init__(
+        self, name: str, page_number: int, value: Optional[Any] = None, readonly: bool = False
+    ) -> None:
         """
         Initialize a new widget.
 
@@ -28,11 +30,13 @@ class Widget:
             name (str): The name of the widget.
             page_number (int): The associated page index
             value (Any): The initial value of the widget. Defaults to None.
+            readonly (bool): True if readonly is set, else False.
         """
         super().__init__()
         self._name: str = name
         self.page_number: int = page_number
         self._value: Optional[Any] = value
+        self._readonly: bool = readonly
         self._description: Optional[str] = None
 
     @property
@@ -65,6 +69,26 @@ class Widget:
         """
         self._value = value
 
+    @property
+    def readonly(self) -> bool:
+        """
+        Determine whether readonly mode is set or not.
+
+        Returns:
+            bool: True if readonly mode is set, else False.
+        """
+        return self._readonly
+
+    @readonly.setter
+    def readonly(self, readonly: bool) -> None:
+        """
+        Specify if the readonly mode is set
+
+        Args:
+            readonly (bool): True if readonly mode is set, else False.
+        """
+        self._readonly = readonly
+
     @property
     def description(self) -> Optional[str]:
         """
@@ -101,6 +125,9 @@ class Widget:
         if self._value:
             result["FieldValue"] = self._value
 
+        if self._readonly:
+            result["Readonly"] = self._readonly
+
         if self._description is not None:
             result["Description"] = self._description
 

pdffiller/widgets/checkbox.py

@@ -24,6 +24,7 @@ class CheckBoxWidget(Widget):
         name: str,
         page_number: int,
         value: Optional[str] = None,
+        readonly: bool = False,
         choices: Optional[List[str]] = None,
     ) -> None:
         """
@@ -33,9 +34,10 @@ class CheckBoxWidget(Widget):
             name (str): The name of the checkbox.
             page_number (int): The associated page index
             value (str): The initial value of the checkbox. Defaults to None.
+            readonly (bool): True if readonly is set, else False.
             choices: The list of available choices. Defaults to None.
         """
-        super().__init__(name, page_number, value)
+        super().__init__(name, page_number, value, readonly)
         self.choices: Optional[List[str]] = choices
 
     @property

pdffiller/widgets/text.py

@@ -25,6 +25,7 @@ class TextWidget(Widget):
         name: str,
         page_number: int,
         value: Optional[str] = None,
+        readonly: bool = False,
         max_length: Optional[int] = None,
     ) -> None:
         """
@@ -34,9 +35,10 @@ class TextWidget(Widget):
             name (str): The name of the checkbox.
             page_number (int): The associated page index
             value (str): The initial value of the checkbox. Defaults to None.
+            readonly (bool): True if readonly is set, else False.
             max_length (int): The maximum length of the text field. Defaults to None.
         """
-        super().__init__(name, page_number, value)
+        super().__init__(name, page_number, value, readonly)
         self.max_length: Optional[int] = max_length
 
     @property

{python_pdffiller-1.0.0.dist-info → python_pdffiller-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-pdffiller
-Version: 1.0.0
+Version: 1.1.0
 Summary: Interact with PDF by inspecting or filling it
 Author-email: Jacques Raphanel <jraphanel@sismic.fr>
 License-Expression: MIT

{python_pdffiller-1.0.0.dist-info → python_pdffiller-1.1.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 pdffiller/__init__.py,sha256=0HtgXhEV1fKTKAcOXGcq4UsCFflDIPCDQvckshZf-1k,195
 pdffiller/__main__.py,sha256=7NPQgZVx6VSZS7OrmyJQ_O1vL4wiSqhiILi-outwUqM,107
-pdffiller/_version.py,sha256=dVVZYByHt776RZ19IpKaGRcRJNNDSwzljM3Y1DafozI,172
+pdffiller/_version.py,sha256=jkVj4mFxUGMPJpsXS5J_l0Rayrz_hST2H3Fewc4-x-A,172
 pdffiller/const.py,sha256=if_j5I8ftczpjrzZjA7idv-XpvIj1-XBF4oe6VtQvF0,434
 pdffiller/exceptions.py,sha256=CdN93bZ0mBBS5vLxg14FYZUy4xkYqoD3_SzqtSkZr4g,1624
-pdffiller/pdf.py,sha256=AfsPcDWoar0N7nRImzpJcgUQ3TyeI8yBZfIv1FYA2Rk,18534
+pdffiller/pdf.py,sha256=kfi1tvUHI3zQJPBe5uSapwFfjI9cnNOGyLaoXQE0QXc,11723
 pdffiller/py.typed.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pdffiller/typing.py,sha256=suxFXOGIF07R8UhrEf-ro_vNA2pXJGfe8CX64dStXTs,954
 pdffiller/utils.py,sha256=pmGf3QwkhKwosk_eFCauzHM-XHp_WGVQAtZlxa7taYY,827
@@ -18,19 +18,19 @@ pdffiller/cli/once_argument.py,sha256=olQvNhObObS0iXVL1YCa-_lH76SV0I4FvnlgR9roqo
 pdffiller/cli/smart_formatter.py,sha256=59hwF07nKbp-P9IfbqKgMFsfbvjIw5SACCZpUF4nnuE,318
 pdffiller/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pdffiller/cli/commands/dump_data_fields.py,sha256=YR8aENCGkCRro0jTuuvMg2HCEos9aF81aL4SxP--_2E,2262
-pdffiller/cli/commands/fill_form.py,sha256=QylVT7cSMbH5FjdNqOtU_eVL9tWQjCceroZ7A2152Q0,4668
+pdffiller/cli/commands/fill_form.py,sha256=R1xF8iHswn_FeYvE7oQOTDwpRf6BjqQ7y2pAHg6yRb4,4627
 pdffiller/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pdffiller/io/colors.py,sha256=QCBEWksTVNurOJQYO0zh1X_xxIOXxXmYSJhbCqnNjI8,1710
 pdffiller/io/output.py,sha256=NWV1SabnR_kXmR8tfUKQQoQ_3RV9wqiSnHqzinQDgB0,11217
 pdffiller/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pdffiller/widgets/base.py,sha256=HosjtNWOXRVjCidZZYlWN7Y_M9Ft1P-F4G3EyluUI3I,2901
-pdffiller/widgets/checkbox.py,sha256=6kBSN7sc6uzujAFzfC_HO8SvtiK736ym7hdPBIR1eT4,1603
+pdffiller/widgets/base.py,sha256=omGVQsQgMa-ALESnUd3_94oVIYScAMl0SPhHC_DG8Lg,3613
+pdffiller/widgets/checkbox.py,sha256=iijStLAsY1G4cljW3a9NxVS_8qxJewFEw-B8jU2aKXk,1711
 pdffiller/widgets/radio.py,sha256=Db9Oc3Q8ge8qqTVPLoz3I1_SJBGyJ8KfA33ixZMr78c,1070
-pdffiller/widgets/text.py,sha256=JsluVKl7ZNj5_UZI9rL4MSOd6rLiPxSggHH3g9raUJI,2289
-python_pdffiller-1.0.0.dist-info/licenses/AUTHORS.rst,sha256=1_hVzMKgmoXvGgrcZC7sIbU_6PvvkB6vwqevAqzrIkQ,205
-python_pdffiller-1.0.0.dist-info/licenses/COPYING,sha256=ADPe-bH2wYq8nFf6EPJyovzTJyl3jSPnm09mGI8FSTo,1074
-python_pdffiller-1.0.0.dist-info/METADATA,sha256=JxmTx9WQJxJWNfvpaMAhpRsJqr1pomUlSuCWmvIXSd4,4319
-python_pdffiller-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_pdffiller-1.0.0.dist-info/entry_points.txt,sha256=RESKKpPPdWl0wDET96ntuFoUydALx9j0mxtbt-MEBjU,49
-python_pdffiller-1.0.0.dist-info/top_level.txt,sha256=5MGWCBFYlu_Ax-I5PgQkV9Xw7O48maPe9z8Qj_yVPL4,10
-python_pdffiller-1.0.0.dist-info/RECORD,,
+pdffiller/widgets/text.py,sha256=SiuyBvZPZ6idCmtZ_05zE26iN6Rz67OfOj1fUm98YQI,2397
+python_pdffiller-1.1.0.dist-info/licenses/AUTHORS.rst,sha256=1_hVzMKgmoXvGgrcZC7sIbU_6PvvkB6vwqevAqzrIkQ,205
+python_pdffiller-1.1.0.dist-info/licenses/COPYING,sha256=ADPe-bH2wYq8nFf6EPJyovzTJyl3jSPnm09mGI8FSTo,1074
+python_pdffiller-1.1.0.dist-info/METADATA,sha256=yWwklFn1pQVt_lQ9EvY58kAXvQd8aeN-K4Aaju0nERU,4319
+python_pdffiller-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_pdffiller-1.1.0.dist-info/entry_points.txt,sha256=RESKKpPPdWl0wDET96ntuFoUydALx9j0mxtbt-MEBjU,49
+python_pdffiller-1.1.0.dist-info/top_level.txt,sha256=5MGWCBFYlu_Ax-I5PgQkV9Xw7O48maPe9z8Qj_yVPL4,10
+python_pdffiller-1.1.0.dist-info/RECORD,,