You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by je...@apache.org on 2024/04/26 23:00:46 UTC
(airflow) 30/48: [docs] update `DagBag` class docstring to include all params (#38814)
This is an automated email from the ASF dual-hosted git repository.
jedcunningham pushed a commit to branch v2-9-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 672d47ebf062b9b152ff407289db9959c9579db5
Author: Kalyan <ka...@live.com>
AuthorDate: Tue Apr 16 17:52:57 2024 +0530
[docs] update `DagBag` class docstring to include all params (#38814)
* update docstring for DagBag class
* break long line
* fix space
Signed-off-by: kalyanr <ka...@live.com>
---------
Signed-off-by: kalyanr <ka...@live.com>
(cherry picked from commit b00274156b28cce6a68dac20e667d21d00310016)
---
airflow/models/dagbag.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/airflow/models/dagbag.py b/airflow/models/dagbag.py
index ce9bf5587b..1902c985be 100644
--- a/airflow/models/dagbag.py
+++ b/airflow/models/dagbag.py
@@ -89,11 +89,16 @@ class DagBag(LoggingMixin):
:param dag_folder: the folder to scan to find DAGs
:param include_examples: whether to include the examples that ship
with airflow or not
+ :param safe_mode: when ``False``, scans all python modules for dags.
+ When ``True`` uses heuristics (files containing ``DAG`` and ``airflow`` strings)
+ to filter python modules to scan for dags.
:param read_dags_from_db: Read DAGs from DB if ``True`` is passed.
If ``False`` DAGs are read from python files.
+ :param store_serialized_dags: deprecated parameter, same effect as `read_dags_from_db`
:param load_op_links: Should the extra operator link be loaded via plugins when
de-serializing the DAG? This flag is set to False in Scheduler so that Extra Operator links
are not loaded to not run User code in Scheduler.
+ :param collect_dags: when True, collects dags during class initialization.
"""
def __init__(