BashOperator

使用 BashOperator 在 Bash shell 中执行命令。要执行的 Bash 命令或脚本由以下内容决定

  1. 使用 BashOperator 时的 bash_command 参数，或

  2. 如果使用 TaskFlow 装饰器 @task.bash，则为从装饰的可调用对象返回的非空字符串值。

提示

建议使用 @task.bash 装饰器而不是经典的 BashOperator 来执行 Bash 命令。

airflow/example_dags/example_bash_decorator.py[源代码]

@task.bash
def run_after_loop() -> str:
    return "echo 1"

run_this = run_after_loop()

airflow/example_dags/example_bash_operator.py[源代码]

run_this = BashOperator(
    task_id="run_after_loop",
    bash_command="ls -alh --color=always / && echo https://airflow.apache.org/  && echo 'some <code>html</code>'",
)

模板

您可以使用 Jinja 模板 来参数化 Bash 命令。

airflow/example_dags/example_bash_decorator.py[源代码]

@task.bash
def also_run_this() -> str:
    return 'echo "ti_key={{ task_instance_key_str }}"'

also_this = also_run_this()

airflow/example_dags/example_bash_operator.py[源代码]

also_run_this = BashOperator(
    task_id="also_run_this",
    bash_command='echo "ti_key={{ task_instance_key_str }}"',
)

使用 @task.bash TaskFlow 装饰器允许您返回格式化的字符串，并利用 可以直接访问装饰任务的执行上下文变量。

airflow/example_dags/example_bash_decorator.py[源代码]

@task.bash
def also_run_this_again(task_instance_key_str) -> str:
    return f'echo "ti_key={task_instance_key_str}"'

also_this_again = also_run_this_again()

鼓励您利用这种方法，因为它非常适合整体 TaskFlow 范例。

注意

在 Bash 命令中使用 Jinja 模板时，应谨慎对待“用户”输入，因为不会对 Bash 命令进行转义和清理。

这主要适用于使用 dag_run.conf，因为它可以通过 Web UI 中的用户提交。大多数默认模板变量都没有风险。

例如，**不要**这样做

@task.bash
def bash_task() -> str:
    return 'echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run.conf else "" }}\'"'


# Or directly accessing `dag_run.conf`
@task.bash
def bash_task(dag_run) -> str:
    message = dag_run.conf["message"] if dag_run.conf else ""
    return f'echo "here is the message: {message}"'

bash_task = BashOperator(
    task_id="bash_task",
    bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run.conf else "" }}\'"',
)

相反，您应该通过 env 关键字参数传递它，并在 Bash 命令中使用双引号。

@task.bash(env={"message": '{{ dag_run.conf["message"] if dag_run.conf else "" }}'})
def bash_task() -> str:
    return "echo \"here is the message: '$message'\""

bash_task = BashOperator(
    task_id="bash_task",
    bash_command="echo \"here is the message: '$message'\"",
    env={"message": '{{ dag_run.conf["message"] if dag_run.conf else "" }}'},
)

跳过

通常，非零退出代码会产生 AirflowException，从而导致任务失败。如果希望任务以 skipped 状态结束，则可以使用代码 99 退出（或者如果您传递了 skip_on_exit_code，则可以使用其他退出代码）。

airflow/example_dags/example_bash_decorator.py[源代码]

@task.bash
def this_will_skip() -> str:
    return 'echo "hello world"; exit 99;'

this_skips = this_will_skip()

airflow/example_dags/example_bash_operator.py[源代码]

this_will_skip = BashOperator(
    task_id="this_will_skip",
    bash_command='echo "hello world"; exit 99;',
    dag=dag,
)

从文件执行命令

BashOperator 和 @task.bash TaskFlow 装饰器都允许您执行存储在文件中的 Bash 命令。这些文件**必须**具有 .sh 或 .bash 扩展名。

请注意脚本名称后面的空格（下一节将详细介绍）。

@task.bash
def run_command_from_script() -> str:
    return "$AIRFLOW_HOME/scripts/example.sh "


run_script = run_command_from_script()

run_script = BashOperator(
    task_id="run_command_from_script",
    bash_command="$AIRFLOW_HOME/scripts/example.sh ",
)

找不到 Jinja 模板

如果在尝试执行 Bash 脚本时遇到“找不到模板”异常，请在脚本名称后面添加一个空格。这是因为 Airflow 试图对其应用 Jinja 模板，这将失败。

@task.bash
def bash_example():
    # This fails with 'Jinja template not found' error
    # return "/home/batcher/test.sh",
    # This works (has a space after)
    return "/home/batcher/test.sh "

BashOperator(
    task_id="bash_example",
    # This fails with 'Jinja template not found' error
    # bash_command="/home/batcher/test.sh",
    # This works (has a space after)
    bash_command="/home/batcher/test.sh ",
)

但是，如果您想在 Bash 脚本中使用模板，请不要添加空格，而是将 Bash 脚本放在包含 DAG 文件的目录的相对位置。因此，如果您的 DAG 文件位于 /usr/local/airflow/dags/test_dag.py 中，则可以将 test.sh 文件移动到 /usr/local/airflow/dags/ 下的任何位置（例如：/usr/local/airflow/dags/scripts/test.sh），并将相对路径传递给 bash_command，如下所示

@task.bash
def bash_example():
    # "scripts" folder is under "/usr/local/airflow/dags"
    return "scripts/test.sh"

t2 = BashOperator(
    task_id="bash_example",
    # "scripts" folder is under "/usr/local/airflow/dags"
    bash_command="scripts/test.sh",
)

为 Bash 脚本创建单独的文件夹可能是出于多种原因，例如分离脚本的逻辑和管道代码、允许以不同语言编写的文件中进行正确的代码突出显示，以及在构建管道时具有通用灵活性。

也可以在 DAG 构造函数调用中将 template_searchpath 定义为指向任何文件夹位置。

@dag(..., template_searchpath="/opt/scripts")
def example_bash_dag():
    @task.bash
    def bash_example():
        return "test.sh "

with DAG("example_bash_dag", ..., template_searchpath="/opt/scripts"):
    t2 = BashOperator(
        task_id="bash_example",
        bash_command="test.sh ",
    )

使用 Python 丰富 Bash

@task.bash TaskFlow 装饰器允许您在一个任务中将 Bash 和 Python 组合成一个强大的组合。

在 @task.bash 任务中使用 Python 条件语句、其他函数调用等可以帮助定义、增强甚至构建要执行的 Bash 命令。

例如，使用条件逻辑来确定任务行为

airflow/example_dags/example_bash_decorator.py[源代码]

@task.bash
def sleep_in(day: str) -> str:
    if day in (WeekDay.SATURDAY, WeekDay.SUNDAY):
        return f"sleep {60 * 60}"
    else:
        raise AirflowSkipException("No sleeping in today!")

sleep_in(day="{{ dag_run.logical_date.strftime('%A').lower() }}")

或者调用一个函数来帮助构建 Bash 命令

airflow/example_dags/example_bash_decorator.py[源代码]

def _get_files_in_cwd() -> list[str]:
    from pathlib import Path

    dir_contents = Path.cwd().glob("airflow/example_dags/*.py")
    files = [str(elem) for elem in dir_contents if elem.is_file()]

    return files

@task.bash
def get_file_stats() -> str:
    files = _get_files_in_cwd()
    cmd = "stat "
    cmd += " ".join(files)

    return cmd

get_file_stats()

这种类型的预执行丰富有许多可能性。

BashSensor

使用 BashSensor 使用任意命令进行感知。该命令在成功时应返回 0，否则返回任何其他值。

airflow/example_dags/example_sensors.py[源代码]

t3 = BashSensor(task_id="Sensor_succeeds", bash_command="exit 0")

t4 = BashSensor(task_id="Sensor_fails_after_3_seconds", timeout=3, soft_fail=True, bash_command="exit 1")

此条目有帮助吗？