apytizer 0.0.1a0__py3-none-any.whl → 0.0.1b1__py3-none-any.whl

apytizer/abstracts/endpoint.py

@@ -1,177 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Abstract endpoint class interface.
-
-This module defines an abstract endpoint class which provides an interface
-for subclasses to implement. Each of the abstract methods represents
-a standard HTTP request method.
-
-"""
-
-# Third-Party Imports
-import abc
-from urllib.parse import urljoin
-
-# Third-Party Imports
-from requests import Response
-
-# Local Imports
-from .api import AbstractAPI
-
-
-class AbstractEndpoint(abc.ABC):
-    """
-    Represents an abstract endpoint.
-
-    Attributes:
-        api: Instance of an API subclass.
-        path: Relative path to API endpoint.
-
-    """
-    api: AbstractAPI
-    path: str
-
-    @property
-    def uri(self) -> str:
-        """Retrieve the endpoint URI."""
-        return urljoin(self.api.url, self.path)
-
-    @property
-    def url(self) -> str:
-        return self.uri
-
-    def __hash__(self) -> int:
-        return hash(self.uri)
-
-    def __repr__(self) -> str:
-        return f'<{self.__class__.__name__!s} uri={self.uri!s}>'
-
-    def __str__(self) -> str:
-        return f'{self.uri!s}'
-
-    @abc.abstractmethod
-    def head(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP HEAD request.
-
-        This method must call the `head` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def get(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP GET request.
-
-        This method must call the `get` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def post(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP POST request.
-
-        This method must call the `post` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def put(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP PUT request.
-
-        This method must call the `put` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def patch(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP PATCH request.
-
-        This method must call the `patch` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def delete(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP DELETE request.
-
-        This method must call the `delete` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def options(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP OPTIONS request.
-
-        This method must call the `options` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def trace(self, *args, **kwargs) -> Response:
-        """
-        Abstract method for sending an HTTP TRACE request.
-
-        This method must call the `trace` method on the component API instance.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/TRACE
-
-        """
-        raise NotImplementedError

apytizer/abstracts/model.py

@@ -1,50 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Abstract model class interface.
-
-This module defines an abstract model class which provides an interface
-for subclasses to implement.
-
-"""
-
-# Standard Library Imports
-from __future__ import annotations
-import abc
-from typing import Mapping
-
-
-class AbstractModel(abc.ABC):
-    """
-    Represents an abstract model.
-
-    """
-    state: Mapping
-
-    @abc.abstractmethod
-    def __eq__(self, other: AbstractModel) -> bool:
-        """
-        Abstract method for determining whether model is equal to another.
-
-        Returns:
-            Whether models are equal.
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def get(self, keys: str, default = None):
-        """
-        Abstract method for getting model property from state.
-
-        Returns:
-            Value of property in model state.
-
-        """
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def update(self, __m: Mapping = None, **kwargs) -> None:
-        """
-        Abstract method for updating model state.
-
-        """
-        raise NotImplementedError

apytizer/abstracts/session.py

@@ -1,39 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Abstract session class interface.
-
-This module defines an abstract session class which provides an interface
-for subclasses to implement.
-
-"""
-
-# Third-Party Imports
-from __future__ import annotations
-import abc
-
-
-class AbstractSession(abc.ABC):
-    """
-    Represents an abstract session.
-    """
-
-    def __enter__(self):
-        """
-        Starts the session as a context manager.
-        """
-        self.start()
-
-    def __exit__(self, *args):
-        """
-        Closes the session as context manager.
-        """
-        self.close(*args)
-
-    @abc.abstractmethod
-    def start(self):
-        """Starts the session."""
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def close(self):
-        """Closes the session."""
-        raise NotImplementedError

apytizer/adapters/transport.py

@@ -1,40 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Transport Adapter.
-
-This module defines a transport adapter class: an implementation of an
-HTTPAdapter which handles exponential backoff for retrying requests and
-provides default values for rate limiting and request timeout.
-
-"""
-
-# Standard Library Imports
-from urllib3.util import Retry
-
-# Third-Party Imports
-from requests import PreparedRequest
-from requests import Response
-from requests.adapters import HTTPAdapter
-
-
-class TransportAdapter(HTTPAdapter):
-    """
-    Implementation of a transport adaptor.
-
-    Transport adapters define methods for interacting with HTTP services,
-    enabling the use of per-service configurations.
-
-    """
-
-    def __init__(self, *args, **kwargs):
-        kwargs.setdefault('max_retries', Retry(
-            total=10,
-            status_forcelist=[413, 429, 500, 502, 503, 504],
-            allowed_methods=["HEAD", "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "TRACE"],
-            backoff_factor=kwargs.pop('rate_limit', 1)
-        ))
-        self.timeout = kwargs.pop('timeout', 5)
-        super().__init__(*args, **kwargs)
-
-    def send(self, request: PreparedRequest, **kwargs) -> Response:
-        kwargs.setdefault('timeout', self.timeout)
-        return super().send(request, **kwargs)

apytizer/base/__init__.py

@@ -1,8 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# pylint: skip-file
-
-from .api import BasicAPI
-from .api import SessionAPI
-from .endpoint import BasicEndpoint
-from .model import BasicModel