Fixed config list ouput for multi-line values

[nailo2c]

Closes: #57355

When a user runs airflow config list --include-descriptions --include-examples,
multi-line values (like dag_bundle_config_list) would cause a
configparser.ParsingError due to improper indentation.

This fix pretty-prints the JSON value using json.dumps(indent=4)
and then adds an additional four-space indent to each new line.
This ensures the INI parser treats the entire block as a
single, valid multi-line value.

[potiuk]

Why not fixing airflow config list --include-descriptions --include-examples to produce correct output ? I Think it makes very little sense to have working --defaults-no-comments flag when we can fix the original command.

[zachliu]

the issue is caused by how python's configparser handles string-value fallback in their get method. when we use fallback=default_value, the indentations are removed. but when we use the set() and then get() without fallback, the indentations are intact 🤔

[zachliu]

off the top of me head, i can change this line

airflow/airflow-core/src/airflow/configuration.py

Line 584 in b32603f

value = self.get(section_to_write, option, fallback=default_value, raw=True)

into

    if isinstance(default_value, str):
        self.set(section_to_write, option, default_value)
        value = self.get(section_to_write, option, raw=True)
    else:
        value = self.get(section_to_write, option, fallback=default_value, raw=True)

[nailo2c]

Hi, I think potiuk is right. I fixed airflow config list --include-descriptions --include-examples, and now it produces the correct output. This approach is simpler than my original one. Please take a look and let me know if you have any feedback on the current version :)

root@7da61615e7c7:/opt/airflow# airflow config list --include-descriptions --include-examples | grep "dag_bundle_config_list" -A 10
# Example: dag_bundle_config_list = [
#       {
#         "name": "my-git-repo",
#         "classpath": "airflow.providers.git.bundles.git.GitDagBundle",
#         "kwargs": {
#           "subdir": "dags",
#           "tracking_ref": "main",
#           "refresh_interval": 0
#         }
#       }
#     ]
dag_bundle_config_list = [
        {
            "name": "dags-folder",
            "classpath": "airflow.dag_processing.bundles.local.LocalDagBundle",
            "kwargs": {}
        }
    ]

# How often (in seconds) to refresh, or look for new files, in a DAG bundle.
refresh_interval = 300

root@7da61615e7c7:/opt/airflow# 
root@7da61615e7c7:/opt/airflow# 
root@7da61615e7c7:/opt/airflow# python - <<'PY'
import configparser, pathlib, sys
p = configparser.ConfigParser()
p.read(pathlib.Path("airflow_new.cfg"))
PY
root@7da61615e7c7:/opt/airflow# 

[potiuk]

Looks good - I updated the title to reflect it, but it would also be great to edit description of the PR to not be misleading about the change (for posterity)

[potiuk]

also rebasing and squashing into a single commit, properly described would be a good thing before we merge it.

[nailo2c]

Thanks for the review, rebasing and squashing are done 🙌

[potiuk]

Thanks !

[github-actions]

Backport failed to create: v3-1-test. View the failure log Run details

Status	Branch	Result
❌	v3-1-test

You can attempt to backport this manually by running:

cherry_picker d009b64 v3-1-test

This should apply the commit to the v3-1-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

[potiuk]

Backport in #58378