architxt.cli.utils

architxt.cli.utils#

Functions

`get_schema_metrics`(schema)
`init_forest`(forest, files)	Initialize a forest by loading trees from a list of storage paths (ZODB directories or JSONL files).
`load_forest`(files)	Load a forest from a list of storage paths (ZODB directories or JSONL files).
`show_metrics`(metrics)
`show_schema`(schema)
`show_valid_trees_metrics`(metrics, schema, ...)

architxt.cli.utils.get_schema_metrics(schema)[source]#

architxt.cli.utils.init_forest(forest, files)[source]#

Initialize a forest by loading trees from a list of storage paths (ZODB directories or JSONL files).

Parameters:

forest (Forest) – The forest to initialize.
files (Iterable[str | Path]) – List of file paths to read into the forest.

>>> with ZODBTreeBucket() as forest:
...     init_forest(forest, ['forest_dir/', 'forest.jsonl'])

architxt.cli.utils.load_forest(files)[source]#

Load a forest from a list of storage paths (ZODB directories or JSONL files).

Parameters:: files (Iterable[str | Path]) – List of file paths to read into a forest.
Yield:: Trees from the list of data files.

>>> forest = load_forest(['forest_dir/', 'forest.jsonl'])

architxt.cli.utils.show_metrics(metrics)[source]#

architxt.cli.utils.show_schema(schema)[source]#

architxt.cli.utils.show_valid_trees_metrics(metrics, schema, trees, step, log)[source]#