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

service: Clean up grpc_servicer.py #394

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Conversation

bkeryan
Copy link
Collaborator

@bkeryan bkeryan commented Sep 21, 2023

What does this Pull Request accomplish?

grpc_servicer.py:

  • Remove unnecessary content from docstrings. This class is internal, so we don't need to document each attribute and parameter.
  • Delete low-value, "play-by-play" comments
  • Delete random capitalization
  • Use kwargs to initialize protobuf fields when convenient to do so
  • Single-source _frame_metadata_dict()
  • Prefix member variables with underscore to indicate that they are private
  • Remove unnecessary type hints for member variables (the type checker can infer these)

Why should this Pull Request be merged?

Make grpc_servicer.py easier to read and edit.

What testing has been done?

Ran poetry run pytest -v

@github-actions
Copy link

Test Results

     12 files  ±0       12 suites  ±0   2m 48s ⏱️ +27s
   215 tests ±0     186 ✔️ ±0    29 💤 ±0  0 ±0 
2 568 runs  ±0  2 220 ✔️ ±0  348 💤 ±0  0 ±0 

Results for commit 7ddbddc. ± Comparison against base commit aa17b56.

@bkeryan bkeryan merged commit 64310d4 into main Sep 22, 2023
17 checks passed
@bkeryan bkeryan deleted the users/bkeryan/cleanup-servicer branch September 22, 2023 00:23
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.

2 participants