Skip to content

Commit 763de56

Browse files
committed
refactor: Consolidate public URL building into shared helper
1 parent ba67df4 commit 763de56

3 files changed

Lines changed: 26 additions & 44 deletions

File tree

‎src/apify_client/_resource_clients/_resource_client.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
from datetime import UTC, datetime, timedelta
66
from functools import cached_property
77
from typing import TYPE_CHECKING, Any, Literal, get_args
8+
from urllib.parse import urlencode, urlparse, urlunparse
89

910
from apify_client._consts import DEFAULT_WAIT_FOR_FINISH, DEFAULT_WAIT_WHEN_JOB_NOT_EXIST
1011
from apify_client._docs import docs_group
@@ -115,6 +116,25 @@ def _build_url(
115116

116117
return url
117118

119+
def _build_public_url(self, path: str, params: dict[str, Any]) -> str:
120+
"""Build a public resource URL with API-normalized query params.
121+
122+
Normalizes `params` the same way the HTTP request path does (bool→true/false, list→comma-joined,
123+
datetime→ISO 8601 Zulu) so the shareable URL matches what the client would send over the wire.
124+
125+
Args:
126+
path: Path segment appended to the resource URL (e.g. 'items', 'keys').
127+
params: Query parameters to normalize and append.
128+
129+
Returns:
130+
The public URL with a normalized query string.
131+
"""
132+
public_url = urlparse(self._build_url(path, public=True))
133+
filtered_params = self._http_client._parse_params(params) # noqa: SLF001
134+
if filtered_params:
135+
public_url = public_url._replace(query=urlencode(filtered_params))
136+
return urlunparse(public_url)
137+
118138
def _build_params(self, **kwargs: Any) -> dict:
119139
"""Merge default params with method params, filtering out None values.
120140

‎src/apify_client/_resource_clients/dataset.py‎

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
from contextlib import asynccontextmanager, contextmanager
44
from dataclasses import dataclass
55
from typing import TYPE_CHECKING, Any
6-
from urllib.parse import urlencode, urlparse, urlunparse
76

87
from apify_client._docs import docs_group
98
from apify_client._models import Dataset, DatasetResponse, DatasetStatistics, DatasetStatisticsResponse
@@ -606,13 +605,7 @@ def create_items_public_url(
606605
)
607606
request_params['signature'] = signature
608607

609-
items_public_url = urlparse(self._build_url('items', public=True))
610-
# Normalize params (bool→true/false, list→comma-joined) the same way the HTTP request path does.
611-
filtered_params = self._http_client._parse_params(request_params) # noqa: SLF001
612-
if filtered_params:
613-
items_public_url = items_public_url._replace(query=urlencode(filtered_params))
614-
615-
return urlunparse(items_public_url)
608+
return self._build_public_url('items', request_params)
616609

617610

618611
@docs_group('Resource clients')
@@ -1173,10 +1166,4 @@ async def create_items_public_url(
11731166
)
11741167
request_params['signature'] = signature
11751168

1176-
items_public_url = urlparse(self._build_url('items', public=True))
1177-
# Normalize params (bool→true/false, list→comma-joined) the same way the HTTP request path does.
1178-
filtered_params = self._http_client._parse_params(request_params) # noqa: SLF001
1179-
if filtered_params:
1180-
items_public_url = items_public_url._replace(query=urlencode(filtered_params))
1181-
1182-
return urlunparse(items_public_url)
1169+
return self._build_public_url('items', request_params)

‎src/apify_client/_resource_clients/key_value_store.py‎

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
from contextlib import asynccontextmanager, contextmanager
55
from http import HTTPStatus
66
from typing import TYPE_CHECKING, Any
7-
from urllib.parse import urlencode, urlparse, urlunparse
87

98
from apify_client._docs import docs_group
109
from apify_client._models import (
@@ -425,13 +424,7 @@ def get_record_public_url(self, key: str, *, timeout: Timeout = 'long') -> str:
425424
if metadata and metadata.url_signing_secret_key:
426425
request_params['signature'] = create_hmac_signature(metadata.url_signing_secret_key, key)
427426

428-
key_public_url = urlparse(self._build_url(f'records/{key}', public=True))
429-
filtered_params = {k: v for k, v in request_params.items() if v is not None}
430-
431-
if filtered_params:
432-
key_public_url = key_public_url._replace(query=urlencode(filtered_params))
433-
434-
return urlunparse(key_public_url)
427+
return self._build_public_url(f'records/{key}', request_params)
435428

436429
def create_keys_public_url(
437430
self,
@@ -482,13 +475,7 @@ def create_keys_public_url(
482475
)
483476
request_params['signature'] = signature
484477

485-
keys_public_url = urlparse(self._build_url('keys', public=True))
486-
487-
filtered_params = {k: v for k, v in request_params.items() if v is not None}
488-
if filtered_params:
489-
keys_public_url = keys_public_url._replace(query=urlencode(filtered_params))
490-
491-
return urlunparse(keys_public_url)
478+
return self._build_public_url('keys', request_params)
492479

493480

494481
@docs_group('Resource clients')
@@ -853,13 +840,7 @@ async def get_record_public_url(self, key: str, *, timeout: Timeout = 'long') ->
853840
if metadata and metadata.url_signing_secret_key:
854841
request_params['signature'] = create_hmac_signature(metadata.url_signing_secret_key, key)
855842

856-
key_public_url = urlparse(self._build_url(f'records/{key}', public=True))
857-
filtered_params = {k: v for k, v in request_params.items() if v is not None}
858-
859-
if filtered_params:
860-
key_public_url = key_public_url._replace(query=urlencode(filtered_params))
861-
862-
return urlunparse(key_public_url)
843+
return self._build_public_url(f'records/{key}', request_params)
863844

864845
async def create_keys_public_url(
865846
self,
@@ -910,10 +891,4 @@ async def create_keys_public_url(
910891
)
911892
request_params['signature'] = signature
912893

913-
keys_public_url = urlparse(self._build_url('keys', public=True))
914-
915-
filtered_params = {k: v for k, v in request_params.items() if v is not None}
916-
if filtered_params:
917-
keys_public_url = keys_public_url._replace(query=urlencode(filtered_params))
918-
919-
return urlunparse(keys_public_url)
894+
return self._build_public_url('keys', request_params)

0 commit comments

Comments
 (0)