nbprint.config.core.Outputs

pydantic model nbprint.config.core.Outputs

Bases: ResultBase, BaseModel

field root: Path = PosixPath('/home/runner/work/nbprint/nbprint/outputs')

field naming: str = '{{name}}-{{date}}'

field tags: list[str] [Optional]

field role: Role = Role.OUTPUTS

field ignore: bool = True

field embedded: bool = False

Whether this output is expected to run from its embedding inside the notebook.

field hook: PyObjectPath | None = None

A callable hook that is called after generation of the notebook. It is passed the config instance. If it returns something non-None, that value is returned by run instead of the output path.

field postprocess: PyObjectPath | None = None

A callable hook that is called after all processing completes. It is passed the config instance/s. NOTE: It may receive multiple Configuration instances, if a parameterized run was performed.

property notebook: Path | None

property executed_notebook: Path | None

property output: Path | None

run(config: Configuration, gen: NotebookNode) → Path | Literal[OutputsProcessing.STOP]