Skip to content

Commit 5e2b358

Browse files
datalogics-kamdatalogics-kam
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 cfb509b commit 5e2b358

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
@@ -3192,9 +3192,9 @@ def convert_office_to_pdf(
31923192
file: PdfRestFile | Sequence[PdfRestFile],
31933193
*,
31943194
output: str | None = None,
3195-
compression: PdfConversionCompression | None = None,
3196-
downsample: PdfConversionDownsample | None = None,
3197-
tagged_pdf: bool | None = None,
3195+
compression: PdfConversionCompression = "lossy",
3196+
downsample: PdfConversionDownsample = 300,
3197+
tagged_pdf: bool = False,
31983198
locale: PdfConversionLocale | None = None,
31993199
page_size: HtmlPageSize | None = None,
32003200
page_margin: str | None = None,
@@ -3236,7 +3236,7 @@ def convert_postscript_to_pdf(
32363236
file: PdfRestFile | Sequence[PdfRestFile],
32373237
*,
32383238
output: str | None = None,
3239-
compression: PdfConversionCompression | None = None,
3239+
compression: PdfConversionCompression = "lossy",
32403240
downsample: PdfConversionDownsample | None = None,
32413241
extra_query: Query | None = None,
32423242
extra_headers: AnyMapping | None = None,
@@ -3324,12 +3324,12 @@ def convert_html_to_pdf(
33243324
file: PdfRestFile | Sequence[PdfRestFile],
33253325
*,
33263326
output: str | None = None,
3327-
compression: PdfConversionCompression | None = None,
3328-
downsample: PdfConversionDownsample | None = None,
3329-
page_size: HtmlPageSize | None = None,
3330-
page_margin: str | None = None,
3331-
page_orientation: HtmlPageOrientation | None = None,
3332-
web_layout: HtmlWebLayout | None = None,
3327+
compression: PdfConversionCompression = "lossy",
3328+
downsample: PdfConversionDownsample = 300,
3329+
page_size: HtmlPageSize = "letter",
3330+
page_margin: str = "1.0in",
3331+
page_orientation: HtmlPageOrientation = "portrait",
3332+
web_layout: HtmlWebLayout = "desktop",
33333333
extra_query: Query | None = None,
33343334
extra_headers: AnyMapping | None = None,
33353335
extra_body: Body | None = None,
@@ -3364,12 +3364,12 @@ def convert_url_to_pdf(
33643364
url: UrlValue,
33653365
*,
33663366
output: str | None = None,
3367-
compression: PdfConversionCompression | None = None,
3368-
downsample: PdfConversionDownsample | None = None,
3369-
page_size: HtmlPageSize | None = None,
3370-
page_margin: str | None = None,
3371-
page_orientation: HtmlPageOrientation | None = None,
3372-
web_layout: HtmlWebLayout | None = None,
3367+
compression: PdfConversionCompression = "lossy",
3368+
downsample: PdfConversionDownsample = 300,
3369+
page_size: HtmlPageSize = "letter",
3370+
page_margin: str = "1.0in",
3371+
page_orientation: HtmlPageOrientation = "portrait",
3372+
web_layout: HtmlWebLayout = "desktop",
33733373
extra_query: Query | None = None,
33743374
extra_headers: AnyMapping | None = None,
33753375
extra_body: Body | None = None,
@@ -4784,9 +4784,9 @@ async def convert_office_to_pdf(
47844784
file: PdfRestFile | Sequence[PdfRestFile],
47854785
*,
47864786
output: str | None = None,
4787-
compression: PdfConversionCompression | None = None,
4788-
downsample: PdfConversionDownsample | None = None,
4789-
tagged_pdf: bool | None = None,
4787+
compression: PdfConversionCompression = "lossy",
4788+
downsample: PdfConversionDownsample = 300,
4789+
tagged_pdf: bool = False,
47904790
locale: PdfConversionLocale | None = None,
47914791
page_size: HtmlPageSize | None = None,
47924792
page_margin: str | None = None,
@@ -4828,7 +4828,7 @@ async def convert_postscript_to_pdf(
48284828
file: PdfRestFile | Sequence[PdfRestFile],
48294829
*,
48304830
output: str | None = None,
4831-
compression: PdfConversionCompression | None = None,
4831+
compression: PdfConversionCompression = "lossy",
48324832
downsample: PdfConversionDownsample | None = None,
48334833
extra_query: Query | None = None,
48344834
extra_headers: AnyMapping | None = None,
@@ -4916,12 +4916,12 @@ async def convert_html_to_pdf(
49164916
file: PdfRestFile | Sequence[PdfRestFile],
49174917
*,
49184918
output: str | None = None,
4919-
compression: PdfConversionCompression | None = None,
4920-
downsample: PdfConversionDownsample | None = None,
4921-
page_size: HtmlPageSize | None = None,
4922-
page_margin: str | None = None,
4923-
page_orientation: HtmlPageOrientation | None = None,
4924-
web_layout: HtmlWebLayout | None = None,
4919+
compression: PdfConversionCompression = "lossy",
4920+
downsample: PdfConversionDownsample = 300,
4921+
page_size: HtmlPageSize = "letter",
4922+
page_margin: str = "1.0in",
4923+
page_orientation: HtmlPageOrientation = "portrait",
4924+
web_layout: HtmlWebLayout = "desktop",
49254925
extra_query: Query | None = None,
49264926
extra_headers: AnyMapping | None = None,
49274927
extra_body: Body | None = None,
@@ -4956,12 +4956,12 @@ async def convert_url_to_pdf(
49564956
url: UrlValue,
49574957
*,
49584958
output: str | None = None,
4959-
compression: PdfConversionCompression | None = None,
4960-
downsample: PdfConversionDownsample | None = None,
4961-
page_size: HtmlPageSize | None = None,
4962-
page_margin: str | None = None,
4963-
page_orientation: HtmlPageOrientation | None = None,
4964-
web_layout: HtmlWebLayout | None = None,
4959+
compression: PdfConversionCompression = "lossy",
4960+
downsample: PdfConversionDownsample = 300,
4961+
page_size: HtmlPageSize = "letter",
4962+
page_margin: str = "1.0in",
4963+
page_orientation: HtmlPageOrientation = "portrait",
4964+
web_layout: HtmlWebLayout = "desktop",
49654965
extra_query: Query | None = None,
49664966
extra_headers: AnyMapping | None = None,
49674967
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)