Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

StagedDataCollection

class cstar.io.staged_data.StagedDataCollection(items: Iterable[StagedData])

Bases: object

A class to hold a collection of related SourceData instances.

paths

Flattened list of all paths across all staged entries.

Type:

list of pathlib.Path

changed_from_source

True if any item’s StagedData.changed_from_source is True

Type:

bool

items

Flattened list of all StagedData entries

Type:

list of StagedData

append:

Add a new StagedData instance to this StagedDataCollection

reset:

Resets each StagedData item in the collection

unstage:

Unstages each StagedData item in the collection

Methods

StagedDataCollection.append(staged)
StagedDataCollection.reset()	Resets each StagedData item in the collection
StagedDataCollection.unstage()	Unstages each StagedData item in the collection

Attributes

StagedDataCollection.changed_from_source	True if any item's StagedData.changed_from_source is True.
StagedDataCollection.common_parent	Returns the nearest shared parent of SourceDataCollection.paths
StagedDataCollection.items	Flattened list of all StagedData entries
StagedDataCollection.paths	Flattened list of all paths across all staged entries.