amsdal 0.5.23__cp311-cp311-macosx_10_9_universal2.whl

amsdal/contrib/frontend_configs/models/frontend_control_config.py

@@ -0,0 +1,108 @@
+from typing import TYPE_CHECKING
+from typing import Any
+from typing import ClassVar
+from typing import Literal
+from typing import Optional
+
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+from amsdal.contrib.frontend_configs.models.frontend_activator_config import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_async_validator import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_control_action import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_option import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_skip_none_base import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_slider_option import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_text_mask import *  # noqa: F403
+from amsdal.contrib.frontend_configs.models.frontend_config_validator import *  # noqa: F403
+
+if TYPE_CHECKING:
+    from amsdal.contrib.frontend_configs.models.frontend_config_control_action import ActionType
+
+ConfigType = Literal[
+    'Bytes',
+    'array',
+    'button',
+    'chat',
+    'checkbox',
+    'date',
+    'dateTriplet',
+    'datetime',
+    'dict',
+    'dropzone',
+    'email',
+    'file',
+    'group',
+    'group_switch',
+    'group_toggle',
+    'info-group',
+    'infoscreen',
+    'multiselect',
+    'number',
+    'number-operations',
+    'number-slider',
+    'number_equals',
+    'number_initial',
+    'number_minus',
+    'number_plus',
+    'object',
+    'object_group',
+    'object_latest',
+    'password',
+    'phone',
+    'radio',
+    'select',
+    'text',
+    'textarea',
+    'time',
+    'toggle',
+    'sections',
+    'section',
+]
+
+
+class ConditionItem(FrontendConfigSkipNoneBase):  # noqa: F405
+    path: str = Field(title='Path')
+    condition: str = Field(title='Condition')
+    value: Any = Field(default=None, title='Value')
+
+
+class Condition(FrontendConfigSkipNoneBase):  # noqa: F405
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    operation: Literal['and', 'or', 'not'] = Field(title='Operation')
+    conditions: list[ConditionItem] = Field(title='Conditions')  # noqa: F405
+
+
+Condition.model_rebuild()
+
+
+class FrontendControlConfig(FrontendConfigSkipNoneBase):  # noqa: F405
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    id: str | None = Field(None, title='ID')
+    type: ConfigType = Field(title='Type')
+    name: str = Field(title='Name')
+    label: str | None = Field(None, title='Label')
+    required: bool | None = Field(None, title='Required')
+    hideLabel: bool | None = Field(None, title='Hide Label')  # noqa: N815
+    actions: list[ActionType] | None = Field(None, title='Actions')  # noqa: F405
+    validators: list['FrontendConfigValidator'] | None = Field(None, title='Validators')  # noqa: F405
+    asyncValidators: list['FrontendConfigAsyncValidator'] | None = Field(  # noqa: F405, N815
+        None,
+        title='Async Validators',
+    )
+    activators: list['FrontendActivatorConfig'] | None = Field(None, title='Activators')  # noqa: F405
+    additionalText: str | None = Field(None, title='Additional Text')  # noqa: N815
+    value: Any | None = Field(None, title='Value')
+    placeholder: str | None = Field(None, title='Placeholder')
+    options: list['FrontendConfigOption'] | None = Field(None, title='Options')  # noqa: F405
+    mask: Optional['FrontendConfigTextMask'] = Field(None, title='Mask')  # noqa: F405
+    controls: list['FrontendControlConfig'] | None = Field(None, title='Controls')
+    showSearch: bool | None = Field(None, title='Show Search')  # noqa: N815
+    sliderOptions: Optional['FrontendConfigSliderOption'] = Field(None, title='Slider Option')  # noqa: F405, N815
+    customLabel: list[str] | None = Field(None, title='Custom Label')  # noqa: N815
+    control: Optional['FrontendControlConfig'] = Field(None, title='Control')
+    entityType: str | None = Field(None, title='Entity Type')  # noqa: N815
+    condition: Condition | None = Field(None, title='Condition')  # noqa: F405
+
+
+FrontendControlConfig.model_rebuild()

amsdal/contrib/frontend_configs/models/frontend_model_config.py

@@ -0,0 +1,14 @@
+from typing import ClassVar
+from typing import Optional
+
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+from amsdal.contrib.frontend_configs.models.frontend_control_config import *  # noqa: F403
+
+
+class FrontendModelConfig(Model):
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    class_name: str = Field(title='Class Name')
+    control: Optional['FrontendControlConfig'] = Field(None, title='Control')  # noqa: F405

amsdal/contrib/frontend_configs/utils.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+
+def merge_ui_configs(base: dict[str, Any], override: dict[str, Any]) -> dict[str, Any]:
+    """
+    Merges two UI configs together. The override config will take precedence over the base config.
+
+    This function recursively merges two dictionaries representing UI configurations.
+    If a key exists in both dictionaries, the value from the override dictionary will be used.
+    If the value is a dictionary or a list, the function will merge them recursively.
+
+    Args:
+        base (dict[str, Any]): The base UI configuration dictionary.
+        override (dict[str, Any]): The override UI configuration dictionary.
+
+    Returns:
+        dict[str, Any]: The merged UI configuration dictionary.
+    """
+    for key, value in override.items():
+        if key not in base:
+            base[key] = value
+        elif isinstance(value, dict):
+            base[key] = merge_ui_configs(base[key], value)
+        elif isinstance(value, list):
+            base[key] = [merge_ui_configs(base[key], item) for item in value]
+        else:
+            base[key] = value
+
+    return base

amsdal/contrib/frontend_configs/utils.pyi

@@ -0,0 +1,17 @@
+from typing import Any
+
+def merge_ui_configs(base: dict[str, Any], override: dict[str, Any]) -> dict[str, Any]:
+    """
+    Merges two UI configs together. The override config will take precedence over the base config.
+
+    This function recursively merges two dictionaries representing UI configurations.
+    If a key exists in both dictionaries, the value from the override dictionary will be used.
+    If the value is a dictionary or a list, the function will merge them recursively.
+
+    Args:
+        base (dict[str, Any]): The base UI configuration dictionary.
+        override (dict[str, Any]): The override UI configuration dictionary.
+
+    Returns:
+        dict[str, Any]: The merged UI configuration dictionary.
+    """

amsdal/errors.py

@@ -0,0 +1,31 @@
+from amsdal_utils.errors import AmsdalError
+
+
+class AmsdalRuntimeError(AmsdalError): ...
+
+
+class TransactionNotFoundError(AmsdalError): ...
+
+
+class AmsdalAuthenticationError(AmsdalRuntimeError): ...
+
+
+class AmsdalDeployError(AmsdalRuntimeError): ...
+
+
+class AmsdalCloudError(AmsdalRuntimeError): ...
+
+
+class AmsdalCloudAlreadyDeployedError(AmsdalCloudError): ...
+
+
+class AmsdalCloudCredentialsError(AmsdalCloudError): ...
+
+
+class AmsdalMissingCredentialsError(AmsdalAuthenticationError): ...
+
+
+class AmsdalAuthConnectionError(AmsdalAuthenticationError): ...
+
+
+class AmsdalSignupError(AmsdalAuthenticationError): ...

amsdal/errors.pyi

@@ -0,0 +1,12 @@
+from amsdal_utils.errors import AmsdalError
+
+class AmsdalRuntimeError(AmsdalError): ...
+class TransactionNotFoundError(AmsdalError): ...
+class AmsdalAuthenticationError(AmsdalRuntimeError): ...
+class AmsdalDeployError(AmsdalRuntimeError): ...
+class AmsdalCloudError(AmsdalRuntimeError): ...
+class AmsdalCloudAlreadyDeployedError(AmsdalCloudError): ...
+class AmsdalCloudCredentialsError(AmsdalCloudError): ...
+class AmsdalMissingCredentialsError(AmsdalAuthenticationError): ...
+class AmsdalAuthConnectionError(AmsdalAuthenticationError): ...
+class AmsdalSignupError(AmsdalAuthenticationError): ...

amsdal/fixtures/manager.pyi

@@ -0,0 +1,170 @@
+from _typeshed import Incomplete
+from amsdal.fixtures.utils import process_fixture_value as process_fixture_value
+from amsdal_models.classes.model import Model
+from collections.abc import Generator
+from pathlib import Path
+from pydantic import BaseModel
+from pydantic.fields import FieldInfo as FieldInfo
+from typing import Any
+
+logger: Incomplete
+
+class FixtureData(BaseModel):
+    class_name: str
+    external_id: str
+    order: float
+    data: dict[str, Any]
+
+class BaseFixturesManager:
+    ORDER_MULTIPLIER: int
+    fixtures_paths: Incomplete
+    fixtures: dict[str | int, list[tuple[float, FixtureData]]]
+    _class_manager: Incomplete
+    _config_manager: Incomplete
+    def __init__(self, fixtures_paths: list[Path]) -> None: ...
+    def load_fixtures(self) -> None:
+        """
+        Loads fixture data from the specified path.
+
+        This method reads fixture data from a JSON file located at the `fixtures_path`.
+        It populates the `fixtures` dictionary with the loaded data, where each fixture
+        is indexed by its external ID.
+
+        Returns:
+            None
+        """
+    def _load_fixtures(self, fixtures_path: Path, order_shift: int = 0) -> None: ...
+    def iter_fixtures(self) -> Generator[FixtureData, None, None]: ...
+    def _process_object_data(self, data: dict[str, Any], model_fields: dict[str, FieldInfo], m2m_fields: dict[str, type[Model]]) -> dict[str, Any]: ...
+
+class FixturesManager(BaseFixturesManager):
+    """
+    Manager class for handling fixture data.
+
+    This class is responsible for loading, processing, and applying fixture data
+    to the database. It supports nested object construction, data processing,
+    and file fixture handling.
+    """
+    def apply_file_fixtures(self) -> None:
+        """
+        Applies file fixtures from the specified directory.
+
+        This method processes file fixtures located in the 'files' directory adjacent to the
+        `fixtures_path`. It iterates through each file, reads its content, and processes it
+        as a fixture. If the file fixture already exists in the database, it updates the
+        existing fixture; otherwise, it creates a new one.
+
+        Returns:
+            None
+        """
+    def _apply_file_fixtures(self, file_dir: Path) -> None: ...
+    def _apply_file_fixtures_rec(self, nested_dir: Path, base_dir: Path) -> None: ...
+    def apply_fixtures(self) -> None:
+        """
+        Applies all loaded fixtures to the database.
+
+        This method processes each fixture in the `fixtures` dictionary in the order
+        specified by their 'order' value. It calls the `process_fixture` method for
+        each fixture and then processes the data in the processing queue.
+
+        Returns:
+            None
+        """
+    def _process_file_fixture(self, file_path: Path, file_key: str) -> None: ...
+    def _process_fixture(self, fixture: FixtureData) -> FixtureData | None:
+        """
+        Processes a single fixture and adds it to the processing queue.
+
+        This method takes a fixture dictionary, checks if the fixture already exists in the database,
+        and either updates the existing fixture or creates a new one. It then adds the fixture data
+        to the processing queue for further processing.
+
+        Args:
+            fixture (dict[str, Any]): The fixture dictionary containing the external ID, class name,
+            and data of the fixture.
+
+        Returns:
+            None
+        """
+    def _process_fixture_object_data(self, class_name: str, external_id: str, data: dict[str, Any]) -> None:
+        """
+        Processes and saves fixture object data to the database.
+
+        This method takes the class name, external ID, and data dictionary of a fixture object,
+        processes the data according to the class schema, and saves the object to the database.
+        If the object already exists, it updates the existing object with the new data.
+
+        Args:
+            class_name (str): The name of the class to which the fixture object belongs.
+            external_id (str): The external ID of the fixture object.
+            data (dict[str, Any]): The data dictionary of the fixture object.
+
+        Returns:
+            None
+        """
+
+class AsyncFixturesManager(BaseFixturesManager):
+    """
+    Manager class for handling fixture data asynchronously.
+
+    This class is responsible for loading, processing, and applying fixture data
+    to the database. It supports nested object construction, data processing,
+    and file fixture handling.
+    """
+    async def apply_file_fixtures(self) -> None:
+        """
+        Applies file fixtures from the specified directory.
+
+        This method processes file fixtures located in the 'files' directory adjacent to the
+        `fixtures_path`. It iterates through each file, reads its content, and processes it
+        as a fixture. If the file fixture already exists in the database, it updates the
+        existing fixture; otherwise, it creates a new one.
+
+        Returns:
+            None
+        """
+    async def _apply_file_fixtures(self, file_dir: Path) -> None: ...
+    async def _apply_file_fixtures_rec(self, nested_dir: Path, base_dir: Path) -> None: ...
+    async def apply_fixtures(self) -> None:
+        """
+        Applies all loaded fixtures to the database.
+
+        This method processes each fixture in the `fixtures` dictionary in the order
+        specified by their 'order' value. It calls the `process_fixture` method for
+        each fixture and then processes the data in the processing queue.
+
+        Returns:
+            None
+        """
+    async def _process_file_fixture(self, file_path: Path, file_key: str) -> None: ...
+    async def _process_fixture(self, fixture: FixtureData) -> FixtureData | None:
+        """
+        Processes a single fixture and adds it to the processing queue.
+
+        This method takes a fixture dictionary, checks if the fixture already exists in the database,
+        and either updates the existing fixture or creates a new one. It then adds the fixture data
+        to the processing queue for further processing.
+
+        Args:
+            fixture (dict[str, Any]): The fixture dictionary containing the external ID, class name,
+            and data of the fixture.
+
+        Returns:
+            None
+        """
+    async def _process_fixture_object_data(self, class_name: str, external_id: str, data: dict[str, Any]) -> None:
+        """
+        Processes and saves fixture object data to the database.
+
+        This method takes the class name, external ID, and data dictionary of a fixture object,
+        processes the data according to the class schema, and saves the object to the database.
+        If the object already exists, it updates the existing object with the new data.
+
+        Args:
+            class_name (str): The name of the class to which the fixture object belongs.
+            external_id (str): The external ID of the fixture object.
+            data (dict[str, Any]): The data dictionary of the fixture object.
+
+        Returns:
+            None
+        """

amsdal/fixtures/utils.pyi

@@ -0,0 +1,9 @@
+from amsdal_utils.models.data_models.reference import Reference
+from types import GenericAlias
+from typing import Any
+
+def process_fixture_value(annotation: Any, value: Any) -> Any: ...
+def _cast_value_to_type(value_type: type | GenericAlias, value: Any) -> Any: ...
+def _is_optional(annotation: Any) -> bool: ...
+def _resolve_type_from_optional(annotation: Any) -> Any: ...
+def _construct_reference_value(class_name: str, object_id: Any) -> Reference: ...

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
+        """