feat: add Generic(De)Serializer stub classes for generic formats
#178
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
aaraney
added
enhancement
aaraney
commented
Aug 26, 2024
|
|
||
| @classmethod | ||
| @abstractmethod | ||
| def from_file(cls, p: Path, *_) -> Self: |
There was a problem hiding this comment.
Note for reviewer, *_ effectively means that subclasses that add arguments must make them keyword only / optional. The goal is improve uniformity of implementations.
There was a problem hiding this comment.
I would add that note in the extended section of the doc string.
There was a problem hiding this comment.
Yeah, I can do that if you are adamant about it. I didn't add a comment b.c. the syntax and meaning are self evident (which I kind of like). Its not a super esoteric pattern, but to be fair, it is a newish pattern.
There was a problem hiding this comment.
I'm not too worried. I probably would literally have written it as "Note to self:" because I would forget in the future haha.
aaraney
force-pushed
the
feat-generic-serde
branch
2 times, most recently
from
ffc7f99
to
777bc32
Compare
hellkite500
reviewed
Aug 26, 2024
aaraney
force-pushed
the
feat-generic-serde
branch
from
777bc32
to
46bc2c4
Compare
hellkite500
approved these changes
Aug 26, 2024
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.
Add
GenericSerializer,GenericDeserializer, andGenericSerializerDeserializerabstract marker classes.ngen.init_configcannot support all formats under the sun, but with other tools likengen.config_genbeing aware of the abstractions present inngen.init_config, these classes provide a common interface for generic data formats to interoperate. Beyond interfaces, thetype's work as markers for other tools (e.g.isinstancecheck and change behavior).ngen.init_config--0.0.7Additions
GenericSerializer,GenericDeserializer, andGenericSerializerDeserializerabstract marker classes. Serializers and Deserializer must impliement the following methods respectively:to_file(self, f: pathlib.Path, *_) -> None,to_str(self, *_) -> strandfrom_file(cls, f: pathlib.Path, *_),from_str(cls, s: str, *_).