lsst-pipe-base 30.2026.400__py3-none-any.whl → 30.2026.500__py3-none-any.whl

lsst/pipe/base/_instrument.py

@@ -35,7 +35,7 @@ from abc import ABCMeta, abstractmethod
 from collections.abc import Sequence
 from typing import TYPE_CHECKING, Any, Self, cast, final
 
-from lsst.daf.butler import DataCoordinate, DataId, DimensionPacker, DimensionRecord, Formatter
+from lsst.daf.butler import DataCoordinate, DataId, DimensionPacker, DimensionRecord, Formatter, FormatterV2
 from lsst.daf.butler.registry import DataIdError
 from lsst.pex.config import Config, RegistryField
 from lsst.resources import ResourcePath, ResourcePathExpression
@@ -311,7 +311,7 @@ class Instrument(metaclass=ABCMeta):
         return instrument_cls(collection_prefix=collection_prefix)
 
     @staticmethod
-    def importAll(registry: Registry) -> None:
+    def importAll(registry: Registry) -> dict[str, type[Instrument]]:
         """Import all the instruments known to this registry.
 
         This will ensure that all metadata translators have been registered.
@@ -321,20 +321,31 @@ class Instrument(metaclass=ABCMeta):
         registry : `lsst.daf.butler.Registry`
             Butler registry to query to find the information.
 
+        Returns
+        -------
+        imported : `dict` [`str`, `type` [`Instrument`]]
+            A mapping containing all the instrument classes that were loaded
+            successfully, keyed by their butler names.
+
         Notes
         -----
         It is allowed for a particular instrument class to fail on import.
         This might simply indicate that a particular obs package has
         not been setup.
         """
+        imported: dict[str, type[Instrument]] = {}
         records = list(registry.queryDimensionRecords("instrument"))
         for record in records:
             cls = record.class_name
+            instrument_name: str = cast(str, record.name)
             with contextlib.suppress(Exception):
-                doImportType(cls)
+                instr = doImportType(cls)
+                assert issubclass(instr, Instrument)
+                imported[instrument_name] = instr
+        return imported
 
     @abstractmethod
-    def getRawFormatter(self, dataId: DataId) -> type[Formatter]:
+    def getRawFormatter(self, dataId: DataId) -> type[Formatter | FormatterV2]:
         """Return the Formatter class that should be used to read a particular
         raw file.
 
@@ -345,7 +356,8 @@ class Instrument(metaclass=ABCMeta):
 
         Returns
         -------
-        formatter : `lsst.daf.butler.Formatter` class
+        formatter : `type` \
+                [`lsst.daf.butler.Formatter` | `lsst.daf.butler.FormatterV2` ]
             Class to be used that reads the file into the correct
             Python object for the raw data.
         """

lsst/pipe/base/_quantumContext.py

@@ -380,8 +380,8 @@ class QuantumContext:
             if dataset is directly a `list` of `~lsst.daf.butler.DatasetRef`
             or a single `~lsst.daf.butler.DatasetRef`. If ``values.NAME`` is
             None, no output is written.
-        dataset : `OutputQuantizedConnection` or `list`[`DatasetRef`] \
-                or `DatasetRef`
+        dataset : `OutputQuantizedConnection` or `list` \
+                [`lsst.daf.butler.DatasetRef`] or `lsst.daf.butler.DatasetRef`
             This argument may either be an `InputQuantizedConnection` which
             describes all the inputs of a quantum, a list of
             `lsst.daf.butler.DatasetRef`, or a single
@@ -460,7 +460,7 @@ class QuantumContext:
 
         Parameters
         ----------
-        ref : `DatasetRef`
+        ref : `lsst.daf.butler.DatasetRef`
             The dataset to attach provenance to. This dataset must have been
             retrieved by this quantum context.
         extra : `dict` [ `str`, `int` | `float` | `str` | `bool` ]

lsst/pipe/base/_status.py

@@ -338,6 +338,20 @@ class QuantumAttemptStatus(enum.Enum):
         """Whether the log dataset was produced."""
         return self is self.SUCCESSFUL or self is self.FAILED
 
+    @property
+    def title(self) -> str:
+        """A version of this status' name suitable for use as a title in a plot
+        or table.
+        """
+        return self.name.capitalize().replace("_", " ")
+
+    @property
+    def is_rare(self) -> bool:
+        """Whether this status is rare enough that it should only be listed
+        when it actually occurs.
+        """
+        return self in (self.ABORTED, self.ABORTED_SUCCESS, self.UNKNOWN)
+
 
 class GetSetDictMetadataHolder(Protocol):
     """Protocol for objects that have a ``metadata`` attribute that satisfies

lsst/pipe/base/automatic_connection_constants.py

@@ -45,6 +45,8 @@ __all__ = (
     "PACKAGES_INIT_OUTPUT_STORAGE_CLASS",
     "PROVENANCE_DATASET_TYPE_NAME",
     "PROVENANCE_STORAGE_CLASS",
+    "RESOURCE_USAGE_STORAGE_CLASS",
+    "RESOURCE_USAGE_TEMPLATE",
 )
 
 
@@ -99,3 +101,12 @@ PROVENANCE_DATASET_TYPE_NAME: str = "run_provenance"
 
 PROVENANCE_STORAGE_CLASS: str = "ProvenanceQuantumGraph"
 """Name of the storage class used to store provenance."""
+
+RESOURCE_USAGE_TEMPLATE: str = "{label}_resource_usage"
+"""String template used to form the name of the resource usage dataset type for
+a task.
+"""
+
+RESOURCE_USAGE_STORAGE_CLASS: str = "ArrowAstropy"
+"""Storage class of the resource usage dataset type for a task.
+"""

lsst/pipe/base/cli/cmd/__init__.py

@@ -32,6 +32,7 @@ __all__ = [
     "retrieve_artifacts_for_quanta",
     "aggregate_graph",
     "ingest_graph",
+    "provenance_report",
 ]
 
 from .commands import (
@@ -41,4 +42,5 @@ from .commands import (
     zip_from_graph,
     aggregate_graph,
     ingest_graph,
+    provenance_report,
 )

lsst/pipe/base/cli/cmd/commands.py

@@ -25,6 +25,9 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import functools
+import operator
+from collections.abc import Iterable
 from typing import Any
 
 import click
@@ -40,6 +43,7 @@ from lsst.daf.butler.cli.opt import (
 from lsst.daf.butler.cli.utils import ButlerCommand, split_commas, unwrap
 
 from ... import script
+from ..._status import QuantumAttemptStatus, QuantumSuccessCaveats
 from ...quantum_graph import aggregator
 from ..opt import instrument_argument, update_output_chain_option
 
@@ -279,7 +283,7 @@ def aggregate_graph(predicted_graph: str, repo: str, **kwargs: Any) -> None:
 
 
 @click.command(
-    short_help="Ingest a provenance quantum graph into a butler, finalizing a RUN collection.",
+    short_help="Ingest a provenance quantum graph into a butler.",
     cls=ButlerCommand,
 )
 @repo_argument(required=True, help="Path or alias for the butler repository.")
@@ -306,3 +310,106 @@ def ingest_graph(
     from ...quantum_graph.ingest_graph import ingest_graph as ingest_graph_py
 
     ingest_graph_py(repo, provenance_graph, transfer=transfer, batch_size=batch_size, output_run=output_run)
+
+
+@click.command(
+    short_help="Print and write provenance reports.",
+    cls=ButlerCommand,
+)
+@click.argument("repo_or_qg")
+@click.argument("collection", required=False, default=None)
+@click.option(
+    "--state",
+    multiple=True,
+    type=click.Choice(QuantumAttemptStatus),
+    help=(
+        "Additional quantum state to include in the status report and data ID tables "
+        "(FAILED, ABORTED, and ABORTED_SUCCESS are included by default)."
+    ),
+)
+@click.option(
+    "--no-state",
+    multiple=True,
+    type=str,
+    metavar="STATE",
+    help="Quantum state to drop from in status report and data ID tables (same options as --state).",
+)
+@click.option(
+    "--status-report",
+    default=None,
+    metavar="URI",
+    help="File or URI (.json) for a detailed report (with data IDs) on quanta with certain states.",
+)
+@click.option(
+    "--quantum-table/--no-quantum-table",
+    default=True,
+    help="Whether to print summary of quantum status counts to STDOUT.",
+)
+@click.option(
+    "--exception-table/--no-exception-table",
+    default=True,
+    help="Whether to print summary of exception type counts STDOUT.",
+)
+@click.option(
+    "--caveat",
+    multiple=True,
+    type=click.Choice(QuantumSuccessCaveats),
+    help=(
+        "Include successful quanta in the status report if they have this caveat. "
+        "May be passed multiple times; any matching caveat is included. "
+        "Passing this option implicitly adds '--state SUCCESSFUL'."
+    ),
+)
+@click.option(
+    "--data-id-table-dir",
+    default=None,
+    metavar="URI",
+    help=(
+        "Directory (may be a URI) for a tree of data ID tables for each "
+        "task label, status, and exception type combination in the status report."
+    ),
+)
+def provenance_report(
+    *,
+    repo_or_qg: str,
+    collection: str | None,
+    state: Iterable[QuantumAttemptStatus],
+    no_state: Iterable[str],
+    status_report: str | None,
+    quantum_table: bool = False,
+    exception_table: bool = False,
+    caveat: Iterable[QuantumSuccessCaveats],
+    data_id_table_dir: str | None,
+) -> None:
+    """Read a provenance quantum graph from a butler or file and use it to
+    generate reports.
+
+    REPO_OR_QG is a path or alias for the butler repository (if reading an
+    ingested graph, as indicated by passing COLLECTION), or the path to a
+    provenance quantum graph file.
+    """
+    from ...quantum_graph import ProvenanceQuantumGraph
+
+    states = set(state)
+    states.add(QuantumAttemptStatus.FAILED)
+    states.add(QuantumAttemptStatus.ABORTED)
+    states.add(QuantumAttemptStatus.ABORTED_SUCCESS)
+    for state_name in no_state:
+        states.discard(QuantumAttemptStatus.__members__[state_name])
+    with_caveats: QuantumSuccessCaveats | None = None
+    if caveat:
+        states.add(QuantumAttemptStatus.SUCCESSFUL)
+        with_caveats = functools.reduce(
+            operator.__or__,
+            caveat,
+            QuantumSuccessCaveats.NO_CAVEATS,
+        )
+    with ProvenanceQuantumGraph.from_args(repo_or_qg, collection=collection, datasets=()) as (graph, _):
+        graph.make_many_reports(
+            status_report_file=status_report,
+            states=states,
+            print_quantum_table=quantum_table,
+            print_exception_table=exception_table,
+            with_caveats=with_caveats,
+            data_id_table_dir=data_id_table_dir,
+        )

lsst/pipe/base/graph/graph.py

@@ -136,13 +136,14 @@ class QuantumGraph:
         Maps tasks to their InitOutput dataset refs. Dataset refs can be either
         resolved or non-resolved. For intermediate resolved refs their dataset
         ID must match ``initInputs`` and Quantum ``initInputs``.
-    globalInitOutputs : iterable [ `~lsst.daf.butler.DatasetRef` ], optional
+    globalInitOutputs : `~collections.abc.Iterable` \
+            [ `~lsst.daf.butler.DatasetRef` ], optional
         Dataset refs for some global objects produced by pipeline. These
         objects include task configurations and package versions. Typically
         they have an empty DataId, but there is no real restriction on what
         can appear here.
-    registryDatasetTypes : iterable [ `~lsst.daf.butler.DatasetType` ], \
-            optional
+    registryDatasetTypes : `~collections.abc.Iterable` \
+            [ `~lsst.daf.butler.DatasetType` ],  optional
         Dataset types which are used by this graph, their definitions must
         match registry. If registry does not define dataset type yet, then
         it should match one that will be created later.
@@ -488,7 +489,7 @@ class QuantumGraph:
 
         Returns
         -------
-        tasks : iterable of `TaskDef`
+        tasks : `~collections.abc.Iterable` [ `TaskDef` ]
             `TaskDef` objects that have the specified `DatasetTypeName` as an
             input, list will be empty if no tasks use specified
             `DatasetTypeName` as an input.
@@ -537,7 +538,7 @@ class QuantumGraph:
 
         Returns
         -------
-        result : iterable of `TaskDef`
+        result : `~collections.abc.Iterable` [`TaskDef`]
             `TaskDef` objects that are associated with the specified
             `DatasetTypeName`.
 
@@ -935,7 +936,7 @@ class QuantumGraph:
             saved structure. If supplied, the
             `~lsst.daf.butler.DimensionUniverse` from the loaded `QuantumGraph`
             will be validated against the supplied argument for compatibility.
-        nodes : iterable of [ `uuid.UUID` | `str` ] or `None`
+        nodes : `~collections.abc.Iterable` [ `uuid.UUID` | `str` ] or `None`
             UUIDs that correspond to nodes in the graph. If specified, only
             these nodes will be loaded. Defaults to None, in which case all
             nodes will be loaded.
@@ -1220,7 +1221,7 @@ class QuantumGraph:
             saved structure. If supplied, the
             `~lsst.daf.butler.DimensionUniverse` from the loaded `QuantumGraph`
             will be validated against the supplied argument for compatibility.
-        nodes : iterable of `uuid.UUID` or `None`
+        nodes : `~collections.abc.Iterable` [`uuid.UUID`] or `None`
             UUIDs that correspond to nodes in the graph. If specified, only
             these nodes will be loaded. Defaults to None, in which case all
             nodes will be loaded.
@@ -1438,7 +1439,7 @@ class QuantumGraph:
         Returns
         -------
         summary : `QgraphSummary`
-           Summary of QuantumGraph.
+            Summary of QuantumGraph.
         """
         inCollection = self.metadata.get("input", None)
         if isinstance(inCollection, str):

lsst/pipe/base/log_capture.py

@@ -103,7 +103,7 @@ class _ExecutionLogRecordsExtra(pydantic.BaseModel):
 
         Parameters
         ----------
-        log_records : `ButlerLogRecords`
+        log_records : `lsst.daf.butler.ButlerLogRecords`
             Logs from a past attempt to run a quantum.
         """
         previous = self.model_validate(log_records.extra)

lsst/pipe/base/pipeline.py

@@ -495,7 +495,7 @@ class Pipeline:
         Returns
         -------
         pipeline: `Pipeline`
-           The new pipeline.
+            The new pipeline.
         """
         return cls.fromIR(copy.deepcopy(pipeline._pipelineIR))
 
@@ -605,7 +605,7 @@ class Pipeline:
 
     @property
     def subsets(self) -> MappingProxyType[str, set]:
-        """Returns a `MappingProxyType` where the keys are the labels of
+        """Returns a `types.MappingProxyType` where the keys are the labels of
         labeled subsets in the `Pipeline` and the values are the set of task
         labels contained within that subset.
         """

lsst/pipe/base/pipelineIR.py

@@ -700,7 +700,7 @@ class PipelineIR:
 
         Parameters
         ----------
-        loaded_yaml: `dict`
+        loaded_yaml : `dict`
             A dictionary which matches the structure that would be produced
             by a yaml reader which parses a pipeline definition document
         """

lsst/pipe/base/pipeline_graph/_dataset_types.py

@@ -106,8 +106,8 @@ class DatasetTypeNode:
             The internal networkx graph.
         get_registered : `~collections.abc.Callable` or `None`
             Callable that takes a dataset type name and returns the
-            `DatasetType` registered in the data repository, or `None` if it is
-            not registered.
+            `~lsst.daf.butler.DatasetType` registered in the data repository,
+            or `None` if it is not registered.
         dimensions : `lsst.daf.butler.DimensionUniverse`
             Definitions of all dimensions.
         previous : `DatasetTypeNode` or `None`

lsst/pipe/base/pipeline_graph/_edges.py

@@ -480,11 +480,11 @@ class ReadEdge(Edge):
         Parameters
         ----------
         current : `lsst.daf.butler.DatasetType` or `None`
-            The current graph-wide `DatasetType`, or `None`.  This will always
-            be the registry's definition of the parent dataset type, if one
-            exists.  If not, it will be the dataset type definition from the
-            task in the graph that writes it, if there is one.  If there is no
-            such task, this will be `None`.
+            The current graph-wide `~lsst.daf.butler.DatasetType`, or `None`.
+            This will always be the registry's definition of the parent dataset
+            type, if one exists.  If not, it will be the dataset type
+            definition from the task in the graph that writes it, if there is
+            one.  If there is no such task, this will be `None`.
         is_initial_query_constraint : `bool`
             Whether this dataset type is currently marked as a constraint on
             the initial data ID query in QuantumGraph generation.
@@ -496,7 +496,7 @@ class ReadEdge(Edge):
         producer : `str` or `None`
             The label of the task that produces this dataset type in the
             pipeline, or `None` if it is an overall input.
-        consumers : `Sequence` [ `str` ]
+        consumers : `~collections.abc.Sequence` [ `str` ]
             Labels for other consuming tasks that have already participated in
             this dataset type's resolution.
         is_registered : `bool`
@@ -512,7 +512,7 @@ class ReadEdge(Edge):
 
         Returns
         -------
-        dataset_type : `DatasetType`
+        dataset_type : `~lsst.daf.butler.DatasetType`
             The updated graph-wide dataset type.  If ``current`` was provided,
             this must be equal to it.
         is_initial_query_constraint : `bool`
@@ -800,15 +800,15 @@ class WriteEdge(Edge):
         Parameters
         ----------
         current : `lsst.daf.butler.DatasetType` or `None`
-            The current graph-wide `DatasetType`, or `None`.  This will always
-            be the registry's definition of the parent dataset type, if one
-            exists.
+            The current graph-wide `~lsst.daf.butler.DatasetType`, or `None`.
+            This will always be the registry's definition of the parent dataset
+            type, if one exists.
         universe : `lsst.daf.butler.DimensionUniverse`
             Object that holds all dimension definitions.
 
         Returns
         -------
-        dataset_type : `DatasetType`
+        dataset_type : `~lsst.daf.butler.DatasetType`
             A dataset type compatible with this edge.  If ``current`` was
             provided, this must be equal to it.
 

lsst/pipe/base/pipeline_graph/_pipeline_graph.py

@@ -1636,7 +1636,7 @@ class PipelineGraph:
 
         Returns
         -------
-        subgraphs : `Iterable` [ `PipelineGraph` ]
+        subgraphs : `~collections.abc.Iterable` [ `PipelineGraph` ]
             An iterable over component subgraphs that could be run
             independently (they have only overall inputs in common).  May be a
             lazy iterator.
@@ -2236,7 +2236,7 @@ class PipelineGraph:
 
         Parameters
         ----------
-        updates : `Mapping` [ `str`, `TaskNode` ]
+        updates : `~collections.abc.Mapping` [ `str`, `TaskNode` ]
             New task nodes with task label keys.  All keys must be task labels
             that are already present in the graph.
         check_edges_unchanged : `bool`, optional

lsst/pipe/base/pipeline_graph/visualization/_dot.py

@@ -66,7 +66,7 @@ def show_dot(
     ----------
     pipeline_graph : `PipelineGraph`
         Pipeline graph to show.
-    stream : `TextIO`, optional
+    stream : `io.TextIO`, optional
         Stream to write the DOT representation to.
     label_edge_connections : `bool`, optional
         If `True`, label edges with their connection names.
@@ -167,21 +167,22 @@ def _render_dataset_type_node(
 
     Parameters
     ----------
-    node_key : NodeKey
-        The key for the node
-    node_data : Mapping[str, Any]
-        The data associated with the node
-    options : NodeAttributeOptions
-        Options for rendering the node
-    stream : TextIO
-        The stream to write the node to
+    node_key : `NodeKey`
+        The key for the node.
+    node_data : `~collections.abc.Mapping` [`str`, `typing.Any`]
+        The data associated with the node.
+    options : `NodeAttributeOptions`
+        Options for rendering the node.
+    stream : `io.TextIO`
+        The stream to write the node to.
+    overflow_ref : `int`, optional
 
     Returns
     -------
     overflow_ref : int
-        The reference number for the next overflow node
+        The reference number for the next overflow node.
     overflow_ids : str | None
-        The ID of the overflow node, if any
+        The ID of the overflow node, if any.
     """
     labels, label_extras, common_prefix = _format_label(str(node_key), _LABEL_MAX_LINES_SOFT)
     if len(labels) + len(label_extras) <= _LABEL_MAX_LINES_HARD:
@@ -271,7 +272,7 @@ def _render_edge(from_node_id: str, to_node_id: str, stream: TextIO, **kwargs: A
         The unique ID of the node the edge is going to
     stream : TextIO
         The stream to write the edge to
-    kwargs : Any
+    **kwargs : Any
         Additional keyword arguments to pass to the edge
     """
     if kwargs:

lsst/pipe/base/pipeline_graph/visualization/_status_annotator.py

@@ -200,6 +200,13 @@ class QuantumGraphExecutionStatusAnnotator:
     """Annotates a networkx graph with task and dataset status information from
     a quantum graph execution summary, implementing the StatusAnnotator
     protocol to update the graph with status data.
+
+    Parameters
+    ----------
+    *args : `typing.Any`
+        Arbitrary arguments.
+    **kwargs : `typing.Any`
+        Arbitrary keyword arguments.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:

lsst/pipe/base/prerequisite_helpers.py

@@ -252,7 +252,8 @@ class PrerequisiteFinder:
             Sequence of collections to search, in order.
         data_id : `lsst.daf.butler.DataCoordinate`
             Data ID for the quantum.
-        skypix_bounds : `Mapping` [ `str`, `lsst.sphgeom.RangeSet` ]
+        skypix_bounds : `~collections.abc.Mapping` \
+              [ `str`, `lsst.sphgeom.RangeSet` ]
             The spatial bounds of this quantum in various skypix dimensions.
             Keys are skypix dimension names (a superset of those in
             `dataset_skypix`) and values are sets of integer pixel ID ranges.

lsst/pipe/base/quantum_graph/_multiblock.py

@@ -43,18 +43,15 @@ import dataclasses
 import logging
 import tempfile
 import uuid
-from collections.abc import Iterator
+import zipfile
+from collections.abc import Iterator, Set
 from contextlib import contextmanager
 from io import BufferedReader, BytesIO
 from operator import attrgetter
-from typing import IO, TYPE_CHECKING, Protocol, TypeAlias, TypeVar
+from typing import IO, Protocol, TypeAlias, TypeVar
 
 import pydantic
 
-if TYPE_CHECKING:
-    import zipfile
-
-
 _LOG = logging.getLogger(__name__)
 
 
@@ -212,7 +209,7 @@ class AddressWriter:
     The converse is not true.
     """
 
-    def write(self, stream: IO[bytes], int_size: int) -> None:
+    def write(self, stream: IO[bytes], int_size: int, all_ids: Set[uuid.UUID] | None = None) -> None:
         """Write all addresses to a file-like object.
 
         Parameters
@@ -221,15 +218,17 @@ class AddressWriter:
             Binary file-like object.
         int_size : `int`
             Number of bytes to use for all integers.
+        all_ids : `~collections.abc.Set` [`uuid.UUID`], optional
+            Set of the union of all UUIDs in any dictionary from a call to
+            `get_all_ids`.
         """
-        indices: set[uuid.UUID] = set()
-        for address_map in self.addresses:
-            indices.update(address_map.keys())
+        if all_ids is None:
+            all_ids = self.get_all_ids()
         stream.write(int_size.to_bytes(1))
-        stream.write(len(indices).to_bytes(int_size))
+        stream.write(len(all_ids).to_bytes(int_size))
         stream.write(len(self.addresses).to_bytes(int_size))
         empty_address = Address()
-        for n, key in enumerate(sorted(indices, key=attrgetter("int"))):
+        for n, key in enumerate(sorted(all_ids, key=attrgetter("int"))):
             row = AddressRow(key, n, [m.get(key, empty_address) for m in self.addresses])
             _LOG.debug("Wrote address %s.", row)
             row.write(stream, int_size)
@@ -246,9 +245,26 @@ class AddressWriter:
         int_size : `int`
             Number of bytes to use for all integers.
         """
-        with zf.open(f"{name}.addr", mode="w") as stream:
+        all_ids = self.get_all_ids()
+        zip_info = zipfile.ZipInfo(f"{name}.addr")
+        row_size = AddressReader.compute_row_size(int_size, len(self.addresses))
+        zip_info.file_size = AddressReader.compute_header_size(int_size) + len(all_ids) * row_size
+        with zf.open(zip_info, mode="w") as stream:
             self.write(stream, int_size=int_size)
 
+    def get_all_ids(self) -> Set[uuid.UUID]:
+        """Return all IDs used by any address dictionary.
+
+        Returns
+        -------
+        all_ids : `~collections.abc.Set` [`uuid.UUID`]
+            Set of all IDs.
+        """
+        all_ids: set[uuid.UUID] = set()
+        for address_map in self.addresses:
+            all_ids.update(address_map.keys())
+        return all_ids
+
 
 @dataclasses.dataclass
 class AddressPage: