Module pyquaca.api_requester

APIRequester class to handle requests to a given API endpoint.

Classes

class APIRequester (url: str, api_key: str | None = None)

Expand source code

class APIRequester(Requester):
    """APIRequester class to handle requests to a given API endpoint."""

    def __init__(self, url: str, api_key: str | None = None):
        super().__init__(url)
        self.logger = self.logger.getChild("API")
        self.api_key = api_key

    def format_url(self, query_string: str) -> str:
        """Format the URL with the given query_string and API key if provided."""
        return self.base_url.format(search_string=query_string, api_key=self.api_key)

APIRequester class to handle requests to a given API endpoint.

Ancestors

• Requester

Methods

def format_url(self, query_string: str) ‑> str

Expand source code

def format_url(self, query_string: str) -> str:
    """Format the URL with the given query_string and API key if provided."""
    return self.base_url.format(search_string=query_string, api_key=self.api_key)

Format the URL with the given query_string and API key if provided.

Inherited members

• Requester:
  • request