viva-emitters 0.2.2__tar.gz

viva_emitters-0.2.2/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.
+

viva_emitters-0.2.2/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: viva-emitters
+Version: 0.2.2
+Summary: Focused emitter library for process-bigraph composites — SQLite, Parquet, and beyond
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: process-bigraph>=1.4.12
+Requires-Dist: bigraph-schema
+Requires-Dist: numpy
+Provides-Extra: sqlite
+Provides-Extra: parquet
+Requires-Dist: duckdb; extra == "parquet"
+Requires-Dist: polars; extra == "parquet"
+Requires-Dist: pyarrow; extra == "parquet"
+Requires-Dist: fsspec; extra == "parquet"
+Requires-Dist: tqdm; extra == "parquet"
+Provides-Extra: xarray
+Requires-Dist: xarray>=2026.04; extra == "xarray"
+Requires-Dist: zarr~=3.1.6; extra == "xarray"
+Requires-Dist: zarrs>=0.2; extra == "xarray"
+Requires-Dist: pint; extra == "xarray"
+Requires-Dist: unum; extra == "xarray"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: duckdb; extra == "dev"
+Requires-Dist: polars; extra == "dev"
+Requires-Dist: pyarrow; extra == "dev"
+Requires-Dist: fsspec; extra == "dev"
+Requires-Dist: tqdm; extra == "dev"
+Requires-Dist: xarray>=2026.04; extra == "dev"
+Requires-Dist: zarr~=3.1.6; extra == "dev"
+Requires-Dist: zarrs>=0.2; extra == "dev"
+Requires-Dist: pint; extra == "dev"
+Requires-Dist: unum; extra == "dev"
+Dynamic: license-file
+
+# viva-emitters
+
+Focused emitter library for [process-bigraph](https://github.com/vivarium-collective/process-bigraph)
+composites. Hosts the heavy-dependency emitters out-of-tree so the
+process-bigraph core stays lean.
+
+The zero-dependency built-ins — `RAMEmitter`, `ConsoleEmitter`, `JSONEmitter`
+— continue to live in `process_bigraph.emitter`. This package adds:
+
+| Emitter          | Extra        | What it does                                          |
+| ---------------- | ------------ | ----------------------------------------------------- |
+| `SQLiteEmitter`  | `[sqlite]`   | One row per tick into a single `.db` file (stdlib).   |
+| `ParquetEmitter` | `[parquet]`  | Hive-partitioned Parquet dataset, batched writes.     |
+
+## Install
+
+```bash
+pip install 'viva-emitters[sqlite]'        # SQLiteEmitter only
+pip install 'viva-emitters[parquet]'       # ParquetEmitter only
+pip install 'viva-emitters[sqlite,parquet]'  # both
+```
+
+The `[sqlite]` extra is empty (Python's stdlib `sqlite3` is enough); it exists
+for symmetry. The `[parquet]` extra pulls in `duckdb`, `polars`, `pyarrow`,
+`fsspec`, and `tqdm`.
+
+## Usage
+
+```python
+from viva_emitters import SQLiteEmitter, ParquetEmitter
+
+# Wire either as a step inside a process-bigraph Composite, e.g. via the
+# usual emitter_from_wires helper:
+#
+#   from process_bigraph.emitter import emitter_from_wires
+#   spec = emitter_from_wires(wires, address='local:SQLiteEmitter')
+```
+
+Reader helpers for the Parquet datasets (`create_duckdb_conn`,
+`read_stacked_columns`, `named_idx`, `ndidx_to_duckdb_expr`, ...) are also
+re-exported from the top-level package.
+
+## Tests
+
+```bash
+pip install -e '.[parquet,dev]'
+pytest
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

viva_emitters-0.2.2/README.md

@@ -0,0 +1,52 @@
+# viva-emitters
+
+Focused emitter library for [process-bigraph](https://github.com/vivarium-collective/process-bigraph)
+composites. Hosts the heavy-dependency emitters out-of-tree so the
+process-bigraph core stays lean.
+
+The zero-dependency built-ins — `RAMEmitter`, `ConsoleEmitter`, `JSONEmitter`
+— continue to live in `process_bigraph.emitter`. This package adds:
+
+| Emitter          | Extra        | What it does                                          |
+| ---------------- | ------------ | ----------------------------------------------------- |
+| `SQLiteEmitter`  | `[sqlite]`   | One row per tick into a single `.db` file (stdlib).   |
+| `ParquetEmitter` | `[parquet]`  | Hive-partitioned Parquet dataset, batched writes.     |
+
+## Install
+
+```bash
+pip install 'viva-emitters[sqlite]'        # SQLiteEmitter only
+pip install 'viva-emitters[parquet]'       # ParquetEmitter only
+pip install 'viva-emitters[sqlite,parquet]'  # both
+```
+
+The `[sqlite]` extra is empty (Python's stdlib `sqlite3` is enough); it exists
+for symmetry. The `[parquet]` extra pulls in `duckdb`, `polars`, `pyarrow`,
+`fsspec`, and `tqdm`.
+
+## Usage
+
+```python
+from viva_emitters import SQLiteEmitter, ParquetEmitter
+
+# Wire either as a step inside a process-bigraph Composite, e.g. via the
+# usual emitter_from_wires helper:
+#
+#   from process_bigraph.emitter import emitter_from_wires
+#   spec = emitter_from_wires(wires, address='local:SQLiteEmitter')
+```
+
+Reader helpers for the Parquet datasets (`create_duckdb_conn`,
+`read_stacked_columns`, `named_idx`, `ndidx_to_duckdb_expr`, ...) are also
+re-exported from the top-level package.
+
+## Tests
+
+```bash
+pip install -e '.[parquet,dev]'
+pytest
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

viva_emitters-0.2.2/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "viva-emitters"
+version = "0.2.2"
+description = "Focused emitter library for process-bigraph composites — SQLite, Parquet, and beyond"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.11"
+dependencies = [
+    "process-bigraph>=1.4.12",
+    "bigraph-schema",
+    "numpy",
+]
+
+[project.optional-dependencies]
+# SQLite uses Python's stdlib ``sqlite3`` — the group exists for symmetry
+# with the other extras so callers can write ``pip install viva-emitters[sqlite]``.
+sqlite = []
+parquet = [
+    "duckdb",
+    "polars",
+    "pyarrow",
+    "fsspec",
+    "tqdm",
+]
+xarray = [
+    "xarray>=2026.04",
+    "zarr~=3.1.6",
+    "zarrs>=0.2",
+    "pint",
+    "unum",
+]
+dev = [
+    "pytest",
+    "duckdb",
+    "polars",
+    "pyarrow",
+    "fsspec",
+    "tqdm",
+    "xarray>=2026.04",
+    "zarr~=3.1.6",
+    "zarrs>=0.2",
+    "pint",
+    "unum",
+]
+
+[tool.setuptools.packages.find]
+include = ["viva_emitters*"]

viva_emitters-0.2.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

viva_emitters-0.2.2/tests/test_emitter_contract.py

@@ -0,0 +1,64 @@
+import pytest
+
+from viva_emitters.contract import EmitterContract
+from viva_emitters.contracts import contract_for, register_contract
+
+
+def test_contract_validates_output_kind():
+    with pytest.raises(ValueError):
+        EmitterContract(output_kind="weird")
+    ok = EmitterContract(output_kind="zarr", output_uri_config_key="out_uri")
+    assert ok.output_kind == "zarr"
+    assert ok.output_uri_config_key == "out_uri"
+
+
+def test_sqlite_emitter_self_describes():
+    from viva_emitters.sqlite_emitter import SQLiteEmitter
+    c = SQLiteEmitter.emitter_contract()
+    assert c.output_kind == "sqlite"
+    assert c.output_uri_config_key == "db_file"
+
+
+def test_parquet_emitter_self_describes():
+    from viva_emitters.parquet_emitter import ParquetEmitter
+    c = ParquetEmitter.emitter_contract()
+    assert c.output_kind == "parquet"
+    assert c.output_uri_config_key  # whatever real key it uses
+
+
+def test_xarray_emitter_self_describes():
+    pytest.importorskip("xarray")
+    pytest.importorskip("zarr")
+    from viva_emitters.xarray_emitter import XArrayEmitter
+    c = XArrayEmitter.emitter_contract()
+    assert c.output_kind == "zarr"
+    assert c.output_uri_config_key == "out_uri"
+    assert contract_for("xarray").output_kind == "zarr"
+    assert contract_for("XArrayEmitter").output_kind == "zarr"
+    assert contract_for(XArrayEmitter).output_kind == "zarr"
+
+
+def test_contract_for_resolves_by_name_and_class():
+    from viva_emitters.sqlite_emitter import SQLiteEmitter
+    assert contract_for("sqlite").output_kind == "sqlite"
+    assert contract_for("SQLiteEmitter").output_kind == "sqlite"
+    assert contract_for(SQLiteEmitter).output_kind == "sqlite"
+
+
+def test_ram_contract_without_editing_process_bigraph():
+    c = contract_for("ram")
+    assert c.output_kind == "ram"
+    assert c.output_uri_config_key is None
+    assert contract_for("RAMEmitter").output_kind == "ram"
+
+
+def test_top_level_exports():
+    import viva_emitters
+    assert hasattr(viva_emitters, "EmitterContract")
+    assert hasattr(viva_emitters, "contract_for")
+    assert hasattr(viva_emitters, "register_contract")
+
+
+def test_unknown_emitter_raises():
+    with pytest.raises(KeyError):
+        contract_for("does-not-exist")

viva_emitters-0.2.2/tests/test_lifecycle.py

@@ -0,0 +1,158 @@
+"""Tests for viva_emitters.lifecycle — the per-agent emitter registry.
+
+These exercise the framework-generic lifecycle utility with a duck-typed
+fake emitter (no heavy parquet deps required) and, where the [parquet]
+extra is available, against a real ParquetEmitter to confirm the
+finalize-before-teardown flow flushes the trailing partial batch and writes
+the success sentinel.
+"""
+
+from __future__ import annotations
+
+import pytest
+
+from viva_emitters import lifecycle
+from viva_emitters.lifecycle import (
+    clear_registry,
+    finalize_emitter_for_agent,
+    get_emitter,
+    register_emitter,
+    registered_agent_ids,
+    unregister_emitter,
+)
+
+
+@pytest.fixture(autouse=True)
+def _clean_registry():
+    """Each test starts and ends with an empty process-global registry."""
+    clear_registry()
+    yield
+    clear_registry()
+
+
+class _FakeEmitter:
+    """Duck-typed stand-in: records close() calls."""
+
+    def __init__(self):
+        self.closed_with = []  # list of success flags passed to close()
+
+    def close(self, success: bool = False):
+        self.closed_with.append(success)
+
+
+def test_register_get_unregister_roundtrip():
+    assert get_emitter("00") is None
+    e = _FakeEmitter()
+    register_emitter("00", e)
+    assert get_emitter("00") is e
+    # agent_id is coerced to str, so an int key finds the same slot.
+    register_emitter(0, e)
+    assert get_emitter("0") is e
+    assert set(registered_agent_ids()) == {"00", "0"}
+    assert unregister_emitter("00") is e
+    assert get_emitter("00") is None
+    # Unregistering a missing key returns None, doesn't raise.
+    assert unregister_emitter("nope") is None
+
+
+def test_finalize_closes_and_unregisters():
+    e = _FakeEmitter()
+    register_emitter("0", e)
+    finalized = finalize_emitter_for_agent("0", success=True)
+    assert finalized is True
+    assert e.closed_with == [True]
+    # Finalize is one-shot: the emitter is gone from the registry.
+    assert get_emitter("0") is None
+    # A second finalize is a no-op (no emitter registered).
+    assert finalize_emitter_for_agent("0", success=True) is False
+    assert e.closed_with == [True]
+
+
+def test_finalize_missing_agent_returns_false():
+    assert finalize_emitter_for_agent("missing") is False
+
+
+def test_finalize_default_success_is_true():
+    e = _FakeEmitter()
+    register_emitter("0", e)
+    finalize_emitter_for_agent("0")
+    assert e.closed_with == [True]
+
+
+def test_finalize_unregisters_even_when_close_raises():
+    class _Boom:
+        def close(self, success: bool = False):
+            raise RuntimeError("boom")
+
+    register_emitter("0", _Boom())
+    with pytest.raises(RuntimeError, match="boom"):
+        finalize_emitter_for_agent("0")
+    # Still unregistered, so a broken emitter isn't retried forever.
+    assert get_emitter("0") is None
+
+
+def test_module_level_exports_match_package_exports():
+    """``from viva_emitters import finalize_emitter_for_agent`` works."""
+    import viva_emitters
+
+    assert viva_emitters.finalize_emitter_for_agent is finalize_emitter_for_agent
+    assert viva_emitters.register_emitter is register_emitter
+
+
+# ---------------------------------------------------------------------------
+# Real-emitter integration: the lifecycle finalize flushes a ParquetEmitter's
+# trailing partial batch and writes the success sentinel before teardown.
+# ---------------------------------------------------------------------------
+
+try:
+    import duckdb  # noqa: F401
+    import polars as pl  # noqa: F401
+
+    _HAVE_PARQUET = True
+except ImportError:
+    _HAVE_PARQUET = False
+
+
+@pytest.mark.skipif(not _HAVE_PARQUET, reason="[parquet] extra not installed")
+def test_finalize_flushes_real_parquet_emitter(tmp_path, core):
+    """finalize_emitter_for_agent flushes buffered rows + writes the sentinel.
+
+    Mirrors the division-boundary flow: a per-generation parquet emitter is
+    constructed and registered under its agent_id, buffers fewer rows than a
+    full batch, and is finalized (instead of being torn down silently) so its
+    partial batch lands on disk and the success sentinel is written.
+    """
+    import os
+
+    from viva_emitters.parquet_emitter import ParquetEmitter
+
+    out_dir = str(tmp_path / "out")
+    emitter = ParquetEmitter(
+        config={
+            "out_dir": out_dir,
+            "batch_size": 100,  # larger than the rows we emit -> partial batch
+            "threaded": False,
+            "partitioning_keys": ["experiment_id", "agent_id"],
+            "metadata": {"experiment_id": "exp", "agent_id": "0"},
+        },
+        core=core,
+    )
+    emitter.last_batch_future.result()
+    register_emitter("0", emitter)
+
+    for t in range(5):
+        emitter.update({"global_time": float(t)})
+
+    # Before finalize the partial batch is only in memory; finalize lands it.
+    assert finalize_emitter_for_agent("0", success=True) is True
+    assert get_emitter("0") is None
+
+    # Trailing partial batch persisted: all 5 rows readable.
+    assert len(emitter.query()) == 5
+
+    # Success sentinel written under the partition path.
+    sentinel = os.path.join(
+        emitter.out_uri, "exp", "success",
+        "experiment_id=exp", "agent_id=0", "s.pq",
+    )
+    assert os.path.exists(sentinel), f"missing success sentinel: {sentinel}"