Skip to content

hdx.utilities.useragent

module hdx.utilities.useragent

User agent utilities.

Classes

class UserAgentError()

Bases : Exception

class UserAgent()

Methods

  • clear_global — Clear stored user agent string.

  • set_global — Set global user agent string.

  • get — Get full user agent string from parameters if supplied falling back on global user agent if set.

classmethod UserAgent.clear_global() → None

Clear stored user agent string.

Returns

  • None — None

classmethod UserAgent.set_global(user_agent: str | None = None, user_agent_config_yaml: Path | str | None = None, user_agent_lookup: str | None = None, **kwargs: Any) → None

Set global user agent string.

Parameters

  • user_agent : str | None — User agent string. HDXPythonLibrary/X.X.X- is prefixed.

  • user_agent_config_yaml : Path | str | None — Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.

  • user_agent_lookup : str | None — Lookup key for YAML. Ignored if user_agent supplied.

Returns

  • None — None

classmethod UserAgent.get(user_agent: str | None = None, user_agent_config_yaml: Path | str | None = None, user_agent_lookup: str | None = None, **kwargs: Any) → str

Get full user agent string from parameters if supplied falling back on global user agent if set.

Parameters

  • user_agent : str | None — User agent string. HDXPythonLibrary/X.X.X- is prefixed.

  • user_agent_config_yaml : Path | str | None — Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.

  • user_agent_lookup : str | None — Lookup key for YAML. Ignored if user_agent supplied.

Returns

  • str — Full user agent string

Raises