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

Make sure multiple_outputs is inferred correctly even when using TypedDict #36652

Merged
merged 3 commits into from Jan 10, 2024

Conversation

noamcohen97
Copy link
Contributor

@noamcohen97 noamcohen97 commented Jan 7, 2024

According to the documentation here, the multiple_outputs parameter should automatically set to true if a dict is being used as the function return type.
The current condition in _infer_multiple_outputs() does not consider a TypedDict as a dict for that matter, as well as any other subclass of dict.
This PR uses issubclass() to make sure any typing.Mapping subclass will make multiple_outputs=True


^ 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.

Copy link

boring-cyborg bot commented Jan 7, 2024

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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

airflow/decorators/base.py Outdated Show resolved Hide resolved
@dirrao dirrao added area:core area:core-operators Operators, Sensors and hooks within Core Airflow labels Jan 8, 2024
@jscheffl
Copy link
Contributor

jscheffl commented Jan 8, 2024

Now just a small "glitch" in imports due to static checks... https://github.com/apache/airflow/actions/runs/7444185558/job/20275885423?pr=36652

Copy link
Contributor

@josh-fell josh-fell left a comment

Choose a reason for hiding this comment

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

Probably worth adding a note about this to the doc you referenced too.

@eladkal eladkal added this to the Airflow 2.8.1 milestone Jan 10, 2024
Copy link
Contributor

@eladkal eladkal left a comment

Choose a reason for hiding this comment

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

LGTM

@jscheffl jscheffl merged commit e11b91c into apache:main Jan 10, 2024
53 checks passed
Copy link

boring-cyborg bot commented Jan 10, 2024

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@noamcohen97 noamcohen97 deleted the bugfix/dict-multiple-outputs branch January 11, 2024 04:39
ephraimbuddy pushed a commit that referenced this pull request Jan 11, 2024
…ypedDict` (#36652)

* Use `issubclass()` to check if return type is a dictionary

* Compare type to `typing.Mapping` instead of `typing.Dict`

* Add documentation

(cherry picked from commit e11b91c)
@ephraimbuddy ephraimbuddy added the type:bug-fix Changelog: Bug Fixes label Jan 15, 2024
ephraimbuddy pushed a commit that referenced this pull request Jan 15, 2024
…ypedDict` (#36652)

* Use `issubclass()` to check if return type is a dictionary

* Compare type to `typing.Mapping` instead of `typing.Dict`

* Add documentation

(cherry picked from commit e11b91c)
abhishekbhakat pushed a commit to abhishekbhakat/my_airflow that referenced this pull request Mar 5, 2024
…ypedDict` (apache#36652)

* Use `issubclass()` to check if return type is a dictionary

* Compare type to `typing.Mapping` instead of `typing.Dict`

* Add documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:core area:core-operators Operators, Sensors and hooks within Core Airflow type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants