chronaxis.load_analysis_plan

Import this object from chronaxis. This page covers its directly public members and necessary construction/context protocols. See the Chinese implementation reference for internals. Return to the public API index. Check required parameters, defaults, returns, and exceptions before calling.

`load_analysis_plan`

Load JSON/YAML and explicit shared definitions, apply supported overrides, and compile a plan. Input-directory declarations expand filenames. Missing signal type, unit, or enum choices can require DBC metadata, but business-message records are not scanned.

python

load_analysis_plan(path: Path | str, *, extensions=None) -> AnalysisPlan

Name	Type	Required	Default	Purpose, choices, and effect
`path`	Path \| str	Yes	No default	Positional or keyword. Configuration file path, not a directory to scan or an arbitrary path object. Read as UTF-8, allowing an initial BOM.
`extensions`	ExtensionRegistry \| None	No	None	Keyword-only trusted registry supplied by Python. The ordinary command line provides only built-in operations.

Returns a checked and compiled AnalysisPlan. It loads the main configuration/shared definitions, expands declared file sets, and reads DBC metadata as needed; it does not read business-message or CSV records.

Raises PlanValidationError for invalid path type, file read/encoding failures, JSON/YAML syntax, duplicate keys, nonfinite constants, or invalid declarations. Load errors include configuration file location and preserve detailed causes through exception chaining.

Side effects: opens configuration/shared files, reads DBCs or enumerates directories as needed, and closes handles before normal or exceptional return. Does not create result files.

python

from chronaxis import load_analysis_plan
plan = load_analysis_plan("Docs/Current/examples/analysis.yaml")

Host-registered operations

Register trusted callbacks in Python and pass the same immutable registry when loading and running a v4 plan. See the worked host example.

Source locations

src/chronaxis/planning/plan.py:376 — line at 8904c2f744951857659abd40aaa3535d57faf53c.