lush-sqlalchemyx 0.1.0__tar.gz → 0.2.0__tar.gz

{lush_sqlalchemyx-0.1.0 → lush_sqlalchemyx-0.2.0}/PKG-INFO

@@ -1,14 +1,23 @@
 Metadata-Version: 2.3
 Name: lush-sqlalchemyx
-Version: 0.1.0
-Summary: see README.md
+Version: 0.2.0
+Summary: SQLAlchemy helpers (DAL) and async MySQL managers, with some web frameworks integrations
 Author: straydragon
-Requires-Dist: sqlalchemy[asyncio]>=2.0.43
+Author-email: straydragon <straydragonl@foxmail.com>
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Requires-Dist: sqlalchemy>=2.0.21
 Requires-Dist: pydantic>=2.11.0,<3.0.0
 Requires-Dist: typing-extensions>=4.12.2
 Requires-Dist: lush-pydanticx>=0.1.0
 Requires-Dist: lush-stdx>=0.1.0
+Requires-Dist: lush-dal-protocol>=0.1.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.43 ; extra == 'asyncio'
+Requires-Dist: flask-sqlalchemy>=3.1.1 ; extra == 'flask'
 Requires-Python: >=3.10
+Provides-Extra: asyncio
+Provides-Extra: flask
 Description-Content-Type: text/markdown
 
 # lush-sqlalchemyx

{lush_sqlalchemyx-0.1.0 → lush_sqlalchemyx-0.2.0}/pyproject.toml

@@ -1,20 +1,30 @@
 [project]
 name = "lush-sqlalchemyx"
-version = "0.1.0"
-description = "see README.md"
+version = "0.2.0"
+description = "SQLAlchemy helpers (DAL) and async MySQL managers, with some web frameworks integrations"
 readme = "README.md"
 requires-python = ">=3.10"
-authors = [{ name = "straydragon" }]
+authors = [{ name = "straydragon", email = "straydragonl@foxmail.com" }]
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+]
 dependencies = [
-    "sqlalchemy[asyncio]>=2.0.43",
+    "sqlalchemy>=2.0.21",
     "pydantic>=2.11.0,<3.0.0",
     "typing-extensions>=4.12.2",
     "lush-pydanticx>=0.1.0",
     "lush-stdx>=0.1.0",
+    "lush-dal-protocol>=0.1.0",
 ]
 
+[project.optional-dependencies]
+asyncio = ["sqlalchemy[asyncio]>=2.0.43"]
+flask = ["flask-sqlalchemy>=3.1.1"]
+
 [build-system]
-requires = ["uv_build>=0.10.12,<0.11.0"]
+requires = ["uv_build>=0.10.12,<0.12.0"]
 build-backend = "uv_build"
 
 [tool.uv]
@@ -23,6 +33,7 @@ package = true
 [tool.uv.sources]
 lush-pydanticx = { path = "../lush-pydanticx" }
 lush-stdx = { path = "../lush-stdx" }
+lush-dal-protocol = { path = "../lush-dal-protocol" }
 
 [dependency-groups]
 dev = [
@@ -31,16 +42,30 @@ dev = [
     "pytest-asyncio>=1.1.0",
     "pytest-cov>=6.2.1",
     "aiosqlite>=0.20.0",
+    "aiomysql>=0.2.0",
     "fastapi[standard]>=0.117.1",
+    "sqlalchemy[asyncio]>=2.0.43",
+    "flask-sqlalchemy>=3.1.1",
+    "flask>=3.0.0",
 ]
 
 [tool.pytest.ini_options]
-addopts = "--import-mode=importlib --cov=lush_sqlalchemyx --cov-report=term-missing"
+addopts = "--import-mode=importlib --cov=lush_sqlalchemyx --cov-branch --cov-report=term-missing --cov-fail-under=100"
 testpaths = ["tests"]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
 asyncio_default_test_loop_scope = "function"
 
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_also = [
+    "if TYPE_CHECKING:",
+    "if __name__ == .__main__.:",
+    "@(abc\\.)?abstractmethod",
+]
+
 [tool.ruff]
 line-length = 140
 indent-width = 4

lush_sqlalchemyx-0.2.0/src/lush_sqlalchemyx/_compat.py

@@ -0,0 +1,24 @@
+"""运行时可选依赖检测."""
+
+from __future__ import annotations
+
+_HAS_ASYNC: bool
+try:
+    from sqlalchemy.ext.asyncio import AsyncSession as _AsyncSession  # noqa: F401
+
+    _HAS_ASYNC = True
+except ImportError:  # pragma: no cover
+    _HAS_ASYNC = False
+
+
+def require_async() -> None:
+    """当异步支持不可用时立即抛出 ``ImportError``.
+
+    应在依赖 ``sqlalchemy.ext.asyncio`` 的文件 **模块级别** 调用,
+    以便用户看到清晰的错误信息而非深层调用栈中的 ``AttributeError``.
+    """
+    if not _HAS_ASYNC:
+        raise ImportError(
+            "Async support requires 'sqlalchemy[asyncio]' (greenlet). "
+            "Install with: pip install 'lush-sqlalchemyx[asyncio]'"
+        )

lush_sqlalchemyx-0.2.0/src/lush_sqlalchemyx/base/dal/__init__.py

@@ -0,0 +1,147 @@
+"""``lush_sqlalchemyx.base.dal`` 公共导出层.
+
+所有原先可从此模块导入的符号保持不变, 同时新增同步模式相关符号.
+"""
+
+# --- shared (sync/async agnostic) ---
+from ._common import (
+    DEFAULT_RETRY_CONFIG,
+    OPTIMISTIC_LOCK_ERROR_MSG_TRAIT,
+    PESSIMISTIC_LOCK_ERROR_MSG_TRAIT,
+    READONLY_SESSION_FLAG,
+    BaseCU,
+    BaseDTO,
+    BaseModelT,
+    CUModelT,
+    DBRetryableError,
+    DTOModelT,
+    FieldMixin,
+    ReadOnlyMixin,
+    RetryConfig,
+    SQLATableT,
+    SoftDeleteTableMixin,
+    StdBaseCU,
+    StdBaseDTO,
+    T,
+    V,
+    _ensure_strict_fields,
+    escape_like,
+    filtered_in_sql_values,
+)
+
+# Event listener references — accessed by tests via getattr(module, name).
+from ._common import __prevent_readonly_write as __prevent_readonly_write  # noqa: F401, PLC2701
+from ._common import __receive_before_flush as __receive_before_flush  # noqa: F401, PLC2701
+
+# --- async (requires sqlalchemy[asyncio]) ---
+from ._async import (
+    AsyncBaseDAL,
+    AsyncRawDAL,
+    AsyncRawReadDAL,
+    AsyncReadDAL,
+    AsyncSQLATableT,
+    AsyncSqlATableBase,
+    AsyncWriteDAL,
+    AsyncXDALOp,
+    BasicAsyncBaseTable,
+    ReadOnlyAsyncBaseDAL,
+    ReadOnlyBasicAsyncBaseTable,
+    StdAsyncBaseTable,
+    StdReadOnlyBasicAsyncBaseTable,
+    async_temp_set_lock_wait_timeout,
+    async_with_retry,
+)
+
+# --- lush-dal-protocol protocols (ORM 无关的抽象层) ---
+from lush_dal_protocol import (
+    AsyncBaseDALProtocol,
+    AsyncReadDALProtocol,
+    AsyncWriteDALProtocol,
+    SyncBaseDALProtocol,
+    SyncReadDALProtocol,
+    SyncWriteDALProtocol,
+)
+
+# --- sync ---
+from ._sync import (
+    BasicSyncBaseTable,
+    ReadOnlySyncBaseDAL,
+    ReadOnlySyncBaseTable,
+    StdReadOnlySyncBaseTable,
+    StdSyncBaseTable,
+    SyncBaseDAL,
+    SyncRawDAL,
+    SyncRawReadDAL,
+    SyncReadDAL,
+    SyncSQLATableT,
+    SyncSqlATableBase,
+    SyncWriteDAL,
+    SyncXDALOp,
+    sync_temp_set_lock_wait_timeout,
+    sync_with_retry,
+)
+
+__all__ = (
+    # common
+    "DEFAULT_RETRY_CONFIG",
+    "OPTIMISTIC_LOCK_ERROR_MSG_TRAIT",
+    "PESSIMISTIC_LOCK_ERROR_MSG_TRAIT",
+    "READONLY_SESSION_FLAG",
+    "BaseCU",
+    "BaseDTO",
+    "BaseModelT",
+    "CUModelT",
+    "DBRetryableError",
+    "DTOModelT",
+    "FieldMixin",
+    "ReadOnlyMixin",
+    "RetryConfig",
+    "SQLATableT",
+    "SoftDeleteTableMixin",
+    "StdBaseCU",
+    "StdBaseDTO",
+    "T",
+    "V",
+    "_ensure_strict_fields",
+    "escape_like",
+    "filtered_in_sql_values",
+    # async
+    "AsyncBaseDAL",
+    "AsyncRawDAL",
+    "AsyncRawReadDAL",
+    "AsyncReadDAL",
+    "AsyncSQLATableT",
+    "AsyncSqlATableBase",
+    "AsyncWriteDAL",
+    "AsyncXDALOp",
+    "BasicAsyncBaseTable",
+    "ReadOnlyAsyncBaseDAL",
+    "ReadOnlyBasicAsyncBaseTable",
+    "StdAsyncBaseTable",
+    "StdReadOnlyBasicAsyncBaseTable",
+    "async_temp_set_lock_wait_timeout",
+    "async_with_retry",
+    # sync
+    "BasicSyncBaseTable",
+    "ReadOnlySyncBaseDAL",
+    "ReadOnlySyncBaseTable",
+    "StdReadOnlySyncBaseTable",
+    "StdSyncBaseTable",
+    "SyncBaseDAL",
+    "SyncRawDAL",
+    "SyncRawReadDAL",
+    "SyncReadDAL",
+    "SyncSQLATableT",
+    "SyncSqlATableBase",
+    "SyncWriteDAL",
+    "SyncXDALOp",
+    "sync_temp_set_lock_wait_timeout",
+    "sync_with_retry",
+    # lush-dal-protocol protocols
+    "AsyncBaseDALProtocol",
+    "AsyncReadDALProtocol",
+    "AsyncWriteDALProtocol",
+    "SyncBaseDALProtocol",
+    "SyncReadDALProtocol",
+    "SyncWriteDALProtocol",
+)