pdf: Apply regex pattern match to page_margin

Author: datalogics-cgreen

src/pdfrest/models/_internal.py

@@ -247,17 +247,7 @@ def _validate_output_language(value: str) -> str:
     return trimmed
 
 
-_PAGE_MARGIN_PATTERN = re.compile(r"^(?:\d+(?:\.\d+)?)(?:mm|in)$")
-
-
-def _validate_page_margin(value: str | None) -> str | None:
-    if value is None:
-        return None
-    trimmed = value.strip()
-    if not trimmed or not _PAGE_MARGIN_PATTERN.fullmatch(trimmed):
-        msg = "page_margin must be a number followed by 'in' or 'mm'."
-        raise ValueError(msg)
-    return trimmed
+_PAGE_MARGIN_REGEX = r"^(?:\d+(?:\.\d+)?)(?:mm|in)$"
 
 
 class UploadURLs(BaseModel):
@@ -735,8 +725,11 @@ class ConvertHtmlToPdfPayload(BaseModel):
     ] = None
     page_margin: Annotated[
         str | None,
-        Field(serialization_alias="page_margin", default=None),
-        AfterValidator(_validate_page_margin),
+        Field(
+            serialization_alias="page_margin",
+            pattern=_PAGE_MARGIN_REGEX,
+            default=None,
+        ),
     ] = None
     page_orientation: Annotated[
         HtmlPageOrientation | None,
@@ -776,8 +769,11 @@ class ConvertUrlToPdfPayload(BaseModel):
     ] = None
     page_margin: Annotated[
         str | None,
-        Field(serialization_alias="page_margin", default=None),
-        AfterValidator(_validate_page_margin),
+        Field(
+            serialization_alias="page_margin",
+            pattern=_PAGE_MARGIN_REGEX,
+            default=None,
+        ),
     ] = None
     page_orientation: Annotated[
         HtmlPageOrientation | None,

tests/test_convert_html_to_pdf.py

@@ -154,7 +154,7 @@ def test_convert_html_to_pdf_validation_errors() -> None:
             }
         )
 
-    with pytest.raises(ValidationError, match="page_margin must be a number"):
+    with pytest.raises(ValidationError, match="String should match pattern"):
         ConvertHtmlToPdfPayload.model_validate(
             {
                 "files": [
@@ -169,6 +169,63 @@ def test_convert_html_to_pdf_validation_errors() -> None:
         )
 
 
+@pytest.mark.parametrize(
+    "page_margin",
+    [
+        pytest.param("8mm", id="whole-millimeters"),
+        pytest.param("2.5in", id="decimal-inches"),
+        pytest.param("10.25mm", id="long-decimal-millimeters"),
+        pytest.param("0in", id="zero-inches"),
+    ],
+)
+def test_convert_html_to_pdf_page_margin_accepts_documented_values(
+    page_margin: str,
+) -> None:
+    payload = ConvertHtmlToPdfPayload.model_validate(
+        {
+            "files": [
+                make_source_file(
+                    str(PdfRestFileID.generate()),
+                    "text/html",
+                    "example.html",
+                )
+            ],
+            "page_margin": page_margin,
+        }
+    )
+
+    assert payload.page_margin == page_margin
+
+
+@pytest.mark.parametrize(
+    "page_margin",
+    [
+        pytest.param("8", id="missing-unit"),
+        pytest.param("mm", id="missing-number"),
+        pytest.param("2.5 in", id="embedded-space"),
+        pytest.param("8MM", id="uppercase-unit"),
+        pytest.param(" 8mm", id="leading-space"),
+        pytest.param("8mm ", id="trailing-space"),
+    ],
+)
+def test_convert_html_to_pdf_page_margin_rejects_invalid_values(
+    page_margin: str,
+) -> None:
+    with pytest.raises(ValidationError, match="String should match pattern"):
+        ConvertHtmlToPdfPayload.model_validate(
+            {
+                "files": [
+                    make_source_file(
+                        str(PdfRestFileID.generate()),
+                        "text/html",
+                        "example.html",
+                    )
+                ],
+                "page_margin": page_margin,
+            }
+        )
+
+
 @pytest.mark.asyncio
 async def test_async_convert_html_to_pdf_success(
     monkeypatch: pytest.MonkeyPatch,

tests/test_convert_url_to_pdf.py

@@ -79,12 +79,51 @@ def test_convert_url_to_pdf_validation_errors() -> None:
             {"url": ["https://example.com/one", "https://example.com/two"]}
         )
 
-    with pytest.raises(ValidationError, match="page_margin must be a number"):
+    with pytest.raises(ValidationError, match="String should match pattern"):
         ConvertUrlToPdfPayload.model_validate(
             {"url": "https://example.com", "page_margin": "mm"}
         )
 
 
+@pytest.mark.parametrize(
+    "page_margin",
+    [
+        pytest.param("8mm", id="whole-millimeters"),
+        pytest.param("2.5in", id="decimal-inches"),
+        pytest.param("10.25mm", id="long-decimal-millimeters"),
+        pytest.param("0in", id="zero-inches"),
+    ],
+)
+def test_convert_url_to_pdf_page_margin_accepts_documented_values(
+    page_margin: str,
+) -> None:
+    payload = ConvertUrlToPdfPayload.model_validate(
+        {"url": "https://example.com/page", "page_margin": page_margin}
+    )
+
+    assert payload.page_margin == page_margin
+
+
+@pytest.mark.parametrize(
+    "page_margin",
+    [
+        pytest.param("8", id="missing-unit"),
+        pytest.param("mm", id="missing-number"),
+        pytest.param("2.5 in", id="embedded-space"),
+        pytest.param("8MM", id="uppercase-unit"),
+        pytest.param(" 8mm", id="leading-space"),
+        pytest.param("8mm ", id="trailing-space"),
+    ],
+)
+def test_convert_url_to_pdf_page_margin_rejects_invalid_values(
+    page_margin: str,
+) -> None:
+    with pytest.raises(ValidationError, match="String should match pattern"):
+        ConvertUrlToPdfPayload.model_validate(
+            {"url": "https://example.com/page", "page_margin": page_margin}
+        )
+
+
 def test_convert_url_to_pdf_request_customization(
     monkeypatch: pytest.MonkeyPatch,
 ) -> None: