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

Standardise dataproc location param to region #16034

Merged
merged 4 commits into from
Jul 7, 2021

Conversation

Daniel-Han-Yang
Copy link
Contributor

Standardises DataProc hook & operators location parameter to region in line
with underlying google DataProc Python client library.

closes: #15622


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

@boring-cyborg boring-cyborg bot added area:providers provider:google Google (including GCP) related issues labels May 24, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented May 24, 2021

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/master/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, pylint 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.
    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

@mik-laj
Copy link
Member

mik-laj commented May 30, 2021

It looks like a breaking change. Can we avoid it and keep backward compatibility with warning? This change also requires an entry in changelog to facilitate migration. See: https://github.com/apache/airflow/blob/master/airflow/providers/google/CHANGELOG.rst

@leahecole
Copy link
Contributor

It looks like a breaking change. Can we avoid it and keep backward compatibility with warning? This change also requires an entry in changelog to facilitate migration. See: https://github.com/apache/airflow/blob/master/airflow/providers/google/CHANGELOG.rst

Thank you so much for doing this change that I haven't had time to do! +1 to @mik-laj 's comment about it being a breaking change.

@Daniel-Han-Yang
Copy link
Contributor Author

@mik-laj Would this now be alright? Please let me know

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Jun 13, 2021
@github-actions
Copy link

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@potiuk
Copy link
Member

potiuk commented Jun 13, 2021

I removed Changelog entry. I am going to describe it soon but changelog entries (unless we introduce bigger description for breaking changes) should be managed by release manager (semi-automatically), not the author.

@eladkal
Copy link
Contributor

eladkal commented Jun 20, 2021

@Daniel-Han-Yang can you fix the Pylint test?

@potiuk
Copy link
Member

potiuk commented Jun 20, 2021

and rebase to latest main please :)

@turbaszek
Copy link
Member

It looks like a breaking change. Can we avoid it and keep backward compatibility with warning? This change also requires an entry in changelog to facilitate migration. See: https://github.com/apache/airflow/blob/master/airflow/providers/google/CHANGELOG.rst

Thank you so much for doing this change that I haven't had time to do! +1 to @mik-laj 's comment about it being a breaking change.

@leahecole should we make similar change in other operators? AFAIK we assumed to use location everywhere to make the interface consistent.

@leahecole
Copy link
Contributor

It looks like a breaking change. Can we avoid it and keep backward compatibility with warning? This change also requires an entry in changelog to facilitate migration. See: https://github.com/apache/airflow/blob/master/airflow/providers/google/CHANGELOG.rst

Thank you so much for doing this change that I haven't had time to do! +1 to @mik-laj 's comment about it being a breaking change.

@leahecole should we make similar change in other operators? AFAIK we assumed to use location everywhere to make the interface consistent.

Good question. I would hope it would be the same, but am not 100% sure. I'll double check other operators and comment once I've looked.

@leahecole
Copy link
Contributor

I just reviewed a bunch of the other GCP operators and it seems like most of the APIs use location, but there are a few outliers that do not, including our friend Dataproc here. I think it's fine to leave the other operators alone but I'll be sure to open issues if I notice other inconsistencies. (I'm a little salty that it's not consistent across and may file some issues internally too 😁 )

Standardises DataProc hook & operators `location` parameter to `region` in line
with underlying google DataProc Python client library.
@Daniel-Han-Yang
Copy link
Contributor Author

@potiuk @eladkal I've just rebased on the PR again as it seems that there was a conflict. is there anything else I'll need to do on my side? Appreciate your guidance on this.

@leahecole leahecole merged commit b0f7f91 into apache:main Jul 7, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 7, 2021

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:providers okay to merge It's ok to merge this PR as it does not require more tests provider:google Google (including GCP) related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistencies with Dataproc Operator parameters
6 participants