Fix templated default/example values in config ref docs #16442
Conversation
We should show the actual default/example value in the configuration
reference docs, not the templated values.
e.g. `{dag_id}` like you get in a generated airflow.cfg, not `{{dag_id}}
like is stored in the airflow.cfg template.
|
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease. |
github-actions
bot
added
the
full tests needed
| @@ -92,7 +92,7 @@ def _default_config_file_path(file_name: str): | |||
| return os.path.join(templates_dir, file_name) | |||
|
|
|||
|
|
|||
| def default_config_yaml() -> dict: | |||
| def default_config_yaml() -> List[dict]: | |||
There was a problem hiding this comment.
Is this right? PyYAML documentation says safe_load only loads the first document, which would be dict.
There was a problem hiding this comment.
https://pyyaml.org/wiki/PyYAMLDocumentation
safe_load(stream)parses the given stream and returns a Python object constructed from for the first document in the stream. If there are no documents in the stream, it returnsNone.safe_loadrecognizes only standard YAML tags and cannot construct an arbitrary Python object.
There was a problem hiding this comment.
Yeah, it is a list:
https://github.com/apache/airflow/blob/main/airflow/config_templates/config.yml
PyYAML is referring to YAML documents: https://pyyaml.org/wiki/PyYAMLDocumentation#documents
We only have one, but you could have more than one in the steam, e.g:
---
- a:b
---
- c:d
Interestingly, for me safe_load actually raises when it sees more than 1 document 🤷♂️
We should show the actual default/example value in the configuration
reference docs, not the templated values.
e.g. `{dag_id}` like you get in a generated airflow.cfg, not `{{dag_id}}
like is stored in the airflow.cfg template.
(cherry picked from commit cc3c13c)
We should show the actual default/example value in the configuration
reference docs, not the templated values.
e.g.
{dag_id}like you get in a generated airflow.cfg, not{{dag_id}}like is stored in the airflow.cfg template.
Before:
After:
