filesystem

Utilities for qnexus-filesystem interactions.

qnexus.filesystem.load(

path: Path,

) → Annotated[TeamRef | UserRef | ProjectRef | CircuitRef | WasmModuleRef | GpuDecoderConfigRef | HUGRRef | QIRRef | JobRef | CompileJobRef | ExecuteJobRef | CompilationResultRef | ExecutionResultRef | CompilationPassRef | SystemRef | IncompleteJobItemRef, FieldInfo(annotation=NoneType, required=True, discriminator='type')]

Load a Nexus Ref from a file.

Examples

>>> import qnexus as qnx
>>> from pathlib import Path
>>> project_ref = qnx.filesystem.load(Path("my_project.json"))

qnexus.filesystem.save(

ref: Annotated[TeamRef | UserRef | ProjectRef | CircuitRef | WasmModuleRef | GpuDecoderConfigRef | HUGRRef | QIRRef | JobRef | CompileJobRef | ExecuteJobRef | CompilationResultRef | ExecutionResultRef | CompilationPassRef | SystemRef | IncompleteJobItemRef, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

path: Path,

mkdir: bool = False,

) → None

Save a Nexus Ref to a file.

Examples

>>> import qnexus as qnx
>>> from pathlib import Path
>>> project_ref = qnx.projects.get(name="my-project")
>>> qnx.filesystem.save(project_ref, Path("my_project.json"))

>>> qnx.filesystem.save(project_ref, Path("data/refs/project.json"), mkdir=True)