simulo.Output
A file registration created while a job is running.
simulo.save_output(name, path) builds this value and validates it
before adding it to the job’s local output registry. It describes a real
file at a real path, but registration alone is not confirmation that the
file was uploaded. After the job body returns successfully and completion
is accepted, the worker uploads eligible registrations to
job_artifacts; persisted files appear in the external /outputs
projection and can be downloaded. Failed, cancelled, timed-out, refused,
or unsuccessful upload paths may leave a registration undelivered, as
detailed in the module-level failure-path contract. Use a job result for
small JSON values or a named volume for files another job needs.
@dataclass(frozen=True, slots=True, kw_only=True)class Output| Field | Type | Default | Description |
|---|---|---|---|
name |
str |
required | Logical filename for the registration. It must be one filename, never a path. Separators, control characters, dots-only and whitespace-only values, empty values, and names over MAX_OUTPUT_NAME_BYTES are rejected. |
path |
str |
required | Filesystem path of the produced file while the job is running. Construction checks that it is a non-empty, NUL-free string within MAX_OUTPUT_PATH_BYTES. The path may be absolute or relative. |
kind |
OutputKind |
OutputKind.FILE |
What kind of file this is. The default is FILE. You may pass an OutputKind value or its string form; unknown values raise ValueError. |