Skip to content

REST: Use the standard User-Agent format #4330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rahulsmahadev wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −2
Open

REST: Use the standard User-Agent format #4330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion pyiceberg/catalog/rest/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

import logging
import os
import platform
import sys
import time
import uuid
Expand Down Expand Up @@ -1231,7 +1232,9 @@ def _config_headers(self, session: Session) -> None:
header_properties = get_header_properties(self.properties)
session.headers.update(header_properties)
session.headers["Content-type"] = "application/json"
session.headers["User-Agent"] = f"PyIceberg/{__version__}"
session.headers["User-Agent"] = (
f"pyiceberg/{__version__} ({platform.python_implementation().lower()} {platform.python_version()})"
)
session.headers["X-Client-Version"] = f"PyIceberg {__version__}"
session.headers.setdefault("X-Iceberg-Access-Delegation", ACCESS_DELEGATION_DEFAULT)

Expand Down
17 changes: 16 additions & 1 deletion tests/catalog/test_rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import base64
import os
import platform
import uuid
from collections.abc import Callable, Iterator
from contextlib import contextmanager
Expand Down Expand Up @@ -95,7 +96,7 @@

TEST_HEADERS = {
"Content-type": "application/json",
"User-Agent": f"PyIceberg/{pyiceberg.__version__}",
"User-Agent": f"pyiceberg/{pyiceberg.__version__} ({platform.python_implementation().lower()} {platform.python_version()})",
"Authorization": f"Bearer {TEST_TOKEN}",
"X-Iceberg-Access-Delegation": "vended-credentials",
}
Expand Down Expand Up @@ -3217,6 +3218,20 @@ def test_auth_header(rest_mock: Mocker) -> None:
)


@pytest.mark.parametrize(
("implementation", "python_version", "expected"),
[("CPython", "3.11.4", "pyiceberg/0.11.0 (cpython 3.11.4)"), ("PyPy", "3.10.16", "pyiceberg/0.11.0 (pypy 3.10.16)")],
)
def test_user_agent_header(
rest_mock: Mocker, monkeypatch: pytest.MonkeyPatch, implementation: str, python_version: str, expected: str
) -> None:
monkeypatch.setattr("pyiceberg.catalog.rest.__version__", "0.11.0")
monkeypatch.setattr(platform, "python_implementation", lambda: implementation)
monkeypatch.setattr(platform, "python_version", lambda: python_version)
catalog = RestCatalog("rest", uri=TEST_URI, warehouse="s3://some-bucket")
assert catalog._session.headers["User-Agent"] == expected


def test_client_version_header(rest_mock: Mocker) -> None:
catalog = RestCatalog("rest", uri=TEST_URI, warehouse="s3://some-bucket")
assert catalog._session.headers.get("X-Client-Version") == f"PyIceberg {pyiceberg.__version__}"
Expand Down
Loading