Skip to content

add user agent prefix and update default user agent #468

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

Merged
ceciliastevens merged 1 commit into from
Dec 17, 2024
Merged

add user agent prefix and update default user agent #468

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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
The intended audience of this file is for py42 consumers -- as such, changes that don't affect
how a consumer would use the library (e.g. adding unit tests, updating documentation, etc) are not captured here.

## Unreleased

### Added

- A setting to add a prefix to the user-agent.

## 1.27.2 - 2024-11-27

### Fixed
Expand Down
12 changes: 9 additions & 3 deletions src/py42/settings/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,22 @@
items_per_page = 500
security_events_per_page = 500

_custom_user_prefix = ""
_custom_user_suffix = ""
_python_version = f"{sys.version_info[0]}.{sys.version_info[1]}.{sys.version_info[2]}"


def get_user_agent_string():
return "py42 {} python {}{}".format(
__version__, _python_version, _custom_user_suffix
return "{}py42/{} python/{}{}".format(
_custom_user_prefix, __version__, _python_version, _custom_user_suffix
)


def set_user_agent_suffix(suffix):
global _custom_user_suffix
_custom_user_suffix = f" {suffix}"
_custom_user_suffix = f" {suffix}" if suffix else ""


def set_user_agent_prefix(prefix):
global _custom_user_prefix
_custom_user_prefix = f"{prefix} " if prefix else ""
9 changes: 8 additions & 1 deletion tests/settings/test_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import py42.settings as settings
from py42.__version__ import __version__

DEFAULT_USER_AGENT_FORMAT = "py42 {0} python {1}"
DEFAULT_USER_AGENT_FORMAT = "py42/{0} python/{1}"


@pytest.fixture
Expand All @@ -29,3 +29,10 @@ def test_get_user_agent_returns_correct_value_after_setting_suffix(default_user_
assert settings.get_user_agent_string() == f"{default_user_agent} example-suffix"
# reset settings to default
settings.set_user_agent_suffix("")


def test_get_user_agent_returns_correct_value_after_setting_prefix(default_user_agent):
settings.set_user_agent_prefix("example-prefix")
assert settings.get_user_agent_string() == f"example-prefix {default_user_agent}"
# reset settings to default
settings.set_user_agent_prefix("")
Loading