agni-eda 0.3.12__tar.gz

agni_eda-0.3.12/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.

agni_eda-0.3.12/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: agni-eda
+Version: 0.3.12
+Summary: Typed Python client for the agni EDA engine, over its CLI or its Connect API
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/panyam/agni
+Project-URL: Documentation, https://panyam.github.io/agni/build/other-languages/
+Project-URL: Issues, https://github.com/panyam/agni/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf<8,>=7.36.2
+Provides-Extra: xlsx
+Requires-Dist: openpyxl>=3.1; extra == "xlsx"
+Provides-Extra: examples
+Requires-Dist: openpyxl>=3.1; extra == "examples"
+Requires-Dist: pyyaml>=6; extra == "examples"
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Requires-Dist: openpyxl>=3.1; extra == "test"
+Requires-Dist: pyyaml>=6; extra == "test"
+Dynamic: license-file
+
+# agni (Python client)
+
+A typed Python client for agni. It calls the `agni` CLI or a running `agni serve` and returns the
+wire contract's own message classes, generated from `protos/agni/v1`.
+
+```sh
+pip install 'agni-eda[xlsx]'           # a release, from PyPI
+pip install -e 'clients/python[xlsx]'  # a checkout
+```
+
+The distribution is `agni-eda` because PyPI's `agni` is an unrelated project, and the import is
+`agni`. Match its version to the `agni` binary or server it talks to.
+
+```python
+from agni import Client, CliTransport, ConnectTransport
+
+c = Client(CliTransport("agni", mounts={"tut": "examples/tutorial-project"}))
+# or: c = Client(ConnectTransport("http://127.0.0.1:8080"))
+snap = c.ingest("mount://tut/designs/gateway")
+resp = c.run_query(snapshot=snap, query='component.class(?c, "resistor") => ?c')
+c.delete_snapshot(snap)
+```
+
+Every question names a snapshot, a design loaded once under one config (agni issue 1061). `ingest`
+returns its name, and takes the `board_uri`, `as_named` and `overlay` a request used to carry, and
+`flatten_hierarchy`, which reads a hierarchical EDIF netlist whole as `--flatten-hierarchy` does.
+A server holds a snapshot until it is deleted or evicted, and refuses one whose files changed. The
+client keeps the definition of each snapshot it ingested, so a question naming one the server lost is
+asked again after ingesting it under the same name, and one whose files changed after updating it, as
+the viewer does (agni issue 1067). A snapshot this client did not ingest, or deleted, still raises
+`AgniError` with code `not_found`, and `AgniError.snapshot_unavailable` says which. The CLI transport has
+no server, so it keeps each definition itself under a name it mints (`snapshots/cli-1`) and turns it
+back into flags for every command it runs.
+
+The guide, `docsite/content/build/other-languages.md`, covers choosing a transport, which rpcs the
+CLI covers, where the two differ today, and writing tables to xlsx.
+
+- `examples/audit_workbook.py` writes a five-sheet audit workbook of the tutorial board, asking its
+  four tables as one query set (`run_queries`) so the design is read once.
+- `examples/revision_audit.py` compares two revisions of the gateway and audits the newer one, writing
+  a workbook and a markdown summary that lists each tab still to be built. `make
+  exercise-revision-audit` runs it with the checkout's binary (agni issue 843).
+- `make proto-py` regenerates `src/agni/v1`. Never edit it by hand; `make proto-check` fails on drift.
+- `make python-test` runs the suite against a built binary and a real server.
+- `make python-dist V=vX.Y.Z` builds the sdist and wheel a release publishes into `dist/python` and
+  installs the wheel into a fresh venv to check it. The release workflow runs it, and the gate runs
+  `python-dist-check`.

agni_eda-0.3.12/README.md

@@ -0,0 +1,47 @@
+# agni (Python client)
+
+A typed Python client for agni. It calls the `agni` CLI or a running `agni serve` and returns the
+wire contract's own message classes, generated from `protos/agni/v1`.
+
+```sh
+pip install 'agni-eda[xlsx]'           # a release, from PyPI
+pip install -e 'clients/python[xlsx]'  # a checkout
+```
+
+The distribution is `agni-eda` because PyPI's `agni` is an unrelated project, and the import is
+`agni`. Match its version to the `agni` binary or server it talks to.
+
+```python
+from agni import Client, CliTransport, ConnectTransport
+
+c = Client(CliTransport("agni", mounts={"tut": "examples/tutorial-project"}))
+# or: c = Client(ConnectTransport("http://127.0.0.1:8080"))
+snap = c.ingest("mount://tut/designs/gateway")
+resp = c.run_query(snapshot=snap, query='component.class(?c, "resistor") => ?c')
+c.delete_snapshot(snap)
+```
+
+Every question names a snapshot, a design loaded once under one config (agni issue 1061). `ingest`
+returns its name, and takes the `board_uri`, `as_named` and `overlay` a request used to carry, and
+`flatten_hierarchy`, which reads a hierarchical EDIF netlist whole as `--flatten-hierarchy` does.
+A server holds a snapshot until it is deleted or evicted, and refuses one whose files changed. The
+client keeps the definition of each snapshot it ingested, so a question naming one the server lost is
+asked again after ingesting it under the same name, and one whose files changed after updating it, as
+the viewer does (agni issue 1067). A snapshot this client did not ingest, or deleted, still raises
+`AgniError` with code `not_found`, and `AgniError.snapshot_unavailable` says which. The CLI transport has
+no server, so it keeps each definition itself under a name it mints (`snapshots/cli-1`) and turns it
+back into flags for every command it runs.
+
+The guide, `docsite/content/build/other-languages.md`, covers choosing a transport, which rpcs the
+CLI covers, where the two differ today, and writing tables to xlsx.
+
+- `examples/audit_workbook.py` writes a five-sheet audit workbook of the tutorial board, asking its
+  four tables as one query set (`run_queries`) so the design is read once.
+- `examples/revision_audit.py` compares two revisions of the gateway and audits the newer one, writing
+  a workbook and a markdown summary that lists each tab still to be built. `make
+  exercise-revision-audit` runs it with the checkout's binary (agni issue 843).
+- `make proto-py` regenerates `src/agni/v1`. Never edit it by hand; `make proto-check` fails on drift.
+- `make python-test` runs the suite against a built binary and a real server.
+- `make python-dist V=vX.Y.Z` builds the sdist and wheel a release publishes into `dist/python` and
+  installs the wheel into a fresh venv to check it. The release workflow runs it, and the gate runs
+  `python-dist-check`.

agni_eda-0.3.12/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=69"]
+build-backend = "setuptools.build_meta"
+
+[project]
+# PyPI's `agni` is an unrelated project, so the distribution is `agni-eda` and the import stays
+# `agni`. The version here is a placeholder: `make python-dist V=vX.Y.Z` stamps the release tag into
+# the copy it builds, since the tag is the only place a version is recorded (RELEASING.md).
+name = "agni-eda"
+version = "0.3.12"
+description = "Typed Python client for the agni EDA engine, over its CLI or its Connect API"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+# The floor is the version buf.gen.py.yaml's plugins stamp into the generated modules, which refuse
+# to import under an older runtime. Bump the two together.
+dependencies = ["protobuf>=7.36.2,<8"]
+
+[project.urls]
+Homepage = "https://github.com/panyam/agni"
+Documentation = "https://panyam.github.io/agni/build/other-languages/"
+Issues = "https://github.com/panyam/agni/issues"
+
+[project.optional-dependencies]
+xlsx = ["openpyxl>=3.1"]
+# The examples read a query set from YAML, the file `agni query --set` takes.
+examples = ["openpyxl>=3.1", "pyyaml>=6"]
+test = ["pytest>=8", "openpyxl>=3.1", "pyyaml>=6"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+# The generated agni.v1.* directories carry no __init__.py, so they are namespace packages.
+namespaces = true
+
+[tool.setuptools.package-data]
+"*" = ["*.pyi", "py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

agni_eda-0.3.12/setup.cfg

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

agni_eda-0.3.12/src/agni/__init__.py

@@ -0,0 +1,32 @@
+"""A typed Python client for agni.
+
+The message classes under ``agni.v1`` are generated from the same protos the engine and the web
+viewer use, so a response here is the wire contract rather than a dict shaped like it.
+"""
+
+from agni.client import Client
+from agni.errors import AgniError, CliUnsupported
+from agni.tables import (
+    rows_as_dicts,
+    table_sheets,
+    tables_to_xlsx,
+    to_rows,
+)
+from agni.transport import CLI_COMMANDS, CLI_ONLY, CliTransport, ConnectTransport, parse
+from agni.values import bindings
+
+__all__ = [
+    "AgniError",
+    "bindings",
+    "CLI_COMMANDS",
+    "CLI_ONLY",
+    "Client",
+    "CliTransport",
+    "CliUnsupported",
+    "ConnectTransport",
+    "parse",
+    "rows_as_dicts",
+    "table_sheets",
+    "tables_to_xlsx",
+    "to_rows",
+]

agni_eda-0.3.12/src/agni/client.py

@@ -0,0 +1,245 @@
+"""The client: one method per rpc, the same types on either transport."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Mapping, Optional, Protocol, Union
+
+from google.protobuf import empty_pb2
+from google.protobuf.message import Message
+
+from agni import services
+from agni.errors import AgniError
+from agni.v1.webapi import checks_pb2, config_pb2, design_pb2, diff_pb2, query_pb2, review_pb2, snapshot_pb2, tables_pb2, workspace_pb2
+
+
+class Transport(Protocol):
+    def call(self, rpc: services.Rpc, request: Message) -> Message: ...
+
+
+class Client:
+    """Asks agni questions through a transport.
+
+    Switching between the CLI and a server changes the constructor argument and nothing else, since
+    both return the rpc's own response message::
+
+        c = Client(CliTransport(mounts={"tut": "examples/tutorial-project"}))
+        c = Client(ConnectTransport("http://127.0.0.1:8080"))
+        snap = c.ingest("mount://tut/designs/gateway")
+        rows = c.run_query(snapshot=snap, query='component.class(?c,"resistor") => ?c')
+        c.delete_snapshot(snap)
+
+    Every question names a snapshot, the design loaded once under one config (agni issue 1061), so
+    a script ingests each design it asks about and passes the name ``ingest`` returns as
+    ``snapshot=``, or ``a_snapshot=`` and ``b_snapshot=`` to ``diff_designs``.
+
+    The named methods cover the questions an analysis script asks. Every other rpc is reachable
+    through ``call``, which resolves the request and response types from the generated descriptors.
+    """
+
+    def __init__(self, transport: Transport) -> None:
+        self.transport = transport
+        # The definition of each snapshot this client ingested, by name, so a question about one the
+        # server lost or saw change can be recovered (agni issue 1067).
+        self._definitions: Dict[str, snapshot_pb2.Snapshot] = {}
+
+    def call(self, service: str, method: str, request: Optional[Message] = None, **fields) -> Message:
+        """Call any rpc by name, e.g. ``call("ProjectService", "ListProjects")``.
+
+        Pass a request message, or its fields as keywords, not both. Raises ``KeyError`` for an rpc
+        agni does not declare, and ``TypeError`` for a request of the wrong message type.
+        """
+        rpc = services.lookup(service, method)
+        if request is None:
+            request = rpc.request(**fields)
+        elif fields:
+            raise TypeError("pass a request message or keyword fields, not both")
+        elif not isinstance(request, rpc.request):
+            raise TypeError(
+                f"{service}/{method} takes {rpc.request.DESCRIPTOR.full_name}, "
+                f"got {request.DESCRIPTOR.full_name}"
+            )
+        try:
+            resp = self.transport.call(rpc, request)
+        except AgniError as e:
+            # A server holds a snapshot until it evicts it or restarts, and refuses one whose files
+            # changed (agni issue 1061). Asked about a snapshot this client ingested, the client
+            # ingests it again under its name, or updates a stale one, and asks once more, as the
+            # viewer does (web/src/snapshots.ts). The CLI transport mints names locally and never
+            # raises this.
+            if service == "SnapshotService" or not self._recover(e):
+                raise
+            resp = self.transport.call(rpc, request)
+        self._remember(service, method, request, resp)
+        return resp
+
+    def _remember(self, service: str, method: str, request: Message, resp: Message) -> None:
+        """Keep, or forget, the definition of the snapshot a SnapshotService call named."""
+        if service != "SnapshotService":
+            return
+        if method == "Ingest":
+            definition = snapshot_pb2.Snapshot()
+            definition.CopyFrom(request.snapshot)  # type: ignore[attr-defined]
+            definition.ClearField("name")
+            self._definitions[resp.name] = definition  # type: ignore[attr-defined]
+        elif method == "UpdateSnapshot" and request.snapshot.name in self._definitions:  # type: ignore[attr-defined]
+            definition = self._definitions[request.snapshot.name]  # type: ignore[attr-defined]
+            if request.HasField("update_mask") and request.update_mask.paths:  # type: ignore[attr-defined]
+                request.update_mask.MergeMessage(request.snapshot, definition)  # type: ignore[attr-defined]
+            else:
+                definition.CopyFrom(request.snapshot)  # type: ignore[attr-defined]
+                definition.ClearField("name")
+        elif method == "DeleteSnapshot":
+            self._definitions.pop(request.name, None)  # type: ignore[attr-defined]
+
+    def _recover(self, e: AgniError) -> bool:
+        """Make the snapshot an error names answerable again, reporting whether it did anything."""
+        d = e.snapshot_unavailable
+        if d is None or e.code not in ("not_found", "failed_precondition"):
+            return False
+        definition = self._definitions.get(d.name)
+        if definition is None:
+            return False
+        if d.reason == snapshot_pb2.SnapshotUnavailable.REASON_STALE:
+            snap = snapshot_pb2.Snapshot()
+            snap.CopyFrom(definition)
+            snap.name = d.name
+            self.call("SnapshotService", "UpdateSnapshot", snapshot=snap)
+        else:
+            self.call("SnapshotService", "Ingest", snapshot=definition, snapshot_id=d.name.removeprefix("snapshots/"))
+        return True
+
+    def ingest(
+        self,
+        uri: str,
+        *,
+        board_uri: str = "",
+        geometry_uri: str = "",
+        as_named: bool = False,
+        flatten_hierarchy: bool = False,
+        overlay: Optional[Union[config_pb2.OverlayConfig, Mapping[str, Any]]] = None,
+        read_board: bool = False,
+        snapshot_id: str = "",
+    ) -> str:
+        """Load the design ``uri`` names and return the snapshot's name, ``snapshots/<id>``, which every
+        question takes as ``snapshot=``.
+
+        ``board_uri`` and ``geometry_uri`` attach a board or schematic other than the ones the design
+        declares, ``as_named`` reads exactly the artifact named, and ``overlay`` is the config every
+        question is answered under. ``flatten_hierarchy`` reads a hierarchical netlist (an EDIF export
+        whose top cell places blocks) whole, as the CLI's ``--flatten-hierarchy`` does; left off, every
+        question is answered over the top cell alone. ``ingest_snapshot`` returns the whole
+        ``Snapshot`` instead.
+        """
+        snap = snapshot_pb2.Snapshot(
+            uri=uri,
+            board_uri=board_uri,
+            geometry_uri=geometry_uri,
+            as_named=as_named,
+            flatten_hierarchy=flatten_hierarchy,
+            overlay=overlay,
+        )
+        resp = self.call("SnapshotService", "Ingest", snapshot=snap, read_board=read_board, snapshot_id=snapshot_id)
+        return resp.name  # type: ignore[attr-defined]
+
+    def ingest_snapshot(self, request: Optional[snapshot_pb2.IngestRequest] = None, **fields) -> snapshot_pb2.Snapshot:
+        """Ingest a definition, ``snapshot={"uri": ...}``, and return the snapshot with what its tiers
+        resolved to. Over the CLI the snapshot carries its name and definition alone."""
+        return self.call("SnapshotService", "Ingest", request, **fields)  # type: ignore[return-value]
+
+    def get_snapshot(self, request: Optional[Union[snapshot_pb2.GetSnapshotRequest, str]] = None, **fields) -> snapshot_pb2.Snapshot:
+        """The snapshot a name names, as ``get_snapshot("snapshots/x")`` or ``name=``."""
+        if isinstance(request, str):
+            request, fields = None, {"name": request, **fields}
+        return self.call("SnapshotService", "GetSnapshot", request, **fields)  # type: ignore[return-value]
+
+    def list_snapshots(self, request: Optional[snapshot_pb2.ListSnapshotsRequest] = None, **fields) -> snapshot_pb2.ListSnapshotsResponse:
+        return self.call("SnapshotService", "ListSnapshots", request, **fields)  # type: ignore[return-value]
+
+    def update_snapshot(self, request: Optional[snapshot_pb2.UpdateSnapshotRequest] = None, **fields) -> snapshot_pb2.Snapshot:
+        """Replace a snapshot's definition, whole or by ``update_mask``, and read it again under the same
+        name. The same definition again is how a stale snapshot is refreshed."""
+        return self.call("SnapshotService", "UpdateSnapshot", request, **fields)  # type: ignore[return-value]
+
+    def delete_snapshot(self, request: Optional[Union[snapshot_pb2.DeleteSnapshotRequest, str]] = None, **fields) -> empty_pb2.Empty:
+        """Forget a snapshot, as ``delete_snapshot("snapshots/x")`` or ``name=``."""
+        if isinstance(request, str):
+            request, fields = None, {"name": request, **fields}
+        return self.call("SnapshotService", "DeleteSnapshot", request, **fields)  # type: ignore[return-value]
+
+    def check_design(self, request: Optional[checks_pb2.CheckDesignRequest] = None, **fields) -> checks_pb2.CheckDesignResponse:
+        """Run the rule catalog. Over the CLI the response carries no ``verdicts``; see the README."""
+        return self.call("CheckService", "CheckDesign", request, **fields)  # type: ignore[return-value]
+
+    def get_check_report(self, request: Optional[checks_pb2.GetCheckReportRequest] = None, **fields) -> checks_pb2.GetCheckReportResponse:
+        return self.call("CheckService", "GetCheckReport", request, **fields)  # type: ignore[return-value]
+
+    def list_rules(self, request: Optional[checks_pb2.ListRulesRequest] = None, **fields) -> checks_pb2.ListRulesResponse:
+        return self.call("CheckService", "ListRules", request, **fields)  # type: ignore[return-value]
+
+    def run_query(self, request: Optional[query_pb2.RunQueryRequest] = None, **fields) -> query_pb2.RunQueryResponse:
+        return self.call("QueryService", "RunQuery", request, **fields)  # type: ignore[return-value]
+
+    def run_queries(self, request: Optional[query_pb2.RunQueriesRequest] = None, **fields) -> query_pb2.RunQueriesResponse:
+        """Answer a named list of queries over one read of the design.
+
+        A query that could not be answered carries ``error`` rather than ``result``; the call itself
+        succeeds, so check each result. ``tabulate(query_set=...)`` turns it into tables.
+        """
+        return self.call("QueryService", "RunQueries", request, **fields)  # type: ignore[return-value]
+
+    def list_query_sets(self, request: Optional[query_pb2.ListQuerySetsRequest] = None, **fields) -> query_pb2.ListQuerySetsResponse:
+        """The query sets the design's project keeps in its ``queries/`` directory, inherited ones
+        first, each parsed. ``run_queries(set=...)`` runs one. An empty ``project`` means the design
+        belongs to none. Connect only."""
+        return self.call("QueryService", "ListQuerySets", request, **fields)  # type: ignore[return-value]
+
+    def parse_query_set(self, request: Optional[query_pb2.ParseQuerySetRequest] = None, **fields) -> query_pb2.ParseQuerySetResponse:
+        """A query set file's ``text`` read into the ``QuerySet`` ``run_queries`` takes, checked as
+        ``agni query --set`` checks it. Connect only."""
+        return self.call("QueryService", "ParseQuerySet", request, **fields)  # type: ignore[return-value]
+
+    def tabulate(self, request: Optional[tables_pb2.TabulateRequest] = None, **fields) -> tables_pb2.TabulateResponse:
+        """The engine's tables for an answer this client already holds: ``check=`` a CheckDesign
+        response, ``query=`` a query answer or ``query_set=`` a set's, with ``order_by`` such as
+        ``["rule", "-subject"]``. These are the rows ``agni check --format csv`` prints, so a workbook
+        built from them matches the csv of the same run. ``agni.tables_to_xlsx`` writes them.
+        """
+        return self.call("TableService", "Tabulate", request, **fields)  # type: ignore[return-value]
+
+    def list_relations(self, request: Optional[query_pb2.ListRelationsRequest] = None, **fields) -> query_pb2.ListRelationsResponse:
+        return self.call("QueryService", "ListRelations", request, **fields)  # type: ignore[return-value]
+
+    def diff_designs(self, request: Optional[diff_pb2.DiffDesignsRequest] = None, **fields) -> diff_pb2.DiffDesignsResponse:
+        return self.call("DiffService", "DiffDesigns", request, **fields)  # type: ignore[return-value]
+
+    def get_design(self, request: Optional[design_pb2.GetDesignRequest] = None, **fields) -> design_pb2.GetDesignResponse:
+        return self.call("DesignService", "GetDesign", request, **fields)  # type: ignore[return-value]
+
+    def trace_design(self, request: Optional[design_pb2.TraceDesignRequest] = None, **fields) -> design_pb2.TraceDesignResponse:
+        """Follow a signal between two pins. ``from`` is a Python keyword, so pass the request
+        message, or ``**{"from": ...}``."""
+        return self.call("DesignService", "TraceDesign", request, **fields)  # type: ignore[return-value]
+
+    def get_layout_report(self, request: Optional[design_pb2.GetLayoutReportRequest] = None, **fields) -> design_pb2.GetLayoutReportResponse:
+        return self.call("DesignService", "GetLayoutReport", request, **fields)  # type: ignore[return-value]
+
+    def create_review(self, request: Optional[review_pb2.CreateReviewRequest] = None, **fields) -> review_pb2.Review:
+        """Score a checklist. Connect only until agni issue 734 lands."""
+        return self.call("ReviewService", "CreateReview", request, **fields)  # type: ignore[return-value]
+
+    def list_checklists(self, request: Optional[review_pb2.ListChecklistsRequest] = None, **fields) -> review_pb2.ListChecklistsResponse:
+        """The checklists the design's project declares, inherited ones included, the project's
+        default first. Each carries its manifest, which ``create_review(manifest=...)`` runs. An
+        empty ``project`` means the design belongs to none."""
+        return self.call("ReviewService", "ListChecklists", request, **fields)  # type: ignore[return-value]
+
+    def render_review_report(self, request: Optional[review_pb2.RenderReviewReportRequest] = None, **fields) -> review_pb2.RenderReviewReportResponse:
+        """A review this client holds, ``review=`` as ``create_review`` returned it, written as the
+        checklist page ``agni review --format html`` writes. Nothing is re-run. Connect only."""
+        return self.call("ReviewService", "RenderReviewReport", request, **fields)  # type: ignore[return-value]
+
+    def get_review_manifest(self, request: Optional[review_pb2.GetReviewManifestRequest] = None, **fields) -> review_pb2.GetReviewManifestResponse:
+        return self.call("ReviewService", "GetReviewManifest", request, **fields)  # type: ignore[return-value]
+
+    def list_mounts(self, request: Optional[workspace_pb2.ListMountsRequest] = None, **fields) -> workspace_pb2.ListMountsResponse:
+        return self.call("WorkspaceService", "ListMounts", request, **fields)  # type: ignore[return-value]