mithril-locks 0.1.0__tar.gz

mithril_locks-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+*.pyc
+__pycache__/**
+
+coverage
+docs/build
+dist/
+build/
+*.egg-info/
+
+.idea
+
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+
+.DS_STORE

mithril_locks-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mithril_locks-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: mithril-locks
+Version: 0.1.0
+Summary: Distributed locks with fencing tokens, sync and async APIs, and multiple backends
+Project-URL: Source, https://github.com/RohanDalton/mithril
+Project-URL: Issues, https://github.com/RohanDalton/mithril/issues
+Author-email: "Rohan B. Dalton" <rohan@rohandalton.io>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: asyncio,distributed-lock,fencing,locking,redis
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: opentelemetry-api<2,>=1.20.0
+Requires-Dist: redis<8,>=5.0
+Requires-Dist: sqlalchemy[asyncio]<3,>=2.0
+Requires-Dist: structlog<26,>=24.0.0
+Provides-Extra: async-postgres
+Requires-Dist: asyncpg<1,>=0.29; extra == 'async-postgres'
+Provides-Extra: async-sqlite
+Requires-Dist: aiosqlite<1,>=0.20; extra == 'async-sqlite'
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary<3,>=2.9; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# Mithril
+
+Mithril provides distributed locks with fencing tokens, ownership checks, TTLs,
+and opt-in automatic renewal. It includes synchronous and asynchronous APIs,
+Redis, Redis Cluster, Redlock, PostgreSQL, SQLite, and local file backends.
+
+## Installation
+
+```sh
+python -m pip install mithril-locks
+```
+
+The distribution is named `mithril-locks`; Python imports use `mithril`.
+Python 3.9 or newer is required. Database drivers are available as extras:
+
+```sh
+python -m pip install 'mithril-locks[postgres]'
+python -m pip install 'mithril-locks[async-postgres]'
+python -m pip install 'mithril-locks[async-sqlite]'
+```
+
+## Usage
+
+```python
+from redis import Redis
+
+from mithril import Lock
+from mithril.backends import RedisBackend
+
+client = Redis.from_url(
+    "redis://localhost:6379/0", socket_timeout=5, socket_connect_timeout=5
+)
+backend = RedisBackend(client)
+
+with Lock("payment", backend=backend, ttl=30, timeout=10) as token:
+    print(token.fencing_token)
+    # Pass the fencing token to your protected resource with each write.
+```
+
+Context managers release the lock on exit and return a `LockToken`. Lock objects
+are single-use. For work that may exceed the TTL, pass `auto_renewal=True`.
+
+The async API uses `mithril.aio.AsyncLock`,
+`mithril.backends.aio.AsyncRedisBackend`, and a `redis.asyncio.Redis` client:
+
+```python
+import asyncio
+
+from redis.asyncio import Redis
+
+from mithril.aio import AsyncLock
+from mithril.backends.aio import AsyncRedisBackend
+
+
+async def main():
+    async with Redis.from_url(
+        "redis://localhost:6379/0", socket_timeout=5, socket_connect_timeout=5
+    ) as client:
+        backend = AsyncRedisBackend(client)
+        async with AsyncLock("payment", backend=backend, ttl=30) as token:
+            print(token.fencing_token)
+
+
+asyncio.run(main())
+```
+
+## Fencing and durability
+
+Your downstream resource must atomically reject writes carrying a fencing token
+older than the highest token it has accepted. A TTL alone cannot stop a delayed
+holder from writing after its lease expires. Fencing counters must be durable:
+Redis failover, eviction, or restoration of an older snapshot can invalidate
+ordering guarantees. Redlock requires an explicit shared fencing authority.
+File locks are for processes on the same host.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

mithril_locks-0.1.0/README.md

@@ -0,0 +1,78 @@
+# Mithril
+
+Mithril provides distributed locks with fencing tokens, ownership checks, TTLs,
+and opt-in automatic renewal. It includes synchronous and asynchronous APIs,
+Redis, Redis Cluster, Redlock, PostgreSQL, SQLite, and local file backends.
+
+## Installation
+
+```sh
+python -m pip install mithril-locks
+```
+
+The distribution is named `mithril-locks`; Python imports use `mithril`.
+Python 3.9 or newer is required. Database drivers are available as extras:
+
+```sh
+python -m pip install 'mithril-locks[postgres]'
+python -m pip install 'mithril-locks[async-postgres]'
+python -m pip install 'mithril-locks[async-sqlite]'
+```
+
+## Usage
+
+```python
+from redis import Redis
+
+from mithril import Lock
+from mithril.backends import RedisBackend
+
+client = Redis.from_url(
+    "redis://localhost:6379/0", socket_timeout=5, socket_connect_timeout=5
+)
+backend = RedisBackend(client)
+
+with Lock("payment", backend=backend, ttl=30, timeout=10) as token:
+    print(token.fencing_token)
+    # Pass the fencing token to your protected resource with each write.
+```
+
+Context managers release the lock on exit and return a `LockToken`. Lock objects
+are single-use. For work that may exceed the TTL, pass `auto_renewal=True`.
+
+The async API uses `mithril.aio.AsyncLock`,
+`mithril.backends.aio.AsyncRedisBackend`, and a `redis.asyncio.Redis` client:
+
+```python
+import asyncio
+
+from redis.asyncio import Redis
+
+from mithril.aio import AsyncLock
+from mithril.backends.aio import AsyncRedisBackend
+
+
+async def main():
+    async with Redis.from_url(
+        "redis://localhost:6379/0", socket_timeout=5, socket_connect_timeout=5
+    ) as client:
+        backend = AsyncRedisBackend(client)
+        async with AsyncLock("payment", backend=backend, ttl=30) as token:
+            print(token.fencing_token)
+
+
+asyncio.run(main())
+```
+
+## Fencing and durability
+
+Your downstream resource must atomically reject writes carrying a fencing token
+older than the highest token it has accepted. A TTL alone cannot stop a delayed
+holder from writing after its lease expires. Fencing counters must be durable:
+Redis failover, eviction, or restoration of an older snapshot can invalidate
+ordering guarantees. Redlock requires an explicit shared fencing authority.
+File locks are for processes on the same host.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

mithril_locks-0.1.0/mithril/UPGRADING.md

@@ -0,0 +1,86 @@
+# Reliability changes
+
+## Before upgrading an existing deployment
+
+Stop all old-version lock users and drain their leases before starting the new
+version. Redis reader metadata and file lease metadata have changed; old and new
+holders must not run concurrently against the same resources.
+
+Preserve fencing history. Back up existing counters and remove their legacy Redis
+expirations with `PERSIST` during the maintenance window. Names and namespaces
+containing punctuation are now percent-encoded in Redis keys, so migrate those
+counters to the encoded keys without lowering their values. Cluster hash tags use
+the same encoding. Ordinary alphanumeric Redis fencing keys and file fencing
+counter paths are unchanged. While all file-lock users are stopped, remove their
+old `.lock` metadata files so the new format can be created. Keep the adjacent
+`.fence` counters and do not delete live `.guard` files.
+
+If an old counter has already expired, recover a floor from durable history or
+the downstream system's highest accepted token before resuming. Draining holders
+alone does not make resetting a fencing counter safe.
+
+## Redlock requires a fencing authority
+
+`RedlockConfig` now requires `fencing_provider`. Taking the maximum of independent
+node counters cannot order acquisitions across changing quorums. All clients
+locking the same resource must share the same persistent authority and namespace.
+Seed that authority at least as high as every previously issued or downstream-
+accepted token before migrating an existing Redlock deployment.
+
+```python
+from redis import Redis
+
+from mithril import RedisFencingTokenProvider
+from mithril.backends import RedlockBackend, RedlockConfig
+
+authority = Redis(
+    host="fencing-service",
+    socket_timeout=0.1,
+    socket_connect_timeout=0.1,
+)
+backend = RedlockBackend(
+    RedlockConfig(
+        instances=[Redis(host=host) for host in ("redis-a", "redis-b", "redis-c")],
+        fencing_provider=RedisFencingTokenProvider(authority),
+    )
+)
+```
+
+The authority must never roll back, expire, or evict issued counters. A Redis
+authority is only as durable as its deployment: asynchronous failover or restoring
+an old snapshot can violate this requirement. Supply a custom `FencingTokenProvider`
+backed by a suitable durable service when needed. The in-memory provider is for
+isolated tests only. Call `backend.close()` when finished to close its private
+bounded-timeout Redis pools; caller-owned clients are not closed.
+
+## Database backends
+
+An SQLAlchemy `Engine` / `AsyncEngine` is now accepted and recommended. Existing
+`Connection` / `AsyncConnection` arguments still work: Mithril borrows independent
+connections from their engine rather than sharing the caller's transaction.
+Configure bounded pool and driver timeouts appropriate for the lease TTL. Retry
+budgets cannot interrupt synchronous driver calls already in progress.
+
+SQLite requires a file-backed database with an independent-connection pool;
+`StaticPool` and `SingletonThreadPool` are rejected. In-memory databases cannot
+provide persistent fencing or safely shared transactions. Async backends still
+require `await backend.initialize()` before use.
+
+## Lifecycle behavior
+
+Nonblocking acquisition makes one attempt. Concurrent acquisition through the
+same facade is rejected. Expired or released instances remain single-use, expose
+no current token, and context exit raises on ownership loss unless preserving an
+exception from the context body. Renewals refresh the facade's deadline; backend
+latency and Redlock drift are subtracted from validity. A manually shortened TTL
+must still exceed the configured background-renewal interval, including jitter.
+
+File leases now allow takeover after TTL expiry even while the previous process
+is alive, and detect process crashes using OS locks. As with every TTL-based
+backend, downstream writes must enforce fencing tokens. A standalone guard check
+followed by an unrelated write is not an atomic fenced write.
+
+Logging and metrics failures no longer interrupt lease ownership or cleanup.
+Epochs are backend-issued persistent sequence numbers, not caller-supplied counts.
+The backend `epoch` argument remains accepted for compatibility but is ignored by
+the built-in backends.

mithril_locks-0.1.0/mithril/__init__.py

@@ -0,0 +1,67 @@
+"""
+Public API for Mithril.
+"""
+
+from __future__ import annotations
+
+from .__version__ import __version__
+from ._fencing import FencingTokenProvider, FileFencingTokenProvider, RedisFencingTokenProvider
+from ._observability import LockHooks, configure_logging, get_logger, set_hooks
+from ._types import LockConfig, LockMode, LockState, LockToken, Result
+from .exceptions import (
+    AlreadyAcquiredError,
+    AutoRenewalStoppedError,
+    BackendError,
+    BackendTimeoutError,
+    BackendUnavailableError,
+    ConfigurationError,
+    FencingTokenError,
+    LockAcquisitionError,
+    LockExpiredError,
+    LockReleaseError,
+    LockRenewalError,
+    LockTimeoutError,
+    MithrilError,
+    NotAcquiredError,
+    RenewalFailedError,
+    StaleTokenError,
+)
+from .lock import Lock
+
+__author__ = "Rohan B. Dalton"
+
+__all__ = [
+    "__version__",
+    "FencingTokenProvider",
+    "FileFencingTokenProvider",
+    "RedisFencingTokenProvider",
+    "LockConfig",
+    "LockMode",
+    "LockState",
+    "LockToken",
+    "Result",
+    "Lock",
+    "LockHooks",
+    "configure_logging",
+    "get_logger",
+    "set_hooks",
+    "MithrilError",
+    "LockAcquisitionError",
+    "LockTimeoutError",
+    "AlreadyAcquiredError",
+    "LockReleaseError",
+    "NotAcquiredError",
+    "LockExpiredError",
+    "LockRenewalError",
+    "RenewalFailedError",
+    "AutoRenewalStoppedError",
+    "FencingTokenError",
+    "StaleTokenError",
+    "BackendError",
+    "BackendUnavailableError",
+    "BackendTimeoutError",
+    "ConfigurationError",
+]
+
+if __name__ == "__main__":
+    pass

mithril_locks-0.1.0/mithril/__version__.py

@@ -0,0 +1,3 @@
+"""Single source of truth for the Mithril release version."""
+
+__version__ = "0.1.0"