This repository was archived by the owner on Nov 28, 2023. It is now read-only.
Make to/from_dict optional #107
Merged
Conversation
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Writing small custom components is very common in teaching material (tutorials, presentations) and might become even more popular depending how the users will receive the new Pipelines in 2.x. Problem is, having to write a
to_dictandfrom_dictevery time is cumbersome, even if the implementation is a single line thanks to the default methods provided by canals.The idea is to remove
to_dictandfrom_dictfrom the Component protocol and make them optional. We use the default serialization methods we already have whento_dictorfrom_dictare not present in a component class.Caveat: when
to_dictis not present, we inspect the__init__signature and see if the init parameters were assigned to an instance variable. If that wasn't the case, we resort to the default value of the parameter. If it doesn't have a default value, we raise an error.ATM all the components have the serialization methods, so I changed
Greetas an example of how this would look like.