vcti-tree-exporter-json 2.0.0

JSON exporter plugin for vcti-tree-exporter: writes a vcti tree to a single .json document (nested nodes carrying name, attributes, and light arrays as JSON lists).

JSON Tree Exporter

JSON exporter plugin for vcti-tree-exporter: writes a vcti tree to a single .json document.

JsonExporter serializes any vcti-tree tree whose node payloads are vcti-datanode DataNodes to one JSON document that mirrors the tree, and ships a get_exporter_descriptor() factory so a consumer registers it in a catalog and resolves it by id ("json") or by attribute lookup.

JSON is a natural fit for structure, metadata, and light arrays — simulation settings, CAE metadata, input decks — that load straight into tooling. It is a poor fit for large numeric arrays (they become bulky nested lists); use HDF5 or NPZ for heavy data.

Installation

pip install vcti-tree-exporter-json

This pulls in vcti-tree-exporter (the protocol/catalog) and numpy.

Tree → JSON mapping

Each node becomes an object; the document root is the tree's root node:

{
  "name": "model",
  "attributes": {"solver": "abaqus"},
  "children": [
    {"name": "info", "attributes": {"count": 7}},
    {"name": "displacement", "attributes": {}, "data": [1.0, 2.0, 3.0]}
  ]
}

Tree node part	JSON
node.name	"name" (the structural name; null if unset)
node.attributes	"attributes" object (always present)
node.load() array	"data" as nested lists (present only for data nodes)
children	"children" array (present only when non-empty)

A node may carry both data and children. Attribute values are JSON-encoded (bytes decoded, numpy scalars/arrays converted to numbers/lists); anything not natively serializable falls back to its str(). Array dtype is not preserved — the export is one-way.

Usage

from pathlib import Path
from vcti.tree.exporter.core import build_registry, get_exporter
from vcti.tree.exporter.json import get_exporter_descriptor

registry = build_registry([get_exporter_descriptor()])   # plus any other format plugins
get_exporter(registry, "json").export(tree, Path("model.json"), overwrite=True)

Or use the exporter directly:

from vcti.tree.exporter.json import JsonExporter
JsonExporter().export(tree, Path("model.json"))

Dependencies

• vcti-tree-exporter — the Exporter protocol and the ExporterDescriptor catalog.
• vcti-tree / vcti-datanode — the tree and payload types.
• numpy. (JSON encoding itself uses only the standard library.)