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

Correctly specify overloads for TaskFlow API for type-hinting #20933

Merged
merged 2 commits into from
Jan 18, 2022

Conversation

ashb
Copy link
Member

@ashb ashb commented Jan 18, 2022

The position of @overload matters -- at least to MyPy, and all
function overloads have to be next to each other.

I also removed the overload for @task.docker, as that one requires
at least an image to be passed, so isn't valid with no parameters

Closes #20929


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.

The position of `@overload` matters -- at least to MyPy, and all
function overloads have to be next to each other.

I also removed the overload for `@task.docker`, as that one _requires_
at least an image to be passed, so isn't valid with no parameters
@ashb
Copy link
Member Author

ashb commented Jan 18, 2022

Lets double check this does fix the mypy -- it did on my testing on one direct file, but sadly I don't trust it to behave the same when run with all files.

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah nice!

@github-actions github-actions bot added the full tests needed We need to run full set of tests for this PR to merge label Jan 18, 2022
@github-actions
Copy link

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.

@ashb
Copy link
Member Author

ashb commented Jan 18, 2022

Confirmed mypy changes good.

@ashb
Copy link
Member Author

ashb commented Jan 18, 2022

Kube failure is an random EOF in the test harness, not a real problem.

@ashb ashb merged commit b474666 into apache:main Jan 18, 2022
@ashb ashb deleted the fix-mypy-parameterless-taskflow branch January 18, 2022 21:17
@ephraimbuddy ephraimbuddy added the type:improvement Changelog: Improvements label Apr 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full tests needed We need to run full set of tests for this PR to merge kind:documentation type:improvement Changelog: Improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants