nigrains 0.1.0__tar.gz

nigrains-0.1.0/.dockerignore

@@ -0,0 +1,7 @@
+.venv
+.git
+dist
+__pycache__
+.mypy_cache
+.ruff_cache
+.pytest_cache

nigrains-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.py text eol=lf

nigrains-0.1.0/.github/workflows/check.yml

@@ -0,0 +1,31 @@
+# Every version the package claims in `requires-python`, on every push.
+# The claim is cheap to make and this is what makes it true.
+name: check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv run --python ${{ matrix.python }} pytest
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run mypy src tests

nigrains-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+# Publishes to PyPI on a tag, with no token anywhere.
+#
+# Trusted Publishing: PyPI verifies a short-lived OIDC token minted by this
+# workflow instead of a secret we would have to store, rotate and eventually
+# leak. It has to be configured once on PyPI as a pending publisher for the
+# project name, naming this repository and this workflow file.
+name: publish
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      # The tests run again here rather than trusting that the tag points at
+      # a commit `check` already passed: a tag can be moved.
+      - run: uv run pytest
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

nigrains-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.py[cod]
+.venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+dist/

nigrains-0.1.0/BENCHMARKS.md

@@ -0,0 +1,100 @@
+# Benchmarks
+
+Run them yourself: `bench/run.sh` builds a container and measures on every
+interpreter this package claims. Two CPUs and 2 GiB, pinned, because a
+benchmark whose numbers move with whatever else the machine is doing measures
+the machine.
+
+Everything below is Linux (Debian bookworm-slim, container, 2 CPUs). Each
+timing is **the fastest of several runs**, not a mean: a slower run measures
+whatever else the machine was doing at the time, and the question here is
+what the code costs when nothing is in its way. Read the shapes, not the
+digits — the digits are this machine's.
+
+## Dispatch
+
+What addressing by identity costs, against a plain `await grain.method()` on
+a grain you already hold.
+
+| Python | direct | `runtime.call` | throughput |
+|---|---|---|---|
+| 3.11 | 0.12 µs | 1.70 µs | 588k calls/s |
+| 3.12 | 0.09 µs | 1.42 µs | 706k calls/s |
+| 3.13 | 0.08 µs | 1.32 µs | 756k calls/s |
+| 3.14 | 0.08 µs | 1.23 µs | **812k calls/s** |
+
+A little over a microsecond, which is roughly one event-loop turn. That is
+noise beside anything a grain would realistically do — a query, a file, a
+model call — and it is not noise beside nothing. A grain whose method is a
+dictionary lookup should not have been a grain.
+
+**Dispatch does not degrade with the size of the fleet**, which is the
+premise of the whole model and therefore the thing most worth checking:
+
+| activated grains | 3.14 |
+|---|---|
+| 1 | 1.27 µs |
+| 1 000 | 1.29 µs |
+| 100 000 | 1.30 µs |
+
+Aggregate over a whole fleet in flight at once — 1000 grains, 100 calls each
+— is 797k calls/s on 3.14, so nothing is lost by spreading the work out.
+
+## Overlap
+
+200 concurrent callers on one grain. Counted, not timed: the number is how
+many were inside the method at the same moment.
+
+| | callers inside at once |
+|---|---|
+| serialised (the default) | **1** |
+| reentrant | **200** |
+
+## Activation
+
+| | 3.11 | 3.14 |
+|---|---|---|
+| 1000 cold grains, called at once | 8.10 µs each | **5.42 µs each** |
+| 1000 callers meeting one cold grain | one activation | one activation |
+| runtime bookkeeping per activation | 1126 B | **1066 B** |
+
+A hundred thousand activated grains cost about **102 MiB** of the runtime's
+own structures, before a grain holds anything of its own. That is the number
+to start from when asking how many one node can keep.
+
+**A grain still activating is never collected**, however long it has been
+sitting there — its call count is zero and its timestamp is the moment it was
+created, which used to look exactly like abandonment. A review found the
+sweep deactivating a grain whose own first caller was still waiting for it.
+
+## Sweeping idle grains
+
+The sweep is the one operation linear in the size of the fleet. It is chunked,
+and the two numbers say why:
+
+| 100 000 idle grains, 3.14 | total | longest stall |
+|---|---|---|
+| in one go | 81.0 ms | **81.1 ms** |
+| chunked (current) | 83.6 ms | **6.9 ms** |
+
+The total is what nobody waits for. The stall is what a caller waits — one
+uninterrupted block with every other coroutine behind it. Chunking trades a
+few per cent of total time for an order of magnitude off the thing anybody
+actually feels.
+
+## Two ways this benchmark was wrong first
+
+Both are kept here because the next person to measure this will reach for the
+same tools.
+
+**Overlap was measured with `asyncio.sleep(0.01)` and wall time.** On Windows
+the default timer resolution is about 15.6 ms, so a 10 ms sleep took one and a
+half ticks and the serialised grain scored *0.6x* — slower than serial, which
+is meaningless. The number was about the platform's clock. Counting callers
+costs the same everywhere.
+
+**Memory per activation counted the tasks that made the activations.** The
+reading was taken right after a `gather` of 100 000 calls, before anything
+collected them, which put finished coroutines into the cost of a grain. One
+`gc.collect()` moved it from 1228 to 1058 bytes, and only the second number is
+about this package.

nigrains-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.1.0 — 2026-09-07
+
+First cut: the node-local half of the runtime.
+
+- `Grain`, `GrainId` and `Runtime`: activation on demand by identity,
+  deactivation of idle grains, reentrancy declared per grain class.
+- Callers meeting a cold grain wait on one activation rather than starting
+  several.
+- A failed activation leaves nothing behind and reaches every waiting caller.
+- Idleness is measured from the last call to finish, so a grain answering a
+  slow call is never collected underneath its caller.
+- The idle sweep yields every thousand grains and confirms idleness again
+  before deactivating, so collecting a large fleet is not one long stall:
+  100 000 idle grains went from an 79 ms block to a 6 ms longest pause.
+- An activation keeps neither its resolved activation event nor a lock it
+  has no use for; both are made or dropped when they stop mattering, which
+  is 1066 bytes of runtime bookkeeping per grain rather than 1228.
+- Callers waiting on a cold grain wait on an Event rather than on a shared
+  future, so one of them being cancelled no longer cancels the activation
+  everybody else was waiting for. A caller whose activation was cancelled by
+  somebody else's task retries rather than inheriting the cancellation.
+- A grain that has not finished activating is never treated as idle, so an
+  `activate()` slower than the idle span is no longer indistinguishable from
+  abandonment.
+
+Not here yet, and named in the README rather than implied away: persistence,
+supervision, and distribution. Single activation is trivially true while
+there is one node, and will be best effort when there is not.

nigrains-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.

nigrains-0.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.5
+Name: nigrains
+Version: 0.1.0
+Summary: Virtual actors for asyncio: grains addressed by identity, activated on demand.
+Project-URL: Homepage, https://github.com/yadozub/nigrains
+Project-URL: Source, https://github.com/yadozub/nigrains
+Project-URL: Issues, https://github.com/yadozub/nigrains/issues
+Project-URL: Changelog, https://github.com/yadozub/nigrains/blob/main/CHANGELOG.md
+Author: Sergey Ilyevich
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: actors,asyncio,grains,orleans,virtual-actors
+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
+Description-Content-Type: text/markdown
+
+# nigrains
+
+*To my teacher and mentor, [Vitaly Chashin](https://github.com/VitalyChashin): called by name once -> answering ever since.*
+
+Virtual actors for asyncio. A grain has an identity rather than a lifetime:
+you call it, and the runtime decides whether an activation has to exist
+first and when an idle one goes away.
+
+```python
+from nigrains import Grain, GrainId, Runtime
+
+
+class Counter(Grain):
+    async def activate(self) -> None:
+        self.count = 0
+
+    async def increment(self) -> int:
+        self.count += 1
+        return self.count
+
+
+runtime = Runtime()
+runtime.register("counter", Counter)
+
+async with runtime:
+    await runtime.call(GrainId("counter", "a"), "increment")  # 1
+    await runtime.call(GrainId("counter", "a"), "increment")  # 2
+    await runtime.call(GrainId("counter", "b"), "increment")  # 1
+```
+
+No registry to populate, no handle to keep, no create and no destroy. The
+second call finds the activation the first built; the third builds its own,
+because the key differs.
+
+## Why this rather than an actor library
+
+Classical actors are created, addressed, supervised and killed, which means
+the application owns placement: which node holds which actor, what happens
+to a message for one that is not there, how a restarted one gets its state
+back. The virtual actor model — Microsoft Orleans' — removes all of it. A
+grain always exists conceptually. Identity *is* the address.
+
+## What it does
+
+- **Activates on demand.** A call to a cold grain builds it and awaits
+  `activate()` before dispatching. Callers arriving during that wait on the
+  same activation instead of starting a second — a cold fleet asked for
+  everything at once is the normal case, not the exceptional one.
+- **Serialises what asked to be serialised.** `reentrant` is a property of
+  the grain class. The default is one call at a time, matching the model;
+  a grain whose methods only read declares otherwise and its callers do not
+  queue behind each other.
+- **Collects what nobody is using.** Idle grains are deactivated by a
+  sweeper. Idleness is measured from the last call to *finish*, so a grain
+  answering a slow call is never collected underneath its own caller.
+
+## What it does not do, on purpose
+
+- **No persistence.** A grain loads whatever it wants in `activate()` and
+  that is its business. A storage abstraction with two users that need
+  different things is how a small runtime stops being small.
+- **No supervision.** A failing call raises to its caller; a grain that
+  fails to activate leaves nothing behind and the next call starts over.
+  Restart policy belongs to whatever asked.
+- **No distribution yet.** This is the node-local half: **one `Runtime`**,
+  so single activation is trivially true within it. Two runtimes in one
+  process are two fleets, and an identity in both is two grains — which is
+  the honest boundary, and not the process. A directory and a transport go
+  in front of `Runtime.call`, and nothing in calling code changes when they
+  arrive; that is the point of addressing by identity.
+
+## The guarantee it will offer, stated as a limit
+
+When distribution lands, single activation is **best effort**. Every
+implementation of this model weakens under a network partition, Orleans
+included, and saying otherwise would be the useful lie that costs someone a
+production incident. A grain that cannot tolerate two of itself must keep
+its authority outside itself — in the database or the cache it fronts —
+rather than in the activation's memory.
+
+For the common case that is not a compromise. A grain fronting immutable
+data is a cache: two activations hold the same thing and answer the same
+way. That is what makes the model affordable without a membership protocol.
+
+## What it costs
+
+Measured on Linux in a pinned container, every interpreter this package
+claims — full tables and how to reproduce them in
+[`BENCHMARKS.md`](BENCHMARKS.md). On Python 3.14:
+
+| | |
+|---|---|
+| `runtime.call` on a hot grain | **1.23 µs** (812k calls/s) |
+| the same with 100 000 grains activated | **1.30 µs** — flat |
+| aggregate, 1000 grains in flight | 797k calls/s |
+| activating 1000 cold grains | 5.4 µs each |
+| 1000 callers meeting one cold grain | **one** activation |
+| runtime bookkeeping per activation | 1066 B (102 MiB for 100k) |
+
+And the reentrancy claim, counted rather than timed — 200 concurrent callers
+on one grain:
+
+| | callers inside at once |
+|---|---|
+| serialised (the default) | **1** |
+| reentrant | **200** |
+
+A microsecond of dispatch is noise beside anything a grain would realistically
+do. It is not noise beside nothing, so a grain whose method is a dictionary
+lookup is a grain that should not have been one.
+
+## Requirements
+
+Python 3.11+ (that floor is `typing.Self`, and nothing else in here reaches
+past it). No dependencies. The suite runs on 3.11, 3.12, 3.13 and 3.14.
+
+## Dedication
+
+Everything here has a name rather than a lifetime:
+call it -> it wakes; forget it -> it cools.
+Once, someone called me by my name ->
+and I answered, and I have not cooled.
+
+I would not have arrived here alone.
+Someone walked beside me, not holding my hand:
+no ready answers -> only questions left behind,
+and waiting, however long, until I answered myself.
+
+A strictness that made me want to be more precise.
+A patience that made me dare more.
+There is no chapter for this in any documentation -> it is passed on only this way.
+
+To my teacher and mentor, Vitaly Chashin:
+everything here that answers remembers the first call.
+
+<https://github.com/VitalyChashin>
+
+## Licence
+
+Apache-2.0.
+
+---
+
+*To my teacher and mentor, Vitaly Chashin.*