Add wload kwargs to produce_or_load
#412
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
An additional keyword argument called wload_kwargs was added to produce_or_load. This makes it possible to pass arguments to wload. For example, if you need to load some data type from disk but the type definition has changed, you need to provide JLD2 a typemap to rebuild the original object. This makes it possible to pass the typemap to wload via produce_or_load. wload_kwargs defaults to an emtpy named tuple. The default type wsave_kwargs was changed to an empty named tuple. This seems like a more natural choice than as an empty Dict which would only work with kwarg splatting if all the keys happened to be of type Symbol. Also slurping kwargs gives a named tuple.
Datseris
approved these changes
Apr 10, 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.
Added the ability to pass keyword arguments to
wloadwithinproduce_or_loadby defining a new kwarg calledwload_kwargs. This works the same way as the existing functionality provided bywsave_kwargs. This is useful, for example, if you need to load a data type from file but the type definition has changed. You can pass a typemap to JLD2 that instructs it how to rebuild the object. This is not possible in the current implementation ofproduce_or_loadbecause there is no way to pass kwargs towload. This pull request makes it possible.The default types for both
wsave_kwargsandwload_kwargsare now empty named tuples. This seems like the more natural choice than an emptyDictwhich would only work for kwarg splatting if the keys happened to be of typeSymbol. It also seems more consistent because slurping of kwargs results in a named tuple.All tests were ran and passed with these changes.