PyPDFForm 1.4.29__py3-none-any.whl → 1.4.31__py3-none-any.whl

PyPDFForm/__init__.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.4.29"
+__version__ = "1.4.31"
 
 from .wrapper import FormWrapper, PdfWrapper
+
+__all__ = ["FormWrapper", "PdfWrapper"]

PyPDFForm/adapter.py

@@ -13,10 +13,10 @@ def readable(obj: Any) -> bool:
 
 def fp_or_f_obj_or_stream_to_stream(
     fp_or_f_obj_or_stream: Union[bytes, str, BinaryIO]
-) -> Union[bytes, None]:
+) -> bytes:
     """Converts a file path or a file object to a stream."""
 
-    result = None
+    result = b""
     if isinstance(fp_or_f_obj_or_stream, bytes):
         result = fp_or_f_obj_or_stream
 
@@ -25,8 +25,7 @@ def fp_or_f_obj_or_stream_to_stream(
 
     elif isinstance(fp_or_f_obj_or_stream, str):
         if not isfile(fp_or_f_obj_or_stream):
-            result = None
-
+            pass
         else:
             with open(fp_or_f_obj_or_stream, "rb+") as _file:
                 result = _file.read()

PyPDFForm/constants.py

@@ -32,8 +32,6 @@ A = "/A"
 JS = "/JS"
 T = "/T"
 Rect = "/Rect"
-Subtype = "/Subtype"
-Widget = "/Widget"
 FT = "/FT"
 Parent = "/Parent"
 Ff = "/Ff"
@@ -43,6 +41,7 @@ AP = "/AP"
 N = "/N"
 Sig = "/Sig"
 DA = "/DA"
+DV = "/DV"
 Btn = "/Btn"
 MaxLen = "/MaxLen"
 Q = "/Q"

PyPDFForm/font.py

@@ -42,9 +42,9 @@ def extract_font_from_text_appearance(text_appearance: str) -> Union[str, None]:
     appearance string of a text field widget.
     """
 
-    text_appearance = text_appearance.split(" ")
+    text_appearances = text_appearance.split(" ")
 
-    for each in text_appearance:
+    for each in text_appearances:
         if each.startswith("/"):
             text_segments = findall("[A-Z][^A-Z]*", each.replace("/", ""))
 

PyPDFForm/middleware/base.py

@@ -14,6 +14,7 @@ class Widget:
     ) -> None:
         """Constructs basic attributes for the object."""
 
+        super().__init__()
         self._name = name
         self.value = value
 

PyPDFForm/middleware/checkbox.py

@@ -34,7 +34,7 @@ class Checkbox(Widget):
         return {"type": "boolean"}
 
     @property
-    def sample_value(self) -> bool:
+    def sample_value(self) -> Union[bool, int]:
         """Sample value of the checkbox."""
 
         return True

PyPDFForm/middleware/dropdown.py

@@ -16,7 +16,7 @@ class Dropdown(Widget):
 
         super().__init__(name, value)
 
-        self.choices = None
+        self.choices = []
 
     @property
     def schema_definition(self) -> dict:

PyPDFForm/middleware/text.py

@@ -22,7 +22,7 @@ class Text(Widget):
         self.text_wrap_length = None
         self.max_length = None
         self.comb = None
-        self.character_paddings = None
+        self.character_paddings = []
         self.text_lines = None
         self.text_line_x_coordinates = None
         self.preview = False

PyPDFForm/patterns.py

@@ -4,9 +4,9 @@
 from pypdf.generic import (DictionaryObject, NameObject, NumberObject,
                            TextStringObject)
 
-from .constants import (AP, AS, CA, DA, FT, IMAGE_FIELD_IDENTIFIER, JS, MK,
+from .constants import (AP, AS, CA, DA, DV, FT, IMAGE_FIELD_IDENTIFIER, JS, MK,
                         READ_ONLY, A, Btn, Ch, Ff, N, Off, Opt, Parent, Q, Sig,
-                        Subtype, T, Tx, V, Widget, Yes)
+                        T, Tx, V, Yes)
 from .middleware.checkbox import Checkbox
 from .middleware.dropdown import Dropdown
 from .middleware.image import Image
@@ -49,7 +49,7 @@ WIDGET_TYPE_PATTERNS = [
     (
         (
             {Parent: {FT: Btn}},
-            {Parent: {Subtype: Widget}},
+            {Parent: {DV: (Yes, Off)}},
             {AS: (Yes, Off)},
         ),
         Checkbox,

PyPDFForm/template.py

@@ -118,7 +118,7 @@ def update_text_field_attributes(
 ) -> None:
     """Auto updates text fields' attributes."""
 
-    for _, _widgets in get_widgets_by_page(template_stream).items():
+    for _widgets in get_widgets_by_page(template_stream).values():
         for _widget in _widgets:
             key = get_widget_key(_widget)
 
@@ -155,11 +155,11 @@ def update_text_field_attributes(
 def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     """Iterates through a PDF and returns all widgets found grouped by page."""
 
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
 
     result = {}
 
-    for i, page in enumerate(pdf.pages):
+    for i, page in enumerate(pdf_file.pages):
         widgets = page.annotations
         result[i + 1] = []
         if widgets:
@@ -177,7 +177,7 @@ def get_widgets_by_page(pdf: bytes) -> Dict[int, List[dict]]:
     return result
 
 
-def get_widget_key(widget: dict) -> Union[str, None]:
+def get_widget_key(widget: dict) -> Union[str, list, None]:
     """Finds a PDF widget's annotated key by pattern matching."""
 
     result = None
@@ -189,7 +189,7 @@ def get_widget_key(widget: dict) -> Union[str, None]:
     return result
 
 
-def get_widget_alignment(widget: dict) -> Union[str, None]:
+def get_widget_alignment(widget: dict) -> Union[str, list, None]:
     """Finds a PDF widget's alignment by pattern matching."""
 
     result = None
@@ -249,7 +249,7 @@ def is_text_multiline(widget: dict) -> bool:
     return check_field_flag_bit(widget, MULTILINE)
 
 
-def get_dropdown_choices(widget: dict) -> Union[Tuple[str], None]:
+def get_dropdown_choices(widget: dict) -> Union[Tuple[str, ...], None]:
     """Returns string options of a dropdown field."""
 
     result = None

PyPDFForm/utils.py

@@ -62,10 +62,10 @@ def preview_widget_to_draw(widget: WIDGET_TYPES) -> Text:
 def remove_all_widgets(pdf: bytes) -> bytes:
     """Removes all widgets from a PDF form."""
 
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
     result_stream = BytesIO()
     writer = PdfWriter()
-    for page in pdf.pages:
+    for page in pdf_file.pages:
         if page.annotations:
             page.annotations.clear()
         writer.add_page(page)
@@ -78,10 +78,10 @@ def remove_all_widgets(pdf: bytes) -> bytes:
 def get_page_streams(pdf: bytes) -> List[bytes]:
     """Returns a list of streams where each is a page of the input PDF."""
 
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
     result = []
 
-    for page in pdf.pages:
+    for page in pdf_file.pages:
         writer = PdfWriter()
         writer.add_page(page)
         with BytesIO() as f:
@@ -96,13 +96,13 @@ def merge_two_pdfs(pdf: bytes, other: bytes) -> bytes:
     """Merges two PDFs into one PDF."""
 
     output = PdfWriter()
-    pdf = PdfReader(stream_to_io(pdf))
-    other = PdfReader(stream_to_io(other))
+    pdf_file = PdfReader(stream_to_io(pdf))
+    other_file = PdfReader(stream_to_io(other))
     result = BytesIO()
 
-    for page in pdf.pages:
+    for page in pdf_file.pages:
         output.add_page(page)
-    for page in other.pages:
+    for page in other_file.pages:
         output.add_page(page)
 
     output.write(result)

PyPDFForm/watermark.py

@@ -165,12 +165,9 @@ def create_watermarks_and_draw(
     watermark = buff.read()
     buff.close()
 
-    results = []
-
-    for i in range(len(pdf_file.pages)):
-        results.append(watermark if i == page_number - 1 else b"")
-
-    return results
+    return [
+        watermark if i == page_number - 1 else b"" for i in range(len(pdf_file.pages))
+    ]
 
 
 def merge_watermarks_with_pdf(
@@ -180,10 +177,10 @@ def merge_watermarks_with_pdf(
     """Merges watermarks with PDF."""
 
     result = BytesIO()
-    pdf = PdfReader(stream_to_io(pdf))
+    pdf_file = PdfReader(stream_to_io(pdf))
     output = PdfWriter()
 
-    for i, page in enumerate(pdf.pages):
+    for i, page in enumerate(pdf_file.pages):
         if watermarks[i]:
             watermark = PdfReader(stream_to_io(watermarks[i]))
             if watermark.pages:

PyPDFForm/widgets/base.py

@@ -29,6 +29,7 @@ class Widget:
     ) -> None:
         """Sets acro form parameters."""
 
+        super().__init__()
         self.page_number = page_number
         self.acro_form_params = {
             "name": name,
@@ -71,8 +72,7 @@ class Widget:
         canvas.save()
         watermark.seek(0)
 
-        result = []
-        for i in range(page_count):
-            result.append(watermark.read() if i == self.page_number - 1 else b"")
-
-        return result
+        return [
+            watermark.read() if i == self.page_number - 1 else b""
+            for i in range(page_count)
+        ]

PyPDFForm/wrapper.py

@@ -36,6 +36,7 @@ class FormWrapper:
     ) -> None:
         """Constructs all attributes for the object."""
 
+        super().__init__()
         self.stream = fp_or_f_obj_or_stream_to_stream(template)
 
     def read(self) -> bytes:
@@ -292,15 +293,13 @@ class PdfWrapper(FormWrapper):
     def schema(self) -> dict:
         """Generates a json schema for the PDF form template."""
 
-        result = {
+        return {
             "type": "object",
             "properties": {
                 key: value.schema_definition for key, value in self.widgets.items()
             },
         }
 
-        return result
-
     @classmethod
     def register_font(
         cls, font_name: str, ttf_file: Union[bytes, str, BinaryIO]

{PyPDFForm-1.4.29.dist-info → PyPDFForm-1.4.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPDFForm
-Version: 1.4.29
+Version: 1.4.31
 Summary: The Python library for PDF forms.
 Home-page: https://github.com/chinapandaman/PyPDFForm
 Author: Jinge Li

PyPDFForm-1.4.31.dist-info/RECORD

@@ -0,0 +1,30 @@
+PyPDFForm/__init__.py,sha256=pRovsD1TN9FVIkHD1qURZWnJ9SMefn8yY8jivZI5Tzs,179
+PyPDFForm/adapter.py,sha256=WFP-r8FLeKa-D9mFO9AphOcuXgyeAI1Ak0d-YsqxsK4,861
+PyPDFForm/constants.py,sha256=FMsdOvnYpchEfki3gf_Y2Wj1SThUxMzsPbOx12_S1GA,1738
+PyPDFForm/coordinate.py,sha256=V_ZZQ1pXtVPAyfMJCX7fKoEimK7XwX6bU3VQ0nKOhQA,7314
+PyPDFForm/filler.py,sha256=pgMA7EC8axKUganmbk7X1uDdsb4OQQFoiI85td3pOO4,7486
+PyPDFForm/font.py,sha256=TbFLY4G72d7cQ3VG2g4HaYKROzQPQUmh6-8ynN6hzXY,5713
+PyPDFForm/image.py,sha256=0GV8PFgY5oLJFHmhPD1fG-_5SBEO7jVLLtxCc_Uodfo,1143
+PyPDFForm/patterns.py,sha256=p33mDZKxQN2h8GgVnZGXNolWPzofky1llIpstjnL3eI,4318
+PyPDFForm/template.py,sha256=a9rDzhHHfnYFo8cDnHnRE9UriUykXvrsyFKVGq9DYd0,13166
+PyPDFForm/utils.py,sha256=9omR-oT3OdZqioxpiGqA9_P0GSFC6mg4Y1xrLvWOzkk,4309
+PyPDFForm/watermark.py,sha256=L4LfzjjyJ6TDq9ad2dbtQYheBOic1_oZ7smhFFekNog,4725
+PyPDFForm/wrapper.py,sha256=Rrb7PhbAWEWOwOX3Z5m-TEfTZfCnEY4AsWg7ashPe7c,9498
+PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PyPDFForm/middleware/base.py,sha256=p-3XsZJ6d7ai2JFLF7LisMWi9yzM3pN7CsFECxtEoI0,751
+PyPDFForm/middleware/checkbox.py,sha256=3-9CMhhtyO9U6lLXDciW-59ng8uS4m6_clPB02mzV9c,1317
+PyPDFForm/middleware/dropdown.py,sha256=On4bn8U9NSzDqytLEQuP5nEGTanJUm_DjtykYcJpyrI,672
+PyPDFForm/middleware/image.py,sha256=xjPxRiGBWFEU3EQGGqJXY1iMX1kmr0jO8O9iVUC5rcc,177
+PyPDFForm/middleware/radio.py,sha256=ehaJoehEzZqxDVb5A6fJkYludeBmtV2Z5GZUPPfUWng,700
+PyPDFForm/middleware/signature.py,sha256=m7tNvGZ7fQ0yuVKzSlLbNQ2IILo1GDnjzMDzMnYCKVM,1104
+PyPDFForm/middleware/text.py,sha256=LNY_9Y2tq3uQEneKoL4vgrJtFTva0KSYzuuzDb5METM,1055
+PyPDFForm/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PyPDFForm/widgets/base.py,sha256=mb8pKLu9d80pr-175T8f0FI1kWo2IOJ5am2_zRQKUl0,2075
+PyPDFForm/widgets/checkbox.py,sha256=MGB6NGI-XMBz4j2erykgYOCd1pswvthuQ6UFowQOd4o,503
+PyPDFForm/widgets/dropdown.py,sha256=2_R5xcLUWAL0G4raVgWWtE7TJdiWJITay-Gtl8YI2QI,705
+PyPDFForm/widgets/text.py,sha256=x8EglZLYoI9osN9wORLRYoR7lebrpj-wx38QiRH7H1A,629
+PyPDFForm-1.4.31.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
+PyPDFForm-1.4.31.dist-info/METADATA,sha256=gnvLbIDdwFs1FaYpgGx2rgjTMEA1KeFHngG72BH-CtU,4151
+PyPDFForm-1.4.31.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
+PyPDFForm-1.4.31.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
+PyPDFForm-1.4.31.dist-info/RECORD,,

{PyPDFForm-1.4.29.dist-info → PyPDFForm-1.4.31.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.1.1)
+Generator: setuptools (70.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

PyPDFForm-1.4.29.dist-info/RECORD

@@ -1,30 +0,0 @@
-PyPDFForm/__init__.py,sha256=7PqqRfPhC05fsbxMhlPBXIs5vnUxIuZeSrivp55uw94,138
-PyPDFForm/adapter.py,sha256=OgAIwcmukpBqHFBLymd3I7wA7wIdipRqgURZA2Y0Hgo,885
-PyPDFForm/constants.py,sha256=Y-WINNe5GoOPfBFQroWuzzLELhAl-Fj_d7_3b1QodW0,1767
-PyPDFForm/coordinate.py,sha256=V_ZZQ1pXtVPAyfMJCX7fKoEimK7XwX6bU3VQ0nKOhQA,7314
-PyPDFForm/filler.py,sha256=pgMA7EC8axKUganmbk7X1uDdsb4OQQFoiI85td3pOO4,7486
-PyPDFForm/font.py,sha256=DCaKN6WIfNeMpP6ud17q1FOVRQXqrdevLycIQ9kItXQ,5711
-PyPDFForm/image.py,sha256=0GV8PFgY5oLJFHmhPD1fG-_5SBEO7jVLLtxCc_Uodfo,1143
-PyPDFForm/patterns.py,sha256=Ylfe6s9UV2X7cRAFQjaGoEa4nVSpEn-MLrH7IROp_aY,4332
-PyPDFForm/template.py,sha256=u3QxYdsT8HhoUBlhmChYaTJeFWI-SSrhICtUYsTTrow,13141
-PyPDFForm/utils.py,sha256=gDeRDszZ5Q59RjZjJYnikS2pQ_hc78osQH2Oy1TuLsY,4269
-PyPDFForm/watermark.py,sha256=clYdRqCuWEE25IL-BUHnSo4HgLkHPSOl7FUJLhbAfGg,4755
-PyPDFForm/wrapper.py,sha256=nwmaBkcnd0wt53s9SHHWFCvSJX4J2f7MU3ktt3105WU,9496
-PyPDFForm/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-PyPDFForm/middleware/base.py,sha256=TmoO8XpjFa5NerAumrAGm_kUt2eFP3DyyF-Vx0uXloM,724
-PyPDFForm/middleware/checkbox.py,sha256=Z92awlKjceMd_ryb9Fhrtyd4fLkU84Ii6fSum60rHcA,1305
-PyPDFForm/middleware/dropdown.py,sha256=BpRh2YPndhhaLY-s-3gqck64d5FoC719-ARgvfV3_N0,674
-PyPDFForm/middleware/image.py,sha256=xjPxRiGBWFEU3EQGGqJXY1iMX1kmr0jO8O9iVUC5rcc,177
-PyPDFForm/middleware/radio.py,sha256=ehaJoehEzZqxDVb5A6fJkYludeBmtV2Z5GZUPPfUWng,700
-PyPDFForm/middleware/signature.py,sha256=m7tNvGZ7fQ0yuVKzSlLbNQ2IILo1GDnjzMDzMnYCKVM,1104
-PyPDFForm/middleware/text.py,sha256=-ETNQoLvgu5cLkpIQtNYHtq75Ou3P7ezYur-E1yb9-k,1057
-PyPDFForm/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-PyPDFForm/widgets/base.py,sha256=Stq-oQt-cfwQ6nilQ4NqpO5udFSKDNb1mAwryrWggZA,2076
-PyPDFForm/widgets/checkbox.py,sha256=MGB6NGI-XMBz4j2erykgYOCd1pswvthuQ6UFowQOd4o,503
-PyPDFForm/widgets/dropdown.py,sha256=2_R5xcLUWAL0G4raVgWWtE7TJdiWJITay-Gtl8YI2QI,705
-PyPDFForm/widgets/text.py,sha256=x8EglZLYoI9osN9wORLRYoR7lebrpj-wx38QiRH7H1A,629
-PyPDFForm-1.4.29.dist-info/LICENSE,sha256=43awmYkI6opyTpg19me731iO1WfXZwViqb67oWtCsFY,1065
-PyPDFForm-1.4.29.dist-info/METADATA,sha256=XpWnZIbenPQtjTIZKAovCTQP7HX0vobgn70b5kc_Tms,4151
-PyPDFForm-1.4.29.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
-PyPDFForm-1.4.29.dist-info/top_level.txt,sha256=GQQKuWqPUjT9YZqwK95NlAQzxjwoQrsxQ8ureM8lWOY,10
-PyPDFForm-1.4.29.dist-info/RECORD,,