Skip to content

Simplify airflowctl query parameter handling#69475

Open
henry3260 wants to merge 1 commit into
apache:mainfrom
henry3260:improve-airflowctl-query-params
Open

Simplify airflowctl query parameter handling#69475
henry3260 wants to merge 1 commit into
apache:mainfrom
henry3260:improve-airflowctl-query-params

Conversation

@henry3260

Copy link
Copy Markdown
Contributor

Why

airflowctl API operations need to build query parameters consistently when optional filters are added. The Dag run list operation already had several repeated checks for skipping unset values and serializing datetimes, and similar optional parameter handling exists in other operations. Centralizing that logic makes future filters easier to add without duplicating the same query parameter handling.

suggested by @bugraoz93 in #68564 (comment)

What

  • Added helper functions in airflow-ctl/src/airflowctl/api/operations.py to build query parameters and serialize datetime values with isoformat().
  • Updated DagRunOperations.list() to use the shared helper for state, date, logical date, ordering, and limit query parameters.
  • Updated JobsOperations.list() to use the same helper while preserving the existing behavior for empty job_type and hostname values.
  • Added a unit test in airflow-ctl/tests/airflow_ctl/api/test_operations.py covering skipped None values and datetime serialization.

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@henry3260

Copy link
Copy Markdown
Contributor Author

For now, I prefer using a helper function instead of a decorator because there are only two call sites. We can revisit a decorator-based approach later if more airflowctl operations need the same query parameter handling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant