feat: add custom __dir__ for messages and message classes #289
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
During development, it can be convenient to inspect objects and types directly to determine what methods and attributes they have using the dir() builtin command in a debugger or a REPL. Because proto-plus messages wrap their fields using __getattr__, the proto fields are not visible by default and must be explicitly exposed to dir().
Codecov Report
@@ Coverage Diff @@
## main #289 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 22
Lines ? 983
Branches ? 219
========================================
Hits ? 983
Misses ? 0
Partials ? 0 Continue to review full report at Codecov.
|
busunkim96
approved these changes
Feb 7, 2022
| names = {f_name for f_name in self._meta.fields.keys()} | ||
| names.update(m.name for m in desc.nested_types) | ||
| names.update(e.name for e in desc.enum_types) | ||
| names.update(dir(object())) |
There was a problem hiding this comment.
It's including all the fields message fields, nested message and enum types, and boilerplate methods and attributes inherited from object. The important one is fields, since they weren't visible before, but since this is customizing __dir__ we need to explicitly add all the others back in too.
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Feb 7, 2022
🤖 I have created a release *beep* *boop* --- ## [1.20.0](v1.19.9...v1.20.0) (2022-02-07) ### Features * add custom __dir__ for messages and message classes ([#289](#289)) ([35e019e](35e019e)) ### Bug Fixes * workaround for buggy pytest ([#291](#291)) ([28aa3b2](28aa3b2)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
During development, it can be convenient to inspect objects and types
directly to determine what methods and attributes they have using the
dir() builtin command in a debugger or a REPL.
Because proto-plus messages wrap their fields using getattr, the
proto fields are not visible by default and must be explicitly exposed
to dir().