hdx.utilities.useragent

User agent utilities.

UserAgent Objects

class UserAgent()

[view_source]

clear_global

@classmethod
def clear_global(cls) -> None

[view_source]

Clear stored user agent string.

Returns:

None

set_global

@classmethod
def set_global(cls,
               user_agent: Optional[str] = None,
               user_agent_config_yaml: Optional[str] = None,
               user_agent_lookup: Optional[str] = None,
               **kwargs: Any) -> None

[view_source]

Set global user agent string.

Arguments:

  • user_agent Optional[str] - User agent string. HDXPythonLibrary/X.X.X- is prefixed.
  • user_agent_config_yaml Optional[str] - Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
  • user_agent_lookup Optional[str] - Lookup key for YAML. Ignored if user_agent supplied.

Returns:

None

get

@classmethod
def get(cls,
        user_agent: Optional[str] = None,
        user_agent_config_yaml: Optional[str] = None,
        user_agent_lookup: Optional[str] = None,
        **kwargs: Any) -> str

[view_source]

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

Arguments:

  • user_agent Optional[str] - User agent string. HDXPythonLibrary/X.X.X- is prefixed.
  • user_agent_config_yaml Optional[str] - Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
  • user_agent_lookup Optional[str] - Lookup key for YAML. Ignored if user_agent supplied.

Returns:

  • str - Full user agent string