amsdal 0.1.26__cp311-cp311-macosx_10_9_universal2.whl → 0.2.0__cp311-cp311-macosx_10_9_universal2.whl

amsdal/migration/data_classes.pyi

@@ -1,42 +1,97 @@
 from amsdal_models.classes.model import Model
-from amsdal_models.schemas.data_models.schema import ObjectSchema, PropertyData
 from amsdal_utils.models.data_models.address import Address as Address
+from amsdal_utils.models.data_models.schema import ObjectSchema as ObjectSchema, PropertyData as PropertyData
 from amsdal_utils.models.enums import SchemaTypes as SchemaTypes
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
 
 class Action(str, Enum):
-    CREATED = 'CREATED'
-    UPDATED = 'UPDATED'
+    """
+    Enumeration for different types of actions.
+
+    Attributes:
+        CREATED (str): Represents a created action.
+        UPDATED (str): Represents an updated action.
+        NO_ACTION (str): Represents no action.
+    """
+    CREATE = 'CREATE'
+    UPDATE = 'UPDATE'
     NO_ACTION = 'NO_ACTION'
 
 @dataclass
 class ClassSaveResult:
+    """
+    Data class representing the result of a class save operation.
+
+    Attributes:
+        action (Action): The action performed during the save operation.
+        instance (Model): The instance of the model that was saved.
+    """
     action: Action
     instance: Model
     def __init__(self, action, instance) -> None: ...
 
+@dataclass
+class CheckClassResult:
+    action: Action
+    instance: Model | None = ...
+    def __init__(self, action, instance=...) -> None: ...
+
 @dataclass
 class ClassUpdateResult:
+    """
+    Data class representing the result of a class update operation.
+
+    Attributes:
+        is_updated (bool): Indicates whether the class was updated.
+        class_instance (Model): The instance of the model that was updated.
+    """
     is_updated: bool
     class_instance: Model
     def __init__(self, is_updated, class_instance) -> None: ...
 
 @dataclass
 class MigrateResult:
+    """
+    Data class representing the result of a migration operation.
+
+    Attributes:
+        class_instance (Model): The instance of the model that was migrated.
+        is_table_created (bool): Indicates whether the table was created during the migration.
+        is_data_migrated (bool): Indicates whether the data was migrated.
+    """
     class_instance: Model
     is_table_created: bool
     is_data_migrated: bool
     def __init__(self, class_instance, is_table_created, is_data_migrated) -> None: ...
 
 class ModuleTypes(str, Enum):
+    """
+    Enumeration for different types of modules.
+
+    Attributes:
+        APP (str): Represents an application module.
+        CORE (str): Represents a core module.
+        CONTRIB (str): Represents a contributed module.
+    """
     APP = 'APP'
     CORE = 'CORE'
     CONTRIB = 'CONTRIB'
 
 @dataclass
 class MigrationFile:
+    """
+    Data class representing a migration file.
+
+    Attributes:
+        path (Path): The file path of the migration.
+        type (ModuleTypes): The type of module the migration belongs to.
+        number (int): The migration number.
+        module (str | None): The module name, if applicable.
+        applied_at (float | None): The timestamp when the migration was applied.
+        stored_address (Address | None): The stored address associated with the migration.
+    """
     path: Path
     type: ModuleTypes
     number: int
@@ -44,22 +99,53 @@ class MigrationFile:
     applied_at: float | None = ...
     stored_address: Address | None = ...
     @property
-    def is_initial(self) -> bool: ...
+    def is_initial(self) -> bool:
+        """
+        Indicates whether this migration is the initial migration.
+
+        Returns:
+            bool: True if this is the initial migration, False otherwise.
+        """
     def __init__(self, path, type, number, module=..., applied_at=..., stored_address=...) -> None: ...
 
 @dataclass
 class ClassSchema:
+    """
+    Data class representing a class schema.
+
+    Attributes:
+        object_schema (ObjectSchema): The object schema associated with the class.
+        type (ModuleTypes): The type of module the class belongs to.
+    """
     object_schema: ObjectSchema
     type: ModuleTypes
     def __init__(self, object_schema, type) -> None: ...
 
 class OperationTypes(str, Enum):
+    """
+    Enumeration for different types of operations.
+
+    Attributes:
+        CREATE_CLASS (str): Represents the operation to create a class.
+        UPDATE_CLASS (str): Represents the operation to update a class.
+        DELETE_CLASS (str): Represents the operation to delete a class.
+    """
     CREATE_CLASS = 'CREATE_CLASS'
     UPDATE_CLASS = 'UPDATE_CLASS'
     DELETE_CLASS = 'DELETE_CLASS'
 
 @dataclass
 class MigrateOperation:
+    """
+    Data class representing a migration operation.
+
+    Attributes:
+        type (OperationTypes): The type of operation being performed.
+        class_name (str): The name of the class involved in the migration.
+        schema_type (SchemaTypes): The type of schema associated with the migration.
+        old_schema (ObjectSchema | PropertyData | None): The old schema before the migration, if applicable.
+        new_schema (ObjectSchema | PropertyData | None): The new schema after the migration, if applicable.
+    """
     type: OperationTypes
     class_name: str
     schema_type: SchemaTypes
@@ -68,11 +154,25 @@ class MigrateOperation:
     def __init__(self, type, class_name, schema_type, old_schema=..., new_schema=...) -> None: ...
 
 class MigrationDirection(str, Enum):
+    """
+    Enumeration for the direction of a migration.
+
+    Attributes:
+        FORWARD (str): Represents a forward migration.
+        BACKWARD (str): Represents a backward migration.
+    """
     FORWARD = 'forward'
     BACKWARD = 'backward'
 
 @dataclass
 class MigrationResult:
+    """
+    Data class representing the result of a migration.
+
+    Attributes:
+        direction (MigrationDirection): The direction of the migration.
+        migration (MigrationFile): The migration file associated with the migration.
+    """
     direction: MigrationDirection
     migration: MigrationFile
     def __init__(self, direction, migration) -> None: ...

amsdal/migration/executors/base.pyi

@@ -2,11 +2,23 @@ import abc
 from _typeshed import Incomplete
 from abc import ABC, abstractmethod
 from amsdal.migration.base_migration_schemas import BaseMigrationSchemas as BaseMigrationSchemas
-from amsdal_models.schemas.data_models.schema import ObjectSchema
+from amsdal_utils.models.data_models.schema import ObjectSchema as ObjectSchema
 from amsdal_utils.models.enums import SchemaTypes as SchemaTypes
 from pydantic import BaseModel
 
 class FieldDescription(BaseModel):
+    """
+    Represents a description of a field in a database schema.
+
+    This class holds information about a field, including its name, ID, type,
+    and whether it has been marked as deleted.
+
+    Attributes:
+        field_name (str): The name of the field.
+        field_id (str): The unique identifier of the field.
+        field_type (str): The type of the field.
+        is_deleted (bool): Indicates whether the field is marked as deleted.
+    """
     field_name: str
     field_id: str
     field_type: str
@@ -18,19 +30,77 @@ def _id_for_column(field_name: str, iteration: str | int) -> str: ...
 def _new_table_schemas(previous_scheme: ObjectSchema | None, new_scheme: ObjectSchema, iteration: int, existing_table_structure: list[FieldDescription]) -> None: ...
 
 class BaseMigrationExecutor(ABC, metaclass=abc.ABCMeta):
+    """
+    Abstract base class for executing migration operations on database schemas.
+
+    This class provides methods for creating, updating, and deleting classes in the database schema.
+    It also manages schema migration buffers and generates full object schemas based on the migration history.
+    """
     schemas: BaseMigrationSchemas
     _buffer: Incomplete
     _non_flushable_buffer: Incomplete
     def __init__(self) -> None: ...
-    def generate_full_object_schema(self, class_name: str, object_schema: ObjectSchema, buffer: list[tuple[str, ObjectSchema, SchemaTypes]]) -> list[FieldDescription]: ...
+    def generate_full_object_schema(self, class_name: str, object_schema: ObjectSchema, buffer: list[tuple[str, ObjectSchema, SchemaTypes]]) -> list[FieldDescription]:
+        """
+        Generates the full object schema based on the migration history.
+
+        This method constructs the full object schema for a given class by iterating through
+        the migration history buffer and applying schema changes in sequence.
+
+        Args:
+            class_name (str): The name of the class for which the schema is being generated.
+            object_schema (ObjectSchema): The current object schema.
+            buffer (list[tuple[str, ObjectSchema, SchemaTypes]]): The migration history buffer.
+
+        Returns:
+            list[FieldDescription]: A list of field descriptions representing the full object schema.
+        """
     @abstractmethod
     def create_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
     @abstractmethod
     def update_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
     @abstractmethod
     def delete_class(self, schemas: BaseMigrationSchemas, class_name: str, schema_type: SchemaTypes) -> None: ...
-    def forward_schema(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
+    def forward_schema(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Forwards the schema to the non-flushable buffer.
+
+        This method appends the given class name, object schema, and schema type to the
+        non-flushable buffer for further processing.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class for which the schema is being forwarded.
+            object_schema (ObjectSchema): The current object schema.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
     @staticmethod
     def _resolve_base_class_name(class_name: str, meta_class: str) -> str: ...
-    def buffer_class_migration(self, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
-    def flush_buffer(self) -> None: ...
+    def buffer_class_migration(self, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Buffers the class migration operation.
+
+        This method appends the given class name, object schema, and schema type to both
+        the non-flushable buffer and the main buffer for further processing.
+
+        Args:
+            class_name (str): The name of the class for which the migration is being buffered.
+            object_schema (ObjectSchema): The current object schema.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def flush_buffer(self) -> None:
+        """
+        Flushes the migration buffer.
+
+        This method clears all entries from the main migration buffer, effectively
+        resetting it for future migration operations.
+
+        Returns:
+            None
+        """

amsdal/migration/executors/default_executor.pyi

@@ -1,24 +1,96 @@
 from _typeshed import Incomplete
 from amsdal.migration.base_migration_schemas import BaseMigrationSchemas as BaseMigrationSchemas
-from amsdal.migration.data_classes import Action as Action, ClassSaveResult as ClassSaveResult
+from amsdal.migration.data_classes import Action as Action, CheckClassResult as CheckClassResult
 from amsdal.migration.executors.base import BaseMigrationExecutor as BaseMigrationExecutor
-from amsdal.migration.utils import object_schema_to_table_schema as object_schema_to_table_schema
 from amsdal_models.classes.model import Model
-from amsdal_models.schemas.data_models.schema import ObjectSchema
+from amsdal_utils.models.data_models.schema import ObjectSchema
 from amsdal_utils.models.enums import SchemaTypes, Versions
 from typing import Any
 
 class DefaultMigrationExecutor(BaseMigrationExecutor):
+    """
+    Default implementation of the BaseMigrationExecutor for handling database schema migrations.
+
+    This class provides concrete implementations for creating, updating, and deleting classes
+    in the database schema. It also manages schema migration buffers and processes object schemas.
+    """
     schemas: Incomplete
     _table_schemas_manager: Incomplete
     def __init__(self, schemas: BaseMigrationSchemas) -> None: ...
-    def create_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
-    def update_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
-    def delete_class(self, schemas: BaseMigrationSchemas, class_name: str, schema_type: SchemaTypes) -> None: ...
-    def flush_buffer(self) -> None: ...
-    def _save_class(self, base_class: type[Model], object_schema: ObjectSchema, schema_type: SchemaTypes) -> ClassSaveResult: ...
-    def _create_table(self, object_schema: ObjectSchema, class_version: str | Versions) -> None: ...
+    def create_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Creates a class in the database schema.
+
+        This method registers a new class version if the schema type is `TYPE` and the class name
+            is not `BaseClasses.OBJECT`.
+        Otherwise, it buffers the class migration operation for further processing.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class to be created.
+            object_schema (ObjectSchema): The schema of the object to be created.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def update_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Buffers the class update operation.
+
+        This method appends the given class name, object schema, and schema type to both
+        the non-flushable buffer and the main buffer for further processing.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class to be updated.
+            object_schema (ObjectSchema): The current object schema.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def delete_class(self, schemas: BaseMigrationSchemas, class_name: str, schema_type: SchemaTypes) -> None:
+        """
+        Deletes a class from the database schema.
+
+        This method removes the specified class from the database schema and unregisters it from the migration schemas.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class to be deleted.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def flush_buffer(self) -> None:
+        """
+        Flushes the migration buffer and processes the buffered classes.
+
+        This method registers the buffered classes in the migration schemas, compiles the buffered classes,
+        and processes each class in the buffer to create tables, save class objects, and migrate historical data.
+        Finally, it clears the main migration buffer.
+
+        Returns:
+            None
+        """
+    @staticmethod
+    def _check_class(base_class: type[Model], object_schema: ObjectSchema) -> CheckClassResult: ...
+    def _save_class(self, base_class: type[Model], object_schema: ObjectSchema, class_object: Model | None, schema_type: SchemaTypes) -> None: ...
+    def _save_object_class_meta(self, base_class: type[Model], object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
+    def _create_table(self, object_schema: ObjectSchema, class_version: str | Versions, using: str | None = None) -> None: ...
     def _migrate_historical_data(self, schemas: BaseMigrationSchemas, class_name: str, prior_version: str, new_version: str) -> None: ...
     def _clean_data(self, model_class: type[Model], data: dict[str, Any]) -> dict[str, Any]: ...
     def _process_object_schema(self, object_schema: ObjectSchema, class_name: str, buffer: list[tuple[str, ObjectSchema, SchemaTypes]]) -> ObjectSchema: ...
-    def register_schemas(self) -> None: ...
+    def register_schemas(self) -> None:
+        """
+        Registers the schemas in the table schemas manager.
+
+        This method retrieves the object schemas from the database, processes them, and registers
+        them in the table schemas manager. It handles both `ClassObject` and `ClassObjectMeta` schemas,
+        and ensures that all necessary references are loaded and processed.
+
+        Returns:
+            None
+        """

amsdal/migration/executors/state_executor.pyi

@@ -1,14 +1,78 @@
 from _typeshed import Incomplete
 from amsdal.migration.base_migration_schemas import BaseMigrationSchemas as BaseMigrationSchemas
 from amsdal.migration.executors.base import BaseMigrationExecutor as BaseMigrationExecutor
-from amsdal_models.schemas.data_models.schema import ObjectSchema
+from amsdal_utils.models.data_models.schema import ObjectSchema as ObjectSchema
 from amsdal_utils.models.enums import SchemaTypes
 
 class StateMigrationExecutor(BaseMigrationExecutor):
+    """
+    Executes state migrations for database schemas.
+
+    This class handles the creation, updating, and deletion of classes in the database schema,
+    as well as flushing buffered migration operations.
+
+    Attributes:
+        schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+        do_fetch_latest_version (bool): Flag indicating whether to fetch the latest version of the schema.
+    """
     schemas: Incomplete
     do_fetch_latest_version: Incomplete
     def __init__(self, schemas: BaseMigrationSchemas, *, do_fetch_latest_version: bool = True) -> None: ...
-    def create_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
-    def update_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
-    def delete_class(self, schemas: BaseMigrationSchemas, class_name: str, schema_type: SchemaTypes) -> None: ...
-    def flush_buffer(self) -> None: ...
+    def create_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Creates a class in the database schema.
+
+        This method registers a new class in the database schema or buffers the class migration
+        operation based on the schema type and class name.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class to be created.
+            object_schema (ObjectSchema): The current object schema.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def update_class(self, schemas: BaseMigrationSchemas, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Buffers the class update operation.
+
+        This method adds the class update operation to the migration buffer, which will be processed
+        when the buffer is flushed.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class to be updated.
+            object_schema (ObjectSchema): The current object schema.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def delete_class(self, schemas: BaseMigrationSchemas, class_name: str, schema_type: SchemaTypes) -> None:
+        """
+        Deletes a class from the database schema.
+
+        This method unregisters a class from the database schema based on the provided class name
+        and schema type.
+
+        Args:
+            schemas (BaseMigrationSchemas): The migration schemas used for the operations.
+            class_name (str): The name of the class to be deleted.
+            schema_type (SchemaTypes): The type of the schema.
+
+        Returns:
+            None
+        """
+    def flush_buffer(self) -> None:
+        """
+        Flushes the migration buffer and processes the buffered classes.
+
+        This method registers all classes in the migration buffer to the database schema and compiles
+        the buffered classes. If the `do_fetch_latest_version` flag is set, it also fetches and registers
+        the latest version of each class.
+
+        Returns:
+            None
+        """

amsdal/migration/file_migration_executor.pyi

@@ -14,6 +14,17 @@ from amsdal_utils.models.enums import SchemaTypes
 logger: Incomplete
 
 class FileMigrationExecutorManager:
+    """
+    Manager class for executing file migrations.
+
+    Attributes:
+        migration_address (Address): The address associated with the migration.
+        core_loader (MigrationsLoader): Loader for core migrations.
+        contrib_loaders (list[MigrationsLoader]): List of loaders for contributed migrations.
+        app_loader (MigrationsLoader): Loader for application migrations.
+        executor (BaseMigrationExecutor): The executor responsible for running migrations.
+        store (BaseMigrationStore): The store for managing migration files.
+    """
     migration_address: Address
     core_loader: Incomplete
     contrib_loaders: Incomplete
@@ -22,7 +33,19 @@ class FileMigrationExecutorManager:
     _applied_migration_files: Incomplete
     store: Incomplete
     def __init__(self, app_migrations_loader: MigrationsLoader, executor: BaseMigrationExecutor, store: BaseMigrationStore | None = None) -> None: ...
-    def execute(self, migration_number: int | None = None, module_type: ModuleTypes | None = None, *, fake: bool = False, skip_data_migrations: bool = False) -> list[MigrationResult]: ...
+    def execute(self, migration_number: int | None = None, module_type: ModuleTypes | None = None, *, fake: bool = False, skip_data_migrations: bool = False) -> list[MigrationResult]:
+        """
+        Executes the migrations.
+
+        Args:
+            migration_number (int | None): The migration number to execute up to. Defaults to None.
+            module_type (ModuleTypes | None): The type of module to migrate. Defaults to None.
+            fake (bool): If True, simulates the migration without applying changes. Defaults to False.
+            skip_data_migrations (bool): If True, skips data migrations. Defaults to False.
+
+        Returns:
+            list[MigrationResult]: List of results from the migration execution.
+        """
     @staticmethod
     def _get_contrib_loaders() -> list[MigrationsLoader]: ...
     def _apply(self, migration_number: int | None = None, module_type: ModuleTypes | None = None, *, fake: bool = False, skip_data_migrations: bool = False) -> list[MigrationResult]: ...
@@ -30,7 +53,16 @@ class FileMigrationExecutorManager:
     def _register_schemas(self, executor: BaseMigrationExecutor) -> None: ...
     def _init_state_from_applied_migrations(self, migrations: list[MigrationFile], module_type: ModuleTypes) -> None: ...
     @staticmethod
-    def get_migration_class(migration: MigrationFile) -> type['Migration']: ...
+    def get_migration_class(migration: MigrationFile) -> type['Migration']:
+        """
+        Retrieves the migration class from the migration file.
+
+        Args:
+            migration (MigrationFile): The migration file.
+
+        Returns:
+            type[Migration]: The migration class.
+        """
     def _is_migration_applied(self, migration: MigrationFile, module_type: ModuleTypes) -> bool: ...
     @staticmethod
     def _map_module_type_to_schema_type(module_type: ModuleTypes) -> SchemaTypes: ...