amsdal 0.4.13__cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

amsdal/cloud/services/auth/signup_service.pyi

@@ -0,0 +1,32 @@
+from _typeshed import Incomplete
+from amsdal.cloud.services.actions.signup_action import FreeSignupAction as FreeSignupAction
+from amsdal.configs.main import settings as settings
+
+LICENCE_PATH: Incomplete
+LICENCE_MESSAGE: Incomplete
+
+def _input(msg: str) -> str: ...
+def _print(msg: str) -> None: ...
+def want_signup_input() -> str: ...
+def licence_input() -> str: ...
+def organization_name_input() -> str: ...
+def email_input() -> str: ...
+
+class SignupService:
+    """
+    Service to handle the signup process for the Amsdal Framework.
+
+    This class provides functionality to prompt the user for signup details, validate the license agreement,
+    and create credentials for the user.
+    """
+    @classmethod
+    def signup_prompt(cls) -> bool:
+        """
+        Prompts the user to sign up for the Amsdal Framework.
+
+        This method guides the user through the signup process, including accepting the license agreement and
+        entering organization and email details. It then creates credentials for the user.
+
+        Returns:
+            bool: True if the signup process is completed successfully, False otherwise.
+        """

amsdal/cloud/services/auth/token.pyi

@@ -0,0 +1,27 @@
+from _typeshed import Incomplete
+from amsdal.cloud.constants import JWT_PUBLIC_KEY as JWT_PUBLIC_KEY
+from amsdal.cloud.services.auth.base import AuthHandlerBase as AuthHandlerBase
+from amsdal.errors import AmsdalAuthenticationError as AmsdalAuthenticationError
+
+HMAC_KEY: bytes
+
+class TokenAuthHandler(AuthHandlerBase):
+    """
+    Handles authentication using a token.
+
+    This class provides functionality to authenticate using a JWT token and validate its checksum.
+    """
+    __token: Incomplete
+    public_key: Incomplete
+    def __init__(self, token: str | None, public_key: str = ...) -> None: ...
+    def _validate_checksum(self, expected_checksum: str) -> None: ...
+    def validate_credentials(self) -> None:
+        """
+        Validates the provided JWT token.
+
+        This method decodes the token and validates its checksum or expiration date.
+
+        Raises:
+            AmsdalAuthenticationError: If the token is expired, has an invalid signature, is invalid, or is missing
+                an expiration date.
+        """

amsdal/configs/constants.py

@@ -0,0 +1,33 @@
+import sys
+from pathlib import Path
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+TYPE_SCHEMAS_PATH: Path = BASE_DIR / 'schemas' / 'types'
+CORE_SCHEMAS_PATH: Path = BASE_DIR / 'schemas' / 'core'
+
+CORE_MIGRATIONS_PATH: Path = BASE_DIR / '__migrations__'
+
+# Environment
+TESTING_ENVIRONMENT = 'testing'
+DEVELOPMENT_ENVIRONMENT = 'development'
+PRODUCTION_ENVIRONMENT = 'production'
+
+
+def get_default_environment() -> str:
+    """
+    Determines the default environment based on the command used to run the script.
+
+    This function checks the command used to run the script and returns the appropriate
+    environment string. If the script is run using `pytest`, it returns 'testing'. Otherwise,
+    it returns 'development'.
+
+    Returns:
+        str: The default environment string, either 'testing' or 'development'.
+    """
+    cmd = sys.argv[0] if sys.argv else ''
+
+    if 'pytest' in cmd:
+        return TESTING_ENVIRONMENT
+
+    return DEVELOPMENT_ENVIRONMENT

amsdal/configs/constants.pyi

@@ -0,0 +1,22 @@
+from _typeshed import Incomplete
+from pathlib import Path
+
+BASE_DIR: Incomplete
+TYPE_SCHEMAS_PATH: Path
+CORE_SCHEMAS_PATH: Path
+CORE_MIGRATIONS_PATH: Path
+TESTING_ENVIRONMENT: str
+DEVELOPMENT_ENVIRONMENT: str
+PRODUCTION_ENVIRONMENT: str
+
+def get_default_environment() -> str:
+    """
+    Determines the default environment based on the command used to run the script.
+
+    This function checks the command used to run the script and returns the appropriate
+    environment string. If the script is run using `pytest`, it returns 'testing'. Otherwise,
+    it returns 'development'.
+
+    Returns:
+        str: The default environment string, either 'testing' or 'development'.
+    """

amsdal/configs/main.py

@@ -0,0 +1,258 @@
+import importlib
+from pathlib import Path
+from typing import TYPE_CHECKING
+from typing import Any
+from typing import TypeAlias
+
+from pydantic import field_validator
+from pydantic import model_validator
+from pydantic_settings import BaseSettings
+from pydantic_settings import SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    """
+    Configuration settings for the application.
+
+    This class defines the configuration settings for the application, including paths,
+    environment variables, and other settings.
+
+    Attributes:
+        model_config (SettingsConfigDict): Configuration for the settings model.
+        APP_PATH (Path): Path to the app directory where the generated models and other files will be placed.
+        CONFIG_PATH (Path | None): Path to the config.yml file. If not specified, the default APP_PATH/config.yml
+            file will be used.
+        MODELS_MODULE_NAME (str): The models module name. The generated models will be placed in this module.
+        SCHEMAS_MODULE_NAME (str): The schemas module name. The schemas will be placed in this module.
+        FIXTURES_MODULE_NAME (str): The fixtures module name. The fixtures will be placed in this module.
+        STATIC_MODULE_NAME (str): The static module name. The static files will be placed in this module.
+        TRANSACTIONS_MODULE_NAME (str): The transactions module name. The transactions will be placed in this module.
+        MIGRATIONS_DIRECTORY_NAME (str): The migrations directory name. The migration files will be placed in this
+            folder.
+        ACCESS_KEY_ID (str | None): The access key that you will get during registering process.
+        SECRET_ACCESS_KEY (str | None): The secret access key that you will get during registering process.
+        ACCESS_TOKEN (str | None): The access token that you will get during sign in process.
+        SANDBOX_ENVIRONMENT (bool | None): If True, the sandbox environment will be used. If False,
+            the cloud environment will be used.
+        CONTRIBS (list[str]): List of contrib modules that will be loaded and used.
+            Can be specified via environment variable AMSDAL_CONTRIBS as comma separated string.
+    """
+
+    model_config = SettingsConfigDict(
+        case_sensitive=True,
+        env_prefix='AMSDAL_',
+        env_file='.env',
+        env_file_encoding='utf-8',
+        extra='ignore',
+    )
+
+    APP_PATH: Path = Path('.')
+    CONFIG_PATH: Path | None = None
+    TYPE_MODELS_MODULE: str = 'amsdal.models.types'
+    CORE_MODELS_MODULE: str = 'amsdal.models.core'
+    USER_MODELS_MODULE_PATH: Path | None = None
+    USER_MODELS_MODULE: str = 'models'
+    FIXTURES_MODULE_PATH: Path | None = None
+    FIXTURES_MODULE_NAME: str = 'fixtures'
+    STATIC_MODULE_PATH: Path | None = None
+    STATIC_MODULE_NAME: str = 'static'
+    TRANSACTIONS_MODULE_PATH: Path | None = None
+    TRANSACTIONS_MODULE_NAME: str = 'transactions'
+    MIGRATIONS_MODULE_PATH: Path | None = None
+    MIGRATIONS_DIRECTORY_NAME: str = 'migrations'
+    ACCESS_KEY_ID: str | None = None
+    SECRET_ACCESS_KEY: str | None = None
+    ACCESS_TOKEN: str | None = None
+    SANDBOX_ENVIRONMENT: bool | None = None
+    CONTRIBS: list[str] = [
+        'amsdal.contrib.auth.app.AuthAppConfig',
+        'amsdal.contrib.frontend_configs.app.FrontendConfigAppConfig',
+    ]
+    CONTRIB_MODELS_PACKAGE_NAME: str = 'models'
+    CONTRIB_MIGRATIONS_DIRECTORY_NAME: str = 'migrations'
+
+    @field_validator('CONTRIBS', mode='after')
+    def load_contrib_modules(cls, value: list[str]) -> list[str]:  # noqa: N805
+        """
+        Loads and initializes contrib modules.
+
+        This method takes a list of contrib module paths, imports each module, and calls the `on_ready` method
+        of the `AppConfig` class within each module.
+
+        Args:
+            value (list[str]): A list of contrib module paths in the format 'package.module.ClassName'.
+
+        Returns:
+            list[str]: The same list of contrib module paths after loading and initializing the modules.
+        """
+        from amsdal.contrib.app_config import AppConfig
+
+        for contrib_module in value:
+            package_name, class_name = contrib_module.rsplit('.', 1)
+            _contrib_module = importlib.import_module(package_name)
+            app_config_class: type[AppConfig] = getattr(_contrib_module, class_name)
+            app_config_class().on_ready()
+
+        return value
+
+    @property
+    def user_models_path(self) -> Path:
+        """
+        Returns the root path for models.
+
+        This property constructs and returns the path to the models directory
+        based on the `APP_PATH` and `MODELS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the models directory.
+        """
+        if self.USER_MODELS_MODULE_PATH:
+            return self.USER_MODELS_MODULE_PATH
+
+        if '.' in self.USER_MODELS_MODULE:
+            _package, _ = self.USER_MODELS_MODULE.split('.', 1)
+            _module = importlib.import_module(_package)
+
+            return Path(_module.__path__[0])
+
+        return self.APP_PATH / self.USER_MODELS_MODULE
+
+    @property
+    def fixtures_root_path(self) -> Path:
+        """
+        Returns the root path for fixtures.
+
+        This property constructs and returns the path to the fixtures directory
+        based on the `APP_PATH` and `FIXTURES_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the fixtures directory.
+        """
+        return self.FIXTURES_MODULE_PATH or self.APP_PATH / self.FIXTURES_MODULE_NAME
+
+    @property
+    def static_root_path(self) -> Path:
+        """
+        Returns the root path for static files.
+
+        This property constructs and returns the path to the static files directory
+        based on the `APP_PATH` and `STATIC_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the static files directory.
+        """
+        return self.STATIC_MODULE_PATH or self.APP_PATH / self.STATIC_MODULE_NAME
+
+    @property
+    def transactions_root_path(self) -> Path:
+        """
+        Returns the root path for transactions.
+
+        This property constructs and returns the path to the transactions directory
+        based on the `models_root_path` and `TRANSACTIONS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the transactions directory.
+        """
+        return self.TRANSACTIONS_MODULE_PATH or self.APP_PATH / self.TRANSACTIONS_MODULE_NAME
+
+    @property
+    def migrations_root_path(self) -> Path:
+        """
+        Returns the root path for migrations.
+
+        This property constructs and returns the path to the migrations directory
+        based on the `models_root_path` and `MIGRATIONS_DIRECTORY_NAME` attributes.
+
+        Returns:
+            Path: The root path for the migrations directory.
+        """
+        return self.MIGRATIONS_MODULE_PATH or self.APP_PATH / self.MIGRATIONS_DIRECTORY_NAME
+
+    @model_validator(mode='after')
+    def check_config_path_set(self) -> 'Settings':
+        """
+        Ensures the configuration path is set.
+
+        This method checks if the `CONFIG_PATH` attribute is set. If it is not set,
+        it assigns a default path based on the `APP_PATH` attribute.
+
+        Returns:
+            Settings: The updated settings instance with the `CONFIG_PATH` attribute set.
+        """
+        config_path = self.CONFIG_PATH
+
+        if not config_path:
+            self.CONFIG_PATH = self.APP_PATH / 'config.yml'
+
+        return self
+
+
+if TYPE_CHECKING:
+    base: TypeAlias = Settings
+else:
+    base: TypeAlias = object
+
+
+class SettingsProxy(base):
+    """
+    Proxy class for accessing and modifying settings.
+
+    This class acts as a proxy for the `Settings` class, allowing for dynamic
+    overriding and accessing of settings attributes.
+    """
+
+    def __init__(self) -> None:
+        self._settings = Settings()
+
+    def override(self, **kwargs: Any) -> None:
+        """
+        Overrides settings with provided keyword arguments.
+
+        This method updates the current settings with the provided keyword arguments.
+
+        Args:
+            **kwargs: Keyword arguments representing settings to override.
+
+        Returns:
+            None
+        """
+        new_settings = self._settings.model_dump()
+        new_settings.update(kwargs)
+        self._settings = Settings(**new_settings)
+
+    def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
+        """
+        Dumps the current settings model to a dictionary.
+
+        This method returns the current settings as a dictionary.
+
+        Args:
+            *args: Additional positional arguments to pass to the underlying model dump method.
+            **kwargs: Additional keyword arguments to pass to the underlying model dump method.
+
+        Returns:
+            dict[str, Any]: The current settings as a dictionary.
+        """
+        return self._settings.model_dump(*args, **kwargs)
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._settings, name)
+
+    def __delattr__(self, name: str) -> None:
+        try:
+            getattr(self._settings, name)
+            self._settings.__delattr__(name)
+        except AttributeError:
+            msg = f'Settings object has no attribute {name}'
+            raise AttributeError(msg) from None
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        if name == '_settings':
+            super().__setattr__(name, value)
+            return
+
+        self._settings.__setattr__(name, value)
+
+
+settings: SettingsProxy = SettingsProxy()

amsdal/configs/main.pyi

@@ -0,0 +1,173 @@
+from _typeshed import Incomplete
+from pathlib import Path
+from pydantic_settings import BaseSettings
+from typing import Any, TypeAlias
+
+class Settings(BaseSettings):
+    """
+    Configuration settings for the application.
+
+    This class defines the configuration settings for the application, including paths,
+    environment variables, and other settings.
+
+    Attributes:
+        model_config (SettingsConfigDict): Configuration for the settings model.
+        APP_PATH (Path): Path to the app directory where the generated models and other files will be placed.
+        CONFIG_PATH (Path | None): Path to the config.yml file. If not specified, the default APP_PATH/config.yml
+            file will be used.
+        MODELS_MODULE_NAME (str): The models module name. The generated models will be placed in this module.
+        SCHEMAS_MODULE_NAME (str): The schemas module name. The schemas will be placed in this module.
+        FIXTURES_MODULE_NAME (str): The fixtures module name. The fixtures will be placed in this module.
+        STATIC_MODULE_NAME (str): The static module name. The static files will be placed in this module.
+        TRANSACTIONS_MODULE_NAME (str): The transactions module name. The transactions will be placed in this module.
+        MIGRATIONS_DIRECTORY_NAME (str): The migrations directory name. The migration files will be placed in this
+            folder.
+        ACCESS_KEY_ID (str | None): The access key that you will get during registering process.
+        SECRET_ACCESS_KEY (str | None): The secret access key that you will get during registering process.
+        ACCESS_TOKEN (str | None): The access token that you will get during sign in process.
+        SANDBOX_ENVIRONMENT (bool | None): If True, the sandbox environment will be used. If False,
+            the cloud environment will be used.
+        CONTRIBS (list[str]): List of contrib modules that will be loaded and used.
+            Can be specified via environment variable AMSDAL_CONTRIBS as comma separated string.
+    """
+    model_config: Incomplete
+    APP_PATH: Path
+    CONFIG_PATH: Path | None
+    TYPE_MODELS_MODULE: str
+    CORE_MODELS_MODULE: str
+    USER_MODELS_MODULE_PATH: Path | None
+    USER_MODELS_MODULE: str
+    FIXTURES_MODULE_PATH: Path | None
+    FIXTURES_MODULE_NAME: str
+    STATIC_MODULE_PATH: Path | None
+    STATIC_MODULE_NAME: str
+    TRANSACTIONS_MODULE_PATH: Path | None
+    TRANSACTIONS_MODULE_NAME: str
+    MIGRATIONS_MODULE_PATH: Path | None
+    MIGRATIONS_DIRECTORY_NAME: str
+    ACCESS_KEY_ID: str | None
+    SECRET_ACCESS_KEY: str | None
+    ACCESS_TOKEN: str | None
+    SANDBOX_ENVIRONMENT: bool | None
+    CONTRIBS: list[str]
+    CONTRIB_MODELS_PACKAGE_NAME: str
+    CONTRIB_MIGRATIONS_DIRECTORY_NAME: str
+    def load_contrib_modules(cls, value: list[str]) -> list[str]:
+        """
+        Loads and initializes contrib modules.
+
+        This method takes a list of contrib module paths, imports each module, and calls the `on_ready` method
+        of the `AppConfig` class within each module.
+
+        Args:
+            value (list[str]): A list of contrib module paths in the format 'package.module.ClassName'.
+
+        Returns:
+            list[str]: The same list of contrib module paths after loading and initializing the modules.
+        """
+    @property
+    def user_models_path(self) -> Path:
+        """
+        Returns the root path for models.
+
+        This property constructs and returns the path to the models directory
+        based on the `APP_PATH` and `MODELS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the models directory.
+        """
+    @property
+    def fixtures_root_path(self) -> Path:
+        """
+        Returns the root path for fixtures.
+
+        This property constructs and returns the path to the fixtures directory
+        based on the `APP_PATH` and `FIXTURES_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the fixtures directory.
+        """
+    @property
+    def static_root_path(self) -> Path:
+        """
+        Returns the root path for static files.
+
+        This property constructs and returns the path to the static files directory
+        based on the `APP_PATH` and `STATIC_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the static files directory.
+        """
+    @property
+    def transactions_root_path(self) -> Path:
+        """
+        Returns the root path for transactions.
+
+        This property constructs and returns the path to the transactions directory
+        based on the `models_root_path` and `TRANSACTIONS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the transactions directory.
+        """
+    @property
+    def migrations_root_path(self) -> Path:
+        """
+        Returns the root path for migrations.
+
+        This property constructs and returns the path to the migrations directory
+        based on the `models_root_path` and `MIGRATIONS_DIRECTORY_NAME` attributes.
+
+        Returns:
+            Path: The root path for the migrations directory.
+        """
+    def check_config_path_set(self) -> Settings:
+        """
+        Ensures the configuration path is set.
+
+        This method checks if the `CONFIG_PATH` attribute is set. If it is not set,
+        it assigns a default path based on the `APP_PATH` attribute.
+
+        Returns:
+            Settings: The updated settings instance with the `CONFIG_PATH` attribute set.
+        """
+base: TypeAlias = Settings
+
+class SettingsProxy(base):
+    """
+    Proxy class for accessing and modifying settings.
+
+    This class acts as a proxy for the `Settings` class, allowing for dynamic
+    overriding and accessing of settings attributes.
+    """
+    _settings: Incomplete
+    def __init__(self) -> None: ...
+    def override(self, **kwargs: Any) -> None:
+        """
+        Overrides settings with provided keyword arguments.
+
+        This method updates the current settings with the provided keyword arguments.
+
+        Args:
+            **kwargs: Keyword arguments representing settings to override.
+
+        Returns:
+            None
+        """
+    def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
+        """
+        Dumps the current settings model to a dictionary.
+
+        This method returns the current settings as a dictionary.
+
+        Args:
+            *args: Additional positional arguments to pass to the underlying model dump method.
+            **kwargs: Additional keyword arguments to pass to the underlying model dump method.
+
+        Returns:
+            dict[str, Any]: The current settings as a dictionary.
+        """
+    def __getattr__(self, name: str) -> Any: ...
+    def __delattr__(self, name: str) -> None: ...
+    def __setattr__(self, name: str, value: Any) -> None: ...
+
+settings: SettingsProxy

amsdal/context/manager.py

@@ -0,0 +1,69 @@
+from contextvars import ContextVar
+from typing import Any
+
+_CONTEXT: ContextVar[dict[str, Any] | None] = ContextVar('_context', default=None)
+
+
+class AmsdalContextManager:
+    """
+    Manages a context for storing and retrieving data.
+
+    This class provides methods to get, set, and add to a context stored in a
+    `ContextVar`. The context is a dictionary that can hold any key-value pairs.
+    """
+
+    @classmethod
+    def get_context(cls) -> dict[str, Any]:
+        """
+        Retrieves the current context or creates a new one if none exists.
+
+        This method gets the current context from the `_CONTEXT` variable. If no
+        context exists, it creates a new empty context and sets it.
+
+        Returns:
+            dict[str, Any]: The current context.
+        """
+        _context = _CONTEXT.get()
+
+        if _context is not None:
+            return _context
+
+        new_context: dict[str, Any] = {}
+        cls.set_context(new_context)
+
+        return new_context
+
+    @classmethod
+    def set_context(cls, context: dict[str, Any]) -> None:
+        """
+        Sets the context to the provided dictionary.
+
+        This method sets the `_CONTEXT` variable to the provided context.
+
+        Args:
+            context (dict[str, Any]): The context to set.
+
+        Returns:
+            None
+        """
+        _CONTEXT.set(context)
+
+    @classmethod
+    def add_to_context(cls, key: str, value: Any) -> None:
+        """
+        Adds a key-value pair to the current context.
+
+        This method adds the provided key-value pair to the current context.
+
+        Args:
+            key (str): The key to add to the context.
+            value (Any): The value to associate with the key.
+
+        Returns:
+            None
+        """
+        context = cls.get_context()
+
+        context[key] = value
+
+        cls.set_context(context)

amsdal/context/manager.pyi

@@ -0,0 +1,50 @@
+from contextvars import ContextVar
+from typing import Any
+
+_CONTEXT: ContextVar[dict[str, Any] | None]
+
+class AmsdalContextManager:
+    """
+    Manages a context for storing and retrieving data.
+
+    This class provides methods to get, set, and add to a context stored in a
+    `ContextVar`. The context is a dictionary that can hold any key-value pairs.
+    """
+    @classmethod
+    def get_context(cls) -> dict[str, Any]:
+        """
+        Retrieves the current context or creates a new one if none exists.
+
+        This method gets the current context from the `_CONTEXT` variable. If no
+        context exists, it creates a new empty context and sets it.
+
+        Returns:
+            dict[str, Any]: The current context.
+        """
+    @classmethod
+    def set_context(cls, context: dict[str, Any]) -> None:
+        """
+        Sets the context to the provided dictionary.
+
+        This method sets the `_CONTEXT` variable to the provided context.
+
+        Args:
+            context (dict[str, Any]): The context to set.
+
+        Returns:
+            None
+        """
+    @classmethod
+    def add_to_context(cls, key: str, value: Any) -> None:
+        """
+        Adds a key-value pair to the current context.
+
+        This method adds the provided key-value pair to the current context.
+
+        Args:
+            key (str): The key to add to the context.
+            value (Any): The value to associate with the key.
+
+        Returns:
+            None
+        """