Skip to content

Commit 6e9cf6a

Browse files
datalogics-kamdatalogics-cgreen
datalogics-kam
authored and
datalogics-cgreen
committed
client: Add default values for PDF conversion parameters
- Set default values for `compression`, `downsample`, `tagged_pdf`, `page_size`, `page_margin`, `page_orientation`, and `web_layout` in client methods. - Aligned test cases with updated defaults to ensure consistent behavior. Assisted-by: Codex
1 parent 5fffcc3 commit 6e9cf6a

4 files changed

Lines changed: 42 additions & 32 deletions

File tree

‎src/pdfrest/client.py‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3309,9 +3309,9 @@ def convert_office_to_pdf(
33093309
file: PdfRestFile | Sequence[PdfRestFile],
33103310
*,
33113311
output: str | None = None,
3312-
compression: PdfConversionCompression | None = None,
3313-
downsample: PdfConversionDownsample | None = None,
3314-
tagged_pdf: bool | None = None,
3312+
compression: PdfConversionCompression = "lossy",
3313+
downsample: PdfConversionDownsample = 300,
3314+
tagged_pdf: bool = False,
33153315
locale: PdfConversionLocale | None = None,
33163316
page_size: HtmlPageSize | None = None,
33173317
page_margin: str | None = None,
@@ -3353,7 +3353,7 @@ def convert_postscript_to_pdf(
33533353
file: PdfRestFile | Sequence[PdfRestFile],
33543354
*,
33553355
output: str | None = None,
3356-
compression: PdfConversionCompression | None = None,
3356+
compression: PdfConversionCompression = "lossy",
33573357
downsample: PdfConversionDownsample | None = None,
33583358
extra_query: Query | None = None,
33593359
extra_headers: AnyMapping | None = None,
@@ -3441,12 +3441,12 @@ def convert_html_to_pdf(
34413441
file: PdfRestFile | Sequence[PdfRestFile],
34423442
*,
34433443
output: str | None = None,
3444-
compression: PdfConversionCompression | None = None,
3445-
downsample: PdfConversionDownsample | None = None,
3446-
page_size: HtmlPageSize | None = None,
3447-
page_margin: str | None = None,
3448-
page_orientation: HtmlPageOrientation | None = None,
3449-
web_layout: HtmlWebLayout | None = None,
3444+
compression: PdfConversionCompression = "lossy",
3445+
downsample: PdfConversionDownsample = 300,
3446+
page_size: HtmlPageSize = "letter",
3447+
page_margin: str = "1.0in",
3448+
page_orientation: HtmlPageOrientation = "portrait",
3449+
web_layout: HtmlWebLayout = "desktop",
34503450
extra_query: Query | None = None,
34513451
extra_headers: AnyMapping | None = None,
34523452
extra_body: Body | None = None,
@@ -3481,12 +3481,12 @@ def convert_url_to_pdf(
34813481
url: UrlValue,
34823482
*,
34833483
output: str | None = None,
3484-
compression: PdfConversionCompression | None = None,
3485-
downsample: PdfConversionDownsample | None = None,
3486-
page_size: HtmlPageSize | None = None,
3487-
page_margin: str | None = None,
3488-
page_orientation: HtmlPageOrientation | None = None,
3489-
web_layout: HtmlWebLayout | None = None,
3484+
compression: PdfConversionCompression = "lossy",
3485+
downsample: PdfConversionDownsample = 300,
3486+
page_size: HtmlPageSize = "letter",
3487+
page_margin: str = "1.0in",
3488+
page_orientation: HtmlPageOrientation = "portrait",
3489+
web_layout: HtmlWebLayout = "desktop",
34903490
extra_query: Query | None = None,
34913491
extra_headers: AnyMapping | None = None,
34923492
extra_body: Body | None = None,
@@ -5012,9 +5012,9 @@ async def convert_office_to_pdf(
50125012
file: PdfRestFile | Sequence[PdfRestFile],
50135013
*,
50145014
output: str | None = None,
5015-
compression: PdfConversionCompression | None = None,
5016-
downsample: PdfConversionDownsample | None = None,
5017-
tagged_pdf: bool | None = None,
5015+
compression: PdfConversionCompression = "lossy",
5016+
downsample: PdfConversionDownsample = 300,
5017+
tagged_pdf: bool = False,
50185018
locale: PdfConversionLocale | None = None,
50195019
page_size: HtmlPageSize | None = None,
50205020
page_margin: str | None = None,
@@ -5056,7 +5056,7 @@ async def convert_postscript_to_pdf(
50565056
file: PdfRestFile | Sequence[PdfRestFile],
50575057
*,
50585058
output: str | None = None,
5059-
compression: PdfConversionCompression | None = None,
5059+
compression: PdfConversionCompression = "lossy",
50605060
downsample: PdfConversionDownsample | None = None,
50615061
extra_query: Query | None = None,
50625062
extra_headers: AnyMapping | None = None,
@@ -5144,12 +5144,12 @@ async def convert_html_to_pdf(
51445144
file: PdfRestFile | Sequence[PdfRestFile],
51455145
*,
51465146
output: str | None = None,
5147-
compression: PdfConversionCompression | None = None,
5148-
downsample: PdfConversionDownsample | None = None,
5149-
page_size: HtmlPageSize | None = None,
5150-
page_margin: str | None = None,
5151-
page_orientation: HtmlPageOrientation | None = None,
5152-
web_layout: HtmlWebLayout | None = None,
5147+
compression: PdfConversionCompression = "lossy",
5148+
downsample: PdfConversionDownsample = 300,
5149+
page_size: HtmlPageSize = "letter",
5150+
page_margin: str = "1.0in",
5151+
page_orientation: HtmlPageOrientation = "portrait",
5152+
web_layout: HtmlWebLayout = "desktop",
51535153
extra_query: Query | None = None,
51545154
extra_headers: AnyMapping | None = None,
51555155
extra_body: Body | None = None,
@@ -5184,12 +5184,12 @@ async def convert_url_to_pdf(
51845184
url: UrlValue,
51855185
*,
51865186
output: str | None = None,
5187-
compression: PdfConversionCompression | None = None,
5188-
downsample: PdfConversionDownsample | None = None,
5189-
page_size: HtmlPageSize | None = None,
5190-
page_margin: str | None = None,
5191-
page_orientation: HtmlPageOrientation | None = None,
5192-
web_layout: HtmlWebLayout | None = None,
5187+
compression: PdfConversionCompression = "lossy",
5188+
downsample: PdfConversionDownsample = 300,
5189+
page_size: HtmlPageSize = "letter",
5190+
page_margin: str = "1.0in",
5191+
page_orientation: HtmlPageOrientation = "portrait",
5192+
web_layout: HtmlWebLayout = "desktop",
51935193
extra_query: Query | None = None,
51945194
extra_headers: AnyMapping | None = None,
51955195
extra_body: Body | None = None,

‎tests/test_convert_html_to_pdf.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ def test_convert_html_to_pdf_success(monkeypatch: pytest.MonkeyPatch) -> None:
3232
"page_orientation": "landscape",
3333
"web_layout": "tablet",
3434
"compression": "lossy",
35+
"downsample": 300,
3536
}
3637
).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
3738

@@ -183,7 +184,12 @@ async def test_async_convert_html_to_pdf_success(
183184
{
184185
"files": [input_file],
185186
"output": "async-converted",
187+
"compression": "lossy",
188+
"downsample": 300,
189+
"page_size": "letter",
190+
"page_margin": "1.0in",
186191
"page_orientation": "portrait",
192+
"web_layout": "desktop",
187193
}
188194
).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
189195

‎tests/test_convert_office_to_pdf.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,9 @@ async def test_async_convert_office_to_pdf_success(
189189
{
190190
"files": [input_file],
191191
"output": "async-converted",
192+
"compression": "lossy",
193+
"downsample": 300,
194+
"tagged_pdf": False,
192195
"locale": "US",
193196
}
194197
).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)

‎tests/test_convert_urls_to_pdf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ def test_convert_urls_to_pdf_success(monkeypatch: pytest.MonkeyPatch) -> None:
2121
{
2222
"url": url,
2323
"output": "url-out",
24+
"compression": "lossy",
2425
"page_size": "letter",
2526
"page_margin": "2.5in",
2627
"page_orientation": "portrait",

0 commit comments

Comments
 (0)