amsdal 0.4.13__cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

amsdal/models/core/file.pyi

@@ -0,0 +1,104 @@
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pathlib import Path
+from typing import BinaryIO, ClassVar
+
+class File(Model):
+    __module_type__: ClassVar[ModuleType] = ...
+    filename: str = ...
+    data: bytes = ...
+    size: float | None = ...
+    def __repr__(self) -> str: ...
+    def __str__(self) -> str: ...
+    async def apre_create(self) -> None:
+        """
+        Prepares the object for creation by setting its size attribute.
+
+        This method calculates the size of the object's data and assigns it to the size attribute.
+        If the data is None, it defaults to an empty byte string.
+
+        Args:
+            None
+        """
+    async def apre_update(self) -> None:
+        """
+        Prepares the object for update by setting its size attribute.
+
+        This method calculates the size of the object's data and assigns it to the size attribute.
+        If the data is None, it defaults to an empty byte string.
+
+        Args:
+            None
+        """
+    @classmethod
+    def data_base64_decode(cls, v: bytes) -> bytes:
+        """
+        Decodes a base64-encoded byte string if it is base64-encoded.
+
+        This method checks if the provided byte string is base64-encoded and decodes it if true.
+        If the byte string is not base64-encoded, it returns the original byte string.
+
+        Args:
+            cls: The class this method belongs to.
+            v (bytes): The byte string to be checked and potentially decoded.
+
+        Returns:
+            bytes: The decoded byte string if it was base64-encoded, otherwise the original byte string.
+        """
+    @classmethod
+    def from_file(cls, file_or_path: Path | BinaryIO) -> File:
+        """
+        Creates a `File` object from a file path or a binary file object.
+
+        Args:
+            file_or_path (Path | BinaryIO): The file path or binary file object.
+
+        Returns:
+            File: The created `File` object.
+
+        Raises:
+            ValueError: If the provided path is a directory.
+        """
+    @property
+    def mimetype(self) -> str | None:
+        """
+        Returns the MIME type of the file based on its filename.
+
+        This method uses the `mimetypes` module to guess the MIME type of the file.
+
+        Returns:
+            str | None: The guessed MIME type of the file, or None if it cannot be determined.
+        """
+    def pre_create(self) -> None:
+        """
+        Prepares the object for creation by setting its size attribute.
+
+        This method calculates the size of the object's data and assigns it to the size attribute.
+        If the data is None, it defaults to an empty byte string.
+
+        Args:
+            None
+        """
+    def pre_update(self) -> None:
+        """
+        Prepares the object for update by setting its size attribute.
+
+        This method calculates the size of the object's data and assigns it to the size attribute.
+        If the data is None, it defaults to an empty byte string.
+
+        Args:
+            None
+        """
+    def to_file(self, file_or_path: Path | BinaryIO) -> None:
+        """
+        Writes the object's data to a file path or a binary file object.
+
+        Args:
+            file_or_path (Path | BinaryIO): The file path or binary file object where the data will be written.
+
+        Returns:
+            None
+
+        Raises:
+            ValueError: If the provided path is a directory.
+        """

amsdal/models/core/fixture.py

@@ -0,0 +1,25 @@
+from typing import Any
+from typing import ClassVar
+
+from amsdal_models.builder.validators.dict_validators import validate_non_empty_keys
+from amsdal_models.classes.data_models.constraints import UniqueConstraint
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+from pydantic.functional_validators import field_validator
+
+
+class Fixture(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    __constraints__: ClassVar[list[UniqueConstraint]] = [
+        UniqueConstraint(name='unq_fixture_external_id', fields=['external_id'])
+    ]
+    class_name: str | None = Field(None, title='Class Name')
+    order: float | None = Field(None, title='Order')
+    external_id: str = Field(title='External ID')
+    data: dict[str, Any | None] = Field(title='Data')
+
+    @field_validator('data')
+    @classmethod
+    def _non_empty_keys_data(cls: type, value: Any) -> Any:
+        return validate_non_empty_keys(value)

amsdal/models/core/fixture.pyi

@@ -0,0 +1,14 @@
+from amsdal_models.classes.data_models.constraints import UniqueConstraint
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class Fixture(Model):
+    __module_type__: ClassVar[ModuleType] = ...
+    __constraints__: ClassVar[list[UniqueConstraint]] = ...
+    class_name: str | None = ...
+    order: float | None = ...
+    external_id: str = ...
+    data: dict[str, Any | None] = ...
+    @classmethod
+    def _non_empty_keys_data(cls, value: Any) -> Any: ...

amsdal/models/core/option.py

@@ -0,0 +1,11 @@
+from typing import ClassVar
+
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class Option(TypeModel):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    key: str = Field(title='Key')
+    value: str = Field(title='Value Type')

amsdal/models/core/option.pyi

@@ -0,0 +1,8 @@
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from typing import ClassVar
+
+class Option(TypeModel):
+    __module_type__: ClassVar[ModuleType]
+    key: str
+    value: str

amsdal/models/core/validator.py

@@ -0,0 +1,12 @@
+from typing import Any
+from typing import ClassVar
+
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class Validator(TypeModel):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    name: str = Field(title='Validator Name')
+    data: Any = Field(title='Validator Data')

amsdal/models/core/validator.pyi

@@ -0,0 +1,8 @@
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class Validator(TypeModel):
+    __module_type__: ClassVar[ModuleType]
+    name: str
+    data: Any

amsdal/models/types/object.py

@@ -0,0 +1,26 @@
+from typing import Any
+from typing import ClassVar
+from typing import Optional
+
+from amsdal_models.builder.validators.dict_validators import validate_non_empty_keys
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+from pydantic.functional_validators import field_validator
+
+
+class Object(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.TYPE
+    title: Optional[str] = Field(None, title='Title')  # noqa: UP007
+    type: Optional[str] = Field(None, title='Type')  # noqa: UP007
+    default: Optional[Any] = Field(None, title='Default')  # noqa: UP007
+    properties: Optional[dict[str, Optional[Any]]] = Field(None, title='Properties')  # noqa: UP007
+    required: Optional[list[str]] = Field(None, title='Required')  # noqa: UP007
+    unique: Optional[list[list[str]]] = Field(None, title='Unique Fields')  # noqa: UP007
+    custom_code: Optional[str] = Field(None, title='Custom Code')  # noqa: UP007
+    meta_class: Optional[str] = Field(None, title='Meta Class')  # noqa: UP007
+
+    @field_validator('properties')
+    @classmethod
+    def _non_empty_keys_properties(cls: type, value: Any) -> Any:  # type: ignore # noqa: A003
+        return validate_non_empty_keys(value)

amsdal/models/types/object.pyi

@@ -0,0 +1,16 @@
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class Object(Model):
+    __module_type__: ClassVar[ModuleType] = ...
+    title: str | None = ...
+    type: str | None = ...
+    default: Any | None = ...
+    properties: dict[str, Any | None] | None = ...
+    required: list[str] | None = ...
+    unique: list[list[str]] | None = ...
+    custom_code: str | None = ...
+    meta_class: str | None = ...
+    @classmethod
+    def _non_empty_keys_properties(cls, value: Any) -> Any: ...

amsdal/queryset/__init__.py

@@ -0,0 +1,21 @@
+from amsdal_models.querysets.base_queryset import QuerySet
+from amsdal_models.querysets.base_queryset import QuerySetCount
+from amsdal_models.querysets.base_queryset import QuerySetOne
+from amsdal_models.querysets.base_queryset import QuerySetOneRequired
+from amsdal_utils.query.data_models.filter import Filter
+from amsdal_utils.query.enums import Lookup
+from amsdal_utils.query.enums import OrderDirection
+from amsdal_utils.query.utils import ConnectorEnum
+from amsdal_utils.query.utils import Q
+
+__all__ = [
+    'ConnectorEnum',
+    'Filter',
+    'Lookup',
+    'OrderDirection',
+    'Q',
+    'QuerySet',
+    'QuerySetCount',
+    'QuerySetOne',
+    'QuerySetOneRequired',
+]

amsdal/queryset/__init__.pyi

@@ -0,0 +1,6 @@
+from amsdal_models.querysets.base_queryset import QuerySet as QuerySet, QuerySetCount as QuerySetCount, QuerySetOne as QuerySetOne, QuerySetOneRequired as QuerySetOneRequired
+from amsdal_utils.query.data_models.filter import Filter as Filter
+from amsdal_utils.query.enums import Lookup as Lookup, OrderDirection as OrderDirection
+from amsdal_utils.query.utils import ConnectorEnum as ConnectorEnum, Q as Q
+
+__all__ = ['ConnectorEnum', 'Filter', 'Lookup', 'OrderDirection', 'Q', 'QuerySet', 'QuerySetCount', 'QuerySetOne', 'QuerySetOneRequired']

amsdal/schemas/core/class_object/model.json

@@ -0,0 +1,31 @@
+{
+  "title": "ClassObject",
+  "type": "object",
+  "properties": {
+    "properties": {
+      "title": "Properties",
+      "type": "dictionary",
+      "items": {
+        "key": {
+          "type": "string"
+        },
+        "value": {
+          "type": "ClassProperty"
+        }
+      }
+    },
+    "required": {
+      "title": "Required",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "meta_class": {
+      "title": "Meta Class",
+      "type": "string",
+      "default": "ClassObject"
+    }
+  },
+  "required": []
+}

amsdal/schemas/core/class_object/properties/display_name.py

@@ -0,0 +1,9 @@
+@property  # type: ignore[misc]
+def display_name(self) -> str:  # type: ignore[no-untyped-def]
+    """
+    Returns the display name of the object.
+
+    Returns:
+        str: The display name, which is the title of the object.
+    """
+    return self.title

amsdal/schemas/core/class_object_meta/model.json

@@ -0,0 +1,59 @@
+{
+  "title": "ClassObjectMeta",
+  "type": "object",
+  "properties": {
+    "title": {
+      "title": "Title",
+      "type": "string"
+    },
+    "type": {
+      "title": "Type",
+      "type": "string"
+    },
+    "default": {
+      "title": "Default",
+      "type": "anything"
+    },
+    "class_schema_type": {
+      "title": "Schema Type",
+      "type": "string"
+    },
+    "properties": {
+      "title": "Properties",
+      "type": "dictionary",
+      "items": {
+        "key": {
+          "type": "string"
+        },
+        "value": {
+          "type": "ClassPropertyMeta"
+        }
+      }
+    },
+    "indexed": {
+      "title": "Indexed",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "unique": {
+      "title": "Unique Fields",
+      "type": "array",
+      "items": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "custom_code": {
+      "title": "Custom Code",
+      "type": "string"
+    }
+  },
+  "required": [
+    "title",
+    "type"
+  ]
+}

amsdal/schemas/core/class_property/model.json

@@ -0,0 +1,22 @@
+{
+  "title": "ClassProperty",
+  "type": "object",
+  "properties": {
+    "type": {
+      "title": "Type",
+      "type": "string"
+    },
+    "items": {
+      "title": "Items",
+      "type": "dictionary",
+      "items": {
+        "key": {"type": "string"},
+        "value": {"type": "anything"}
+      }
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "meta_class": "TypeMeta"
+}

amsdal/schemas/core/class_property_meta/model.json

@@ -0,0 +1,23 @@
+{
+  "title": "ClassPropertyMeta",
+  "type": "object",
+  "properties": {
+    "title": {
+      "title": "Title",
+      "type": "string"
+    },
+    "default": {
+      "title": "Default",
+      "type": "anything"
+    },
+    "options": {
+      "title": "Options",
+      "type": "array",
+      "items": {
+        "type": "Option"
+      }
+    }
+  },
+  "required": [],
+  "meta_class": "TypeMeta"
+}

amsdal/schemas/core/file/hooks/pre_create.py

@@ -0,0 +1,24 @@
+def pre_create(self) -> None:  # type: ignore[no-untyped-def]
+    """
+    Prepares the object for creation by setting its size attribute.
+
+    This method calculates the size of the object's data and assigns it to the size attribute.
+    If the data is None, it defaults to an empty byte string.
+
+    Args:
+        None
+    """
+    self.size = len(self.data or b'')
+
+
+async def apre_create(self) -> None:  # type: ignore[no-untyped-def]
+    """
+    Prepares the object for creation by setting its size attribute.
+
+    This method calculates the size of the object's data and assigns it to the size attribute.
+    If the data is None, it defaults to an empty byte string.
+
+    Args:
+        None
+    """
+    self.size = len(self.data or b'')

amsdal/schemas/core/file/hooks/pre_update.py

@@ -0,0 +1,24 @@
+def pre_update(self):  # type: ignore[no-untyped-def]
+    """
+    Prepares the object for update by setting its size attribute.
+
+    This method calculates the size of the object's data and assigns it to the size attribute.
+    If the data is None, it defaults to an empty byte string.
+
+    Args:
+        None
+    """
+    self.size = len(self.data or b'')
+
+
+async def apre_update(self):  # type: ignore[no-untyped-def]
+    """
+    Prepares the object for update by setting its size attribute.
+
+    This method calculates the size of the object's data and assigns it to the size attribute.
+    If the data is None, it defaults to an empty byte string.
+
+    Args:
+        None
+    """
+    self.size = len(self.data or b'')

amsdal/schemas/core/file/model.json

@@ -0,0 +1,23 @@
+{
+  "title": "File",
+  "type": "object",
+  "default": null,
+  "properties": {
+    "filename": {
+      "title": "Filename",
+      "type": "string"
+    },
+    "data": {
+      "title": "Data",
+      "type": "binary"
+    },
+    "size": {
+      "title": "Size",
+      "type": "number"
+    }
+  },
+  "required": [
+    "filename",
+    "data"
+  ]
+}

amsdal/schemas/core/file/properties/from_file.py

@@ -0,0 +1,34 @@
+from pathlib import Path
+from typing import BinaryIO
+
+
+@classmethod  # type: ignore[misc, no-untyped-def]
+def from_file(  # type: ignore[no-untyped-def]
+    cls,
+    file_or_path: Path | BinaryIO,
+) -> 'File':  # type: ignore[name-defined]  # noqa: F821
+    """
+    Creates a `File` object from a file path or a binary file object.
+
+    Args:
+        file_or_path (Path | BinaryIO): The file path or binary file object.
+
+    Returns:
+        File: The created `File` object.
+
+    Raises:
+        ValueError: If the provided path is a directory.
+    """
+    if isinstance(file_or_path, Path):
+        if file_or_path.is_dir():
+            msg = f'{file_or_path} is a directory'
+            raise ValueError(msg)
+
+        data = file_or_path.read_bytes()
+        filename = file_or_path.name
+    else:
+        file_or_path.seek(0)
+        data = file_or_path.read()
+        filename = Path(file_or_path.name).name
+
+    return cls(data=data, filename=filename)

amsdal/schemas/core/file/properties/mimetype.py

@@ -0,0 +1,13 @@
+@property  # type: ignore[misc]
+def mimetype(self) -> str | None:  # type: ignore[no-untyped-def]
+    """
+    Returns the MIME type of the file based on its filename.
+
+    This method uses the `mimetypes` module to guess the MIME type of the file.
+
+    Returns:
+        str | None: The guessed MIME type of the file, or None if it cannot be determined.
+    """
+    import mimetypes
+
+    return mimetypes.guess_type(self.filename)[0]

amsdal/schemas/core/file/properties/str.py

@@ -0,0 +1,6 @@
+def __str__(self) -> str:  # type: ignore[no-untyped-def] # noqa: N807
+    return repr(self)
+
+
+def __repr__(self) -> str:  # type: ignore[no-untyped-def] # noqa: N807
+    return f'File<{self.filename}>({self.size or len(self.data) or 0} bytes)'

amsdal/schemas/core/file/properties/to_file.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+from typing import BinaryIO
+
+
+def to_file(self, file_or_path: Path | BinaryIO) -> None:  # type: ignore[no-untyped-def]
+    """
+    Writes the object's data to a file path or a binary file object.
+
+    Args:
+        file_or_path (Path | BinaryIO): The file path or binary file object where the data will be written.
+
+    Returns:
+        None
+
+    Raises:
+        ValueError: If the provided path is a directory.
+    """
+    if isinstance(file_or_path, Path):
+        if file_or_path.is_dir():
+            file_or_path = file_or_path / self.name
+        file_or_path.write_bytes(self.data)  # type: ignore[union-attr]
+    else:
+        file_or_path.write(self.data)
+        file_or_path.seek(0)

amsdal/schemas/core/file/properties/validate_data.py

@@ -0,0 +1,32 @@
+import base64
+
+from pydantic import field_validator
+
+
+@field_validator('data')  # type: ignore[misc]
+@classmethod
+def data_base64_decode(cls, v: bytes) -> bytes:  # type: ignore[no-untyped-def]
+    """
+    Decodes a base64-encoded byte string if it is base64-encoded.
+
+    This method checks if the provided byte string is base64-encoded and decodes it if true.
+    If the byte string is not base64-encoded, it returns the original byte string.
+
+    Args:
+        cls: The class this method belongs to.
+        v (bytes): The byte string to be checked and potentially decoded.
+
+    Returns:
+        bytes: The decoded byte string if it was base64-encoded, otherwise the original byte string.
+    """
+    is_base64: bool = False
+
+    try:
+        is_base64 = base64.b64encode(base64.b64decode(v)) == v
+    except Exception:
+        ...
+
+    if is_base64:
+        return base64.b64decode(v)
+
+    return v

amsdal/schemas/core/fixture/model.json

@@ -0,0 +1,35 @@
+{
+  "title": "Fixture",
+  "type": "object",
+  "properties": {
+    "class_name": {
+      "title": "Class Name",
+      "type": "string"
+    },
+    "order": {
+      "title": "Order",
+      "type": "number"
+    },
+    "external_id": {
+      "title": "External ID",
+      "type": "string"
+    },
+    "data": {
+      "title": "Data",
+      "type": "dictionary",
+      "items": {
+        "key": {"type": "string"},
+        "value": {"type": "anything"}
+      }
+    }
+  },
+  "required": [
+    "data",
+    "external_id"
+  ],
+  "unique": [
+    [
+      "external_id"
+    ]
+  ]
+}

amsdal/schemas/core/option/model.json

@@ -0,0 +1,19 @@
+{
+  "title": "Option",
+  "type": "object",
+  "properties": {
+    "key": {
+      "title": "Key",
+      "type": "string"
+    },
+    "value": {
+      "title": "Value Type",
+      "type": "string"
+    }
+  },
+  "required": [
+    "key",
+    "value"
+  ],
+  "meta_class": "TypeMeta"
+}