amsdal 0.4.13__cp312-cp312-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/__init__.pyi

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

amsdal/models/core/class_object.py

@@ -0,0 +1,37 @@
+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
+
+
+class ClassObject(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    properties: Optional[dict[str, Optional['ClassProperty']]] = Field(None, title='Properties')  # noqa: F405, UP007
+    table_name: Optional[str] = Field(None, title='Table name')  # noqa: UP007
+    primary_key: Optional[list[str]] = Field(None, title='Primary key fields')  # noqa: UP007
+    indexed: Optional[list[str]] = Field(None, title='Indexed')  # noqa: UP007
+    unique: Optional[list[list[str]]] = Field(None, title='Unique Fields')  # noqa: UP007
+    required: Optional[list[str]] = Field(None, title='Required')  # noqa: UP007
+    meta_class: Optional[str] = Field('ClassObject', title='Meta Class')  # noqa: UP007
+
+    @field_validator('properties')
+    @classmethod
+    def _non_empty_keys_properties(cls: type, value: Any) -> Any:
+        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_object.pyi

@@ -0,0 +1,24 @@
+from amsdal.models.core.class_property import *
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class ClassObject(Model):
+    __module_type__: ClassVar[ModuleType] = ...
+    properties: dict[str, ClassProperty | None] | None = ...
+    table_name: str | None = ...
+    primary_key: list[str] | None = ...
+    indexed: list[str] | None = ...
+    unique: list[list[str]] | None = ...
+    required: list[str] | None = ...
+    meta_class: str | None = ...
+    @classmethod
+    def _non_empty_keys_properties(cls, value: Any) -> Any: ...
+    @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.
+        """

amsdal/models/core/class_object_meta.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
+
+from amsdal.models.core.class_property_meta import *  # noqa: F403
+
+
+class ClassObjectMeta(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    title: str = Field(title='Title')
+    type: str = Field(title='Type')
+    default: Any | None = Field(None, title='Default')
+    class_schema_type: str | None = Field(None, title='Schema Type')
+    properties: dict[str, Optional['ClassPropertyMeta']] | None = Field(None, title='Properties')  # noqa: F405
+    custom_code: str | None = Field(None, title='Custom Code')
+
+    @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/core/class_object_meta.pyi

@@ -0,0 +1,15 @@
+from amsdal.models.core.class_property_meta import *
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class ClassObjectMeta(Model):
+    __module_type__: ClassVar[ModuleType] = ...
+    title: str = ...
+    type: str = ...
+    default: Any | None = ...
+    class_schema_type: str | None = ...
+    properties: dict[str, ClassPropertyMeta | None] | None = ...
+    custom_code: str | None = ...
+    @classmethod
+    def _non_empty_keys_properties(cls, value: Any) -> Any: ...

amsdal/models/core/class_property.py

@@ -0,0 +1,20 @@
+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
+
+
+class ClassProperty(TypeModel):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    type: str = Field(title='Type')
+    items: dict[str, Any | None] | None = Field(None, title='Items')
+    db_field: list[str] | None = Field(None, title='DB Fields')
+
+    @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/class_property.pyi

@@ -0,0 +1,11 @@
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class ClassProperty(TypeModel):
+    __module_type__: ClassVar[ModuleType]
+    type: str
+    items: dict[str, Any | None] | None
+    db_field: list[str] | None
+    @classmethod
+    def _non_empty_keys_items(cls, value: Any) -> Any: ...

amsdal/models/core/class_property_meta.py

@@ -0,0 +1,15 @@
+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
+
+from amsdal.models.core.option import *  # noqa: F403
+
+
+class ClassPropertyMeta(TypeModel):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    title: str | None = Field(None, title='Title')
+    default: Any | None = Field(None, title='Default')
+    options: list['Option'] | None = Field(None, title='Options')  # noqa: F405

amsdal/models/core/class_property_meta.pyi

@@ -0,0 +1,10 @@
+from amsdal.models.core.option import *
+from amsdal_models.classes.model import TypeModel
+from amsdal_utils.models.enums import ModuleType
+from typing import Any, ClassVar
+
+class ClassPropertyMeta(TypeModel):
+    __module_type__: ClassVar[ModuleType]
+    title: str | None
+    default: Any | None
+    options: list['Option'] | None

amsdal/models/core/file.py

@@ -0,0 +1,156 @@
+import base64
+from pathlib import Path
+from typing import BinaryIO
+from typing import ClassVar
+
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic import field_validator
+from pydantic.fields import Field
+
+
+class File(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CORE
+    filename: str = Field(title='Filename')
+    data: bytes = Field(title='Data')
+    size: float | None = Field(None, title='Size')
+
+    def __repr__(self) -> str:
+        return f'File<{self.filename}>({self.size or len(self.data) or 0} bytes)'
+
+    def __str__(self) -> str:
+        return repr(self)
+
+    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
+        """
+        self.size = len(self.data or b'')
+
+    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
+        """
+        self.size = len(self.data or b'')
+
+    @field_validator('data')
+    @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.
+        """
+        is_base64: bool = False
+        try:
+            is_base64 = base64.b64encode(base64.b64decode(v)) == v
+        except Exception:
+            ...
+        if is_base64:
+            return base64.b64decode(v)
+        return v
+
+    @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.
+        """
+        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)  # type: ignore[call-arg]
+
+    @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 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
+        """
+        self.size = len(self.data or b'')
+
+    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
+        """
+        self.size = len(self.data or b'')
+
+    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.
+        """
+        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)