Rename public-facing is_rtl to is_right_to_left

- Rename to "is_right_to_left" for readability
- Keep "is_rtl" alias

Assisted-by: Codex

Author: datalogics-cgreen

src/pdfrest/models/_internal.py

@@ -1121,7 +1121,11 @@ class PdfAddTextObjectModel(BaseModel):
     y: Annotated[float, Field(serialization_alias="y")]
     is_rtl: Annotated[
         bool | None,
-        Field(serialization_alias="is_rtl", default=None),
+        Field(
+            validation_alias=AliasChoices("is_right_to_left", "is_rtl"),
+            serialization_alias="is_rtl",
+            default=None,
+        ),
     ] = None
 
     @model_validator(mode="after")

src/pdfrest/types/public.py

@@ -123,7 +123,7 @@ class PdfAddTextObject(TypedDict, total=False):
     text_size: Required[float | str]
     x: Required[float | str]
     y: Required[float | str]
-    is_rtl: bool
+    is_right_to_left: bool
 
 
 PdfPageSelection = str | int | Sequence[str | int]

tests/test_add_text_to_pdf.py

@@ -51,6 +51,8 @@ def _serialize_text_object_for_request(
     cmyk = serialized.get("text_color_cmyk")
     if isinstance(cmyk, (list, tuple)):
         serialized["text_color_cmyk"] = ",".join(str(channel) for channel in cmyk)
+    if "is_right_to_left" in serialized:
+        serialized["is_rtl"] = serialized.pop("is_right_to_left")
     # Add-text payloads now quote non-string values inside the text_objects JSON.
     for key, value in list(serialized.items()):
         if not isinstance(value, str):
@@ -72,7 +74,11 @@ def handler(request: httpx.Request) -> httpx.Response:
             assert payload["id"] == str(pdf_file.id)
             assert payload["output"] == "with-text"
             assert payload["text_objects"] == json.dumps(
-                [_serialize_text_object_for_request(make_text_object())],
+                [
+                    _serialize_text_object_for_request(
+                        make_text_object(is_right_to_left=True)
+                    )
+                ],
                 separators=(",", ":"),
             )
             return httpx.Response(
@@ -99,7 +105,7 @@ def handler(request: httpx.Request) -> httpx.Response:
     with PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client:
         response = client.add_text_to_pdf(
             pdf_file,
-            text_objects=[make_text_object()],
+            text_objects=[make_text_object(is_right_to_left=True)],
             output="with-text",
         )
 
@@ -283,7 +289,11 @@ def handler(request: httpx.Request) -> httpx.Response:
             payload = json.loads(request.content.decode("utf-8"))
             assert payload["id"] == str(pdf_file.id)
             assert payload["text_objects"] == json.dumps(
-                [_serialize_text_object_for_request(make_text_object(page="all"))],
+                [
+                    _serialize_text_object_for_request(
+                        make_text_object(page="all", is_right_to_left=True)
+                    )
+                ],
                 separators=(",", ":"),
             )
             return httpx.Response(
@@ -310,7 +320,7 @@ def handler(request: httpx.Request) -> httpx.Response:
     async with AsyncPdfRestClient(api_key=ASYNC_API_KEY, transport=transport) as client:
         response = await client.add_text_to_pdf(
             pdf_file,
-            text_objects=[make_text_object(page="all")],
+            text_objects=[make_text_object(page="all", is_right_to_left=True)],
         )
 
     assert seen == {"post": 1, "get": 1}