thds.core 1.42.20250715194419__py3-none-any.whl → 1.43.20250718170951__py3-none-any.whl

thds/core/refcount.py

@@ -0,0 +1,99 @@
+"""There are times when what you want is a lazy-ish resource, but you don't want it to live forever - just for the duration of the current stack's usage.
+At the same time, if another thread or stack is currently using the resource, you want to reuse it.
+
+A good example of using this might be a ThreadPoolExecutor where multiple other threads might be doing similar work concurrently, and it would help if they could all share the same pool:
+
+```
+from concurrent.futures import ThreadPoolExecutor
+from thds.core import refcount
+
+
+shared_thread_pool = refcount.Resource(lambda: ThreadPoolExecutor())
+
+
+def do_work(thunks):
+    with shared_thread_pool.get() as thread_pool:
+        for res in parallel.yield_results(thunks, executor_cm=thread_pool):
+            print(res)
+        ...
+```
+"""
+
+import threading
+import typing as ty
+from contextlib import contextmanager
+
+from . import log
+
+R = ty.TypeVar("R")
+logger = log.getLogger(__name__)
+
+
+class _ContextProxy(ty.Generic[R]):
+    """A proxy to wrap a resource and neuter its context management methods."""
+
+    def __init__(self, resource: R):
+        self._resource = resource
+
+    def __getattr__(self, name: str) -> ty.Any:
+        return getattr(self._resource, name)
+
+    def __enter__(self) -> R:
+        # The user might still do `with proxy: ...`. We allow it,
+        # but it does nothing and just returns the underlying resource.
+        return self._resource
+
+    def __exit__(self, *args: ty.Any) -> None:
+        # This is a no-op; the real cleanup is handled by _RefCountResource
+        pass
+
+
+class _RefCountResource(ty.Generic[R]):
+    def __init__(self, factory: ty.Callable[[], ty.ContextManager[R]]) -> None:
+        self._factory = factory
+        self._rcm__exit__: ty.Optional[ty.Callable[[ty.Any, ty.Any, ty.Any], ty.Optional[bool]]] = None
+        self._resource: ty.Optional[R] = None
+        self._ref_count: int = 0
+        self._lock = threading.RLock()
+
+    @contextmanager
+    def get(self) -> ty.Iterator[R]:
+        with self._lock:
+            assert self._ref_count >= 0, "Reference count should not be negative prior to incrementing"
+            if self._ref_count == 0:
+                assert (
+                    self._rcm__exit__ is None
+                ), "Resource CM __exit__ should be None when ref count is zero"
+                assert self._resource is None, "Resource should be None when ref count is zero"
+                resource_cm = self._factory()
+                resource = resource_cm.__enter__()
+                self._rcm__exit__ = resource_cm.__exit__
+                if id(resource) == id(resource_cm):
+                    logger.info("Patching self-managing resource to avoid double exit: %s", resource)
+                    # this is one of those context managers that returns itself
+                    # since we manage this resource, we need to prevent others from trying to enter or exit it.
+                    resource = _ContextProxy(resource)  # type: ignore[assignment]
+                self._resource = resource
+            self._ref_count += 1
+            assert self._resource is not None, "Resource should not be None after incrementing ref count"
+            resource = self._resource
+        try:
+            yield resource
+
+        finally:
+            with self._lock:
+                self._ref_count -= 1
+                assert self._ref_count >= 0, "Reference count should not be negative after decrementing"
+                if self._ref_count == 0:
+                    assert (
+                        self._rcm__exit__ is not None
+                    ), "Resource CM __exit__ should not be None when ref count is zero"
+                    assert (
+                        self._resource is not None
+                    ), "Resource should not be None when ref count is zero"
+                    self._rcm__exit__(None, None, None)
+                    self._resource = None
+                    self._rcm__exit__ = None
+
+
+Resource = _RefCountResource  # probably preferable to use this name

{thds_core-1.42.20250715194419.dist-info → thds_core-1.43.20250718170951.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: thds.core
-Version: 1.42.20250715194419
+Version: 1.43.20250718170951
 Summary: Core utilities.
 Author-email: Trilliant Health <info@trillianthealth.com>
 License: MIT

{thds_core-1.42.20250715194419.dist-info → thds_core-1.43.20250718170951.dist-info}/RECORD

@@ -35,6 +35,7 @@ thds/core/progress.py,sha256=4YGbxliDl1i-k-88w4s86uy1E69eQ6xJySGPSkpH1QM,3358
 thds/core/project_root.py,sha256=K18U3MLthZnzmdrWmKKtHLd6iu7am9b2vNAThqknpfo,891
 thds/core/protocols.py,sha256=4na2EeWUDWfLn5-SxfMmKegDSndJ5z-vwMhDavhCpEM,409
 thds/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+thds/core/refcount.py,sha256=KWhF5vULrCUCJPoqh3X58JkbfYo8HmYpUrmCHjrUx64,4020
 thds/core/scaling.py,sha256=f7CtdgK0sN6nroTq5hLAkG8xwbWhbCZUULstSKjoxO0,1615
 thds/core/scope.py,sha256=9RWWCFRqsgjTyH6rzRm_WnO69N_sEBRaykarc2PAnBY,10834
 thds/core/source_serde.py,sha256=X4c7LiT3VidejqtTel9YB6dWGB3x-ct39KF9E50Nbx4,139
@@ -71,8 +72,8 @@ thds/core/sqlite/structured.py,sha256=SvZ67KcVcVdmpR52JSd52vMTW2ALUXmlHEeD-VrzWV
 thds/core/sqlite/types.py,sha256=oUkfoKRYNGDPZRk29s09rc9ha3SCk2SKr_K6WKebBFs,1308
 thds/core/sqlite/upsert.py,sha256=BmKK6fsGVedt43iY-Lp7dnAu8aJ1e9CYlPVEQR2pMj4,5827
 thds/core/sqlite/write.py,sha256=z0219vDkQDCnsV0WLvsj94keItr7H4j7Y_evbcoBrWU,3458
-thds_core-1.42.20250715194419.dist-info/METADATA,sha256=U8x8pK4LvE5VfZEEVGGiB8FVLdzmKm0Kn9sabHdmjHk,2216
-thds_core-1.42.20250715194419.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-thds_core-1.42.20250715194419.dist-info/entry_points.txt,sha256=bOCOVhKZv7azF3FvaWX6uxE6yrjK6FcjqhtxXvLiFY8,161
-thds_core-1.42.20250715194419.dist-info/top_level.txt,sha256=LTZaE5SkWJwv9bwOlMbIhiS-JWQEEIcjVYnJrt-CriY,5
-thds_core-1.42.20250715194419.dist-info/RECORD,,
+thds_core-1.43.20250718170951.dist-info/METADATA,sha256=UUrXBliBFNet_IP4KZgrALXRSYdWWCjACqMcYcpmiZo,2216
+thds_core-1.43.20250718170951.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+thds_core-1.43.20250718170951.dist-info/entry_points.txt,sha256=bOCOVhKZv7azF3FvaWX6uxE6yrjK6FcjqhtxXvLiFY8,161
+thds_core-1.43.20250718170951.dist-info/top_level.txt,sha256=LTZaE5SkWJwv9bwOlMbIhiS-JWQEEIcjVYnJrt-CriY,5
+thds_core-1.43.20250718170951.dist-info/RECORD,,