amsdal 0.1.25__cp310-cp310-win_amd64.whl → 0.1.27__cp310-cp310-win_amd64.whl

amsdal/migration/executors/base.pyi

@@ -7,6 +7,18 @@ 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

@@ -9,16 +9,86 @@ 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 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
+        """
     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 _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

@@ -5,10 +5,74 @@ from amsdal_models.schemas.data_models.schema import 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: ...

amsdal/migration/file_migration_generator.pyi

@@ -20,28 +20,120 @@ class StateMigrationStore(BaseMigrationStore):
     def fetch_migrations(self) -> list[MigrationFile]: ...
 
 class StateMigrationSchemas(BaseMigrationSchemas):
+    """
+    Manages the state of migration schemas.
+
+    Attributes:
+        state (dict[str, tuple[SchemaTypes, ObjectSchema]]): A dictionary mapping class names to their schema types
+            and object schemas.
+    """
     state: Incomplete
     def __init__(self) -> None: ...
-    def register_model(self, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None: ...
-    def unregister_model(self, class_name: str) -> None: ...
+    def register_model(self, class_name: str, object_schema: ObjectSchema, schema_type: SchemaTypes) -> None:
+        """
+        Registers a model with the given class name, object schema, and schema type.
+
+        Args:
+            class_name (str): The name of the class to register.
+            object_schema (ObjectSchema): The object schema of the class.
+            schema_type (SchemaTypes): The type of schema.
+
+        Returns:
+            None
+        """
+    def unregister_model(self, class_name: str) -> None:
+        """
+        Unregisters a model with the given class name.
+
+        Args:
+            class_name (str): The name of the class to unregister.
+
+        Returns:
+            None
+        """
     def compile_buffered_classes(self) -> None: ...
 
 class FileMigrationGenerator:
+    """
+    Generates migration files based on schema changes.
+    """
     _operations: ClassVar[dict[OperationTypes, Callable[..., MigrateOperation]]]
     _app_migrations_path: Incomplete
     _app_migrations_loader: Incomplete
     _schema_loader: Incomplete
     _state: Incomplete
     def __init__(self, schema_loader: BaseClassSchemaLoader, app_migrations_path: Path | None = None) -> None: ...
-    def make_migrations(self, name: str | None = None, *, is_data: bool = False, schema_type: SchemaTypes = ...) -> MigrationFile: ...
-    def generate_operations(self, schema_type: SchemaTypes) -> list[MigrateOperation]: ...
+    def make_migrations(self, name: str | None = None, *, is_data: bool = False, schema_type: SchemaTypes = ...) -> MigrationFile:
+        """
+        Creates migration files based on schema changes.
+
+        Args:
+            name (str | None): The name of the migration. Defaults to None.
+            is_data (bool): If True, creates a data migration. Defaults to False.
+            schema_type (SchemaTypes): The type of schema. Defaults to SchemaTypes.USER.
+
+        Returns:
+            MigrationFile: The created migration file.
+
+        Raises:
+            UserWarning: If no changes are detected.
+        """
+    def generate_operations(self, schema_type: SchemaTypes) -> list[MigrateOperation]:
+        """
+        Generates migration operations based on schema changes.
+
+        Args:
+            schema_type (SchemaTypes): The type of schema.
+
+        Returns:
+            list[MigrateOperation]: List of migration operations.
+        """
     def _make_data_migrations(self, name: str | None = None) -> MigrationFile: ...
     def _init_state(self) -> None: ...
     @classmethod
-    def build_operations(cls, schema_type: SchemaTypes, class_schema: ObjectSchema, old_class_schema: ObjectSchema | None) -> list[MigrateOperation]: ...
-    def write_migration_file(self, operations: list[MigrateOperation], name: str | None = None) -> MigrationFile: ...
-    def write_data_migration_file(self, name: str | None = None) -> MigrationFile: ...
+    def build_operations(cls, schema_type: SchemaTypes, class_schema: ObjectSchema, old_class_schema: ObjectSchema | None) -> list[MigrateOperation]:
+        """
+        Builds migration operations based on schema changes.
+
+        Args:
+            schema_type (SchemaTypes): The type of schema.
+            class_schema (ObjectSchema): The new class schema.
+            old_class_schema (ObjectSchema | None): The old class schema. Defaults to None.
+
+        Returns:
+            list[MigrateOperation]: List of migration operations.
+        """
+    def write_migration_file(self, operations: list[MigrateOperation], name: str | None = None) -> MigrationFile:
+        """
+        Writes migration operations to a file.
+
+        Args:
+            operations (list[MigrateOperation]): List of migration operations.
+            name (str | None): The name of the migration. Defaults to None.
+
+        Returns:
+            MigrationFile: The created migration file.
+        """
+    def write_data_migration_file(self, name: str | None = None) -> MigrationFile:
+        """
+        Writes data migration operations to a file.
+
+        Args:
+            name (str | None): The name of the migration. Defaults to None.
+
+        Returns:
+            MigrationFile: The created data migration file.
+        """
     @staticmethod
-    def generate_name_from_operations(operations: list[MigrateOperation]) -> str: ...
+    def generate_name_from_operations(operations: list[MigrateOperation]) -> str:
+        """
+        Generates a name for the migration file based on operations.
+
+        Args:
+            operations (list[MigrateOperation]): List of migration operations.
+
+        Returns:
+            str: The generated name.
+        """
     @staticmethod
     def _get_migration_file_name(number: int, name: str) -> str: ...

amsdal/migration/file_migration_store.pyi

@@ -17,14 +17,44 @@ class BaseMigrationStore(ABC, metaclass=abc.ABCMeta):
     def delete_migration(self, migration: MigrationFile) -> None: ...
 
 class FileMigrationStore(BaseMigrationStore):
+    """
+    Manages the storage and retrieval of migration files.
+
+    Attributes:
+        migration_address (Address): The address associated with the migration.
+    """
     migration_address: Address
     _config_manager: Incomplete
     _amsdal_config: Incomplete
     _connections_manager: Incomplete
     def __init__(self) -> None: ...
-    def fetch_migrations(self) -> list[MigrationFile]: ...
-    def save_migration(self, migration: MigrationFile) -> None: ...
-    def delete_migration(self, migration: MigrationFile) -> None: ...
+    def fetch_migrations(self) -> list[MigrationFile]:
+        """
+        Fetches the list of applied migrations.
+
+        Returns:
+            list[MigrationFile]: List of applied migration files.
+        """
+    def save_migration(self, migration: MigrationFile) -> None:
+        """
+        Saves a migration file.
+
+        Args:
+            migration (MigrationFile): The migration file to save.
+
+        Returns:
+            None
+        """
+    def delete_migration(self, migration: MigrationFile) -> None:
+        """
+        Deletes a migration file.
+
+        Args:
+            migration (MigrationFile): The migration file to delete.
+
+        Returns:
+            None
+        """
     def _save_historical_data(self, address: Address, data: dict[str, Any], metadata: dict[str, Any]) -> None: ...
     @staticmethod
     def _build_migration_data(migration: MigrationFile) -> dict[str, Any]: ...

amsdal/migration/file_migration_writer.pyi

@@ -3,16 +3,71 @@ from pathlib import Path
 from typing import ClassVar
 
 class FileMigrationWriter:
+    """
+    Handles the writing of migration files.
+
+    Attributes:
+        template_path (Path): The path to the migration template file.
+        data_template_path (Path): The path to the data migration template file.
+        operation_name_map (ClassVar[dict[OperationTypes, str]]): A mapping of operation types to their
+            string representations.
+    """
     template_path: Path
     data_template_path: Path
     operation_name_map: ClassVar[dict[OperationTypes, str]]
     @classmethod
-    def write(cls, file_path: Path, operations: list[MigrateOperation]) -> None: ...
+    def write(cls, file_path: Path, operations: list[MigrateOperation]) -> None:
+        """
+        Writes the migration operations to a file.
+
+        Args:
+            file_path (Path): The path to the migration file.
+            operations (list[MigrateOperation]): The list of migration operations to write.
+
+        Returns:
+            None
+        """
     @classmethod
-    def write_data_migration(cls, file_path: Path) -> None: ...
+    def write_data_migration(cls, file_path: Path) -> None:
+        """
+        Writes a data migration to a file.
+
+        Args:
+            file_path (Path): The path to the data migration file.
+
+        Returns:
+            None
+        """
     @classmethod
-    def render(cls, operations: list[MigrateOperation]) -> str: ...
+    def render(cls, operations: list[MigrateOperation]) -> str:
+        """
+        Renders the migration operations into a string.
+
+        Args:
+            operations (list[MigrateOperation]): The list of migration operations to render.
+
+        Returns:
+            str: The rendered migration operations as a string.
+        """
     @classmethod
-    def render_operation(cls, operation: MigrateOperation) -> str: ...
+    def render_operation(cls, operation: MigrateOperation) -> str:
+        """
+        Renders a single migration operation into a string.
+
+        Args:
+            operation (MigrateOperation): The migration operation to render.
+
+        Returns:
+            str: The rendered migration operation as a string.
+        """
     @classmethod
-    def reformat(cls, content: str) -> str: ...
+    def reformat(cls, content: str) -> str:
+        """
+        Reformats the content using the Black formatter.
+
+        Args:
+            content (str): The content to reformat.
+
+        Returns:
+            str: The reformatted content.
+        """