Skip to content

baseModel

Base Model that routes inherit from

BaseModel ¤

base model for all the models

Attributes:

Name Type Description
_raw Union[Dict[str, Any], List[Any], Any]

Raw response from API

_request_client RequestsClient

Request Client

Source code in sendou/models/baseModel.py
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class BaseModel:
    """
    base model for all the models

    Attributes:
        _raw (Union[Dict[str, Any], List[Any], Any]): Raw response from API
        _request_client (RequestsClient): Request Client
    """
    _raw: Union[Dict[str, Any], List[Any], Any]  # Holes raw response from API
    _request_client: RequestsClient

    def __init__(self, data: Union[Dict[str, Any], List[Any]], request_client: RequestsClient):
        """
        Init

        Args:
            data: Raw data from API
            request_client: Request Client
        """
        self._raw = data
        self._request_client = request_client

    @staticmethod
    def api_route(**kwargs) -> str:
        """Returns API route for the model (Not Implemented in BaseModel)"""
        raise NotImplementedError("api_route not implemented")

__init__(data, request_client) ¤

Init

Parameters:

Name Type Description Default
data Union[Dict[str, Any], List[Any]]

Raw data from API

required
request_client RequestsClient

Request Client

required
Source code in sendou/models/baseModel.py
19
20
21
22
23
24
25
26
27
28
def __init__(self, data: Union[Dict[str, Any], List[Any]], request_client: RequestsClient):
    """
    Init

    Args:
        data: Raw data from API
        request_client: Request Client
    """
    self._raw = data
    self._request_client = request_client

api_route(**kwargs) staticmethod ¤

Returns API route for the model (Not Implemented in BaseModel)

Source code in sendou/models/baseModel.py
30
31
32
33
@staticmethod
def api_route(**kwargs) -> str:
    """Returns API route for the model (Not Implemented in BaseModel)"""
    raise NotImplementedError("api_route not implemented")