Model Base Classes

core/model_base.py

Extensible models applicable to all APIS.

"""
# Model Base Classes

`core/model_base.py`

Extensible models applicable to all APIS.
"""
# Built-ins
from pprint import pformat


class ModelBase:
    """
    Base model for all API models.

    Raises:
        NotImplementedError: When setting a property with no setter.
    """
    # set _api_client to None on new instances with __new__
    def __new__(cls, *args, **kwargs):
        instance = super().__new__(cls)
        instance._api_client = None
        return instance

    def __setattr__(self, name, value):
        prop = getattr(self, name, None)
        if isinstance(prop, property) and not prop.fset:
            raise NotImplementedError(f"Setting {name} property is either not supported by the API \
                                      or not implemented in the SDK.")
        super().__setattr__(name, value)

    def __repr__(self):
        properties = {attr: getattr(self, attr) for attr in dir(self)
                      if isinstance(getattr(type(self), attr, None), property)}

        return f"{self.__class__.__name__}(\n{pformat(properties)}\n)"

    def __getitem__(self, key):
        return getattr(self, key)

    def __setitem__(self, key, value):
        setattr(self, key, value)

    @property
    def api_client(self):
        return getattr(self, "_api_client", None)

    @api_client.setter
    def api_client(self, api_client):
        self._api_client = api_client

Classes

class ModelBase (*args, **kwargs)

Base model for all API models.

Raises

NotImplementedError

When setting a property with no setter.

Expand source code

class ModelBase:
    """
    Base model for all API models.

    Raises:
        NotImplementedError: When setting a property with no setter.
    """
    # set _api_client to None on new instances with __new__
    def __new__(cls, *args, **kwargs):
        instance = super().__new__(cls)
        instance._api_client = None
        return instance

    def __setattr__(self, name, value):
        prop = getattr(self, name, None)
        if isinstance(prop, property) and not prop.fset:
            raise NotImplementedError(f"Setting {name} property is either not supported by the API \
                                      or not implemented in the SDK.")
        super().__setattr__(name, value)

    def __repr__(self):
        properties = {attr: getattr(self, attr) for attr in dir(self)
                      if isinstance(getattr(type(self), attr, None), property)}

        return f"{self.__class__.__name__}(\n{pformat(properties)}\n)"

    def __getitem__(self, key):
        return getattr(self, key)

    def __setitem__(self, key, value):
        setattr(self, key, value)

    @property
    def api_client(self):
        return getattr(self, "_api_client", None)

    @api_client.setter
    def api_client(self, api_client):
        self._api_client = api_client

Subclasses

• Admin
• AdminList
• TeamPriorityLevel
• Article
• ArticleList
• ArticleStatistics
• Conversation
• DataAttribute
• DataAttributeList
• DataEvent
• DataEventList
• DataEventSummary
• DataExportJob
• Collection
• CollectionList
• Section
• SectionList
• AdminPriorityLevel
• Team
• TeamList

Instance variables

var api_client

Expand source code

@property
def api_client(self):
    return getattr(self, "_api_client", None)