leasepool 0.1.1__tar.gz

leasepool-0.1.1/.gitignore

@@ -0,0 +1,12 @@
+.venv/
+.vscode/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+.coverage
+htmlcov/

leasepool-0.1.1/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for leasepool.
+# Place this file in your project root.
+#
+# Reference:
+# https://docs.readthedocs.com/platform/stable/config-file/v2.html
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/source/conf.py
+  builder: html
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

leasepool-0.1.1/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.

leasepool-0.1.1/PKG-INFO

@@ -0,0 +1,345 @@
+Metadata-Version: 2.4
+Name: leasepool
+Version: 0.1.1
+Summary: Executor leasing, backpressure, and adaptive CPU/I/O offloading for async Python.
+Project-URL: Homepage, https://github.com/jackofsometrades99/leasepool
+Project-URL: Repository, https://pypi.org/project/leasepool/
+Project-URL: Documentation, https://leasepool.readthedocs.io/en/latest/
+Author: Sambhu Nampoothiri G
+License: Apache-2.0
+License-File: LICENSE
+Keywords: asyncio,backpressure,concurrent.futures,executor,processpool,threadpool
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# leasepool
+
+**Executor leasing, backpressure, and adaptive CPU/I/O offloading for async Python.**
+
+`leasepool` helps async applications borrow local executor capacity safely. Instead
+of passing raw `ThreadPoolExecutor` or `ProcessPoolExecutor` objects around your
+codebase, callers acquire short-lived leases, run synchronous work, and return the
+executor to the manager.
+
+Use it when you need to run blocking I/O, legacy sync SDK calls, or CPU-heavy
+functions from an `asyncio` application without letting unbounded executor usage
+spread through the service.
+
+## Install
+
+```bash
+pip install leasepool
+```
+
+For local development from this repository:
+
+```bash
+pip install -e .
+```
+
+## Project links
+
+- GitHub: https://github.com/jackofsometrades99/leasepool
+- PyPI: https://pypi.org/project/leasepool/
+- Official Documentation: https://leasepool.readthedocs.io/en/latest/
+
+## Free-threaded Python / no-GIL support
+
+`leasepool` is a pure Python package and does not ship native extension modules.
+It is intended to work on CPython free-threaded builds.
+
+Current support level:
+
+- CPython free-threaded builds: Stable
+- Package classifier: `Programming Language :: Python :: Free Threading :: 3 - Stable`
+
+Note that `leasepool` can manage executor leases safely, but functions submitted by
+users are still responsible for their own thread-safety when run concurrently.
+
+## Quickstart
+
+```python
+import asyncio
+import time
+
+from leasepool import ExecutorBackend, LeasedExecutorManager
+
+
+def blocking_uppercase(value: str) -> str:
+    time.sleep(0.2)
+    return value.upper()
+
+
+async def main() -> None:
+    manager = LeasedExecutorManager(
+        backend=ExecutorBackend.THREAD,
+        max_pools=2,
+        min_pools=1,
+        workers_per_pool=4,
+        name_prefix="quickstart-worker",
+    )
+
+    await manager.start()
+
+    try:
+        async with await manager.acquire(owner="quickstart") as lease:
+            result = await lease.run(blocking_uppercase, "hello leasepool")
+
+        print(result)
+    finally:
+        await manager.stop()
+
+
+asyncio.run(main())
+```
+
+## Core usage model
+
+A `LeasedExecutorManager` owns a bounded number of executor pools.
+
+```text
+async application
+  -> LeasedExecutorManager
+  -> ExecutorLease
+  -> ThreadPoolExecutor / ProcessPoolExecutor
+```
+
+The lease is the temporary right to submit work to one executor. Prefer the async
+context-manager style because it returns the lease automatically:
+
+```python
+async with await manager.acquire(owner="vendor-sdk-call") as lease:
+    result = await lease.run(sync_function, payload)
+```
+
+Manual release is also available when your control flow requires it:
+
+```python
+lease = await manager.acquire(owner="manual-flow")
+try:
+    result = await lease.run(sync_function)
+finally:
+    await lease.release()
+```
+
+`lease.executor` is a safe proxy. It supports `submit()`, but prevents callers
+from shutting down the internal executor or submitting after the lease expires or
+has been released.
+
+## Backends
+
+### Thread backend
+
+Use `backend="thread"` or `ExecutorBackend.THREAD` for blocking I/O:
+
+- blocking vendor SDKs
+- synchronous HTTP or database clients
+- file I/O
+- small blocking operations called from async services
+
+### Process backend
+
+Use `backend="process"` or `ExecutorBackend.PROCESS` for CPU-heavy Python work
+that should run across CPU cores:
+
+```python
+manager = LeasedExecutorManager(
+    backend=ExecutorBackend.PROCESS,
+    max_pools=1,
+    min_pools=1,
+    workers_per_pool=4,
+)
+```
+
+Functions, arguments, and return values submitted to the process backend must be
+picklable. Prefer top-level functions and simple serializable data. Do not submit
+lambdas, nested functions, sockets, database clients, or async clients.
+
+### Interpreter backend
+
+`backend="interpreter"` is reserved for Python 3.14+ `InterpreterPoolExecutor`.
+On earlier Python versions, selecting it raises `UnsupportedBackendError`.
+
+## Backpressure and waiting
+
+`max_pools` bounds the number of executor objects owned by one manager. If every
+pool is leased, `acquire()` waits by default:
+
+```python
+lease = await manager.acquire(owner="wait-for-capacity", timeout=2.0)
+```
+
+Fail immediately with `wait=False`:
+
+```python
+from leasepool import LeaseUnavailableError
+
+try:
+    lease = await manager.acquire(owner="no-wait", wait=False)
+except LeaseUnavailableError:
+    # Return HTTP 503, retry later, or enqueue elsewhere.
+    ...
+```
+
+## Lease expiry
+
+Each lease has a soft lifetime and a grace period:
+
+```python
+manager = LeasedExecutorManager(
+    backend="thread",
+    max_pools=2,
+    default_lease_seconds=300.0,
+    lease_grace_seconds=15.0,
+)
+
+lease = await manager.acquire(lease_seconds=30.0, owner="bounded-operation")
+```
+
+After `lease_seconds + lease_grace_seconds`, new submissions through that lease
+raise `LeaseExpiredError`. Existing work that was already submitted is left to the
+underlying executor semantics.
+
+## Adaptive sizing
+
+You can connect desired pool count to a runtime signal:
+
+```python
+connected_devices: set[str] = set()
+
+manager = LeasedExecutorManager(
+    backend="thread",
+    max_pools=10,
+    min_pools=1,
+    units_per_pool=10,
+    size_provider=lambda: len(connected_devices),
+)
+
+await manager.start()
+
+connected_devices.add("device-1")
+manager.notify_scale_changed()
+```
+
+The target executor count is:
+
+```text
+max(min_pools, ceil(size_provider() / units_per_pool))
+```
+
+capped by `max_pools`. Idle executors above the target are shut down. Active
+non-expired leases are not revoked just because the target shrinks.
+
+## WorkGrinder
+
+`WorkGrinder` batches many async submitters into leased executor batches:
+
+```python
+from leasepool import WorkGrinder
+
+grinder = WorkGrinder(
+    executor_manager=manager,
+    batch_size_threshold=50,
+    max_wait_seconds=2.0,
+    lease_seconds=60.0,
+)
+
+await grinder.start()
+
+try:
+    result = await grinder.submit(sync_function, payload, owner="item-1")
+finally:
+    await grinder.stop(cancel_pending=True)
+```
+
+Use:
+
+- `await grinder.submit(...)` to queue work and wait for its result.
+- `await grinder.enqueue(...)` to receive an `asyncio.Future` immediately.
+- `grinder.submit_from_thread(...)` from non-async code or another OS thread.
+- `grinder.stats()` for diagnostics from the event-loop thread.
+
+## Process worker log forwarding
+
+Worker-process logs do not automatically flow through the parent process logger.
+Enable forwarding when using the process backend:
+
+```python
+import logging
+
+from leasepool import LeasedExecutorManager, ProcessLoggingConfig
+
+manager = LeasedExecutorManager(
+    backend="process",
+    max_pools=1,
+    min_pools=1,
+    workers_per_pool=2,
+    process_logging=ProcessLoggingConfig(
+        enabled=True,
+        level="INFO",
+        target_logger=logging.getLogger("leasepool.process"),
+    ),
+)
+```
+
+A convenience form is also available:
+
+```python
+manager = LeasedExecutorManager(
+    backend="process",
+    max_pools=1,
+    forward_process_logs=True,
+    process_log_level="INFO",
+)
+```
+
+## Diagnostics
+
+```python
+print(manager.backend)
+print(manager.available_count)
+print(manager.leased_count)
+print(manager.total_count)
+print(manager.desired_executor_count())
+print(manager.stats())
+```
+
+`manager.stats()` includes backend, sizing, counts, workers per pool, and current
+lease expiry information.
+
+## Examples
+
+The `examples/` directory is designed as a learning path:
+
+```bash
+python examples/00_quickstart_thread_backend.py
+python examples/07_process_backend_cpu_work.py
+python examples/08_work_grinder_submit.py
+python examples/13_process_log_forwarding.py
+python examples/14_complete_library_walkthrough.py
+```
+
+For process-backend examples, run files directly instead of pasting them into a
+REPL. `ProcessPoolExecutor` needs importable top-level functions.
+
+See `README_EXAMPLES.md` for the complete example map.
+
+## What leasepool is not
+
+`leasepool` is not a distributed task queue. It does not provide persistence,
+remote workers, retries across machines, scheduling, or broker integration. It
+manages local executor capacity inside one Python process.