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

Add type annotations for enum parameters in methods #169

Merged
merged 1 commit into from
Dec 5, 2023

Conversation

shibd
Copy link
Member

@shibd shibd commented Dec 5, 2023

Motivation

This PR adds type annotations for enum parameters in various methods in the pulsar-client-python package. The goal of these changes is to improve the clarity and readability of the code, and to provide better hints to developers about the expected types of the parameters.

Modifications

The following methods have been modified to include type annotations for their enum parameters:

  • Client.create_producer
  • Client.subscribe
  • Client.create_reader

For example, in the Client.create_producer method, the compression_type parameter was previously defined as compression_type=CompressionType.NONE, but now it is defined as compression_type: CompressionType = CompressionType.NONE.

Benefits

The addition of these type annotations will make the code easier to read and understand. It will also provide better hints to developers about the expected types of the parameters, which could help prevent bugs and errors.

Please review and provide feedback.

Copy link
Member

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

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

Thank you!

@shibd shibd merged commit 39d4f9d into apache:main Dec 5, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants