-
Notifications
You must be signed in to change notification settings - Fork 14.7k
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
mark dag_run and ti as automatically injected #42103
base: main
Are you sure you want to change the base?
Conversation
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
cc: @uranusjr - as our MyPy / Typing expert - what do you think? That looks cool. |
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions. |
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions. |
@uranusjr -> WDYT? I think there were some plans for those MyPy checks but I know no details |
I rebased the PR BTW |
Does this mypy plug-in get used outside of the airflow repo? Can you give an example of where this change helps mypy (I assume to not error in some cases)? |
@ashb I use a copy of this plugin in my project, to help me during the dag authoring. In my case I relies on taskflow definition and I have a bunch of @task
def retrieve_url(dag_run: DagRun) -> str:
"""something that uses dag_run.conf"""
return dag_run.conf['url']
@task
def print_content(url: str) -> None:
"""something that uses url from xcom"""
print(request.get(url))
@dag
def my_dag() -> DAG:
url = retrieve_url() # dag_run is not passed
print_content(url) # url is passed
my_dag() without the plugin I would have had errors in the dag definition or rely on |
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me, only question is if we want to add all the context variables (since they all are auto injected).
Allow the usage of the mypy plugins to typecheck the
@task
annotated tasks. With this change it will be possible to avoid mypy complains when definiing a task like in https://airflow.apache.org/docs/apache-airflow/stable/tutorial/taskflow.html#accessing-context-variables-in-decorated-tasks withti
as an automatically injected parameter.^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in newsfragments.