@@ -93,6 +93,7 @@ def get_fernet():
93
93
94
94
This function could fail either because Cryptography is not installed
95
95
or because the Fernet key is invalid.
96
+
96
97
:return: Fernet object
97
98
:raises: AirflowException if there's a problem trying to load Fernet
98
99
"""
@@ -1915,6 +1916,7 @@ class SkipMixin(LoggingMixin):
1915
1916
def skip (self , dag_run , execution_date , tasks ):
1916
1917
"""
1917
1918
Sets tasks instances to skipped from the same dag run.
1919
+
1918
1920
:param dag_run: the DagRun for which to set the tasks to skipped
1919
1921
:param execution_date: execution_date
1920
1922
:param tasks: tasks to skip (not task_ids)
@@ -2985,6 +2987,7 @@ def get_run_dates(self, start_date, end_date=None):
2985
2987
"""
2986
2988
Returns a list of dates between the interval received as parameter using this
2987
2989
dag's schedule interval. Returned dates can be used for execution dates.
2990
+
2988
2991
:param start_date: the start date of the interval
2989
2992
:type start_date: datetime
2990
2993
:param end_date: the end date of the interval, defaults to datetime.utcnow()
@@ -3153,6 +3156,7 @@ def is_paused(self, session=None):
3153
3156
def get_active_runs (self , session = None ):
3154
3157
"""
3155
3158
Returns a list of dag run execution dates currently running
3159
+
3156
3160
:param session:
3157
3161
:return: List of execution dates
3158
3162
"""
@@ -3168,6 +3172,7 @@ def get_active_runs(self, session=None):
3168
3172
def get_num_active_runs (self , external_trigger = None , session = None ):
3169
3173
"""
3170
3174
Returns the number of active "running" dag runs
3175
+
3171
3176
:param external_trigger: True for externally triggered active dag runs
3172
3177
:type external_trigger: bool
3173
3178
:param session:
@@ -3645,6 +3650,7 @@ def run(
3645
3650
delay_on_limit_secs = 1.0 ):
3646
3651
"""
3647
3652
Runs the DAG.
3653
+
3648
3654
:param start_date: the start date of the range to run
3649
3655
:type start_date: datetime
3650
3656
:param end_date: the end date of the range to run
@@ -4057,6 +4063,7 @@ def set(
4057
4063
TODO: "pickling" has been deprecated and JSON is preferred. "pickling" will be
4058
4064
removed in Airflow 2.0. :param enable_pickling: If pickling is not enabled, the
4059
4065
XCOM value will be parsed as JSON instead.
4066
+
4060
4067
:return: None
4061
4068
"""
4062
4069
session .expunge_all ()
@@ -4110,6 +4117,7 @@ def get_one(
4110
4117
"""
4111
4118
Retrieve an XCom value, optionally meeting certain criteria.
4112
4119
TODO: "pickling" has been deprecated and JSON is preferred. "pickling" will be removed in Airflow 2.0.
4120
+
4113
4121
:param enable_pickling: If pickling is not enabled, the XCOM value will be parsed to JSON instead.
4114
4122
:return: XCom value
4115
4123
"""
@@ -4412,6 +4420,7 @@ def find(dag_id=None, run_id=None, execution_date=None,
4412
4420
session = None ):
4413
4421
"""
4414
4422
Returns a set of dag runs for the given search criteria.
4423
+
4415
4424
:param dag_id: the dag_id to find dag runs for
4416
4425
:type dag_id: integer, list
4417
4426
:param run_id: defines the the run id for this dag run
@@ -4485,6 +4494,7 @@ def get_task_instances(self, state=None, session=None):
4485
4494
def get_task_instance (self , task_id , session = None ):
4486
4495
"""
4487
4496
Returns the task instance specified by task_id for this dag run
4497
+
4488
4498
:param task_id: the task id
4489
4499
"""
4490
4500
@@ -4535,6 +4545,7 @@ def update_state(self, session=None):
4535
4545
"""
4536
4546
Determines the overall state of the DagRun based on the state
4537
4547
of its TaskInstances.
4548
+
4538
4549
:return: State
4539
4550
"""
4540
4551
0 commit comments