Source code for multiversx_sdk.network_providers.user_agent

import logging
from typing import Any

from multiversx_sdk.network_providers.config import NetworkProviderConfig
from multiversx_sdk.network_providers.constants import UNKNOWN_CLIENT_NAME

logger = logging.getLogger("user_agent")



[docs]
def extend_user_agent(user_agent_prefix: str, config: NetworkProviderConfig):
    if config.client_name is None:
        logger.info("We recommend providing the `client_name` when instantiating a NetworkProvider (e.g. ProxyNetworkProvider, ApiNetworkProvider). This information will be used for metrics collection and improving our services.")

    headers: dict[str, Any] = config.requests_options.setdefault("headers", {})
    resolved_client_name = config.client_name or UNKNOWN_CLIENT_NAME

    current_user_agent = headers.get("User-Agent", "")
    new_user_agent = f"{current_user_agent} {user_agent_prefix}/{resolved_client_name}" if current_user_agent else f"{user_agent_prefix}/{resolved_client_name}"

    headers["User-Agent"] = new_user_agent