everysk-lib 1.10.2__cp312-cp312-win_amd64.whl

everysk/sdk/entities/fields.py

@@ -0,0 +1,375 @@
+# -*- coding: utf_8 -*-
+###############################################################################
+#
+# (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.datetime import DateTime
+from everysk.core.fields import ChoiceField, DateTimeField, ListField, StrField, _min_max_validate
+from everysk.core.log import Logger
+from everysk.sdk.engines.market_data import MarketDataPublic
+from everysk.sdk.entities.tags import Tags
+
+log = Logger(name=__name__)
+
+
+###############################################################################
+#   CurrencyField Class Implementation
+###############################################################################
+class CurrencyField(ChoiceField):
+    """
+    A field for currency codes with validation capabilities.
+
+    This class extends the standard ChoiceField and adds validation for the values
+    added or inserted into it.
+    """
+
+    _choices: list[str] = None
+    _market_data: MarketDataPublic = MarketDataPublic()
+
+    def __init__(
+        self,
+        default: str = None,
+        choices: list = None,
+        readonly: bool = False,
+        required: bool = False,
+        required_lazy: bool = True,
+        empty_is_none: bool = False,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            default=default,
+            choices=choices,
+            readonly=readonly,
+            required=required,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+    def _get_choices(self) -> set():
+        """
+        Get all available currencies.
+
+        Returns:
+            A list of all available currencies.
+        """
+        if not self._choices:
+            try:
+                self._choices = {
+                    item['code'] for item in self._market_data.get_currencies(fields='code', status__eq='active')
+                }
+            except Exception as error:
+                log.error('Failed to get currencies from public Market Data: %s', error)
+
+            # If we don't have a list of currencies we set to the one in the settings
+            if not self._choices:
+                self._choices = set(settings.ENTITY_BASE_CURRENCY_DEFAULT_LIST)
+
+        return self._choices
+
+
+###############################################################################
+#   EntityNameField Class Implementation
+###############################################################################
+class EntityNameField(StrField):
+    """
+    This class is a subclass of StrField and provides specific validation for name, including
+    size limits and pattern matching.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is the value from settings).
+        max_size (int): The maximum allowed size for the list (default is the value from settings).
+    """
+
+    attr_type = str
+
+    def __init__(
+        self,
+        default: Any = None,
+        regex: str = None,
+        min_size: int = settings.ENTITY_NAME_MIN_LENGTH,
+        max_size: int = settings.ENTITY_NAME_MAX_LENGTH,
+        readonly: bool = False,
+        required: bool = False,
+        required_lazy: bool = True,
+        empty_is_none: bool = True,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            default=default,
+            regex=regex,
+            min_size=min_size,
+            max_size=max_size,
+            readonly=readonly,
+            required=required,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+
+###############################################################################
+#   EntityDescriptionField Class Implementation
+###############################################################################
+class EntityDescriptionField(StrField):
+    """
+    This class is a subclass of StrField and provides specific validation for description, including
+    size limits and pattern matching.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is the value from settings).
+        max_size (int): The maximum allowed size for the list (default is the value from settings).
+    """
+
+    attr_type = str
+
+    def __init__(
+        self,
+        default: Any = None,
+        regex: str = None,
+        min_size: int = settings.ENTITY_DESCRIPTION_MIN_LEN,
+        max_size: int = settings.ENTITY_DESCRIPTION_MAX_LEN,
+        readonly: bool = False,
+        required: bool = False,
+        required_lazy: bool = False,
+        empty_is_none: bool = False,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            default=default,
+            regex=regex,
+            min_size=min_size,
+            max_size=max_size,
+            readonly=readonly,
+            required=required,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+
+###############################################################################
+#   EntityLinkUIDField Class Implementation
+###############################################################################
+class EntityLinkUIDField(StrField):
+    """
+    This class is a subclass of StrField and provides specific validation for link uid, including
+    size limits and pattern matching.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is the value from settings).
+        max_size (int): The maximum allowed size for the list (default is the value from settings).
+    """
+
+    attr_type = str
+
+    def __init__(
+        self,
+        default: Any = None,
+        regex: str = None,
+        min_size: int = settings.ENTITY_LINK_UID_MIN_LENGTH,
+        max_size: int = settings.ENTITY_LINK_UID_MAX_LENGTH,
+        readonly: bool = False,
+        required: bool = False,
+        required_lazy: bool = False,
+        empty_is_none: bool = True,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            default=default,
+            regex=regex,
+            min_size=min_size,
+            max_size=max_size,
+            readonly=readonly,
+            required=required,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+
+###############################################################################
+#   EntityWorkspaceField Class Implementation
+###############################################################################
+class EntityWorkspaceField(StrField):
+    """
+    This class is a subclass of StrField and provides specific validation for workspace, including
+    size limits and pattern matching.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is the value from settings).
+        max_size (int): The maximum allowed size for the list (default is the value from settings).
+    """
+
+    attr_type = str
+
+    def __init__(
+        self,
+        default: Any = None,
+        regex: str = settings.ENTITY_WORKSPACE_REGEX,
+        min_size: int = settings.ENTITY_WORKSPACE_MIN_LENGTH,
+        max_size: int = settings.ENTITY_WORKSPACE_MAX_LENGTH,
+        readonly: bool = False,
+        required: bool = False,
+        required_lazy: bool = True,
+        empty_is_none: bool = True,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            default=default,
+            regex=regex,
+            min_size=min_size,
+            max_size=max_size,
+            readonly=readonly,
+            required=required,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+
+###############################################################################
+#   EntityDateTimeField Class Implementation
+###############################################################################
+class EntityDateTimeField(DateTimeField):
+    """
+    This class is a subclass of StrField and provides specific validation for date, including
+    size limits and pattern matching.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is the value from DateTime market start).
+        max_size (int): The maximum allowed size for the list (default is one day delta from now).
+    """
+
+    attr_type = DateTime
+
+    def __init__(
+        self,
+        default: Any = None,
+        min_date: DateTime = None,
+        max_date: DateTime = None,
+        force_time: str = 'MIDDAY',
+        required: bool = False,
+        readonly: bool = False,
+        required_lazy: bool = True,
+        empty_is_none: bool = True,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            default,
+            min_date=min_date,
+            max_date=max_date,
+            force_time=force_time,
+            required=required,
+            readonly=readonly,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+    def validate(self, attr_name: str, value: Any, attr_type: type = None) -> None:
+        """
+        Checks if value is greater than min and lower than max including both values.
+
+        Args:
+            attr_name (str): The name of the attribute being validated.
+            value (Any): The value to validate.
+            attr_type (type): The type of the attribute being validated.
+
+        Raises:
+            FieldValueError: If the value is not within the specified range.
+
+        Example:
+            >>> from everysk.sdk.entities.fields import EntityDateTimeField
+            >>> from everysk.core.datetime.datetime import DateTime
+            >>> field = EntityDateTimeField(min_date=DateTime(2023-01-01), max_date=DateTime(2023-12-31))
+            >>> try:
+            >>> ... field.validate("test_field", DateTime(2023, 6, 15))
+            >>> ... print("Valid Date")
+            >>> except Exception as e:
+            >>> ... print(f"Validation error: {e}")
+            >>> Valid Date
+        """
+        min_date = self.min_date if self.min_date is not None else DateTime.market_start()
+        max_date = (
+            self.max_date if self.max_date is not None else DateTime.now().delta(1, 'D').force_time('LAST_MINUTE')
+        )
+        _min_max_validate(min_date, max_date, value, attr_name)
+        return super().validate(attr_name, value, attr_type)
+
+
+###############################################################################
+#   EntityTagsField Class Implementation
+###############################################################################
+class EntityTagsField(ListField):
+    """
+    This class is a subclass of ListField and provides specific validation for tags, including
+    size limits and pattern matching.
+
+    Attributes:
+        min_size (int): The minimum allowed size for the list (default is the value from settings).
+        max_size (int): The maximum allowed size for the list (default is the value from settings).
+    """
+
+    attr_type = Tags
+
+    def __init__(
+        self,
+        default: Any = None,
+        min_size: int = settings.ENTITY_MIN_TAG_SIZE,
+        max_size: int = settings.ENTITY_MAX_TAG_SIZE,
+        readonly: bool = False,
+        required: bool = False,
+        required_lazy: bool = False,
+        empty_is_none: bool = False,
+        **kwargs,
+    ) -> None:
+        if default is not None and not isinstance(default, Tags):
+            default = Tags(default)
+        super().__init__(
+            default=default,
+            min_size=min_size,
+            max_size=max_size,
+            readonly=readonly,
+            required=required,
+            required_lazy=required_lazy,
+            empty_is_none=empty_is_none,
+            **kwargs,
+        )
+
+    def clean_value(self, value: Any) -> Any:
+        """
+        This method ensures that the provided value is in the expected format before assigning it to an attribute.
+        If the value is None, it is replaced with an empty TagsList. If it is not already a TagsList instance,
+        it is converted into one.
+
+        Args:
+            value (Any): The value to clean, None, A TagsList instance, or any other value.
+
+        Example:
+            >>> from everysk.sdk.entities.tags import Tags
+            >>> from everysk.sdk.entities.fields import EntityTagsField
+            >>> field = EntityTagsField()
+
+            >>> cleaned_value_none = field.clean_value(None)
+            >>> print(cleaned_value_none)
+            >>> []
+
+            >>> cleaned_non_empty_tags = field.clean_value(Tags(['tag1', 'tag2']))
+            >>> print(cleaned_non_empty_tags)
+            >>> ['tag1', 'tag2']
+        """
+        value = super().clean_value(value)
+        if value is None:
+            value = Tags()
+        elif not isinstance(value, Tags):
+            value = Tags(value)
+        return value

everysk/sdk/entities/file/base.py

@@ -0,0 +1,215 @@
+###############################################################################
+#
+# (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 Self
+
+from everysk.config import settings
+from everysk.core.exceptions import SDKValueError
+from everysk.core.fields import ListField, StrField, ChoiceField
+from everysk.sdk.engines.cryptography import generate_unique_id
+from everysk.sdk.entities.base import BaseEntity, ScriptMetaClass
+from everysk.sdk.entities.fields import EntityNameField, EntityDescriptionField, EntityLinkUIDField, EntityWorkspaceField, EntityDateTimeField, EntityTagsField
+from everysk.sdk.entities.query import Query
+from everysk.sdk.entities.script import Script
+
+
+###############################################################################
+#   File Class Implementation
+###############################################################################
+class File(BaseEntity, metaclass=ScriptMetaClass):
+    """
+    This class represents a file entity object and provides methods to validate and manage the entity's data.
+
+    Attributes:
+        script (Script): The script object associated with the file.
+        id (StrField): The unique identifier of the file.
+        workspace (EntityWorkspaceField): The workspace of the file.
+        name (EntityNameField): The name of the file.
+        tags (EntityTagsField): The tags of the file.
+        description (EntityDescriptionField): The description of the file.
+        link_uid (EntityLinkUIDField): The link UID of the file.
+        date (EntityDateTimeField): The date associated with the file.
+        data (StrField): The file data in base64 format.
+        url (StrField): The URL of the file.
+        content_type (ChoiceField): The content type of the file.
+
+        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.file.base import File
+        >>> file = File()
+        >>> file.script = 'my_script'
+        >>> file.id = 'file_12345678'
+        >>> file.name = 'My File'
+        >>> file.tags = ['tag1', 'tag2']
+        >>> file.description = 'This is a sample file.'
+        >>> file.workspace = 'my_workspace'
+        >>> file.date = DateTime.fromisoformat('20220101')
+        >>> file.data = 'base64_encoded_data_here'
+        >>> file.content_type = 'application/pdf'
+        >>> file.url = '/1234567891011211234567890'
+        >>> file.create()
+        >>> print(file)
+        {
+            'id': 'file_12345678',
+            'script': 'my_script',
+            'name': 'My File',
+            'description': 'This is a sample file.',
+            'tags': ['tag1', 'tag2'],
+            'link_uid': None,
+            'workspace': 'my_workspace',
+            'date': '20220101',
+            'data': 'base64_encoded_data_here',
+            'content_type': 'application/pdf',
+            'url': '/1234567891011211234567890'
+            'created': '2021-01-01T00:00:00.000000Z',
+            'updated': '2021-01-01T00:00:00.000000Z',
+        }
+    """
+    script: Script
+    _orderable_attributes = ListField(default=['date', 'created_on', 'updated_on', 'name'], readonly=True)
+    _allowed_query_attributes_for_all_operators = ListField(default=settings.ENTITY_ALLOWED_QUERY_ATTRIBUTES_FOR_ALL_OPERATORS + ['content_type'], readonly=True)
+
+    id = StrField(regex=settings.FILE_ID_REGEX, max_size=settings.FILE_ID_MAX_SIZE, required_lazy=True, empty_is_none=True)
+
+    name = EntityNameField()
+    description = EntityDescriptionField()
+    tags = EntityTagsField()
+    link_uid = EntityLinkUIDField()
+    workspace = EntityWorkspaceField()
+
+    date = EntityDateTimeField()
+
+    hash = StrField(default=None, max_size=settings.FILE_HASH_LENGTH, required_lazy=True)
+    data = StrField(default=None, max_size=settings.FILE_DATA_MAX_SIZE_IN_BASE64, required_lazy=True)
+    content_type = ChoiceField(default=None, choices=settings.FILE_CONTENT_TYPES, required_lazy=True)
+    url = StrField(required_lazy=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:
+            >>> file = File()
+            >>> file.validate()
+            True
+        """
+        return self.get_response(self_obj=self)
+
+    @classmethod
+    def validate_transient(cls, entity_dict: dict) -> Self:
+        """
+        Validate the entity properties.
+
+        Args:
+            entity_dict (dict): The entity properties.
+
+        Returns:
+            BaseEntity: The entity object.
+
+        Example:
+            >>> entity_dict = {'name': 'My Entity'}
+            >>> BaseEntity.validate_transient(entity_dict)
+        """
+        return cls.get_response(params={'entity_dict': entity_dict})
+
+    def _check_entity_to_query(self) -> bool:
+        """
+        Check the entity object to query.
+
+        Returns:
+            bool: True if the entity object is valid.
+        """
+        super()._check_entity_to_query()
+        if self.url and (self.name or self.tags or self.link_uid):
+            raise SDKValueError("Can't filter by URL and Name, Tags or Link UID 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.
+        """
+        query = super()._mount_query(query)
+
+        if self.url is not None:
+            query = query.where('url', self.url)
+
+        return query
+
+    @staticmethod
+    def get_id_prefix() -> str:
+        """
+        Returns the prefix of the file id field value.
+
+        Returns:
+            str: The prefix of the file id field value.
+
+        Example:
+            >>> File.get_id_prefix()
+            'file_'
+        """
+        return settings.FILE_ID_PREFIX
+
+    @staticmethod
+    def generate_url() -> str:
+        """
+        Generate a unique url for the file.
+
+        Returns:
+            str: A unique url for the file.
+
+        Example:
+            >>> File.generate_url()
+            '/1234567891011211234567890'
+        """
+        return f'/{generate_unique_id()}'
+
+    def to_dict(self, add_class_path: bool = False, recursion: bool = False) -> dict:
+        """
+        Convert the entity to a JSON-serializable dictionary.
+        This method converts the entity object into a dictionary that can be easily
+        serialized to JSON.
+
+        Args:
+            self (Self): The entity instance to convert.
+            with_internals (bool, optional): Whether to include internal parameters. Defaults to True.
+            recursion (bool, optional): Whether to include nested entities. Defaults to False.
+
+        Returns:
+            dict: A dictionary representation of the File entity.
+        Raises:
+            NotImplementedError: This method should be implemented in subclasses.
+        """
+        dct: dict = super().to_dict(add_class_path=add_class_path, recursion=recursion)
+
+        if add_class_path is False:
+            dct['url'] = f"{settings.FILE_URL_PATH}{self.url}" if self.url else None
+
+        return dct

everysk/sdk/entities/file/settings.py

@@ -0,0 +1,63 @@
+###############################################################################
+#
+# (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 IntField, ListField, RegexField, StrField
+
+FILE_URL_PATH = StrField(default='/file', readonly=True)
+FILE_URL_LENGTH = IntField(default=32, readonly=True)
+FILE_HASH_LENGTH = IntField(default=40, readonly=True)
+
+FILE_ID_REGEX = RegexField(default=r'^file_[a-zA-Z0-9]', readonly=True)
+FILE_ID_MAX_SIZE = IntField(default=30, readonly=True)
+FILE_ID_PREFIX = StrField(default='file_', readonly=True)
+
+FILE_DATA_MAX_SIZE_IN_RAW = IntField(default=(100 * 1024 * 1024), readonly=True)
+FILE_DATA_MAX_SIZE_IN_BASE64 = IntField(
+    default=139810133, readonly=True
+)  # int(FILE_DATA_MAX_SIZE_IN_RAW / 3 * 4) # 13.33MB in BASE64 ~= 10MB in RAW
+
+FILE_CONTENT_TYPES = ListField(
+    default=[
+        None,
+        'application/csv',
+        'application/javascript',
+        'application/json',
+        'application/x-python',
+        'application/x-python-code',
+        'application/x-python-script',
+        'text/x-python',
+        'text/x-python-code',
+        'text/x-python-script',
+        'application/msword',
+        'application/octet-stream',
+        'application/pdf',
+        'application/vnd.ms-excel',
+        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+        'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+        'application/x-zip-compressed',
+        'application/xml',
+        'application/zip',
+        'image/bmp',
+        'image/gif',
+        'image/jpeg',
+        'image/png',
+        'image/svg+xml',
+        'image/webp',
+        'text/comma-separated-values',
+        'text/csv',
+        'text/html',
+        'text/plain',
+        'text/markdown',
+        'text/x-comma-separated-values',
+        'text/xml',
+        'audio/mpeg',
+        'audio/wav',
+    ],
+    readonly=True,
+)