archipy-mysql 5.11.0__tar.gz

archipy_mysql-5.11.0/.gitignore

@@ -0,0 +1,245 @@
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+.idea
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+dist
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.ruff_cache
+bandit-report.json
+
+.gitattributes

archipy_mysql-5.11.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.5
+Name: archipy-mysql
+Version: 5.11.0
+Summary: ArchiPy mysql adapter.
+Author-email: Hossein Nejati <hosseinnejati14@gmail.com>
+License-Expression: Apache-2.0
+Requires-Python: <4,>=3.14
+Requires-Dist: archipy==5.11.0
+Provides-Extra: async
+Requires-Dist: asyncmy2>=0.2.21; extra == 'async'
+Provides-Extra: sync
+Requires-Dist: pymysql>=1.2.3; extra == 'sync'
+Description-Content-Type: text/markdown
+
+# archipy-mysql
+
+mysql adapter for [ArchiPy](https://syntaxarc.github.io/ArchiPy/). Install via the core extra:
+
+```bash
+uv add "archipy[mysql]"
+```

archipy_mysql-5.11.0/README.md

@@ -0,0 +1,7 @@
+# archipy-mysql
+
+mysql adapter for [ArchiPy](https://syntaxarc.github.io/ArchiPy/). Install via the core extra:
+
+```bash
+uv add "archipy[mysql]"
+```

archipy_mysql-5.11.0/archipy/adapters/mysql/__init__.py

@@ -0,0 +1 @@
+"""MySQL adapter package."""

archipy_mysql-5.11.0/archipy/adapters/mysql/sqlalchemy/__init__.py

@@ -0,0 +1 @@
+"""MySQL SQLAlchemy adapters for ArchiPy."""

archipy_mysql-5.11.0/archipy/adapters/mysql/sqlalchemy/adapters.py

@@ -0,0 +1,78 @@
+"""MySQL SQLAlchemy adapter implementations."""
+
+from typing import override
+
+from archipy.adapters.base.sqlalchemy.adapters import (
+    AsyncBaseSQLAlchemyAdapter,
+    BaseSQLAlchemyAdapter,
+)
+from archipy.adapters.mysql.sqlalchemy.session_managers import (
+    AsyncMySQLSQlAlchemySessionManager,
+    MySQLSQlAlchemySessionManager,
+)
+from archipy.configs.base_config import BaseConfig
+from archipy.configs.config_template import MySQLSQLAlchemyConfig
+
+
+class MySQLSQLAlchemyAdapter(BaseSQLAlchemyAdapter[MySQLSQLAlchemyConfig]):
+    """Synchronous SQLAlchemy adapter for MySQL.
+
+    Inherits from BaseSQLAlchemyAdapter to provide MySQL-specific session management
+    and database operations.
+
+    Args:
+        orm_config: MySQL-specific configuration. If None, uses global config.
+    """
+
+    def __init__(self, orm_config: MySQLSQLAlchemyConfig | None = None) -> None:
+        """Initialize the MySQL adapter with a session manager.
+
+        Args:
+            orm_config: MySQL-specific configuration. If None, uses global config.
+        """
+        configs = BaseConfig.global_config().MYSQL_SQLALCHEMY if orm_config is None else orm_config
+        super().__init__(configs)
+
+    @override
+    def _create_session_manager(self, configs: MySQLSQLAlchemyConfig) -> MySQLSQlAlchemySessionManager:
+        """Create a MySQL-specific session manager.
+
+        Args:
+            configs: MySQL configuration.
+
+        Returns:
+            A MySQL session manager instance.
+        """
+        return MySQLSQlAlchemySessionManager(configs)
+
+
+class AsyncMySQLSQLAlchemyAdapter(AsyncBaseSQLAlchemyAdapter[MySQLSQLAlchemyConfig]):
+    """Asynchronous SQLAlchemy adapter for MySQL.
+
+    Inherits from AsyncBaseSQLAlchemyAdapter to provide async MySQL-specific session
+    management and database operations.
+
+    Args:
+        orm_config: MySQL-specific configuration. If None, uses global config.
+    """
+
+    def __init__(self, orm_config: MySQLSQLAlchemyConfig | None = None) -> None:
+        """Initialize the async MySQL adapter with a session manager.
+
+        Args:
+            orm_config: MySQL-specific configuration. If None, uses global config.
+        """
+        configs = BaseConfig.global_config().MYSQL_SQLALCHEMY if orm_config is None else orm_config
+        super().__init__(configs)
+
+    @override
+    def _create_async_session_manager(self, configs: MySQLSQLAlchemyConfig) -> AsyncMySQLSQlAlchemySessionManager:
+        """Create an async MySQL-specific session manager.
+
+        Args:
+            configs: MySQL configuration.
+
+        Returns:
+            An async MySQL session manager instance.
+        """
+        return AsyncMySQLSQlAlchemySessionManager(configs)

archipy_mysql-5.11.0/archipy/adapters/mysql/sqlalchemy/session_manager_registry.py

@@ -0,0 +1,125 @@
+"""Registry for MySQL SQLAlchemy session managers."""
+
+from archipy.adapters.base.sqlalchemy.session_manager_ports import (
+    AsyncSessionManagerPort,
+    SessionManagerPort,
+)
+from archipy.adapters.base.sqlalchemy.session_manager_registry import (
+    SessionManagerRegistry,
+)
+from archipy.adapters.mysql.sqlalchemy.session_managers import (
+    AsyncMySQLSQlAlchemySessionManager,
+    MySQLSQlAlchemySessionManager,
+)
+from archipy.helpers.metaclasses.singleton import Singleton
+from archipy.models.errors import (
+    DatabaseConnectionError,
+    InvalidArgumentError,
+    InvalidEntityTypeError,
+)
+
+
+class MySQLSessionManagerRegistry(SessionManagerRegistry, metaclass=Singleton):
+    """Registry for MySQL SQLAlchemy session managers.
+
+    This registry provides a centralized access point for both synchronous and
+    asynchronous MySQL session managers, implementing the Service Locator pattern.
+    It lazily initializes the appropriate session manager when first requested.
+
+    The registry maintains singleton instances of:
+    - A synchronous session manager (MySQLSQlAlchemySessionManager)
+    - An asynchronous session manager (AsyncMySQLSQlAlchemySessionManager)
+    """
+
+    @classmethod
+    def get_sync_manager(cls) -> SessionManagerPort:
+        """Get the synchronous MySQL session manager instance.
+
+        Lazily initializes a default MySQLSQlAlchemySessionManager if none has been set.
+
+        Returns:
+            SessionManagerPort: The registered synchronous session manager
+
+        Raises:
+            DatabaseConnectionError: If there's an error initializing the session manager
+        """
+        if cls._sync_instance is None:
+            try:
+                cls._sync_instance = MySQLSQlAlchemySessionManager()
+            except Exception as e:
+                raise DatabaseConnectionError(
+                    database="mysql",
+                ) from e
+        return cls._sync_instance
+
+    @classmethod
+    def set_sync_manager(cls, manager: SessionManagerPort) -> None:
+        """Set a custom synchronous session manager.
+
+        Args:
+            manager: An instance implementing SessionManagerPort
+
+        Raises:
+            InvalidArgumentError: If the manager is None
+            InvalidEntityTypeError: If the manager doesn't implement SessionManagerPort
+        """
+        if manager is None:
+            raise InvalidArgumentError(argument_name="mysql_session_manager")
+
+        if not isinstance(manager, SessionManagerPort):
+            raise InvalidEntityTypeError(
+                expected_type="SessionManagerPort",
+                actual_type=type(manager).__name__,
+            )
+        cls._sync_instance = manager
+
+    @classmethod
+    def get_async_manager(cls) -> AsyncSessionManagerPort:
+        """Get the asynchronous MySQL session manager instance.
+
+        Lazily initializes a default AsyncMySQLSQlAlchemySessionManager if none has been set.
+
+        Returns:
+            AsyncSessionManagerPort: The registered asynchronous session manager
+
+        Raises:
+            DatabaseConnectionError: If there's an error initializing the session manager
+        """
+        if cls._async_instance is None:
+            try:
+                cls._async_instance = AsyncMySQLSQlAlchemySessionManager()
+            except Exception as e:
+                raise DatabaseConnectionError(
+                    database="mysql",
+                ) from e
+        return cls._async_instance
+
+    @classmethod
+    def set_async_manager(cls, manager: AsyncSessionManagerPort) -> None:
+        """Set a custom asynchronous session manager.
+
+        Args:
+            manager: An instance implementing AsyncSessionManagerPort
+
+        Raises:
+            InvalidArgumentError: If the manager is None
+            InvalidEntityTypeError: If the manager doesn't implement AsyncSessionManagerPort
+        """
+        if manager is None:
+            raise InvalidArgumentError(argument_name="mysql_async_session_manager")
+
+        if not isinstance(manager, AsyncSessionManagerPort):
+            raise InvalidEntityTypeError(
+                expected_type="AsyncSessionManagerPort",
+                actual_type=type(manager).__name__,
+            )
+        cls._async_instance = manager
+
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the registry to its initial state.
+
+        This method clears both registered managers, useful for testing.
+        """
+        cls._sync_instance = None
+        cls._async_instance = None

archipy_mysql-5.11.0/archipy/adapters/mysql/sqlalchemy/session_managers.py

@@ -0,0 +1,176 @@
+"""MySQL SQLAlchemy session manager implementations."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, override
+
+from sqlalchemy import URL
+from sqlalchemy.dialects.mysql.base import MySQLTypeCompiler
+from sqlalchemy.exc import SQLAlchemyError
+
+from archipy.adapters.base.sqlalchemy.session_managers import (
+    AsyncBaseSQLAlchemySessionManager,
+    BaseSQLAlchemySessionManager,
+)
+from archipy.configs.base_config import BaseConfig
+from archipy.configs.config_template import MySQLSQLAlchemyConfig
+from archipy.helpers.metaclasses.singleton import Singleton
+from archipy.models.errors import DatabaseConnectionError
+
+if TYPE_CHECKING:
+    from sqlalchemy.dialects.postgresql import UUID as PostgresUUID
+
+
+def _patch_mysql_uuid_mapping() -> None:
+    """Patch the MySQL type compiler to map UUID to VARCHAR.
+
+    MySQL does not support a native UUID column type, so PostgreSQL UUID
+    columns used in shared entity models must be mapped to VARCHAR(36).
+    This is patched at module level to ensure it is applied before engine creation.
+    """
+
+    def visit_UUID(self: MySQLTypeCompiler, type_: PostgresUUID, **kw: object) -> str:  # noqa: ARG001
+        """Map PostgreSQL UUID to VARCHAR(36) for MySQL."""
+        return "VARCHAR(36)"
+
+    MySQLTypeCompiler.visit_UUID = visit_UUID
+
+
+# Apply the patch when the module is imported
+_patch_mysql_uuid_mapping()
+
+
+class MySQLSQlAlchemySessionManager(BaseSQLAlchemySessionManager[MySQLSQLAlchemyConfig], metaclass=Singleton):
+    """Synchronous SQLAlchemy session manager for MySQL.
+
+    Inherits from BaseSQLAlchemySessionManager to provide MySQL-specific session
+    management, including connection URL creation and engine configuration.
+
+    Args:
+        orm_config: MySQL-specific configuration. If None, uses global config.
+    """
+
+    def __init__(self, orm_config: MySQLSQLAlchemyConfig | None = None) -> None:
+        """Initialize the MySQL session manager.
+
+        Args:
+            orm_config: MySQL-specific configuration. If None, uses global config.
+        """
+        configs = BaseConfig.global_config().MYSQL_SQLALCHEMY if orm_config is None else orm_config
+        super().__init__(configs)
+
+    @override
+    def _expected_config_type(self) -> type[MySQLSQLAlchemyConfig]:
+        """Return the expected configuration type for MySQL.
+
+        Returns:
+            The MySQLSQLAlchemyConfig class.
+        """
+        return MySQLSQLAlchemyConfig
+
+    @override
+    def _get_database_name(self) -> str:
+        """Return the name of the database being used.
+
+        Returns:
+            str: The name of the database ('mysql').
+        """
+        return "mysql"
+
+    @override
+    def _create_url(self, configs: MySQLSQLAlchemyConfig) -> URL:
+        """Create a MySQL connection URL.
+
+        Args:
+            configs: MySQL configuration.
+
+        Returns:
+            A SQLAlchemy URL object for MySQL.
+
+        Raises:
+            DatabaseConnectionError: If there's an error creating the URL.
+        """
+        try:
+            return URL.create(
+                drivername=configs.DRIVER_NAME,
+                username=configs.USERNAME,
+                password=configs.PASSWORD,
+                host=configs.HOST,
+                port=configs.PORT,
+                database=configs.DATABASE,
+            )
+        except SQLAlchemyError as e:
+            raise DatabaseConnectionError(
+                database=self._get_database_name(),
+            ) from e
+
+
+class AsyncMySQLSQlAlchemySessionManager(
+    AsyncBaseSQLAlchemySessionManager[MySQLSQLAlchemyConfig],
+    metaclass=Singleton,
+):
+    """Asynchronous SQLAlchemy session manager for MySQL.
+
+    Inherits from AsyncBaseSQLAlchemySessionManager to provide async MySQL-specific
+    session management, including connection URL creation and async engine configuration.
+
+    Args:
+        orm_config: MySQL-specific configuration. If None, uses global config.
+    """
+
+    def __init__(self, orm_config: MySQLSQLAlchemyConfig | None = None) -> None:
+        """Initialize the async MySQL session manager.
+
+        Args:
+            orm_config: MySQL-specific configuration. If None, uses global config.
+        """
+        configs = BaseConfig.global_config().MYSQL_SQLALCHEMY if orm_config is None else orm_config
+        super().__init__(configs)
+
+    @override
+    def _expected_config_type(self) -> type[MySQLSQLAlchemyConfig]:
+        """Return the expected configuration type for MySQL.
+
+        Returns:
+            The MySQLSQLAlchemyConfig class.
+        """
+        return MySQLSQLAlchemyConfig
+
+    @override
+    def _get_database_name(self) -> str:
+        """Return the name of the database being used.
+
+        Returns:
+            str: The name of the database ('mysql').
+        """
+        return "mysql"
+
+    @override
+    def _create_url(self, configs: MySQLSQLAlchemyConfig) -> URL:
+        """Create an async MySQL connection URL.
+
+        For async operations, MySQL uses the mysql+asyncmy driver which is provided
+        by the asyncmy2 package.
+
+        Args:
+            configs: MySQL configuration.
+
+        Returns:
+            A SQLAlchemy URL object for MySQL with async driver.
+
+        Raises:
+            DatabaseConnectionError: If there's an error creating the URL.
+        """
+        try:
+            return URL.create(
+                drivername="mysql+asyncmy",
+                username=configs.USERNAME,
+                password=configs.PASSWORD,
+                host=configs.HOST,
+                port=configs.PORT,
+                database=configs.DATABASE,
+            )
+        except SQLAlchemyError as e:
+            raise DatabaseConnectionError(
+                database=self._get_database_name(),
+            ) from e

archipy_mysql-5.11.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "archipy-mysql"
+description = "ArchiPy mysql adapter."
+authors = [
+    { name = "Hossein Nejati", email = "hosseinnejati14@gmail.com" },
+]
+readme = "README.md"
+license = "Apache-2.0"
+version = "5.11.0" # This version is set on publish flow!
+requires-python = ">=3.14,<4"
+dependencies = [
+    "archipy==5.11.0", # Pinned to core version on publish flow!
+]
+
+[project.optional-dependencies]
+sync = ["pymysql>=1.2.3"]
+async = ["asyncmy2>=0.2.21"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["archipy"]
+
+[tool.uv.sources]
+archipy = { workspace = true }