Class APIResponse

py/selenium/webdriver/common/api_request_context.py:50–98

Represents an HTTP response from an API request. Attributes: status: HTTP status code. status_text: HTTP status text. headers: Response headers as a dict. url: The request URL.

class APIResponse:
    """Represents an HTTP response from an API request.

    Attributes:
        status: HTTP status code.
        status_text: HTTP status text.
        headers: Response headers as a dict.
        url: The request URL.
    """

    def __init__(self, status: int, status_text: str, headers: dict[str, str], url: str, body: bytes) -> None:
        self.status = status
        self.status_text = status_text
        self.headers = headers
        self.url = url
        self._body = body

    @property
    def ok(self) -> bool:
        """Whether the response status is in the 200-299 range."""
        return 200 <= self.status <= 299

    def json(self) -> Any:
        """Parse the response body as JSON.

        Returns:
            The parsed JSON object.
        """
        return json.loads(self._body)

    def text(self) -> str:
        """Decode the response body as UTF-8 text.

        Returns:
            The response body as a string.
        """
        return self._body.decode("utf-8")

    def body(self) -> bytes:
        """Return the raw response body bytes.

        Returns:
            The response body as bytes.
        """
        return self._body

    def dispose(self) -> None:
        """Free the response body memory."""
        self._body = b""


def _cookie_matches(cookie: dict, url: str, default_domain: str = "") -> bool: