amsdal 0.5.34__cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

amsdal/manager.pyi

@@ -0,0 +1,265 @@
+from _typeshed import Incomplete
+from amsdal.cloud.services.actions.manager import CloudActionsManager as CloudActionsManager
+from amsdal.cloud.services.auth.signup_service import SignupService as SignupService
+from amsdal.configs.main import settings as settings
+from amsdal.errors import AmsdalAuthenticationError as AmsdalAuthenticationError, AmsdalMissingCredentialsError as AmsdalMissingCredentialsError, AmsdalRuntimeError as AmsdalRuntimeError, AmsdalSignupError as AmsdalSignupError
+from amsdal.fixtures.manager import AsyncFixturesManager as AsyncFixturesManager, FixturesManager as FixturesManager
+from amsdal.mixins.class_versions_mixin import ClassVersionsMixin as ClassVersionsMixin
+from amsdal_data.transactions.decorators import async_transaction, transaction
+from amsdal_models.classes.class_manager import ClassManager
+from amsdal_utils.config.data_models.amsdal_config import AmsdalConfig as AmsdalConfig
+from amsdal_utils.utils.singleton import Singleton
+
+class AmsdalManager(ClassVersionsMixin, metaclass=Singleton):
+    """
+    Manages the AMSDAL framework components and operations.
+
+    This class is responsible for initializing, setting up, and managing various components
+    of the AMSDAL framework, including connections, data management, schema management,
+    and authentication. It also provides methods for building and tearing down the framework.
+    """
+    _class_manager: ClassManager
+    _config_manager: Incomplete
+    _config: Incomplete
+    _data_application: Incomplete
+    _is_setup: bool
+    __is_authenticated: bool
+    _metadata_manager: Incomplete
+    _auth_manager: Incomplete
+    def __init__(self, *, raise_on_new_signup: bool = False) -> None:
+        """
+        Initializes all sub managers. Reads the configuration.
+
+        Returns:
+            None
+        """
+    @property
+    def is_setup(self) -> bool: ...
+    @property
+    def is_authenticated(self) -> bool:
+        """
+        Indicates if the AMSDAL license authentication process has been passed.
+
+        This property returns a boolean value indicating whether the AMSDAL license
+        authentication process has been successfully completed.
+
+        Returns:
+            bool: True if authenticated, False otherwise.
+        """
+    def pre_setup(self) -> None:
+        """
+        Initiates models root path and adds it into sys.path.
+
+        This method initializes the class manager models modules and sets up the models root path
+        as specified in the settings. It ensures that the models root path is added
+        to the system path for proper module resolution.
+
+        Returns:
+            None
+        """
+    def setup(self) -> None:
+        """
+        Initiates models root path and the connections.
+
+        This method sets up the AMSDAL framework by initializing the models root path and
+        establishing connections. It ensures that the setup process is only performed once.
+
+        Raises:
+            AmsdalRuntimeError: If the AMSDAL manager is already set up.
+
+        Returns:
+            None
+        """
+    @transaction
+    def post_setup(self) -> None:
+        """
+        Registers internal classes and prepares connections (creates internal tables).
+        """
+    def _check_auth(self) -> None: ...
+    @property
+    def cloud_actions_manager(self) -> CloudActionsManager:
+        """
+        Provides access to the CloudActionsManager.
+
+        This property checks if the AMSDAL manager is authenticated and then returns
+        an instance of the CloudActionsManager.
+
+        Returns:
+            CloudActionsManager: An instance of the CloudActionsManager.
+
+        Raises:
+            AmsdalAuthenticationError: If the AMSDAL manager is not authenticated.
+        """
+    def authenticate(self) -> None:
+        """
+        Run AMSDAL license authentication process.
+
+        This method runs the AMSDAL license authentication process and sets the
+        authentication status accordingly.
+
+        Returns:
+            None
+        """
+    @transaction
+    def apply_fixtures(self) -> None:
+        """
+        Loads and applies fixtures defined in your application.
+
+        This method loads the fixtures from the specified path and applies them to the
+        AMSDAL framework. It uses the `FixturesManager` to manage the loading and application
+        of the fixtures.
+
+        Returns:
+            None
+        """
+    def init_classes(self) -> None:
+        """
+        Initializes and imports classes based on the schema manager's class schemas.
+
+        This method iterates over the class schemas provided by the schema manager and imports
+        the classes into the class manager, excluding those of type `SchemaTypes.TYPE`.
+
+        Returns:
+            None
+        """
+    def teardown(self) -> None:
+        """
+        Clean up everything on the application exit.
+
+        This method performs a cleanup of all components managed by the AMSDAL framework
+        when the application exits. It disconnects and invalidates connections, clears caches,
+        and resets the setup status.
+
+        Raises:
+            AmsdalRuntimeError: If the AMSDAL manager is not set up.
+
+        Returns:
+            None
+        """
+
+class AsyncAmsdalManager(ClassVersionsMixin, metaclass=Singleton):
+    """
+    Manages the AMSDAL framework components and operations.
+
+    This class is responsible for initializing, setting up, and managing various components
+    of the AMSDAL framework, including connections, data management, schema management,
+    and authentication. It also provides methods for building and tearing down the framework.
+    """
+    _class_manager: ClassManager
+    _config_manager: Incomplete
+    _config: Incomplete
+    _data_application: Incomplete
+    _is_setup: bool
+    __is_authenticated: bool
+    _metadata_manager: Incomplete
+    _auth_manager: Incomplete
+    def __init__(self, *, raise_on_new_signup: bool = False) -> None:
+        """
+        Initializes all sub managers. Reads the configuration.
+
+        Returns:
+            None
+        """
+    @property
+    def is_setup(self) -> bool: ...
+    @property
+    def is_authenticated(self) -> bool:
+        """
+        Indicates if the AMSDAL license authentication process has been passed.
+
+        This property returns a boolean value indicating whether the AMSDAL license
+        authentication process has been successfully completed.
+
+        Returns:
+            bool: True if authenticated, False otherwise.
+        """
+    def pre_setup(self) -> None:
+        """
+        Initiates models root path and adds it into sys.path.
+
+        This method initializes the class manager and sets up the models root path
+        as specified in the settings. It ensures that the models root path is added
+        to the system path for proper module resolution.
+
+        Returns:
+            None
+        """
+    async def setup(self) -> None:
+        """
+        Initiates models root path and the connections.
+
+        This method sets up the AMSDAL framework by initializing the models root path and
+        establishing connections. It ensures that the setup process is only performed once.
+
+        Raises:
+            AmsdalRuntimeError: If the AMSDAL manager is already set up.
+
+        Returns:
+            None
+        """
+    @async_transaction
+    async def post_setup(self) -> None:
+        """
+        Registers internal classes and prepares connections (creates internal tables).
+        """
+    def _check_auth(self) -> None: ...
+    @property
+    def cloud_actions_manager(self) -> CloudActionsManager:
+        """
+        Provides access to the CloudActionsManager.
+
+        This property checks if the AMSDAL manager is authenticated and then returns
+        an instance of the CloudActionsManager.
+
+        Returns:
+            CloudActionsManager: An instance of the CloudActionsManager.
+
+        Raises:
+            AmsdalAuthenticationError: If the AMSDAL manager is not authenticated.
+        """
+    def authenticate(self) -> None:
+        """
+        Run AMSDAL license authentication process.
+
+        This method runs the AMSDAL license authentication process and sets the
+        authentication status accordingly.
+
+        Returns:
+            None
+        """
+    @async_transaction
+    async def apply_fixtures(self) -> None:
+        """
+        Loads and applies fixtures defined in your application.
+
+        This method loads the fixtures from the specified path and applies them to the
+        AMSDAL framework. It uses the `FixturesManager` to manage the loading and application
+        of the fixtures.
+
+        Returns:
+            None
+        """
+    def init_classes(self) -> None:
+        """
+        Initializes and imports classes based on the schema manager's class schemas.
+
+        This method iterates over the class schemas provided by the schema manager and imports
+        the classes into the class manager, excluding those of type `SchemaTypes.TYPE`.
+
+        Returns:
+            None
+        """
+    async def teardown(self) -> None:
+        """
+        Clean up everything on the application exit.
+
+        This method performs a cleanup of all components managed by the AMSDAL framework
+        when the application exits. It disconnects and invalidates connections, clears caches,
+        and resets the setup status.
+
+        Raises:
+            AmsdalRuntimeError: If the AMSDAL manager is not set up.
+
+        Returns:
+            None
+        """

amsdal/mixins/class_versions_mixin.pyi

@@ -0,0 +1,12 @@
+from amsdal_data.connections.historical.schema_version_manager import AsyncHistoricalSchemaVersionManager, HistoricalSchemaVersionManager
+
+class ClassVersionsMixin:
+    """
+    Mixin class to manage class versions and related table schemas.
+    """
+    @staticmethod
+    def _register_internal_classes(schema_version_manager: HistoricalSchemaVersionManager | AsyncHistoricalSchemaVersionManager) -> None: ...
+    @classmethod
+    def register_internal_classes(cls) -> None: ...
+    @classmethod
+    def aregister_internal_classes(cls) -> None: ...

amsdal/models/__init__.py

@@ -0,0 +1,19 @@
+from amsdal_models.builder.validators.dict_validators import validate_non_empty_keys
+from amsdal_models.builder.validators.options_validators import validate_options
+from amsdal_models.classes.data_models.constraints import UniqueConstraint
+from amsdal_models.classes.data_models.indexes import IndexInfo
+from amsdal_models.classes.model import Model
+from amsdal_models.classes.model import TypeModel
+from amsdal_models.classes.relationships.many_reference_field import ManyReferenceField
+from amsdal_models.classes.relationships.reference_field import ReferenceField
+
+__all__ = [
+    'IndexInfo',
+    'ManyReferenceField',
+    'Model',
+    'ReferenceField',
+    'TypeModel',
+    'UniqueConstraint',
+    'validate_non_empty_keys',
+    'validate_options',
+]

amsdal/models/core/class_object.py

@@ -0,0 +1,38 @@
+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
+
+from amsdal.models.core.class_property import *  # noqa: F403
+from amsdal.models.core.storage_metadata import *  # noqa: F403
+
+
+class ClassObject(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    title: str = Field(title='Title')
+    type: str = Field(title='Type')
+    module_type: str = Field(title='Module Type')
+    properties: Optional[dict[str, Optional['ClassProperty']]] = Field(None, title='Properties')  # noqa: F405, UP007
+    required: Optional[list[str]] = Field(None, title='Required')  # noqa: UP007
+    custom_code: str | None = Field(None, title='Custom Code')
+    storage_metadata: Optional['StorageMetadata'] = Field(None, title='Storage metadata')  # noqa: F405
+
+    @field_validator('properties')
+    @classmethod
+    def _non_empty_keys_properties(cls: type, value: Any) -> Any:  # type: ignore # noqa: A003
+        return validate_non_empty_keys(value)
+
+    @property
+    def display_name(self) -> str:
+        """
+        Returns the display name of the object.
+
+        Returns:
+            str: The display name, which is the title of the object.
+        """
+        return self.title

amsdal/models/core/class_property.py

@@ -0,0 +1,26 @@
+from typing import Any
+from typing import ClassVar
+
+from amsdal_models.builder.validators.dict_validators import validate_non_empty_keys
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+from pydantic.functional_validators import field_validator
+
+from amsdal.models.core.option import *  # noqa: F403
+
+
+class ClassProperty(TypeModel):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    title: str | None = Field(None, title='Title')
+    type: str = Field(title='Type')
+    default: Any | None = Field(None, title='Default')
+    options: list['Option'] | None = Field(None, title='Options')  # noqa: F405
+    items: dict[str, Any | None] | None = Field(None, title='Items')
+    discriminator: str | None = Field(None, title='Discriminator')
+    extra: dict[str, Any | None] = Field(default_factory=dict, title='Extra')
+
+    @field_validator('items')
+    @classmethod
+    def _non_empty_keys_items(cls: type, value: Any) -> Any:  # type: ignore # noqa: A003
+        return validate_non_empty_keys(value)

amsdal/models/core/file.py

@@ -0,0 +1,243 @@
+import base64
+import io
+from contextlib import suppress
+from pathlib import Path
+from typing import IO
+from typing import Any
+from typing import BinaryIO
+from typing import ClassVar
+
+from amsdal_models.classes.model import Model
+from amsdal_models.storage.backends.db import AsyncFileWrapper
+from amsdal_models.storage.backends.db import DBStorage
+from amsdal_models.storage.base import Storage
+from amsdal_utils.models.data_models.reference import Reference
+from amsdal_utils.models.enums import ModuleType
+from pydantic import PrivateAttr
+from pydantic import model_validator
+from pydantic.fields import Field
+
+
+class File(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    filename: str = Field(title='Filename')
+    data: bytes | None = Field(default=None, title='Data')
+    size: float | None = Field(default=None, title='Size')
+    storage_address: Reference | None = Field(default=None, title='Storage Reference')
+
+    _source: BinaryIO | None = PrivateAttr(default=None)
+    _storage: Storage | None = PrivateAttr(default=None)
+
+    @property
+    def storage(self) -> Storage:
+        from amsdal.storages import default_storage
+
+        if self._storage:
+            return self._storage
+
+        if self.storage_address:
+            return Storage.from_storage_spec({'storage_class': self.storage_address.ref.resource})
+
+        return default_storage()
+
+    def __repr__(self) -> str:
+        return f'File<{self.filename}>({self.size or len(self.data or "") or 0} bytes)'
+
+    def __str__(self) -> str:
+        return repr(self)
+
+    def pre_create(self) -> None:
+        from amsdal_models.storage.persistence import persist_file
+
+        persist_file(self, storage=self.storage)
+
+    def pre_update(self) -> None:
+        from amsdal_models.storage.persistence import persist_file
+
+        persist_file(self, storage=self.storage)
+
+    async def apre_create(self) -> None:
+        from amsdal_models.storage.persistence import apersist_file
+
+        await apersist_file(self, storage=self.storage)
+
+    async def apre_update(self) -> None:
+        from amsdal_models.storage.persistence import apersist_file
+
+        await apersist_file(self, storage=self.storage)
+
+    @model_validator(mode='before')
+    @classmethod
+    def validate_model_data(cls, data: Any) -> Any:
+        if isinstance(data, dict):
+            if 'data' in data:
+                if data['data']:
+                    data['data'] = cls.data_base64_decode(data['data'])
+                    data['size'] = len(data['data'])
+                else:
+                    data['size'] = 0
+        return data
+
+    @classmethod
+    def data_base64_decode(cls, data: Any) -> bytes:
+        if isinstance(data, str):
+            data = data.encode('utf-8')
+
+        is_base64: bool = False
+
+        with suppress(Exception):
+            is_base64 = base64.b64encode(base64.b64decode(data)) == data
+
+        if is_base64:
+            return base64.b64decode(data)
+
+        return data
+
+    @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.
+        """
+        f: BinaryIO | io.BufferedReader
+
+        if isinstance(file_or_path, Path):
+            if file_or_path.is_dir():
+                msg = f'{file_or_path} is a directory'
+                raise ValueError(msg)
+            f = file_or_path.open('rb')
+            filename = file_or_path.name
+            size = file_or_path.stat().st_size
+
+        else:
+            f = file_or_path
+            filename = Path(getattr(f, 'name', 'unnamed')).name
+
+            try:
+                if f.seekable():
+                    f.seek(0, io.SEEK_END)
+                    size = f.tell()
+                    f.seek(0)
+                else:
+                    size = None
+            except (OSError, AttributeError):
+                size = None
+
+        obj = cls(filename=filename, size=size)
+        obj._source = f
+        return obj
+
+    @classmethod
+    def from_bytes(cls, filename: str, data: bytes) -> 'File':
+        """
+        Creates a `File` object from a byte string.
+
+        Args:
+            filename (str): The filename of the file.
+            data (bytes): The byte string containing the file data.:
+
+        Returns:
+            File: The created `File` object.
+        """
+        obj = cls(filename=filename, data=data, size=len(data))
+        return obj
+
+    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.
+        """
+        with self.open() as f:
+            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(f.read())  # type: ignore[union-attr]
+            else:
+                file_or_path.write(f.read())
+                file_or_path.seek(0)
+
+    def url(self) -> str:
+        """
+        Return a URL for this file using its storage_address.
+
+        Raises StateError if storage_address is missing.
+        """
+        return self.storage.url(self)
+
+    def open(self, mode: str = 'rb') -> IO[Any]:
+        """
+        Open a binary stream for reading (or other modes if supported) using storage_address.
+
+        Raises StateError if storage_address is missing.
+        """
+        return self.storage.open(self, mode)
+
+    async def aurl(self) -> str:
+        """
+        Async variant of url().
+
+        Uses the resolved storage to call aurl(); if the backend does not implement
+        async, falls back to the sync url().
+        """
+        try:
+            return await self.storage.aurl(self)  # type: ignore[attr-defined]
+        except NotImplementedError:
+            return self.storage.url(self)
+
+    async def aopen(self, mode: str = 'rb') -> Any:
+        """
+        Async variant of open().
+
+        Uses the resolved storage to call aopen(); if the backend does not implement
+        async, falls back to the sync open().
+        """
+        try:
+            return await self.storage.aopen(self, mode)
+        except NotImplementedError:
+            return AsyncFileWrapper(self.storage.open(self, mode))
+
+    @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.
+        """
+        import mimetypes
+
+        return mimetypes.guess_type(self.filename)[0]
+
+    def read_bytes(self) -> bytes:
+        with self.open() as f:
+            return f.read()
+
+    async def aread_bytes(self) -> bytes:
+        async with await self.aopen() as f:
+            return await f.read()
+
+    def set_data(self, data: bytes | str) -> None:
+        if not isinstance(self.storage, DBStorage):
+            msg = 'Cannot set data on a file that is not stored in a database. Use `File.from_bytes` instead.'
+            raise ValueError(msg)
+
+        self.data = self.data_base64_decode(data)
+        self.size = len(self.data)

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/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/storage_metadata.py

@@ -0,0 +1,15 @@
+from typing import ClassVar
+from typing import Optional
+
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class StorageMetadata(TypeModel):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    table_name: Optional[str] = Field(None, title='Table name')  # noqa: UP007
+    db_fields: dict[str, list[str]] | None = Field(None, title='Database fields')
+    primary_key: Optional[list[str]] = Field(None, title='Primary key fields')  # noqa: UP007
+    indexed: Optional[list[list[str]]] = Field(None, title='Indexed')  # noqa: UP007
+    unique: Optional[list[list[str]]] = Field(None, title='Unique Fields')  # noqa: UP007

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')