Skip to content

Commit dba36f7

Browse files
committed
refactor(api): rename user_agent parameter to user_agent_package in BaseClient, SyncAPIClient, and AsyncAPIClient for better clarity
1 parent 7f515bc commit dba36f7

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

src/gradient/_base_client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ def __init__(
376376
timeout: float | Timeout | None = DEFAULT_TIMEOUT,
377377
custom_headers: Mapping[str, str] | None = None,
378378
custom_query: Mapping[str, object] | None = None,
379-
user_agent: str | None = None,
379+
user_agent_package: str | None = None,
380380
user_agent_version: str | None = None,
381381
) -> None:
382382
self._version = version
@@ -388,7 +388,7 @@ def __init__(
388388
self._strict_response_validation = _strict_response_validation
389389
self._idempotency_header = None
390390
self._platform: Platform | None = None
391-
self._user_agent_name = user_agent
391+
self._user_agent_package = user_agent_package
392392
self._user_agent_version = user_agent_version
393393

394394
if max_retries is None: # pyright: ignore[reportUnnecessaryComparison]
@@ -676,8 +676,8 @@ def _validate_headers(
676676
@property
677677
def user_agent(self) -> str:
678678
# Format: "Gradient/package/version"
679-
package = self._user_agent_name or "Python"
680-
version = self._user_agent_version if self._user_agent_name and self._user_agent_version else self._version
679+
package = self._user_agent_package or "Python"
680+
version = self._user_agent_version if self._user_agent_package and self._user_agent_version else self._version
681681
return f"Gradient/{package}/{version}"
682682

683683
@property
@@ -867,7 +867,7 @@ def __init__(
867867
custom_query=custom_query,
868868
custom_headers=custom_headers,
869869
_strict_response_validation=_strict_response_validation,
870-
user_agent=user_agent,
870+
user_agent_package=user_agent_package,
871871
user_agent_version=user_agent_version,
872872
)
873873
self._client = http_client or SyncHttpxClientWrapper(
@@ -1401,7 +1401,7 @@ def __init__(
14011401
custom_query=custom_query,
14021402
custom_headers=custom_headers,
14031403
_strict_response_validation=_strict_response_validation,
1404-
user_agent=user_agent,
1404+
user_agent_package=user_agent_package,
14051405
user_agent_version=user_agent_version,
14061406
)
14071407
self._client = http_client or AsyncHttpxClientWrapper(

src/gradient/_client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ def __init__(
107107
# part of our public interface in the future.
108108
_strict_response_validation: bool = False,
109109
# User agent tracking parameters
110-
user_agent: str | None = None,
110+
user_agent_package: str | None = None,
111111
user_agent_version: str | None = None,
112112
) -> None:
113113
"""Construct a new synchronous Gradient client instance.
@@ -172,7 +172,7 @@ def __init__(
172172
custom_headers=default_headers,
173173
custom_query=default_query,
174174
_strict_response_validation=_strict_response_validation,
175-
user_agent=user_agent,
175+
user_agent_package=user_agent_package,
176176
user_agent_version=user_agent_version,
177177
)
178178

@@ -420,7 +420,7 @@ def __init__(
420420
# part of our public interface in the future.
421421
_strict_response_validation: bool = False,
422422
# User agent tracking parameters
423-
user_agent: str | None = None,
423+
user_agent_package: str | None = None,
424424
user_agent_version: str | None = None,
425425
) -> None:
426426
"""Construct a new async AsyncGradient client instance.
@@ -485,7 +485,7 @@ def __init__(
485485
custom_headers=default_headers,
486486
custom_query=default_query,
487487
_strict_response_validation=_strict_response_validation,
488-
user_agent=user_agent,
488+
user_agent_package=user_agent_package,
489489
user_agent_version=user_agent_version,
490490
)
491491

0 commit comments

Comments
 (0)