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

Changed type hinting for handler function #42275

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Ariel2400
Copy link

Due to changes introduced in #36205, we experienced breakage in our SQLExecuteQueryOperator. In short, our assumption was that the handler is able to also transform the data type returned from the query. For example our handler looked something like this:

def custom_handler(cursor):
    results = fetch_all_handler(cursor)
    columns = [column[0] for column in cursor.description]
    result_dicts = [dict(zip(columns, record)) for record in results]
    return [SomeDataclass(col_a=d[“COL_A”]

As that was changed, that led to errors in our dags. We now moved to use the _process_output method as we should’ve done in the first place, but we this type hint will prevent further confusion as to what are the constraints of the handler passed to the operator.

Copy link

boring-cyborg bot commented Sep 17, 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 Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.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: [email protected]
    Slack: https://s.apache.org/airflow-slack

@nevcohen
Copy link
Contributor

nevcohen commented Sep 17, 2024

How about a test that makes sure your use case doesn't fail now?
so that it doesn't happen again

@Ariel2400
Copy link
Author

As the change includes only type hinting, I think it would be too restrictive to also enforce it as a test, as types in python are not strict

@nevcohen
Copy link
Contributor

If @romsharon98 agrees with you, so no problem

@romsharon98
Copy link
Contributor

If @romsharon98 agrees with you, so no problem

I agree with @Ariel2400

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.

3 participants