Source code for tests.system.providers.papermill.example_papermill_remote_verify

# 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.
This DAG will use Papermill to run the notebook "hello_world", based on the execution date
it will create an output notebook "out-<date>". All fields, including the keys in the parameters, are

from __future__ import annotations

import os
from datetime import datetime, timedelta

import scrapbook as sb

from airflow import DAG
from airflow.decorators import task
from airflow.providers.papermill.operators.papermill import PapermillOperator

[docs]START_DATE = datetime(2021, 1, 1)
[docs]SCHEDULE_INTERVAL = "@once"
[docs]DAGRUN_TIMEOUT = timedelta(minutes=60)
[docs]ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
[docs]DAG_ID = "example_papermill_operator_remote_verify"
# [START howto_verify_operator_papermill_remote_kernel] @task
[docs]def check_notebook(output_notebook, execution_date): """ Verify the message in the notebook """ notebook = sb.read_notebook(output_notebook) message = notebook.scraps["message"] print(f"Message in notebook {message} for {execution_date}") if != f"Ran from Airflow at {execution_date}!": return False return True
with DAG( dag_id="example_papermill_operator_remote_verify", schedule="@once", start_date=START_DATE, dagrun_timeout=DAGRUN_TIMEOUT, catchup=False, ) as dag:
[docs] run_this = PapermillOperator( task_id="run_example_notebook", input_nb=os.path.join(os.path.dirname(os.path.realpath(__file__)), "input_notebook.ipynb"), output_nb="/tmp/out-{{ execution_date }}.ipynb", parameters={"msgs": "Ran from Airflow at {{ execution_date }}!"}, kernel_conn_id="jupyter_kernel_default", )
run_this >> check_notebook( output_notebook="/tmp/out-{{ execution_date }}.ipynb", execution_date="{{ execution_date }}" ) # [END howto_verify_operator_papermill_remote_kernel] from tests.system.utils import get_test_run # noqa: E402 # Needed to run the example DAG with pytest (see: tests/system/
[docs]test_run = get_test_run(dag)

Was this entry helpful?