gc-primitives 0.1.0__py3-none-any.whl

gc_primitives/__init__.py

@@ -0,0 +1,14 @@
+"""gc-primitives · 减少分配与复用的 Python 语义移植。
+
+规范见仓库根 SPEC.md。纯 Python 实现，**不承诺性能收益**，价值在跨语言契约一致。
+
+    from gc_primitives import Pool
+
+    pool = Pool(list, list.clear)
+    with pool.borrow() as xs:
+        xs.append(1)
+"""
+from ._pool import Lease, Pool, PoolStateError, noop_recycler
+
+__all__ = ["Pool", "Lease", "PoolStateError", "noop_recycler"]
+__version__ = "0.1.0"

gc_primitives/_pool.py

@@ -0,0 +1,166 @@
+"""gc-primitives · 纯 Python 语义移植。
+
+行为规范见仓库根 SPEC.md。定位是**跨语言契约一致性**，不承诺比 CPython 解释器快：
+CPython 主力是引用计数，另有分代 GC 清循环引用，再加 pymalloc 的 arena 与小对象
+free-list，解释器底层已经在做复用，纯 Python 再手写一层对象池常与内置缓存重叠。
+
+契约要点：
+  - 用 ``with pool.borrow() as x`` 显式归还（对应 Java 的 try-with-resources）；
+  - 句柄与对象只归借用线程使用，跨线程归还/取用抛 PoolStateError；
+  - 每线程空闲对象数有上限，超出直接丢弃；
+  - 归还时由库调用 recycler 复位；复位失败则**对象丢弃、绝不回池**；
+  - 误用始终强制校验，不设开关。
+"""
+from __future__ import annotations
+
+import threading
+from typing import Any, Callable, Generic, List, Optional, TypeVar
+
+T = TypeVar("T")
+
+__all__ = ["Pool", "Lease", "PoolStateError", "noop_recycler"]
+
+
+class PoolStateError(RuntimeError):
+    """池契约被破坏时抛出；对应 Java 的 PoolStateException / C++ 的 pool_error。"""
+
+
+def noop_recycler(value: Any) -> None:
+    """不做任何复位的复位钩子，适用于无可变状态的对象。"""
+    return None
+
+
+class Lease(Generic[T]):
+    """一次借用的句柄，配合 ``with`` 使用。"""
+
+    __slots__ = ("_pool", "_value", "_borrower", "_active")
+
+    def __init__(self, pool: "Pool[T]", value: T, borrower: int) -> None:
+        self._pool: Pool[T] = pool
+        self._value: Optional[T] = value
+        self._borrower = borrower
+        self._active = True
+
+    def get(self) -> T:
+        if not self._active:
+            raise PoolStateError("lease is closed; get() after close()")
+        if threading.get_ident() != self._borrower:
+            raise PoolStateError("lease used off its borrowing thread")
+        return self._value  # type: ignore[return-value]
+
+    def close(self) -> None:
+        """显式归还；重复关闭或跨线程关闭抛 PoolStateError。"""
+        if not self._active:
+            raise PoolStateError("lease already returned (double close)")
+        if threading.get_ident() != self._borrower:
+            raise PoolStateError("cross-thread return")
+
+        self._active = False
+        value = self._value
+        self._value = None
+        # 复位失败时 _return 会照常抛异常，但对象不回池；租约此时已失效
+        self._pool._return(value)
+
+    def __enter__(self) -> T:
+        return self.get()
+
+    def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> bool:
+        # 即使 with 体内抛异常，也要归还（并让原异常继续冒泡）
+        self.close()
+        return False
+
+    @property
+    def active(self) -> bool:
+        return self._active
+
+
+class Pool(Generic[T]):
+    """全局对象内含线程本地状态：一个 Pool 实例可跨线程使用，每线程各自一份有界空闲栈。"""
+
+    DEFAULT_CAPACITY = 64
+
+    def __init__(
+        self,
+        factory: Callable[[], T],
+        recycler: Optional[Callable[[T], Any]] = None,
+        capacity: int = DEFAULT_CAPACITY,
+    ) -> None:
+        if capacity <= 0:
+            raise ValueError("capacity must be > 0")
+        self._factory = factory
+        self._recycler: Callable[[T], Any] = recycler or noop_recycler
+        self._capacity = capacity
+        self._local = threading.local()
+        self._lock = threading.Lock()
+        self._borrows = 0
+        self._returns = 0
+        self._live = 0
+
+    def borrow(self) -> Lease[T]:
+        state = self._state(create=True)
+        if state:
+            value = state.pop()
+        else:
+            value = self._factory()
+            if value is None:
+                raise PoolStateError("factory returned None")
+        with self._lock:
+            self._borrows += 1
+            self._live += 1
+        return Lease(self, value, threading.get_ident())
+
+    def capacity(self) -> int:
+        return self._capacity
+
+    def idle_count(self) -> int:
+        """当前线程的空闲对象数；仅用于诊断。"""
+        return len(self._state(create=False))
+
+    def active_leases(self) -> int:
+        with self._lock:
+            return self._live
+
+    def borrow_count(self) -> int:
+        with self._lock:
+            return self._borrows
+
+    def return_count(self) -> int:
+        with self._lock:
+            return self._returns
+
+    def assert_no_active_leases(self) -> None:
+        n = self.active_leases()
+        if n != 0:
+            raise PoolStateError(
+                f"{n} lease(s) not returned; use 'with pool.borrow() as x'"
+            )
+
+    # ---- 内部 ----
+
+    def _state(self, create: bool) -> List[T]:
+        values: Optional[List[T]] = getattr(self._local, "values", None)
+        if values is None:
+            if not create:
+                return []
+            values = []
+            self._local.values = values
+        return values
+
+    def _return(self, value: Optional[T]) -> None:
+        try:
+            self._recycler(value)  # type: ignore[arg-type]
+        except BaseException:
+            # 复位失败：对象直接丢弃，计数照常结算，租约已失效，污染不得入池
+            with self._lock:
+                self._returns += 1
+                self._live -= 1
+            raise
+
+        with self._lock:
+            self._returns += 1
+            self._live -= 1
+
+        state = self._state(create=False)
+        if len(state) < self._capacity:
+            state.append(value)  # type: ignore[arg-type]
+        # 超出上限直接丢弃，由引用计数回收，保证有界

gc_primitives-0.1.0.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: gc-primitives
+Version: 0.1.0
+Summary: Allocation-reducing object pooling primitives (Python semantic port of the cross-language spec)
+Author-email: rainbowcrr-sys <rainbowcrr.sys@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/rainbowcrr-sys/rbc-monorepo
+Project-URL: Repository, https://github.com/rainbowcrr-sys/rbc-monorepo
+Project-URL: Specification, https://github.com/rainbowcrr-sys/rbc-monorepo/blob/main/SPEC.md
+Keywords: object-pool,allocation,zero-dependency,gc-primitives
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# gc-primitives · Python 版
+
+> 中文 · [English](README.en.md)
+
+与 Java / C++ 版同一套概念契约的纯 Python 语义移植，行为规范见仓库根 [SPEC.md](../SPEC.md)（[English](../SPEC.en.md)）。
+
+> **不承诺性能收益。** 这一版的定位是跨语言契约一致性、语义清晰与教学对照，
+> 不是「比解释器快」。原因见下。
+
+## 为什么纯 Python 对象池不承诺加速
+
+CPython 主力是**引用计数**：每个对象记着被谁指着，引用归零立刻就地释放，根本不攒着等 GC；
+另外才挂了一个**分代 GC**，专门清引用计数搞不定的循环引用（A 指 B、B 指 A）。
+再加上 pymalloc 的 arena 和小对象 free-list（`list` / `dict` / `float` 等解释器自己就池化），
+底层已经在做复用了。纯 Python 再手写一层对象池，常常只是和内置缓存重叠，
+甚至因为多一层 Python 函数调用更慢。
+
+所以这一版的价值是：**同一套契约在第三个语言里也成立**，以及能跟 Java / C++ 版逐条对照。
+
+## 导入
+
+```python
+from gc_primitives import Pool
+
+pool = Pool(list, list.clear, capacity=8)   # factory, recycler, capacity
+
+with pool.borrow() as xs:
+    xs.append("hello")
+# __exit__ 自动归还，list.clear 在这里把对象复位
+```
+
+`with pool.borrow() as x` 对应 Java 的 try-with-resources 与 C++ 的 RAII 析构。
+**必须显式用 `with`（或显式 `lease.close()`）**，Python 版不做析构兜底自动归还。
+
+无状态对象可以省掉复位钩子：
+
+```python
+from gc_primitives import Pool, noop_recycler
+
+pool = Pool(object, noop_recycler)   # 也可直接省略 recycler 参数
+```
+
+## API 对照（snake_case 对齐语义，不照搬 camelCase）
+
+| Java | C++ | Python |
+| --- | --- | --- |
+| `Pool<T>` / `Pools.threadLocal(...)` | `rbc::gc::Pool<T, F, R>` | `Pool` |
+| `Lease<T>` | `Pool::Lease` | `Lease` |
+| `Recycler<T>` / `Supplier<T>` | 模板参数 `Recycler` / `Factory` | `recycler` / `factory` 可调用对象 |
+| `PoolStateException` | `pool_error` | `PoolStateError` |
+| `borrow()` | `borrow()` | `borrow()` |
+| `capacity()` / `idleCount()` | `capacity()` / `idle_count()` | `capacity()` / `idle_count()` |
+| `activeLeases()` | `active_leases()` | `active_leases()` |
+| `borrowCount()` / `returnCount()` | `borrow_count()` / `return_count()` | `borrow_count()` / `return_count()` |
+| `assertNoActiveLeases()` | `assert_no_active_leases()` | `assert_no_active_leases()` |
+
+## 契约细则（Python 特有）
+
+- **并发用 `threading.local` 有界栈**，只保证线程隔离。
+  ⚠️ **asyncio 同一线程内的多个任务不隔离**：协程切换不会触发线程切换，
+  本库不会识别任务边界。需要任务级隔离请自己按 task 分 Pool，或等后续 ContextVar 方案。
+- **复位失败**：异常照常抛出，但**对象直接丢弃、绝不回池**，租约仍然失效，计数照常结算。
+  不像 Java/C++ 那样约定「复位不抛」——Python 没有 `noexcept`，因此选择在契约层隔离污染。
+- **`factory` 返回 `None`** 即抛 `PoolStateError`；`capacity <= 0` 抛 `ValueError`。
+- **误用始终强制校验**：双重归还、跨线程归还/取用、关闭后 `get()` 全抛 `PoolStateError`。
+- 不拦截「归还后仍被外部引用」——`close()` 之后不得再持有 `with ... as x` 拿到的对象。
+
+## 测试
+
+只用标准库 `unittest`，无需安装任何依赖：
+
+```bash
+python3 -m unittest discover -s python/tests -v
+```
+
+14 项契约测试与 Java / C++ 版逐条对应，额外覆盖 `with` 体内抛异常仍归还、复位失败丢弃对象。
+
+## 分发
+
+PyPI：`gc-primitives`，导入名 `gc_primitives`，Python 3.9+，Apache-2.0，版本 `0.1.0`。
+
+```bash
+pip install gc-primitives
+```
+
+打包：
+
+```bash
+cd python && python3 -m build
+```
+
+版本与 Java / C++ 各自独立，不被已发布的 Java `0.1.0` 锁住。

gc_primitives-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+gc_primitives/__init__.py,sha256=ikfY1TxwX3g0-cRJf6AZ52p4-fqAcqfoE5uSOcXOGMU,454
+gc_primitives/_pool.py,sha256=33-ToYDDCRo0nnW9-u1lTlaYkRCcsNkYPxneu9XerjI,5632
+gc_primitives-0.1.0.dist-info/licenses/LICENSE,sha256=6QexHxP6iua3HAEMlGxDFa5FRYNAzeLQaaId49D17Vo,11344
+gc_primitives-0.1.0.dist-info/METADATA,sha256=917VWQuJ_cTeRhXul1QDW0XwzKH_KJL_58rRm7_-p1E,5023
+gc_primitives-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+gc_primitives-0.1.0.dist-info/top_level.txt,sha256=ekx66NyKU7sAxt_p4z5CJghk3PqDT5RLbgZIfKHXYus,14
+gc_primitives-0.1.0.dist-info/RECORD,,

gc_primitives-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gc_primitives-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 rainbowcrr-sys
+
+   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.

gc_primitives-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gc_primitives