astronomer.providers.core.sensors.external_task

Module Contents

Classes

ExternalTaskSensorAsync

Waits for a different DAG or a task in a different DAG to complete for a

class astronomer.providers.core.sensors.external_task.ExternalTaskSensorAsync(*, external_dag_id, external_task_id=None, external_task_ids=None, allowed_states=None, failed_states=None, execution_delta=None, execution_date_fn=None, check_existence=False, **kwargs)[source]

Bases: airflow.sensors.external_task.ExternalTaskSensor

Waits for a different DAG or a task in a different DAG to complete for a specific logical date.

Parameters
  • external_dag_id (str) – The dag_id that contains the task you want to wait for

  • external_task_id (Optional[str]) – The task_id that contains the task you want to wait for. If None (default value) the sensor waits for the DAG

  • external_task_ids (Optional[Collection[str]]) – The list of task_ids that you want to wait for. If None (default value) the sensor waits for the DAG. Either external_task_id or external_task_ids can be passed to ExternalTaskSensor, but not both.

  • allowed_states (Optional[Iterable[str]]) – Iterable of allowed states, default is ['success']

  • failed_states (Optional[Iterable[str]]) – Iterable of failed or dis-allowed states, default is None

  • execution_delta (Optional[datetime.timedelta]) – time difference with the previous execution to look at, the default is the same logical date as the current task or DAG. For yesterday, use [positive!] datetime.timedelta(days=1). Either execution_delta or execution_date_fn can be passed to ExternalTaskSensor, but not both.

  • execution_date_fn (Optional[Callable]) – function that receives the current execution’s logical date as the first positional argument and optionally any number of keyword arguments available in the context dictionary, and returns the desired logical dates to query. Either execution_delta or execution_date_fn can be passed to ExternalTaskSensor, but not both.

  • check_existence (bool) – Set to True to check if the external task exists (when external_task_id is not None) or check if the DAG to wait for exists (when external_task_id is None), and immediately cease waiting if the external task or DAG does not exist (default value: False).

execute(self, context)[source]

Correctly identify which trigger to execute, and defer execution as expected.

execute_complete(self, context, session, event=None)[source]

Verifies that there is a success status for each task via execution date.

get_execution_dates(self, context)[source]

Helper function to set execution dates depending on which context and/or internal fields are populated.