Source code for airflow.operators.papermill_operator

# -*- coding: utf-8 -*-
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

import papermill as pm

from airflow.models import BaseOperator
from airflow.lineage.datasets import DataSet
from airflow.utils.decorators import apply_defaults

[docs]class NoteBook(DataSet):
[docs] type_name = "jupyter_notebook"
[docs] attributes = ['location', 'parameters']
[docs]class PapermillOperator(BaseOperator): """ Executes a jupyter notebook through papermill that is annotated with parameters :param input_nb: input notebook (can also be a NoteBook or a File inlet) :type input_nb: str :param output_nb: output notebook (can also be a NoteBook or File outlet) :type output_nb: str :param parameters: the notebook parameters to set :type parameters: dict """ @apply_defaults def __init__(self, input_nb, output_nb, parameters, *args, **kwargs): super(PapermillOperator, self).__init__(*args, **kwargs) self.inlets.append(NoteBook(qualified_name=input_nb, location=input_nb, parameters=parameters)) self.outlets.append(NoteBook(qualified_name=output_nb, location=output_nb))
[docs] def execute(self, context): for i in range(len(self.inlets)): pm.execute_notebook(self.inlets[i].location, self.outlets[i].location, parameters=self.inlets[i].parameters, progress_bar=False, report_mode=True)

Was this entry helpful?