Deprecate conf from Task Context (apache#44968)

aws-mwaa · Dec 17, 2024 · 02a1be8 · 02a1be8
1 parent 0eab2b4
commit 02a1be8
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/airflow/utils/context.py b/airflow/utils/context.py
@@ -359,6 +359,7 @@ class Context(MutableMapping[str, Any]):
         "tomorrow_ds_nodash": [],
         "yesterday_ds": [],
         "yesterday_ds_nodash": [],
+        "conf": [],
     }
 
     def __init__(self, context: MutableMapping[str, Any] | None = None, **kwargs: Any) -> None:

diff --git a/docs/apache-airflow/templates-ref.rst b/docs/apache-airflow/templates-ref.rst
@@ -79,8 +79,6 @@ Variable                                    Type                  Description
 ``{{ conn }}``                                                    Airflow connections. See `Airflow Connections in Templates`_ below.
 ``{{ task_instance_key_str }}``             str                   | A unique, human-readable key to the task instance. The format is
                                                                   | ``{dag_id}__{task_id}__{ds_nodash}``.
-``{{ conf }}``                              AirflowConfigParser   | The full configuration object representing the content of your
-                                                                  | ``airflow.cfg``. See :mod:`airflow.configuration.conf`.
 ``{{ run_id }}``                            str                   The currently running :class:`~airflow.models.dagrun.DagRun` run ID.
 ``{{ dag_run }}``                           DagRun                The currently running :class:`~airflow.models.dagrun.DagRun`.
 ``{{ test_mode }}``                         bool                  Whether the task instance was run by the ``airflow test`` CLI.
@@ -133,6 +131,8 @@ Deprecated Variable                     Description
                                         you may be able to use ``prev_data_interval_start_success`` instead if
                                         the timetable/schedule you use for the DAG defines ``data_interval_start``
                                         compatible with the legacy ``execution_date``.
+``{{ conf }}``                          The full configuration object representing the content of your
+                                        ``airflow.cfg``. See :mod:`airflow.configuration.conf`.
 =====================================   ==========================================================================
 
 Note that you can access the object's attributes and methods with simple

diff --git a/newsfragments/44968.misc.rst b/newsfragments/44968.misc.rst
@@ -0,0 +1 @@
+The ``conf`` variable, which provided access to the full Airflow configuration (``airflow.cfg``), has been deprecated and will be removed in Airflow 3 from the Task (Jinja2) template context for security and simplicity. If you need specific configuration values in your tasks, retrieve them explicitly in your DAG or task code using the ``airflow.configuration.conf`` module. For users retrieving the webserver URL (e.g., to include log links in task or callbacks), one of the most common use-case, use the ``ti.log_url`` property available in the ``TaskInstance`` context instead.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The ``conf`` variable, which provided access to the full Airflow configuration (``airflow.cfg``), has been deprecated and will be removed in Airflow 3 from the Task (Jinja2) template context for security and simplicity. If you need specific configuration values in your tasks, retrieve them explicitly in your DAG or task code using the ``airflow.configuration.conf`` module. For users retrieving the webserver URL (e.g., to include log links in task or callbacks), one of the most common use-case, use the ``ti.log_url`` property available in the ``TaskInstance`` context instead.