sqlalchemy-dlock 0.4__tar.gz → 0.5__tar.gz

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v0.5
+
+Date: 2023-12-06
+
+- New:
+  - `contextual_timeout` parameter for “with” statement
+  - Support Python 3.12
+
 ## v0.4
 
 Date: 2023-06-17
@@ -95,7 +103,7 @@ Date: 2021-03-09
 
     - `sadlock` -> `create_sadlock`
     - `asyncio.sadlock` -> `asyncio.create_async_sadlock`
-  
+
     and some other ...
 
 ## v0.2a1

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/MANIFEST.in

@@ -1,8 +1,11 @@
 exclude .*
 exclude *.docker-compose.yml
+exclude *.requirements.txt
 exclude codecov.yml
+exclude coverage.*
 
 prune .*
 prune docs
-prune tests
 prune scripts
+prune tests
+prune htmlcov

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlalchemy-dlock
-Version: 0.4
+Version: 0.5
 Summary: A distributed lock implementation based on SQLAlchemy
 Author-email: liu xue yan <liu_xue_yan@foxmail.com>
 License: BSD-3-Clause
@@ -14,33 +14,49 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: SQLAlchemy<3.0,>=1.4
 Provides-Extra: asyncio
+Requires-Dist: SQLAlchemy[asyncio]<3.0,>=1.4; extra == "asyncio"
 Provides-Extra: mysqlclient
+Requires-Dist: mysqlclient; extra == "mysqlclient"
 Provides-Extra: pymysql
+Requires-Dist: pymysql; extra == "pymysql"
 Provides-Extra: aiomysql
+Requires-Dist: SQLAlchemy[asyncio]<3.0,>=1.4; extra == "aiomysql"
+Requires-Dist: aiomysql; extra == "aiomysql"
 Provides-Extra: psycopg2
+Requires-Dist: psycopg2>=2.8; extra == "psycopg2"
 Provides-Extra: psycopg2-binary
+Requires-Dist: psycopg2-binary>=2.8; extra == "psycopg2-binary"
 Provides-Extra: psycopg3
+Requires-Dist: SQLAlchemy<3.0,>=2.0; extra == "psycopg3"
+Requires-Dist: psycopg; extra == "psycopg3"
 Provides-Extra: psycopg3-binary
+Requires-Dist: SQLAlchemy<3.0,>=2.0; extra == "psycopg3-binary"
+Requires-Dist: psycopg[binary]; extra == "psycopg3-binary"
 Provides-Extra: psycopg3-c
-Provides-Extra: asyncpg3
-License-File: LICENSE
-License-File: AUTHORS.md
+Requires-Dist: SQLAlchemy<3.0,>=2.0; extra == "psycopg3-c"
+Requires-Dist: psycopg[c]; extra == "psycopg3-c"
+Provides-Extra: asyncpg
+Requires-Dist: SQLAlchemy[asyncio]<3.0,>=1.4; extra == "asyncpg"
+Requires-Dist: asyncpg; extra == "asyncpg"
 
-# SQLAlchemy-DLock
+# sqlalchemy-dlock
 
 [![Python package](https://github.com/tanbro/sqlalchemy-dlock/actions/workflows/python-package.yml/badge.svg)](https://github.com/tanbro/sqlalchemy-dlock/actions/workflows/python-package.yml)
 [![PyPI](https://img.shields.io/pypi/v/sqlalchemy-dlock)](https://pypi.org/project/sqlalchemy-dlock/)
-[![Documentation Status](https://readthedocs.org/projects/sqlalchemy-dlock/badge/?version=latest)](https://sqlalchemy-dlock.readthedocs.io/en/latest/?badge=latest)
-[![codecov](https://codecov.io/gh/tanbro/sqlalchemy-dlock/branch/main/graph/badge.svg?token=GfcDT1ckFX)](https://codecov.io/gh/tanbro/sqlalchemy-dlock)
+[![Documentation Status](https://readthedocs.org/projects/sqlalchemy-dlock/badge/?version=latest)](https://sqlalchemy-dlock.readthedocs.io/en/latest/)
+[![codecov](https://codecov.io/gh/tanbro/sqlalchemy-dlock/branch/main/graph/badge.svg)](https://codecov.io/gh/tanbro/sqlalchemy-dlock)
 
-Distributed lock based on Database and [SQLAlchemy][].
+`sqlalchemy-dlock` is a distributed-lock library based on Database and [SQLAlchemy][].
 
 It currently supports below locks:
 
  Database  |                                             Lock
 ---------- | ---------------------------------------------------------------------------------------------
-MySQL      | [named lock](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html)
+MySQL      | [named lock](https://dev.mysql.com/doc/refman/en/locking-functions.html)
 PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS)
 
 ## Install
@@ -51,7 +67,7 @@ pip install sqlalchemy-dlock
 
 ## Usage
 
-- Work with [SQLAlchemy][] `Connection`:
+- Work with [SQLAlchemy][] [`Connection`](https://docs.sqlalchemy.org/20/core/connections.html):
 
   ```python
   from sqlalchemy import create_engine
@@ -110,7 +126,7 @@ pip install sqlalchemy-dlock
       assert not lock2.locked
   ```
 
-- Work with [SQLAlchemy][] `ORM` session:
+- Work with [SQLAlchemy][] [`ORM` `Session`](https://docs.sqlalchemy.org/en/20/orm/session.html):
 
   ```python
   from sqlalchemy import create_engine
@@ -130,10 +146,10 @@ pip install sqlalchemy-dlock
 
 - Asynchronous I/O Support
 
-  > **Note**:
+  > **NOTE**
   >
-  > - [SQLAlchemy][] `1.x`: <https://docs.sqlalchemy.org/14/orm/extensions/asyncio.html>
-  > - [SQLAlchemy][] `2.x`: <https://docs.sqlalchemy.org/20/orm/extensions/asyncio.html>
+  > - [SQLAlchemy][] `1.x`'s asynchronous I/O: <https://docs.sqlalchemy.org/14/orm/extensions/asyncio.html>
+  > - [SQLAlchemy][] `2.x`'s asynchronous I/O: <https://docs.sqlalchemy.org/20/orm/extensions/asyncio.html>
 
   ```python
   from sqlalchemy.ext.asyncio import create_async_engine
@@ -143,7 +159,7 @@ pip install sqlalchemy-dlock
 
   engine = create_async_engine('postgresql+asyncpg://scott:tiger@127.0.0.1/')
 
-  async with engine.begin() as conn:
+  async with engine.connect() as conn:
       async with create_async_sadlock(conn, key) as lock:
           assert lock.locked
           await lock.release()
@@ -152,22 +168,20 @@ pip install sqlalchemy-dlock
       assert not lock.locked
   ```
 
-  > **Note**:
+  > **NOTE**
   >
-  > [aiomysql][], [asyncpg][] and [psycopg][] are tested asynchronous drivers
+  > [aiomysql][], [asyncpg][] and [psycopg][] are tested asynchronous drivers.
   >
-  > We can install asynchronous DB libraries like one of blows:
+  > We can install it with asynchronous DB libraries:
   >
   > - ```bash
-  >   pip install sqlalchemy-dlock[asyncpg]
+  >   pip install SQLAlchemy[asyncio] aiomysql sqlalchemy-dlock
   >   ```
   >
-  > - ```bash
-  >   pip install sqlalchemy-dlock[asyncio] aiomysql
-  >   ```
+  > or
   >
   > - ```bash
-  >   pip install SQLALchemy[asyncio] sqlalchemy-dlock psycopg
+  >   pip install SQLAlchemy[asyncio] asyncpg sqlalchemy-dlock
   >   ```
 
 ## Test
@@ -179,7 +193,7 @@ Following drivers are tested:
   - [pymysql][] (synchronous)
   - [aiomysql][] (asynchronous)
 - Postgres:
-  - [psycopg2][] (asynchronous)
+  - [psycopg2][] (synchronous)
   - [asyncpg][] (asynchronous)
   - [psycopg][] (synchronous and asynchronous)
 
@@ -187,15 +201,15 @@ You can run unit-tests
 
 - on local environment:
 
-  1. Install the project with drivers and `asyncio` extra requires, a virtual environment ([venv][]) is strongly advised:
+  1. Install the project in editable mode with `asyncio` optional dependencies, and libraries/drivers needed in test. A virtual environment ([venv][]) is strongly advised:
 
      ```bash
-     pip install -e .[mysqlclient psycopg2-binary aiomysql asyncpg]
+     pip install -e .[asyncio] -r tests/requirements.txt
      ```
 
-  1. start up mysql and postgresql
+  1. start up mysql and postgresql service
 
-     There is a docker [compose][] file `db.docker-compose.yml` in the project dir,
+     There is a docker [compose][] file `db.docker-compose.yml` in project's top directory,
      which can be used to run mysql and postgresql develop environment conveniently:
 
      ```bash
@@ -204,48 +218,43 @@ You can run unit-tests
 
   1. set environment variables `TEST_URLS` and `TEST_ASYNC_URLS` for sync and async database connection url.
      Multiple connections separated by space.
-     The test cases load environment variables in `tests/.env`.
 
-     eg (and also the defaults):
+     eg: (following values are also the defaults, and can be omitted)
 
      ```ini
      TEST_URLS=mysql://test:test@127.0.0.1/test postgresql://postgres:test@127.0.0.1/
      TEST_ASYNC_URLS=mysql+aiomysql://test:test@127.0.0.1/test postgresql+asyncpg://postgres:test@127.0.0.1/
      ```
 
+     > **NOTE**
+     >
+     > The test cases would load environment variables from dot-env file `tests/.env`.
+
   1. run unit-test
 
      ```bash
      python -m unittest
      ```
 
-- or on docker-compose:
+- or on docker [compose][]:
 
-  1. build the project
+  Name of [compose][] services for Python and [SQLAlchemy][] version matrix defined in [compose][] file `docker-compose.yml` has such format:
 
-     ```bash
-     python -m pip install build && python -m build -w
-     ```
+      python{{X.Y}}-sqlalchemy{{X}}
 
-  1. run unit-test
+  For example, if want to run tests for Python `3.8` and [SQLAlchemy][] `1.x`, we shall up to run unit-tests as below:
 
-     Name of services for Python and [SQLAlchemy][] version matrix in the [compose][] file has such format:
-
-         python{{X.Y}}-sqlalchemy{{X}}
-
-     For example, if want to take a test for Python `3.9` and [SQLAlchemy][] `2.x`, we shall up to run unit-tests as below:
-
-     ```bash
-     cd tests
-     docker compose up python3.9-sqlalchemy2
-     ```
+  ```bash
+  cd tests
+  docker compose up python3.8-sqlalchemy1
+  ```
 
-     For Python `3.8` and [SQLAlchemy][] `1.x`:
+  For Python `3.10` and [SQLAlchemy][] `2.x`:
 
-     ```bash
-     cd tests
-     docker compose up python3.8-sqlalchemy1
-     ```
+  ```bash
+  cd tests
+  docker compose up python3.10-sqlalchemy2
+  ```
 
 [SQLAlchemy]: https://www.sqlalchemy.org/ "The Python SQL Toolkit and Object Relational Mapper"
 [venv]: https://docs.python.org/library/venv.html "The venv module supports creating lightweight “virtual environments”, each with their own independent set of Python packages installed in their site directories. "

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/README.md

@@ -1,17 +1,17 @@
-# SQLAlchemy-DLock
+# sqlalchemy-dlock
 
 [![Python package](https://github.com/tanbro/sqlalchemy-dlock/actions/workflows/python-package.yml/badge.svg)](https://github.com/tanbro/sqlalchemy-dlock/actions/workflows/python-package.yml)
 [![PyPI](https://img.shields.io/pypi/v/sqlalchemy-dlock)](https://pypi.org/project/sqlalchemy-dlock/)
-[![Documentation Status](https://readthedocs.org/projects/sqlalchemy-dlock/badge/?version=latest)](https://sqlalchemy-dlock.readthedocs.io/en/latest/?badge=latest)
-[![codecov](https://codecov.io/gh/tanbro/sqlalchemy-dlock/branch/main/graph/badge.svg?token=GfcDT1ckFX)](https://codecov.io/gh/tanbro/sqlalchemy-dlock)
+[![Documentation Status](https://readthedocs.org/projects/sqlalchemy-dlock/badge/?version=latest)](https://sqlalchemy-dlock.readthedocs.io/en/latest/)
+[![codecov](https://codecov.io/gh/tanbro/sqlalchemy-dlock/branch/main/graph/badge.svg)](https://codecov.io/gh/tanbro/sqlalchemy-dlock)
 
-Distributed lock based on Database and [SQLAlchemy][].
+`sqlalchemy-dlock` is a distributed-lock library based on Database and [SQLAlchemy][].
 
 It currently supports below locks:
 
  Database  |                                             Lock
 ---------- | ---------------------------------------------------------------------------------------------
-MySQL      | [named lock](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html)
+MySQL      | [named lock](https://dev.mysql.com/doc/refman/en/locking-functions.html)
 PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS)
 
 ## Install
@@ -22,7 +22,7 @@ pip install sqlalchemy-dlock
 
 ## Usage
 
-- Work with [SQLAlchemy][] `Connection`:
+- Work with [SQLAlchemy][] [`Connection`](https://docs.sqlalchemy.org/20/core/connections.html):
 
   ```python
   from sqlalchemy import create_engine
@@ -81,7 +81,7 @@ pip install sqlalchemy-dlock
       assert not lock2.locked
   ```
 
-- Work with [SQLAlchemy][] `ORM` session:
+- Work with [SQLAlchemy][] [`ORM` `Session`](https://docs.sqlalchemy.org/en/20/orm/session.html):
 
   ```python
   from sqlalchemy import create_engine
@@ -101,10 +101,10 @@ pip install sqlalchemy-dlock
 
 - Asynchronous I/O Support
 
-  > **Note**:
+  > **NOTE**
   >
-  > - [SQLAlchemy][] `1.x`: <https://docs.sqlalchemy.org/14/orm/extensions/asyncio.html>
-  > - [SQLAlchemy][] `2.x`: <https://docs.sqlalchemy.org/20/orm/extensions/asyncio.html>
+  > - [SQLAlchemy][] `1.x`'s asynchronous I/O: <https://docs.sqlalchemy.org/14/orm/extensions/asyncio.html>
+  > - [SQLAlchemy][] `2.x`'s asynchronous I/O: <https://docs.sqlalchemy.org/20/orm/extensions/asyncio.html>
 
   ```python
   from sqlalchemy.ext.asyncio import create_async_engine
@@ -114,7 +114,7 @@ pip install sqlalchemy-dlock
 
   engine = create_async_engine('postgresql+asyncpg://scott:tiger@127.0.0.1/')
 
-  async with engine.begin() as conn:
+  async with engine.connect() as conn:
       async with create_async_sadlock(conn, key) as lock:
           assert lock.locked
           await lock.release()
@@ -123,22 +123,20 @@ pip install sqlalchemy-dlock
       assert not lock.locked
   ```
 
-  > **Note**:
+  > **NOTE**
   >
-  > [aiomysql][], [asyncpg][] and [psycopg][] are tested asynchronous drivers
+  > [aiomysql][], [asyncpg][] and [psycopg][] are tested asynchronous drivers.
   >
-  > We can install asynchronous DB libraries like one of blows:
+  > We can install it with asynchronous DB libraries:
   >
   > - ```bash
-  >   pip install sqlalchemy-dlock[asyncpg]
+  >   pip install SQLAlchemy[asyncio] aiomysql sqlalchemy-dlock
   >   ```
   >
-  > - ```bash
-  >   pip install sqlalchemy-dlock[asyncio] aiomysql
-  >   ```
+  > or
   >
   > - ```bash
-  >   pip install SQLALchemy[asyncio] sqlalchemy-dlock psycopg
+  >   pip install SQLAlchemy[asyncio] asyncpg sqlalchemy-dlock
   >   ```
 
 ## Test
@@ -150,7 +148,7 @@ Following drivers are tested:
   - [pymysql][] (synchronous)
   - [aiomysql][] (asynchronous)
 - Postgres:
-  - [psycopg2][] (asynchronous)
+  - [psycopg2][] (synchronous)
   - [asyncpg][] (asynchronous)
   - [psycopg][] (synchronous and asynchronous)
 
@@ -158,15 +156,15 @@ You can run unit-tests
 
 - on local environment:
 
-  1. Install the project with drivers and `asyncio` extra requires, a virtual environment ([venv][]) is strongly advised:
+  1. Install the project in editable mode with `asyncio` optional dependencies, and libraries/drivers needed in test. A virtual environment ([venv][]) is strongly advised:
 
      ```bash
-     pip install -e .[mysqlclient psycopg2-binary aiomysql asyncpg]
+     pip install -e .[asyncio] -r tests/requirements.txt
      ```
 
-  1. start up mysql and postgresql
+  1. start up mysql and postgresql service
 
-     There is a docker [compose][] file `db.docker-compose.yml` in the project dir,
+     There is a docker [compose][] file `db.docker-compose.yml` in project's top directory,
      which can be used to run mysql and postgresql develop environment conveniently:
 
      ```bash
@@ -175,48 +173,43 @@ You can run unit-tests
 
   1. set environment variables `TEST_URLS` and `TEST_ASYNC_URLS` for sync and async database connection url.
      Multiple connections separated by space.
-     The test cases load environment variables in `tests/.env`.
 
-     eg (and also the defaults):
+     eg: (following values are also the defaults, and can be omitted)
 
      ```ini
      TEST_URLS=mysql://test:test@127.0.0.1/test postgresql://postgres:test@127.0.0.1/
      TEST_ASYNC_URLS=mysql+aiomysql://test:test@127.0.0.1/test postgresql+asyncpg://postgres:test@127.0.0.1/
      ```
 
+     > **NOTE**
+     >
+     > The test cases would load environment variables from dot-env file `tests/.env`.
+
   1. run unit-test
 
      ```bash
      python -m unittest
      ```
 
-- or on docker-compose:
-
-  1. build the project
+- or on docker [compose][]:
 
-     ```bash
-     python -m pip install build && python -m build -w
-     ```
-
-  1. run unit-test
+  Name of [compose][] services for Python and [SQLAlchemy][] version matrix defined in [compose][] file `docker-compose.yml` has such format:
 
-     Name of services for Python and [SQLAlchemy][] version matrix in the [compose][] file has such format:
+      python{{X.Y}}-sqlalchemy{{X}}
 
-         python{{X.Y}}-sqlalchemy{{X}}
+  For example, if want to run tests for Python `3.8` and [SQLAlchemy][] `1.x`, we shall up to run unit-tests as below:
 
-     For example, if want to take a test for Python `3.9` and [SQLAlchemy][] `2.x`, we shall up to run unit-tests as below:
-
-     ```bash
-     cd tests
-     docker compose up python3.9-sqlalchemy2
-     ```
+  ```bash
+  cd tests
+  docker compose up python3.8-sqlalchemy1
+  ```
 
-     For Python `3.8` and [SQLAlchemy][] `1.x`:
+  For Python `3.10` and [SQLAlchemy][] `2.x`:
 
-     ```bash
-     cd tests
-     docker compose up python3.8-sqlalchemy1
-     ```
+  ```bash
+  cd tests
+  docker compose up python3.10-sqlalchemy2
+  ```
 
 [SQLAlchemy]: https://www.sqlalchemy.org/ "The Python SQL Toolkit and Object Relational Mapper"
 [venv]: https://docs.python.org/library/venv.html "The venv module supports creating lightweight “virtual environments”, each with their own independent set of Python packages installed in their site directories. "

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/pyproject.toml

@@ -23,27 +23,27 @@ dynamic = ["version"]
 requires-python = ">=3.7"
 # requires
 dependencies = [
-  "SQLAlchemy>=1.4.3,<3.0",
+  "SQLAlchemy>=1.4,<3.0",
 ]
 # extra requires
 [project.optional-dependencies]
 # SQLAlchemy with asyncio, no engines
-asyncio = ["SQLAlchemy[asyncio]"]
+asyncio = ["SQLAlchemy[asyncio]>=1.4,<3.0"]
 # MySQL
 mysqlclient = ["mysqlclient"]
 pymysql = ["pymysql"]
 # MySQL asyncio
-aiomysql = ["SQLAlchemy[asyncio]", "aiomysql"]
+aiomysql = ["SQLAlchemy[asyncio]>=1.4,<3.0", "aiomysql"]
 # Postgres
 # psycopg2: sync
 psycopg2 = ["psycopg2>=2.8"] # psycopg2 compiling needed when install
 psycopg2-binary = ["psycopg2-binary>=2.8"] # psycopg2 with pre-compiled C library
 # psycopg3: both sync and asyncio
-psycopg3 = ["SQLAlchemy>=2.0", "psycopg"] # psycopg3 dynamik link to libpq
-psycopg3-binary = ["SQLAlchemy>=2.0", "psycopg[binary]"] # psycopg3 with pre-compiled C library
-psycopg3-c = ["SQLAlchemy>=2.0", "psycopg[c]"] # psycopg3 compiling needed when install
+psycopg3 = ["SQLAlchemy>=2.0,<3.0", "psycopg"] # psycopg3 dynamik link to libpq
+psycopg3-binary = ["SQLAlchemy>=2.0,<3.0", "psycopg[binary]"] # psycopg3 with pre-compiled C library
+psycopg3-c = ["SQLAlchemy>=2.0,<3.0", "psycopg[c]"] # psycopg3 compiling needed when install
 # Postgres asyncio
-asyncpg3 = ["SQLAlchemy[asyncio]", "asyncpg"]
+asyncpg = ["SQLAlchemy[asyncio]>=1.4,<3.0", "asyncpg"]
 
 # Project links
 [project.urls]
@@ -57,10 +57,7 @@ where = ["src"]
 [tool.setuptools_scm]
 write_to = "src/sqlalchemy_dlock/version.py"
 
-[options.packages.find]
-where = "src"
-
 [tool.black]
-line-length = 127
+line-length = 128
 [tool.isort]
 profile = "black"

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/src/sqlalchemy_dlock/__init__.py

@@ -3,5 +3,5 @@ Distributed lock based on Database and SQLAlchemy
 """
 
 from .exceptions import *
-from .functions import *
+from .factory import *
 from .version import version as __version__

sqlalchemy-dlock-0.5/src/sqlalchemy_dlock/asyncio/__init__.py

@@ -0,0 +1 @@
+from .factory import *

sqlalchemy-dlock-0.4/src/sqlalchemy_dlock/asyncio/functions.py → sqlalchemy-dlock-0.5/src/sqlalchemy_dlock/asyncio/factory.py

@@ -1,15 +1,18 @@
 from importlib import import_module
+from typing import Union
 
 from sqlalchemy.engine import Connection
 from sqlalchemy.ext.asyncio import AsyncConnection
 
-from ..utils import safe_name
-from .baselock import BaseAsyncSadLock, TAsyncConnectionOrSession
+from ..utils import pascal_case, safe_name
+from .lock.base import BaseAsyncSadLock, TAsyncConnectionOrSession
 
 __all__ = ["create_async_sadlock"]
 
 
-def create_async_sadlock(connection_or_session: TAsyncConnectionOrSession, key, *args, **kwargs) -> BaseAsyncSadLock:
+def create_async_sadlock(
+    connection_or_session: TAsyncConnectionOrSession, key, contextual_timeout: Union[float, int, None] = None, **kwargs
+) -> BaseAsyncSadLock:
     if isinstance(connection_or_session, AsyncConnection):
         sync_engine = connection_or_session.sync_engine
     else:
@@ -23,5 +26,5 @@ def create_async_sadlock(connection_or_session: TAsyncConnectionOrSession, key,
         mod = import_module(f"..lock.{engine_name}", __name__)
     except ImportError as exception:  # pragma: no cover
         raise NotImplementedError(f"{engine_name}: {exception}")
-    lock_cls = getattr(mod, "AsyncSadLock")
-    return lock_cls(connection_or_session, key, *args, **kwargs)
+    clz = getattr(mod, f"{pascal_case(engine_name)}AsyncSadLock")
+    return clz(connection_or_session, key, contextual_timeout=contextual_timeout, **kwargs)

sqlalchemy-dlock-0.4/src/sqlalchemy_dlock/asyncio/baselock.py → sqlalchemy-dlock-0.5/src/sqlalchemy_dlock/asyncio/lock/base.py

@@ -6,13 +6,24 @@ TAsyncConnectionOrSession = Union[AsyncConnection, AsyncSession, async_scoped_se
 
 
 class BaseAsyncSadLock:
-    def __init__(self, connection_or_session: TAsyncConnectionOrSession, key: Any, *args, **kwargs):
+    def __init__(
+        self,
+        connection_or_session: TAsyncConnectionOrSession,
+        key: Any,
+        /,
+        contextual_timeout: Union[float, int, None] = None,
+        **kwargs,
+    ):
         self._acquired = False
         self._connection_or_session = connection_or_session
         self._key = key
+        self._contextual_timeout = contextual_timeout
 
     async def __aenter__(self):
-        await self.acquire()
+        if self._contextual_timeout is None:
+            await self.acquire()
+        elif not await self.acquire(timeout=self._contextual_timeout):  # the timeout period has elapsed and not acquired
+            raise TimeoutError()
         return self
 
     async def __aexit__(self, exc_type, exc_value, exc_tb):
@@ -35,10 +46,12 @@ class BaseAsyncSadLock:
     def locked(self) -> bool:
         return self._acquired
 
-    async def acquire(self, block: bool = True, timeout: Union[float, int, None] = None, *args, **kwargs) -> bool:
+    async def acquire(
+        self, block: bool = True, timeout: Union[float, int, None] = None, *args, **kwargs
+    ) -> bool:  # pragma: no cover
         raise NotImplementedError()
 
-    async def release(self, *args, **kwargs):
+    async def release(self, *args, **kwargs):  # pragma: no cover
         raise NotImplementedError()
 
     async def close(self, *args, **kwargs):

{sqlalchemy-dlock-0.4 → sqlalchemy-dlock-0.5}/src/sqlalchemy_dlock/asyncio/lock/mysql.py

@@ -1,8 +1,8 @@
 from typing import Any, Callable, Optional, Union
 
 from ...exceptions import SqlAlchemyDLockDatabaseError
-from ...statement.mysql import STATEMENTS
-from ..baselock import BaseAsyncSadLock, TAsyncConnectionOrSession
+from ...statement.mysql import LOCK, UNLOCK
+from .base import BaseAsyncSadLock, TAsyncConnectionOrSession
 
 MYSQL_LOCK_NAME_MAX_LENGTH = 64
 
@@ -19,12 +19,9 @@ def default_convert(key: Union[bytearray, bytes, int, float]) -> str:
     return result
 
 
-class AsyncSadLock(BaseAsyncSadLock):
+class MysqlAsyncSadLock(BaseAsyncSadLock):
     def __init__(
-        self,
-        connection_or_session: TAsyncConnectionOrSession,
-        key,
-        convert: Optional[TConvertFunction] = None,
+        self, connection_or_session: TAsyncConnectionOrSession, key, /, convert: Optional[TConvertFunction] = None, **kwargs
     ):
         if convert:
             key = convert(key)
@@ -35,7 +32,7 @@ class AsyncSadLock(BaseAsyncSadLock):
         if len(key) > MYSQL_LOCK_NAME_MAX_LENGTH:
             raise ValueError(f"MySQL enforces a maximum length on lock names of {MYSQL_LOCK_NAME_MAX_LENGTH} characters.")
         #
-        super().__init__(connection_or_session, key)
+        super().__init__(connection_or_session, key, **kwargs)
 
     async def acquire(self, block: bool = True, timeout: Union[float, int, None] = None) -> bool:
         if self._acquired:
@@ -49,10 +46,8 @@ class AsyncSadLock(BaseAsyncSadLock):
                 timeout = 0
         else:
             timeout = 0
-        stmt = STATEMENTS["lock"].params(str=self._key, timeout=timeout)
-        r = await self.connection_or_session.stream(stmt)
-        ret_val = (await r.one())[0]
-
+        stmt = LOCK.params(str=self._key, timeout=timeout)
+        ret_val = (await self.connection_or_session.execute(stmt)).scalar_one()
         if ret_val == 1:
             self._acquired = True
         elif ret_val == 0:
@@ -66,9 +61,8 @@ class AsyncSadLock(BaseAsyncSadLock):
     async def release(self):
         if not self._acquired:
             raise ValueError("invoked on an unlocked lock")
-        stmt = STATEMENTS["unlock"].params(str=self._key)
-        r = await self.connection_or_session.stream(stmt)
-        ret_val = (await r.one())[0]
+        stmt = UNLOCK.params(str=self._key)
+        ret_val = (await self.connection_or_session.execute(stmt)).scalar_one()
         if ret_val == 1:
             self._acquired = False
         elif ret_val == 0:  # pragma: no cover
@@ -83,5 +77,5 @@ class AsyncSadLock(BaseAsyncSadLock):
                 "was never obtained by a call to GET_LOCK(), "
                 "or has previously been released."
             )
-        else:
+        else:  # pragma: no cover
             raise SqlAlchemyDLockDatabaseError(f"RELEASE_LOCK({self._key!r}) returns {ret_val}")