nbprint.config.core.Configuration

pydantic model nbprint.config.core.Configuration

Bases: CallableModel, BaseModel

field name: str [Required]

field resources: dict[str, BaseModel] [Optional]

field outputs: Outputs [Required]

field parameters: Parameters [Optional]

field page: Page [Optional]

field context: Context [Optional]

field content: ContentMarshall [Optional]

field overlays: list[Overlay] [Optional]

Formatting overlays merged into ingested notebook cells.

field layout_overlays: list[LayoutOverlay] [Optional]

Layout overlays that wrap contiguous ranges of ingested cells in a flex container.

field tags: list[str] [Optional]

field role: Role = Role.CONFIGURATION

field ignore: bool = True

field pagedjs: bool = True

field debug: bool = True

generate(**_) → list[NotebookNode]

Generate a notebook node for this model. This will be called before the runtime of the notebook, use it for code generation.

Args:

metadata (dict): common cell metadata

Returns:

NotebookNode: the content of the notebook node

static load(path_or_model: str | Path | dict | Configuration, name: str) → Configuration

run(dry_run: bool = False, *, _multi: bool = False) → Path | None

property context_type: Type[ContextType]

Return the context type for the model.

By default, it reads the value from the function signature (if a concrete value is provided), otherwise the implementation needs to be overridden.

property result_type: Type[ResultType]

Return the result type for the model.

By default, it reads the value from the function signature (if a concrete value is provided), otherwise the implementation needs to be overridden.