harborapi.responselog

A log of HTTP responses.

Source code in harborapi/responselog.py

@dataclass
class ResponseLog:
    """A log of HTTP responses."""

    entries: Deque[ResponseLogEntry]

    def __init__(self, max_logs: Optional[int] = None) -> None:
        """Initialize the log."""
        self.entries = deque(maxlen=max_logs)

    def add(self, entry: ResponseLogEntry) -> None:
        """Add a new entry to the log."""
        self.entries.append(entry)

    def resize(self, max_logs: int) -> None:
        """Resize the log to the specified maximum number of entries."""
        self.entries = deque(self.entries, maxlen=max_logs)

    def clear(self) -> None:
        """Clear the log."""
        self.entries.clear()

    def __iter__(self) -> Iterator[ResponseLogEntry]:
        """Return an iterator over the entries in the log."""
        return iter(self.entries)

    def __getitem__(self, index: int) -> ResponseLogEntry:
        """Return the entry at the specified index."""
        return self.entries[index]

    def __len__(self) -> int:
        """Return the number of entries in the log."""
        return len(self.entries)

entries: Deque[ResponseLogEntry] = deque(maxlen=max_logs) instance-attribute

__init__(max_logs=None)

Initialize the log.

Source code in harborapi/responselog.py

def __init__(self, max_logs: Optional[int] = None) -> None:
    """Initialize the log."""
    self.entries = deque(maxlen=max_logs)

add(entry)

Add a new entry to the log.

Source code in harborapi/responselog.py

def add(self, entry: ResponseLogEntry) -> None:
    """Add a new entry to the log."""
    self.entries.append(entry)

resize(max_logs)

Resize the log to the specified maximum number of entries.

Source code in harborapi/responselog.py

def resize(self, max_logs: int) -> None:
    """Resize the log to the specified maximum number of entries."""
    self.entries = deque(self.entries, maxlen=max_logs)

clear()

Clear the log.

Source code in harborapi/responselog.py

def clear(self) -> None:
    """Clear the log."""
    self.entries.clear()

__iter__()

Return an iterator over the entries in the log.

Source code in harborapi/responselog.py

def __iter__(self) -> Iterator[ResponseLogEntry]:
    """Return an iterator over the entries in the log."""
    return iter(self.entries)

__getitem__(index)

Return the entry at the specified index.

Source code in harborapi/responselog.py

def __getitem__(self, index: int) -> ResponseLogEntry:
    """Return the entry at the specified index."""
    return self.entries[index]

__len__()

Return the number of entries in the log.

Source code in harborapi/responselog.py

def __len__(self) -> int:
    """Return the number of entries in the log."""
    return len(self.entries)

Bases: NamedTuple

A log entry for an HTTP response.

Source code in harborapi/responselog.py

class ResponseLogEntry(NamedTuple):
    """A log entry for an HTTP response."""

    url: URL
    """An httpx.URL object representing the URL of the request. Can be cast to string using `str()`."""
    method: str
    """The HTTP method used for the request."""
    status_code: int
    """The HTTP status code of the response."""
    duration: float
    """The duration of the full request/response cycle in seconds."""
    response_size: int
    """The size of the response body in bytes."""

    def __repr__(self) -> str:
        return f"<ResponseLogEntry [{self.method} {self.url} {self.status_code}]>"

url: URL instance-attribute

An httpx.URL object representing the URL of the request. Can be cast to string using str().

method: str instance-attribute

The HTTP method used for the request.

status_code: int instance-attribute

The HTTP status code of the response.

duration: float instance-attribute

The duration of the full request/response cycle in seconds.

response_size: int instance-attribute

The size of the response body in bytes.

__repr__()

Source code in harborapi/responselog.py

def __repr__(self) -> str:
    return f"<ResponseLogEntry [{self.method} {self.url} {self.status_code}]>"