everysk-lib 1.10.2__cp312-cp312-win_amd64.whl

everysk/sdk/entities/base_list.py

@@ -0,0 +1,131 @@
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from collections.abc import Iterable
+from typing import Any
+
+from everysk.core.exceptions import FieldValueError
+
+
+###############################################################################
+#   EntityList Class Implementation
+###############################################################################
+class EntityList(list):
+    """
+    A list subclass with validation capabilities.
+
+    This class extends the standard Python list and adds validation for the values
+    added or inserted into it.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is None).
+        max_size (int): The maximum allowed size for the list (default is None).
+
+    Example:
+        To create a custom list with validation capabilities:
+        my_list = EntityList()
+    """
+    min_size: int | None = None
+    max_size: int | None = None
+
+    def __init__(self, *args) -> None:
+        """
+        Initialize the EntityList.
+
+        Args:
+            *args: Optional initial elements to populate the list.
+
+        Example:
+            To create an EntityList with initial elements:
+            my_list = EntityList([1, 2, 3])
+        """
+        if args:
+            try:
+                args = ([self._validate(item) for item in args[0]], )
+            except TypeError:
+                raise FieldValueError('Unsupported format.') from TypeError
+        super().__init__(*args)
+
+    def __setitem__(self, index: int, value: Any) -> None:
+        """
+        Set an item in the list with validation.
+
+        Args:
+            index (int): The index at which to set the value.
+            value: The value to be set.
+        """
+        value = self._validate(value)
+        return super().__setitem__(index, value)
+
+    def insert(self, __index: int, __object: Any) -> None:
+        """
+        Insert an object at a specified index with validation.
+
+        Args:
+            __index (int): The index at which to insert the object.
+            __object: The object to be inserted.
+        """
+        __object = self._validate(__object)
+        return super().insert(__index, __object)
+
+    def append(self, __object: Any) -> None:
+        """
+        Append an object to the list with validation.
+
+        Args:
+            __object: The object to be appended.
+        """
+        __object = self._validate(__object)
+        return super().append(__object)
+
+    def extend(self, __iterable: Iterable) -> None:
+        """
+        Extend the list with values from an iterable with validation.
+
+        Args:
+            __iterable (Iterable): An iterable containing values to be added to the list.
+        """
+        for value in __iterable:
+            value = self._validate(value)
+        return super().extend(__iterable)
+
+    def _validate(self, value: Any) -> Any:
+        """
+        Validate a value.
+
+        Args:
+            value: The value to be validated.
+
+        Raises:
+            NotImplementedError: This method should be overridden in subclasses.
+
+        Returns:
+            The validated value.
+        """
+        raise NotImplementedError()
+
+    def to_native(self, add_class_path: str | None = None, recursion: bool = False) -> Any:
+        """
+        Converts the object to the specified Python type.
+
+        Args:
+            add_class_path (str | None, optional): The class path to add when converting the object. Defaults to None.
+            recursion (bool, optional): Indicates whether to recursively convert nested objects. Defaults to False.
+
+        Returns:
+            object: The converted object.
+
+        """
+        return self.to_list(add_class_path=add_class_path, recursion=recursion)
+
+    def to_list(self, add_class_path: bool = False, recursion: bool = False) -> list[dict]: # pylint: disable=unused-argument
+        """
+        Convert the Securities collection to a list of dictionaries.
+        """
+        return list(self)

everysk/sdk/entities/custom_index/base.py

@@ -0,0 +1,209 @@
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from everysk.config import settings
+from everysk.core.fields import ListField, StrField, FloatField, ChoiceField
+from everysk.core.exceptions import SDKValueError
+from everysk.sdk.entities.base import BaseEntity, ScriptMetaClass
+from everysk.sdk.entities.query import Query
+from everysk.sdk.entities.script import Script
+from everysk.sdk.entities.fields import CurrencyField, EntityNameField, EntityDescriptionField, EntityTagsField
+
+
+###############################################################################
+#   CustomIndex Class Implementation
+###############################################################################
+class CustomIndex(BaseEntity, metaclass=ScriptMetaClass):
+    """
+    This class represents a custom index entity object.
+
+    Attributes:
+        script (Script): The script object associated to the entity.
+        _orderable_attributes (ListField): The list of orderable attributes.
+        symbol (StrField): The symbol of the custom index.
+        id (StrField): The id of the custom index.
+        data (ListField): The data of the custom index.
+
+        periodicity (ChoiceField): The periodicity of the custom index.
+        data_type (ChoiceField): The data type of the custom index.
+        currency (CurrencyField): The currency of the custom index.
+        base_price (FloatField): The base price of the custom index.
+
+        description (EntityDescriptionField): The description of the custom index.
+        name (EntityNameField): The name of the custom index.
+        tags (EntityTagsField): The tags of the custom index.
+
+        created_on (DateTimeField): The creation date of the custom index.
+        updated_on (DateTimeField): The last update date of the custom index.
+        version (IntField): The version of the custom index.
+
+    Example:
+        >>> from everysk.sdk.entities.custom_index.base import CustomIndex
+        >>> custom_index = CustomIndex(
+            symbol='CUSTOM:INDEX',
+            data=[...],
+            periodicity='M',
+            data_type='PRICE',
+            currency='USD',
+            base_price=100,
+            description='Custom index description',
+            name='Custom index name',
+            tags=['tag1', 'tag2']
+        )
+        >>> custom_index.save()
+    """
+
+    script: Script
+    _orderable_attributes = ListField(default=['created_on', 'updated_on', 'name'], readonly=True)
+
+    symbol = StrField(regex=settings.CUSTOM_INDEX_SYMBOL_REGEX, min_size=settings.CUSTOM_INDEX_SYMBOL_MIN_SIZE, max_size=settings.CUSTOM_INDEX_SYMBOL_MAX_SIZE, required_lazy=True, empty_is_none=True)
+
+    data = ListField(min_size=settings.CUSTOM_INDEX_MIN_DATA_BLOB, required_lazy=True)
+
+    periodicity = ChoiceField(default=None, choices=(settings.CUSTOM_INDEX_PERIODICITY_MONTHLY, settings.CUSTOM_INDEX_PERIODICITY_DAILY, None), required_lazy=True)
+    data_type = ChoiceField(default=None, choices=(settings.CUSTOM_INDEX_DATA_TYPE_PRICE, settings.CUSTOM_INDEX_DATA_TYPE_RETURN, settings.CUSTOM_INDEX_DATA_TYPE_RETURN_100, None), required_lazy=True)
+    currency = CurrencyField()
+    base_price = FloatField(min_size=settings.CUSTOM_INDEX_BASE_PRICE_MIN_VAL, max_size=settings.CUSTOM_INDEX_BASE_PRICE_MAX_VAL)
+
+    description = EntityDescriptionField()
+    name = EntityNameField()
+    tags = EntityTagsField()
+
+    @property
+    def id(self) -> str:
+        """
+        Returns the id of the custom index. The id is a alias for the symbol.
+
+        Returns:
+            str: The id of the custom index.
+
+        Example:
+            >>> custom_index = CustomIndex(symbol='CUSTOM:INDEX')
+            >>> custom_index.id
+            'CUSTOM:INDEX'
+        """
+        return self.symbol
+
+    @id.setter
+    def id(self, value: str) -> None:
+        """
+        Sets the id of the custom index. The id is a alias for the symbol.
+
+        Args:
+            value (str): The id of the custom index.
+
+        Example:
+            >>> custom_index = CustomIndex()
+            >>> custom_index.id = 'CUSTOM:INDEX'
+            >>> custom_index.symbol
+            'CUSTOM:INDEX'
+            >>> custom_index.id
+            'CUSTOM:INDEX'
+        """
+        self.symbol = value
+
+    def validate(self) -> bool:
+        """
+        This method validates the entity object and raises an exception if it is not
+        valid. The validation is performed by calling the `validate` method of each field
+        of the entity.
+
+        Args:
+            self (Self): The entity object to be validated.
+
+        Raises:
+            FieldValueError: If the entity object is not valid.
+            RequiredFieldError: If a required field is missing.
+
+        Returns:
+            bool: True if the entity object is valid, False otherwise.
+
+        Example:
+            >>> custom_index = CustomIndex(symbol='CUSTOM:INDEX', name='Custom index name', ...)
+            >>> custom_index.validate()
+            True
+        """
+        return self.get_response(self_obj=self)
+
+    def _pre_validate(self):
+        pass
+
+    def _pos_validate(self):
+        self.created_on = None
+        self.updated_on = None
+
+    def _check_query(self, query: Query) -> bool:
+        """
+        Check the query object.
+
+        Args:
+            query (Query): The query object.
+
+        Returns:
+            Query: The query object.
+        """
+        return True
+
+    def _check_entity_to_query(self) -> bool:
+        """
+        Check the entity object to query.
+
+        Returns:
+            bool: True if the entity object is valid.
+        """
+        if self.name and self.tags:
+            raise SDKValueError("Can't filter by Name and Tags at the same time")
+
+        return True
+
+    def _mount_query(self, query: Query) -> Query:
+        """
+        Mount the query object.
+
+        Args:
+            query (Query): The query object.
+
+        Returns:
+            Query: The query object.
+        """
+        if self.name is not None:
+            query = query.where('name', self.name)
+        if self.tags:
+            query = query.where('tags', self.tags)
+
+        return query
+
+    @staticmethod
+    def get_id_prefix() -> str:
+        """
+        Returns the prefix of the custom index id field value.
+
+        Returns:
+            str: The prefix of the custom index id field value.
+
+        Example:
+            >>> from everysk.sdk.custom_index.base import CustomIndex
+            >>> CustomIndex.get_id_prefix()
+            'CUSTOM:'
+        """
+        return settings.CUSTOM_INDEX_SYMBOL_PREFIX
+
+    @classmethod
+    def modify_many(cls, entity_id_list: list[str], overwrites: dict | list[dict]) -> list:
+        """
+        The custom index does not support the modify_many method.
+        """
+        raise NotImplementedError()
+
+    @classmethod
+    def clone_many(cls, entity_id_list: list[str], overwrites: dict | list[dict]) -> list:
+        """
+        The custom index does not support the clone_many method.
+        """
+        raise NotImplementedError()

everysk/sdk/entities/custom_index/settings.py

@@ -0,0 +1,29 @@
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from everysk.core.fields import StrField, IntField, FloatField, RegexField
+
+
+CUSTOM_INDEX_SYMBOL_REGEX = RegexField(default=r'^CUSTOM:[A-Z0-9_]*$', readonly=True)
+CUSTOM_INDEX_SYMBOL_PREFIX = StrField(default='CUSTOM:', readonly=True)
+
+CUSTOM_INDEX_SYMBOL_MIN_SIZE = IntField(default=8, readonly=True) # len(CUSTOM_INDEX_SYMBOL_PREFIX) + 1
+CUSTOM_INDEX_SYMBOL_MAX_SIZE = IntField(default=107, readonly=True) # len(CUSTOM_INDEX_SYMBOL_PREFIX) + 100
+
+CUSTOM_INDEX_MIN_DATA_BLOB = IntField(default=1, readonly=True)
+
+CUSTOM_INDEX_BASE_PRICE_MIN_VAL = FloatField(default=-9999999999999.99, readonly=True)
+CUSTOM_INDEX_BASE_PRICE_MAX_VAL = FloatField(default=+9999999999999.99, readonly=True)
+
+CUSTOM_INDEX_DATA_TYPE_PRICE = StrField(default='PRICE', readonly=True)
+CUSTOM_INDEX_DATA_TYPE_RETURN = StrField(default='RETURN', readonly=True)
+CUSTOM_INDEX_DATA_TYPE_RETURN_100 = StrField(default='RETURN_100', readonly=True)
+
+CUSTOM_INDEX_PERIODICITY_MONTHLY = StrField(default='M', readonly=True)
+CUSTOM_INDEX_PERIODICITY_DAILY = StrField(default='D', readonly=True)

everysk/sdk/entities/datastore/base.py

@@ -0,0 +1,160 @@
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from typing import Any
+
+from everysk.config import settings
+from everysk.core.exceptions import RequiredError, FieldValueError
+from everysk.core.fields import ListField, StrField
+from everysk.core.serialize import dumps
+
+from everysk.sdk.entities.base import BaseEntity, ScriptMetaClass
+from everysk.sdk.entities.fields import EntityNameField, EntityDescriptionField, EntityLinkUIDField, EntityWorkspaceField, EntityDateTimeField, EntityTagsField
+from everysk.sdk.entities.script import Script
+
+
+###############################################################################
+#   Datastore Class Implementation
+###############################################################################
+class Datastore(BaseEntity, metaclass=ScriptMetaClass):
+    """
+    This class represents a datastore entity object and provides methods to validate
+    and manage the entity object's data.
+
+    Attributes:
+        script (Script): The script object associated with the datastore.
+        id (StrField): The unique identifier of the datastore.
+        workspace (EntityWorkspaceField): The workspace of the datastore.
+        name (EntityNameField): The name of the datastore.
+        tags (EntityTagsField): The tags of the datastore.
+        description (EntityDescriptionField): The description of the datastore.
+        link_uid (EntityLinkUIDField): The link UID of the datastore.
+        date (EntityDateTimeField): The date associated with the datastore.
+        data (Any): The data associated with the datastore.
+        level (StrField): The level of the datastore.
+
+        version (StrField): The version of the datastore.
+        created_on (DateTimeField): The created on date of the datastore.
+        updated_on (DateTimeField): The updated on date of the datastore.
+
+    Example:
+        >>> from everysk.sdk.entities.datastore.base import Datastore
+        >>> datastore = Datastore()
+        >>> datastore.id = 'dats_12345678'
+        >>> datastore.name = 'My Datastore'
+        >>> datastore.tags = ['tag1', 'tag2']
+        >>> datastore.description = 'This is a sample datastore.'
+        >>> datastore.workspace = 'my_workspace'
+        >>> datastore.date = DateTime.fromisoformat('20220101')
+        >>> datastore.level = '1'
+        >>> datastore.data = {'key1': 'value1', 'key2': 'value2'}
+        >>> datastore.create()
+        >>> print(datastore)
+        {
+            'id': 'dats_12345678',
+            'name': 'My Datastore',
+            'description': 'This is a sample datastore.',
+            'tags': ['tag1', 'tag2'],
+            'link_uid': None,
+            'workspace': 'my_workspace',
+            'date': '20220101',
+            'level': '1',
+            'data': {'key1': 'value1', 'key2': 'value2'},
+            'version': 'v1',
+            'created_on': '2021-01-01T00:00:00.000000Z',
+            'updated_on': '2021-01-01T00:00:00.000000Z',
+        }
+    """
+    script: Script = None
+    _orderable_attributes = ListField(default=['date', 'created_on', 'updated_on', 'name'], readonly=True)
+
+    id = StrField(regex=settings.DATASTORE_ID_REGEX, max_size=settings.DATASTORE_ID_MAX_SIZE, required_lazy=True, empty_is_none=True)
+
+    name = EntityNameField()
+    description = EntityDescriptionField()
+    tags = EntityTagsField()
+    link_uid = EntityLinkUIDField()
+    workspace = EntityWorkspaceField()
+
+    date = EntityDateTimeField()
+    level = StrField(min_size=1, max_size=settings.DATASTORE_LEVEL_MAX_LENGTH)
+
+    data: Any = None
+
+    def __init__(self, data=None, **kwargs) -> None:
+        super().__init__(data=data, **kwargs)
+
+    @staticmethod
+    def get_id_prefix() -> str:
+        """
+        Returns the prefix of the datastore id field value.
+
+        Returns:
+            str: The prefix of the datastore id field value.
+
+        Example:
+            >>> Datastore.get_id_prefix()
+            'dats_'
+
+        Notes:
+            The prefix is typically used to distinguish datastore IDs from other types of IDs
+        """
+        return settings.DATASTORE_ID_PREFIX
+
+    def validate_type_data(self) -> bool:
+        """
+        Validates the 'data' attribute of the Datastore entity to ensure it is not None and contains valid JSON data.
+
+        Raises:
+            RequiredError: If the 'data' attribute is None.
+            FieldValueError: If the 'data' attribute is not valid JSON.
+
+        Returns:
+            bool: True if validation succeeds.
+
+        Example:
+            >>> datastore = Datastore()
+            >>> datastore.data = {'key1': 'value1', 'key2': 'value2'}
+            >>> datastore.validate_type_data()  # Validation succeeds
+            True
+        """
+
+        if self.data is None:
+            raise RequiredError('The data attribute is required')
+
+        try:
+            dumps(self.data)
+        except Exception as exc: # pylint: disable=broad-except
+            raise FieldValueError('Datastore data is not a valid json') from exc
+
+        return True
+
+    def validate(self) -> bool:
+        """
+        This method validates the entity object and raises an exception if it is not
+        valid. The validation is performed by calling the `validate` method of each field
+        of the entity.
+
+        Args:
+            self (Self): The entity object to be validated.
+
+        Raises:
+            FieldValueError: If the entity object is not valid.
+            RequiredFieldError: If a required field is missing.
+
+        Returns:
+            bool: True if the entity object is valid, False otherwise.
+
+        Example:
+            >>> entity = Entity()
+            >>> entity.validate()
+            True
+        """
+        self.validate_type_data()
+        return self.get_response(self_obj=self)

everysk/sdk/entities/datastore/settings.py

@@ -0,0 +1,17 @@
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from everysk.core.fields import StrField, IntField, RegexField
+
+
+DATASTORE_ID_REGEX = RegexField(default=r'^dats_[a-zA-Z0-9]', readonly=True)
+DATASTORE_ID_PREFIX = StrField(default='dats_', readonly=True)
+DATASTORE_ID_MAX_SIZE = IntField(default=30, readonly=True)
+
+DATASTORE_LEVEL_MAX_LENGTH = IntField(default=32, readonly=True)