pdfdancer-client-python 0.3.11__py3-none-any.whl → 0.3.12__py3-none-any.whl

pdfdancer/__init__.py

@@ -55,7 +55,7 @@ from .paragraph_builder import ParagraphBuilder
 from .path_builder import BezierBuilder, LineBuilder, PathBuilder
 from .text_line_builder import TextLineBuilder
 
-__version__ = "0.3.11"
+__version__ = "0.3.12"
 __all__ = [
     "PDFDancer",
     "ParagraphBuilder",

pdfdancer/pdfdancer_v1.py

@@ -134,7 +134,7 @@ DEFAULT_RETRY_BACKOFF_FACTOR = float(
 
 
 def _dict_to_replacements(
-    replacements: Dict[str, Union[str, dict]]
+    replacements: Dict[str, Union[str, dict]],
 ) -> List[TemplateReplacement]:
     """Convert dict-based replacements to TemplateReplacement list."""
     result = []
@@ -2292,6 +2292,37 @@ class PDFDancer:
         targets = [RedactTarget(obj.internal_id, replacement) for obj in objects]
         return self._redact(targets, replacement, placeholder_color)
 
+    def clear_clipping(self, object_ref: ObjectRef) -> bool:
+        """
+        Clear clipping on a single PDF object.
+
+        Args:
+            object_ref: Reference to the object whose clipping should be removed
+
+        Returns:
+            True when the server cleared clipping successfully
+        """
+        return self._clear_clipping(object_ref)
+
+    def _clear_clipping(self, object_ref: ObjectRef) -> bool:
+        """
+        Internal helper to clear clipping from a single object.
+        """
+        if object_ref is None:
+            raise ValidationException("Object reference cannot be null")
+
+        response = self._make_request(
+            "PUT",
+            "/pdf/clipping/clear",
+            data={"objectRef": object_ref.to_dict()},
+        )
+        result = bool(response.json())
+
+        if result:
+            self._invalidate_snapshots()
+
+        return result
+
     # Template Replacement Operations
 
     def _apply_replacements(
@@ -2506,19 +2537,21 @@ class PDFDancer:
             data["pathIds"] = path_ids
         if region is not None:
             data["region"] = {
-                "x": region.x, "y": region.y,
-                "width": region.width, "height": region.height,
+                "x": region.x,
+                "y": region.y,
+                "width": region.width,
+                "height": region.height,
             }
-        response = self._make_request(
-            "POST", "/pdf/path-group/create", data=data
-        )
+        response = self._make_request("POST", "/pdf/path-group/create", data=data)
         self._invalidate_snapshots()
         return PathGroupInfo.from_dict(response.json())
 
     def _move_path_group(self, page_index, group_id, x, y):
         data = {
-            "pageIndex": page_index, "groupId": group_id,
-            "x": x, "y": y,
+            "pageIndex": page_index,
+            "groupId": group_id,
+            "x": x,
+            "y": y,
         }
         response = self._make_request("PUT", "/pdf/path-group/move", data=data)
         self._invalidate_snapshots()
@@ -2526,13 +2559,12 @@ class PDFDancer:
 
     def _transform_path_group(self, page_index, group_id, transform_type, **kwargs):
         data = {
-            "pageIndex": page_index, "groupId": group_id,
+            "pageIndex": page_index,
+            "groupId": group_id,
             "transformType": transform_type,
         }
         data.update({k: v for k, v in kwargs.items() if v is not None})
-        response = self._make_request(
-            "PUT", "/pdf/path-group/transform", data=data
-        )
+        response = self._make_request("PUT", "/pdf/path-group/transform", data=data)
         self._invalidate_snapshots()
         return response.json()
 
@@ -2552,15 +2584,16 @@ class PDFDancer:
         if width <= 0 or height <= 0:
             raise ValidationException("Width and height must be positive")
         return self._transform_path_group(
-            page_index, group_id, "RESIZE",
-            targetWidth=width, targetHeight=height,
+            page_index,
+            group_id,
+            "RESIZE",
+            targetWidth=width,
+            targetHeight=height,
         )
 
     def _remove_path_group(self, page_index, group_id):
         data = {"pageIndex": page_index, "groupId": group_id}
-        response = self._make_request(
-            "DELETE", "/pdf/path-group/remove", data=data
-        )
+        response = self._make_request("DELETE", "/pdf/path-group/remove", data=data)
         self._invalidate_snapshots()
         return response.json()
 
@@ -2568,12 +2601,52 @@ class PDFDancer:
         from .models import PathGroupInfo
         from .types import PathGroupObject
 
-        response = self._make_request(
-            "GET", f"/pdf/page/{page_index}/path-groups"
-        )
+        response = self._make_request("GET", f"/pdf/page/{page_index}/path-groups")
         infos = [PathGroupInfo.from_dict(d) for d in response.json()]
         return [PathGroupObject(self, page_index, info) for info in infos]
 
+    def clear_path_group_clipping(self, page_number: int, group_id: str) -> bool:
+        """
+        Clear clipping for a grouped set of paths.
+
+        Args:
+            page_number: 1-based page number containing the path group
+            group_id: Identifier returned by `group_paths(...)`
+
+        Returns:
+            True when the server cleared clipping successfully
+        """
+        return self._clear_path_group_clipping(page_number, group_id)
+
+    def _clear_path_group_clipping(self, page_number: int, group_id: str) -> bool:
+        """
+        Internal helper to clear clipping from a path group using the v1 API.
+        """
+        if page_number is None:
+            raise ValidationException("page_number cannot be null")
+        if not isinstance(page_number, int):
+            raise ValidationException(
+                f"page_number must be an integer, got {type(page_number)}"
+            )
+        if page_number < 1:
+            raise ValidationException(
+                f"page_number must be >= 1 (1-based indexing), got {page_number}"
+            )
+        if group_id is None or not str(group_id).strip():
+            raise ValidationException("group_id cannot be null or empty")
+
+        response = self._make_request(
+            "PUT",
+            "/pdf/path-group/clipping/clear",
+            data={"pageNumber": page_number, "groupId": str(group_id).strip()},
+        )
+        result = bool(response.json())
+
+        if result:
+            self._invalidate_snapshots()
+
+        return result
+
     def new_paragraph(self) -> ParagraphBuilder:
         return ParagraphBuilder(self)
 

pdfdancer/types.py

@@ -65,6 +65,10 @@ class PDFObjectBase:
             Position.at_page_coordinates(self.position.page_number, x, y),
         )
 
+    def clear_clipping(self) -> bool:
+        """Detach any active clipping path from this object."""
+        return self._client.clear_clipping(self.object_ref())
+
     def redact(self, replacement: str = "[REDACTED]") -> bool:
         """Redact this object from the PDF document."""
         from .models import RedactTarget
@@ -329,21 +333,22 @@ class PathGroupObject:
         return True
 
     def rotate(self, degrees: float) -> bool:
-        self._client._rotate_path_group(
-            self._page_index, self.group_id, degrees
-        )
+        self._client._rotate_path_group(self._page_index, self.group_id, degrees)
         return True
 
     def resize(self, width: float, height: float) -> bool:
-        self._client._resize_path_group(
-            self._page_index, self.group_id, width, height
-        )
+        self._client._resize_path_group(self._page_index, self.group_id, width, height)
         return True
 
     def remove(self) -> bool:
         self._client._remove_path_group(self._page_index, self.group_id)
         return True
 
+    def clear_clipping(self) -> bool:
+        return self._client.clear_path_group_clipping(
+            self._page_index + 1, self.group_id
+        )
+
     def __repr__(self):
         return f"PathGroupObject(group_id={self.group_id!r}, path_count={self.path_count}, page_index={self._page_index})"
 

{pdfdancer_client_python-0.3.11.dist-info → pdfdancer_client_python-0.3.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdfdancer-client-python
-Version: 0.3.11
+Version: 0.3.12
 Summary: Python client for PDFDancer API
 Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
 License: 
@@ -359,7 +359,7 @@ with PDFDancer.open("contract.pdf") as pdf:
 ```
 
 Selectors return typed objects (`ParagraphObject`, `TextLineObject`, `ImageObject`, `FormFieldObject`, `PageClient`, …)
-with helpers such as `delete()`, `move_to(x, y)`, `redact()`, or `edit()` depending on the object type.
+with helpers such as `delete()`, `move_to(x, y)`, `clear_clipping()`, `redact()`, or `edit()` depending on the object type.
 
 **Singular selection methods** return the first match (or `None`) for convenience:
 

{pdfdancer_client_python-0.3.11.dist-info → pdfdancer_client_python-0.3.12.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pdfdancer/__init__.py,sha256=qWqBV3h56VKzL7lzH9SZ-N09qNR-nwuBxpquBtswOKE,2884
+pdfdancer/__init__.py,sha256=DiYQ2gDQ4kYu8eUXc7Z-0vgdoeBi0Cek5jusrq0LYVE,2884
 pdfdancer/exceptions.py,sha256=U6kD3NvcdNt05_OU11Tml5dXGtlodEtYC9zcV4fHXkc,2270
 pdfdancer/fingerprint.py,sha256=eL3PHPgv-knMya7s95RXg3qzzpkAA1aevxqb6tuOb34,3061
 pdfdancer/image_builder.py,sha256=aBxMFAMFzzbGTjlVH0hi94mA81cH8tp37Pk84HRPV00,1892
@@ -6,12 +6,12 @@ pdfdancer/models.py,sha256=nrR8ssEIz7BttWCMv7F0oriTego5Jh-h-34GvJmoni8,60462
 pdfdancer/page_builder.py,sha256=ARWLRtlrLGbES-0nbiigTOsRVmodRX0DNK8YIAkA9Ig,3850
 pdfdancer/paragraph_builder.py,sha256=OmhzYazMnq0n0rhrjWcKbo0LQfEC7BZoiLB29ycF630,20504
 pdfdancer/path_builder.py,sha256=safKb_IeHRWlQbyBTIXfcoBfXxUZhuzYvBIob5Tbp-8,23938
-pdfdancer/pdfdancer_v1.py,sha256=qGfgRG247wz-4i8H-jADvbl0vkKMlLdZdH-xVwOFIIY,135917
+pdfdancer/pdfdancer_v1.py,sha256=JaiB47v_zgUwb7OtnmnVDt4jroxB5Bh6sGQpAU8ZIBg,138359
 pdfdancer/text_line_builder.py,sha256=8jYknV4hw0fyzwX0OI_oLvnh5aMmCV3jXaVkmYLu6MQ,10273
-pdfdancer/types.py,sha256=5AK8xmPhlvACy_HoF7DtHADy_praBHFmL2QnVwSgBVU,24676
-pdfdancer_client_python-0.3.11.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-pdfdancer_client_python-0.3.11.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
-pdfdancer_client_python-0.3.11.dist-info/METADATA,sha256=ZF4o1QezR6BB7_xkUVMRoWnmKKt7JFH6PjLp4JpJBVw,28736
-pdfdancer_client_python-0.3.11.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-pdfdancer_client_python-0.3.11.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
-pdfdancer_client_python-0.3.11.dist-info/RECORD,,
+pdfdancer/types.py,sha256=w0dJ6JcHgm62BFDzZTx7v10GymjNaZw8x8lKfg-U2zA,24949
+pdfdancer_client_python-0.3.12.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pdfdancer_client_python-0.3.12.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
+pdfdancer_client_python-0.3.12.dist-info/METADATA,sha256=8uO4RQWyE64otUm9cY_Vj9gZsBH5-JpajgDcvijv_JM,28756
+pdfdancer_client_python-0.3.12.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pdfdancer_client_python-0.3.12.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
+pdfdancer_client_python-0.3.12.dist-info/RECORD,,

{pdfdancer_client_python-0.3.11.dist-info → pdfdancer_client_python-0.3.12.dist-info}/WHEEL

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