Introduce new style for python extensions #3302
Merged
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
jleibs
commented
Sep 12, 2023
There was a problem hiding this comment.
This is the main file to review.
jleibs
commented
Sep 12, 2023
There was a problem hiding this comment.
Example of overriding init.
jleibs
commented
Sep 12, 2023
There was a problem hiding this comment.
Example of overriding field converters and providing a native_to_pa_array_override.
3 tasks
emilk
approved these changes
Sep 13, 2023
Comment on lines
+550
to
+551
| let init_define_arg = if ext_class.has_init || overrides.contains(&old_init_override_name) { | ||
| "init=False".to_owned() |
There was a problem hiding this comment.
if has_init, then init=False… I don't follow
There was a problem hiding this comment.
Adding comment to clarify:
// If the `ExtensionClass` has its own `__init__` then we need to pass the `init=False` argument
// to the `@define` decorator, to prevent it from generating its own `__init__`, which would
// take precedence over the `ExtensionClass`.
| format!( | ||
| "# You can define your own __init__ function as a member of {} in {}", | ||
| ext_class.name, ext_class.file_name | ||
| ), |
Comment on lines
+693
to
+695
| quote_array_method_from_obj(ext_class, overrides, objects, obj), | ||
| 1, | ||
| 4, |
There was a problem hiding this comment.
off-topic, but I find the 1, 4, really confusing and hard to read.
To me it would be more natural with the argument-order indentation, text, newlines, since that is the order they will be emitted in the code.
There was a problem hiding this comment.
Yeah, after working in this code I want to build a clearer helper function / macro.
|
we have all extension mechanisms documented in |
emilk
pushed a commit
that referenced
this pull request
Sep 13, 2023
### What Builds on top of: #3302 One of the items raised by #3268 was wanting to extend a component type. But components previously had no instantiation. This PR creates Component objects that derive from their baseclass as well as the extension class. These can be used anywhere the datatype could be used instead. Example with TextLogLevel: ``` >>> rr2.TextLog(body="Hello", level=rr2.cmp.TextLogLevel.WARN) rr.TextLog( rerun.label<string>( ['Hello'] ) rerun.components.TextLogLevel<string>( ['WARN'] ) rerun.colorrgba<uint32>( [] ) ) >>> rr2.TextLog(body="World", level=rr2.cmp.TextLogLevel("my custom level")) rr.TextLog( rerun.label<string>( ['World'] ) rerun.components.TextLogLevel<string>( ['my custom level'] ) rerun.colorrgba<uint32>( [] ) ) ``` ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3303) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/3303) - [Docs preview](https://rerun.io/preview/177f58319e85da35d223c1fd0a109d35fbc7bd03/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/177f58319e85da35d223c1fd0a109d35fbc7bd03/examples) <!--EXAMPLES-PREVIEW--> - [Recent benchmark results](https://ref.rerun.io/dev/bench/) - [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
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.
What
Python extensions can now be implemented by declaring a class
TypeExtin an adjacent filetype_ext.py.This matches the existing conventions established in the cpp and rs code-generators.
This import is done automatically as a relative import from the base type, so no more maintaining overrides
__init__.pyimport-lists for extensions. Additionally, the extension type itself provides the scope for all exposed extensions, simplifying the generated import.init()is now overridden by declaring__init__directly on the extension class. This is a departure from declaringinit_overridebut means things like help and code completion for the class now see the actual init implementation. For example:Field converters no longer need the classname prefix.
color__rgba__field_converter_override->ColorExt.rgba__field_converter_override.Any other methods on the extension class are found through normal python function dispatch.
Resolves: #3268
The PR only migrates Color and Angle as a proof-of-concept. Additional types will be migrated in follow-up PRs and then support for the previous override mechanism can be removed.
Checklist