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

amsdal/migration/file_migration_generator.pyi

@@ -8,8 +8,8 @@ from amsdal.migration.file_migration_store import BaseMigrationStore as BaseMigr
 from amsdal.migration.file_migration_writer import FileMigrationWriter as FileMigrationWriter
 from amsdal.migration.migrations_loader import MigrationsLoader as MigrationsLoader
 from amsdal.migration.schemas_loaders import BaseClassSchemaLoader as BaseClassSchemaLoader
-from amsdal_models.schemas.data_models.schema import ObjectSchema
-from amsdal_utils.models.enums import SchemaTypes
+from amsdal_utils.models.data_models.schema import ObjectSchema as ObjectSchema
+from amsdal_utils.models.enums import SchemaTypes, Versions
 from collections.abc import Callable as Callable
 from pathlib import Path
 from typing import ClassVar
@@ -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, class_version: str | Versions = ...) -> 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

@@ -4,9 +4,8 @@ from abc import ABC, abstractmethod
 from amsdal.configs.main import settings as settings
 from amsdal.migration.data_classes import MigrationFile as MigrationFile, ModuleTypes as ModuleTypes
 from amsdal.migration.utils import contrib_to_module_root_path as contrib_to_module_root_path, map_module_type_to_schema_type as map_module_type_to_schema_type
-from amsdal_utils.config.data_models.amsdal_config import AmsdalConfig as AmsdalConfig
 from amsdal_utils.models.data_models.address import Address
-from typing import Any
+from typing import Any, ClassVar
 
 class BaseMigrationStore(ABC, metaclass=abc.ABCMeta):
     @abstractmethod
@@ -17,14 +16,43 @@ 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_TABLE: ClassVar[str]
     migration_address: Address
-    _config_manager: Incomplete
-    _amsdal_config: Incomplete
-    _connections_manager: Incomplete
+    _operation_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.
+        """

amsdal/migration/migrations.pyi

@@ -16,15 +16,60 @@ class Operation(ABC, metaclass=abc.ABCMeta):
     def backward(self, executor: BaseMigrationExecutor) -> None: ...
 
 class SchemaOperation(Operation):
+    """
+    Base class for schema operations.
+
+    Attributes:
+        forward_args (list[Any]): Arguments for the forward operation.
+        backward_args (list[Any]): Arguments for the backward operation.
+        forward_method_name (str): Name of the method to call for the forward operation.
+        backward_method_name (str): Name of the method to call for the backward operation.
+    """
     forward_args: list[Any]
     backward_args: list[Any]
     forward_method_name: str
     backward_method_name: str
-    def forward(self, executor: BaseMigrationExecutor) -> None: ...
-    def forward_schema(self, executor: BaseMigrationExecutor) -> None: ...
-    def backward(self, executor: BaseMigrationExecutor) -> None: ...
+    def forward(self, executor: BaseMigrationExecutor) -> None:
+        """
+        Executes the forward operation.
+
+        Args:
+            executor (BaseMigrationExecutor): The executor responsible for running migrations.
+
+        Returns:
+            None
+        """
+    def forward_schema(self, executor: BaseMigrationExecutor) -> None:
+        """
+        Executes the forward schema operation.
+
+        Args:
+            executor (BaseMigrationExecutor): The executor responsible for running migrations.
+
+        Returns:
+            None
+        """
+    def backward(self, executor: BaseMigrationExecutor) -> None:
+        """
+        Executes the backward operation.
+
+        Args:
+            executor (BaseMigrationExecutor): The executor responsible for running migrations.
+
+        Returns:
+            None
+        """
 
 class CreateClass(SchemaOperation):
+    """
+    Represents an operation to create a class schema.
+
+    Attributes:
+        forward_method_name (str): The name of the method to call for the forward operation.
+        backward_method_name (str): The name of the method to call for the backward operation.
+        forward_args (list[Any]): Arguments for the forward operation.
+        backward_args (list[Any]): Arguments for the backward operation.
+    """
     forward_method_name: str
     backward_method_name: str
     forward_args: Incomplete
@@ -32,6 +77,15 @@ class CreateClass(SchemaOperation):
     def __init__(self, class_name: str, new_schema: dict[str, Any], schema_type: SchemaTypes) -> None: ...
 
 class UpdateClass(SchemaOperation):
+    """
+    Represents an operation to update a class schema.
+
+    Attributes:
+        forward_method_name (str): The name of the method to call for the forward operation.
+        backward_method_name (str): The name of the method to call for the backward operation.
+        forward_args (list[Any]): Arguments for the forward operation.
+        backward_args (list[Any]): Arguments for the backward operation.
+    """
     forward_method_name: str
     backward_method_name: str
     forward_args: Incomplete
@@ -39,6 +93,15 @@ class UpdateClass(SchemaOperation):
     def __init__(self, class_name: str, old_schema: dict[str, Any], new_schema: dict[str, Any], schema_type: SchemaTypes) -> None: ...
 
 class DeleteClass(SchemaOperation):
+    """
+    Represents an operation to delete a class schema.
+
+    Attributes:
+        forward_method_name (str): The name of the method to call for the forward operation.
+        backward_method_name (str): The name of the method to call for the backward operation.
+        forward_args (list[Any]): Arguments for the forward operation.
+        backward_args (list[Any]): Arguments for the backward operation.
+    """
     forward_method_name: str
     backward_method_name: str
     forward_args: Incomplete
@@ -48,14 +111,56 @@ class DeleteClass(SchemaOperation):
 class MigrationSchemas(DefaultMigrationSchemas): ...
 
 class MigrateData(Operation):
+    """
+    Represents a data migration operation.
+
+    Attributes:
+        forward_migration (Callable[[MigrationSchemas \\| BaseMigrationSchemas], None]): The function to call for
+            the forward migration.
+        backward_migration (Callable[[MigrationSchemas \\| BaseMigrationSchemas], None]): The function to call for
+            the backward migration.
+    """
     @staticmethod
     def noop(schemas: MigrationSchemas) -> None: ...
     forward_migration: Incomplete
     backward_migration: Incomplete
     def __init__(self, forward_migration: Callable[[MigrationSchemas | BaseMigrationSchemas], None], backward_migration: Callable[[MigrationSchemas | BaseMigrationSchemas], None]) -> None: ...
-    def forward(self, executor: BaseMigrationExecutor) -> None: ...
-    def backward(self, executor: BaseMigrationExecutor) -> None: ...
-    def forward_schema(self, executor: BaseMigrationExecutor) -> None: ...
+    def forward(self, executor: BaseMigrationExecutor) -> None:
+        """
+        Executes the forward data migration.
+
+        Args:
+            executor (BaseMigrationExecutor): The executor responsible for running migrations.
+
+        Returns:
+            None
+        """
+    def backward(self, executor: BaseMigrationExecutor) -> None:
+        """
+        Executes the backward data migration.
+
+        Args:
+            executor (BaseMigrationExecutor): The executor responsible for running migrations.
+
+        Returns:
+            None
+        """
+    def forward_schema(self, executor: BaseMigrationExecutor) -> None:
+        """
+        No-op for forward schema in data migration.
+
+        Args:
+            executor (BaseMigrationExecutor): The executor responsible for running migrations.
+
+        Returns:
+            None
+        """
 
 class Migration:
+    """
+    Represents a collection of migration operations.
+
+    Attributes:
+        operations (list[Operation]): The list of migration operations.
+    """
     operations: list[Operation]

amsdal/migration/migrations_loader.pyi

@@ -4,14 +4,29 @@ from collections.abc import Iterator
 from pathlib import Path
 
 class MigrationsLoader:
+    """
+    Loads and manages migration files from a specified directory.
+    """
     _migrations_path: Incomplete
     _module_type: Incomplete
     _module_name: Incomplete
     _migrations_files: Incomplete
     def __init__(self, migrations_dir: Path, module_type: ModuleTypes, module_name: str | None = None) -> None: ...
     @property
-    def has_initial_migration(self) -> bool: ...
+    def has_initial_migration(self) -> bool:
+        """
+        Checks if there is an initial migration file.
+
+        Returns:
+            bool: True if there is an initial migration file, False otherwise.
+        """
     @property
-    def last_migration_number(self) -> int: ...
+    def last_migration_number(self) -> int:
+        """
+        Gets the number of the last migration file.
+
+        Returns:
+            int: The number of the last migration file, or -1 if there are no migration files.
+        """
     def __iter__(self) -> Iterator[MigrationFile]: ...
     def _load_migration_files(self) -> None: ...

amsdal/migration/schemas_loaders.pyi

@@ -4,8 +4,8 @@ from abc import ABC, abstractmethod
 from amsdal.configs.constants import CORE_SCHEMAS_PATH as CORE_SCHEMAS_PATH, TYPE_SCHEMAS_PATH as TYPE_SCHEMAS_PATH
 from amsdal.configs.main import settings as settings
 from amsdal.migration.data_classes import ClassSchema as ClassSchema, ModuleTypes as ModuleTypes
-from amsdal_models.schemas.data_models.schema import ObjectSchema
 from amsdal_models.schemas.mixins.enrich_schemas_mixin import EnrichSchemasMixin
+from amsdal_utils.models.data_models.schema import ObjectSchema as ObjectSchema
 from collections.abc import Iterator
 from pathlib import Path
 
@@ -14,10 +14,23 @@ class BaseClassSchemaLoader(ABC, metaclass=abc.ABCMeta):
     def iter_app_schemas(self) -> Iterator[ClassSchema]: ...
 
 class JsonClassSchemaLoader(EnrichSchemasMixin, BaseClassSchemaLoader):
+    """
+    Loads and enriches JSON class schemas from a specified root path.
+
+    Attributes:
+        schemas_root_path (Path): The root path to the JSON schemas.
+        module_type (ModuleTypes): The type of the module for the schemas.
+    """
     schemas_root_path: Incomplete
     module_type: Incomplete
     def __init__(self, schemas_root_path: Path, module_type: ModuleTypes = ...) -> None: ...
-    def iter_app_schemas(self) -> Iterator[ClassSchema]: ...
+    def iter_app_schemas(self) -> Iterator[ClassSchema]:
+        """
+        Iterates over the application schemas.
+
+        Yields:
+            ClassSchema: The next class schema in the iteration.
+        """
     def _enriched_user_schemas(self) -> list[ObjectSchema]: ...
     @staticmethod
     def _load_schemas(schemas_path: Path) -> list[ObjectSchema]: ...

amsdal/migration/utils.pyi

@@ -2,17 +2,57 @@ from _typeshed import Incomplete
 from amsdal.migration.data_classes import ModuleTypes as ModuleTypes
 from amsdal.schemas.manager import SchemaManager as SchemaManager
 from amsdal_models.classes.model import Model
-from amsdal_models.schemas.data_models.core import DictSchema, LegacyDictSchema, TypeData
-from amsdal_models.schemas.data_models.schema import ObjectSchema, PropertyData
+from amsdal_utils.models.data_models.core import DictSchema, LegacyDictSchema, TypeData as TypeData
+from amsdal_utils.models.data_models.schema import ObjectSchema as ObjectSchema, PropertyData as PropertyData
 from amsdal_utils.models.data_models.table_schema import ArraySchemaModel, DictSchemaModel, JsonSchemaModel, NestedSchemaModel, TableColumnSchema, TableSchema
 from amsdal_utils.models.enums import SchemaTypes
 from pathlib import Path
 
 reference_schema: Incomplete
 
-def object_schema_to_table_schema(object_schema: ObjectSchema) -> TableSchema: ...
+def object_schema_to_table_schema(object_schema: ObjectSchema) -> TableSchema:
+    """
+    Converts an ObjectSchema to a TableSchema.
+
+    Args:
+        object_schema (ObjectSchema): The object schema to convert.
+
+    Returns:
+        TableSchema: The converted table schema.
+    """
 def _process_properties(properties: dict[str, PropertyData] | None, required: list[str]) -> list[TableColumnSchema]: ...
 def _process_property_type(property_type: str, items: TypeData | DictSchema | LegacyDictSchema | None = None, context: dict[str, type | Model | NestedSchemaModel] | None = None) -> type | NestedSchemaModel | ArraySchemaModel | DictSchemaModel | type[JsonSchemaModel]: ...
-def schema_to_nested_column_schema(schema: ObjectSchema, context: dict[str, type | Model | NestedSchemaModel]) -> NestedSchemaModel | type: ...
-def contrib_to_module_root_path(contrib: str) -> Path: ...
-def map_module_type_to_schema_type(module_type: ModuleTypes) -> SchemaTypes: ...
+def schema_to_nested_column_schema(schema: ObjectSchema, context: dict[str, type | Model | NestedSchemaModel]) -> NestedSchemaModel | type:
+    """
+    Converts an ObjectSchema to a NestedSchemaModel or type.
+
+    Args:
+        schema (ObjectSchema): The schema to convert.
+        context (dict[str, type | Model | NestedSchemaModel]): The context for the conversion.
+
+    Returns:
+        NestedSchemaModel | type: The converted nested schema model or type.
+    """
+def contrib_to_module_root_path(contrib: str) -> Path:
+    """
+    Converts a contrib string to the root path of the module.
+
+    Args:
+        contrib (str): The contrib string to convert.
+
+    Returns:
+        Path: The root path of the module.
+    """
+def map_module_type_to_schema_type(module_type: ModuleTypes) -> SchemaTypes:
+    """
+    Maps a ModuleTypes value to a SchemaTypes value.
+
+    Args:
+        module_type (ModuleTypes): The module type to map.
+
+    Returns:
+        SchemaTypes: The corresponding schema type.
+
+    Raises:
+        ValueError: If the module type is unknown.
+    """

amsdal/mixins/build_mixin.pyi

@@ -5,22 +5,74 @@ from amsdal_models.schemas.loaders.cli_fixtures_loader import CliFixturesLoader
 from pathlib import Path
 
 class CliMultiFixturesLoader(CliFixturesLoader):
+    """
+    Loads multiple fixtures from specified schema directories.
+
+    Attributes:
+        models_with_fixtures (list[tuple[Path, ObjectSchema]]): List of tuples containing the path and object schema
+            of models with fixtures.
+    """
     models_with_fixtures: Incomplete
     def __init__(self, schema_dirs: list[Path]) -> None: ...
 
 class BuildMixin:
+    """
+    Provides methods to build models, transactions, static files, migrations, and fixtures for a CLI application.
+    """
     @classmethod
-    def build_models(cls, user_schemas_path: Path) -> None: ...
-    @staticmethod
-    def build_transactions(cli_app_path: Path) -> None: ...
+    def build_models(cls, user_schemas_path: Path) -> None:
+        """
+        Builds models from the specified user schemas path and predefined schema directories.
+
+        Args:
+            user_schemas_path (Path): The path to the user schemas directory.
+
+        Returns:
+            None
+        """
     @staticmethod
-    def build_static_files(cli_app_path: Path) -> None: ...
+    def build_transactions(cli_app_path: Path) -> None:
+        """
+        Builds transactions from the specified CLI application path.
+
+        Args:
+            cli_app_path (Path): The path to the CLI application directory.
+
+        Returns:
+            None
+        """
     @staticmethod
-    def build_migrations(cli_app_path: Path) -> None: ...
+    def build_static_files(cli_app_path: Path) -> None:
+        """
+        Builds static files from the specified CLI application path.
+
+        Args:
+            cli_app_path (Path): The path to the CLI application directory.
+
+        Returns:
+            None
+        """
     @staticmethod
-    def build_fixtures(cli_app_path: Path) -> None: ...
+    def build_migrations(cli_app_path: Path) -> None:
+        """
+        Builds migrations from the specified CLI application path.
+
+        Args:
+            cli_app_path (Path): The path to the CLI application directory.
+
+        Returns:
+            None
+        """
     @staticmethod
-    def _reimport_models() -> None:
+    def build_fixtures(cli_app_path: Path) -> None:
         """
-        Imports all generated models. Important for cases when models are generated already
+        Builds fixtures from the specified CLI application path.
+
+        Args:
+            cli_app_path (Path): The path to the CLI application directory.
+
+        Returns:
+            None
         """
+    @staticmethod
+    def _reimport_models() -> None: ...