Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve DAG Factory nomenclature consistencies #284

Open
tatiana opened this issue Nov 15, 2024 · 0 comments
Open

Improve DAG Factory nomenclature consistencies #284

tatiana opened this issue Nov 15, 2024 · 0 comments

Comments

@tatiana
Copy link
Collaborator

tatiana commented Nov 15, 2024

This feedback was reported by Karen Braganza on DAG Factory 0.19.0:

Some parameter names do not match between Airflow and DAG Factory (example: schedule vs schedule_interval or execution_timeout vs execution_timeout_secs). This can be confusing without comprehensive documentation. I often had to read through the code to determine correct parameter names, which defeats the purpose of DAG factory for people unfamiliar with Python.

This confusion is exacerbated by inconsistencies in nomenclature within DAG factory itself. Example:

  • retry_delay_sec and dagrun_timeout_sec end with sec
  • On the other hand, execution_timeout_secs and sla_secs end with secs.
  • There is an extra ‘s’ at the end of execution_timeout_secs and sla_secs. These parameter names should be consistent.

I believe some of the inconsistencies may have been introduced for backwards compatibility since DAG Factory has historically supported many versions of Airflow, including 1.x. That said, I agree with Karen we should review and make these more consistent.

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

No branches or pull requests

1 participant