Merge pull request #9 from tanbro/develop

Develop
tanbro · Dec 1, 2024 · 2992161 · 2992161
2 parents 38a930b + cea3da3
commit 2992161
Show file tree

Hide file tree

Showing 34 changed files with 287 additions and 405 deletions.
diff --git a/README.md b/README.md
@@ -108,7 +108,7 @@ pip install sqlalchemy-dlock
 
   ```python
   from sqlalchemy.ext.asyncio import create_async_engine
-  from sqlalchemy_dlock.asyncio import create_async_sadlock
+  from sqlalchemy_dlock import create_async_sadlock
 
   key = 'user/001'
 

diff --git a/db.docker-compose.yml → docker-compose.database.yml b/db.docker-compose.yml → docker-compose.database.yml
diff --git a/docs/README.rst b/docs/README.rst
@@ -19,14 +19,20 @@ How to build docs
 
    .. code:: sh
 
-      sphinx-apidoc -o docs/apidocs -eMTf src
+      rm -fr docs/apidocs/* && sphinx-apidoc -o docs/apidocs -eMTf src
 
 #. Build HTML documentation:
 
    .. code:: sh
 
       make -C docs html
 
+   or rebuild it:
+
+   .. code:: sh
+
+      make -C docs clean html
+
 The built static web site is output to ``docs/_build/html``, we can serve it:
 
 .. code:: sh

diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.factory.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.factory.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.lock.base.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.lock.base.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.lock.mysql.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.lock.mysql.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.lock.postgresql.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.lock.postgresql.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.lock.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.lock.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.asyncio.types.rst b/docs/apidocs/sqlalchemy_dlock.asyncio.types.rst
diff --git a/docs/apidocs/sqlalchemy_dlock.registry.rst b/docs/apidocs/sqlalchemy_dlock.registry.rst
@@ -0,0 +1,7 @@
+sqlalchemy\_dlock.registry module
+=================================
+
+.. automodule:: sqlalchemy_dlock.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidocs/sqlalchemy_dlock.rst b/docs/apidocs/sqlalchemy_dlock.rst
@@ -12,7 +12,6 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
-   sqlalchemy_dlock.asyncio
    sqlalchemy_dlock.lock
    sqlalchemy_dlock.statement
 
@@ -24,5 +23,6 @@ Submodules
 
    sqlalchemy_dlock.exceptions
    sqlalchemy_dlock.factory
+   sqlalchemy_dlock.registry
    sqlalchemy_dlock.types
    sqlalchemy_dlock.utils
diff --git a/src/sqlalchemy_dlock/__init__.py b/src/sqlalchemy_dlock/__init__.py
@@ -4,4 +4,5 @@
 
 from ._version import __version__, __version_tuple__
 from .exceptions import SqlAlchemyDLockBaseException, SqlAlchemyDLockDatabaseError
-from .factory import create_sadlock
+from .factory import create_async_sadlock, create_sadlock
+from .lock import BaseAsyncSadLock, BaseSadLock
diff --git a/src/sqlalchemy_dlock/asyncio/__init__.py b/src/sqlalchemy_dlock/asyncio/__init__.py
diff --git a/src/sqlalchemy_dlock/asyncio/factory.py b/src/sqlalchemy_dlock/asyncio/factory.py
diff --git a/src/sqlalchemy_dlock/asyncio/lock/__init__.py b/src/sqlalchemy_dlock/asyncio/lock/__init__.py
diff --git a/src/sqlalchemy_dlock/asyncio/lock/base.py b/src/sqlalchemy_dlock/asyncio/lock/base.py
diff --git a/src/sqlalchemy_dlock/asyncio/lock/mysql.py b/src/sqlalchemy_dlock/asyncio/lock/mysql.py