Skip to content

[FLINK-17256][python] Support keyword arguments in the PyFlink descriptor API #12013

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.

Sign up for GitHub

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

Jump to bottom
Closed
shuiqiangchen wants to merge 1 commit into from
Closed

[FLINK-17256][python] Support keyword arguments in the PyFlink descriptor API #12013

shuiqiangchen wants to merge 1 commit into from

Conversation

@shuiqiangchen
Copy link
Contributor

@shuiqiangchen shuiqiangchen commented May 7, 2020

What is the purpose of the change

Keyword arguments is a very commonly used feature in Python. We should support it in the PyFlink Descriptor API to make the API more user friendly for Python users.

Brief change log

  • add constructor keyword arguments for descriptors in descritors.py

Verifying this change

This change is already covered by existing tests in test_descriptors.py

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): ( no)
  • The serializers: (no)
  • The runtime per-record code paths (performance sensitive): (no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (no)
  • The S3 file system connector: (no)

Documentation

  • Does this pull request introduce a new feature? (no)

@flinkbot
Copy link
Collaborator

flinkbot commented May 7, 2020

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit c947260 (Thu May 07 03:07:44 UTC 2020)

Warnings:

  • No documentation files were touched! Remember to keep the Flink docs up to date!

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

Details
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented May 7, 2020 •
edited
Loading

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build

@dianfu dianfu self-assigned this May 7, 2020
dianfu
dianfu reviewed May 7, 2020
View reviewed changes
Copy link
Contributor

@dianfu dianfu left a comment

Choose a reason for hiding this comment

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

@shuiqiangchen Thanks for the PR. Only a few minor comments.

flink-python/pyflink/table/descriptors.py
self._j_schema = self._j_schema.field(field_name, _to_java_type(field_type))
return self

def fields(self, fields):
Copy link
Contributor

@dianfu dianfu May 7, 2020

Choose a reason for hiding this comment

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

could you add a test case for this method?

Copy link
Contributor Author

@shuiqiangchen shuiqiangchen May 7, 2020

Choose a reason for hiding this comment

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

Ok, I will add it.

flink-python/pyflink/table/descriptors.py Outdated
def __init__(self):
def __init__(self, version=None, topic=None, properties=None, start_from_earliest=False,
start_from_latest=False, start_from_group_offsets=True,
specific_offsets_dict=None, start_from_timestamp=None,
Copy link
Contributor

@dianfu dianfu May 7, 2020

Choose a reason for hiding this comment

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

rename to start_from_specific_offsets_dict?

Copy link
Contributor Author

@shuiqiangchen shuiqiangchen May 7, 2020

Choose a reason for hiding this comment

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

Yes, it would be much clearer for users to use the argument.

flink-python/pyflink/table/descriptors.py Outdated
def __init__(self, version=None, topic=None, properties=None, start_from_earliest=False,
start_from_latest=False, start_from_group_offsets=True,
specific_offsets_dict=None, start_from_timestamp=None,
sink_partitioner_fixed=True, sink_partitioner_round_robin=False,
Copy link
Contributor

@dianfu dianfu May 7, 2020

Choose a reason for hiding this comment

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

It seems that the round robin is the default partitioner. Could you double check if this is the case?

@shuiqiangchen shuiqiangchen force-pushed the flink-17256 branch 4 times, most recently from 47db51f to f944068 Compare May 8, 2020 01:37
@dianfu
Copy link
Contributor

dianfu commented May 8, 2020

The failed tests are not related to this PR. Have created ticket FLINK-17576 to tract that.

@dianfu dianfu changed the title [FLINK-17256] Suppport keyword arguments in the PyFlink Descriptor API. [FLINK-17256][python] Support keyword arguments in the PyFlink descriptor API May 8, 2020
@dianfu dianfu closed this in 0d1738b May 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dianfu dianfu dianfu approved these changes

Assignees

@dianfu dianfu

Labels

component=API/Python review=description?

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@shuiqiangchen @flinkbot @dianfu @rmetzger