airflow.providers.papermill.operators.papermill

Module Contents

Classes

NoteBook

Jupyter notebook

PapermillOperator

Executes a jupyter notebook through papermill that is annotated with parameters
class airflow.providers.papermill.operators.papermill.NoteBook[source]

Bases: airflow.lineage.entities.File

Jupyter notebook

template_fields: ClassVar[Collection[str]][source]
type_hint: Optional[str] = 'jupyter_notebook'[source]
parameters: Optional[dict][source]
meta_schema: str[source]
class airflow.providers.papermill.operators.papermill.PapermillOperator(*, input_nb=None, output_nb=None, parameters=None, kernel_name=None, language_name=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Executes a jupyter notebook through papermill that is annotated with parameters

Parameters

  • input_nb (str | NoteBook | None) – input notebook, either path or NoteBook inlet.

  • output_nb (str | NoteBook | None) – output notebook, either path or NoteBook outlet.

  • parameters (dict | None) – the notebook parameters to set

  • kernel_name (str | None) – (optional) name of kernel to execute the notebook against (ignores kernel name in the notebook document metadata)

supports_lineage = True[source]
template_fields: Sequence[str] = ('input_nb', 'output_nb', 'parameters', 'kernel_name', 'language_name')[source]
execute(context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?