Add a new builtin Spec and conformer for renaming map keys #68
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
aphera
reviewed
Apr 28, 2020
Comment on lines
+1208
to
+1209
| If ``type_`` is specified, the resulting Spec will only validate the input value as | ||
| types named by ``type_``, otherwise :py:class:`dict` will be used. |
| def rename_spec( # noqa: MC0001 # pylint: disable=too-many-arguments | ||
| tag: Optional[Tag] = None, | ||
| replacements: Optional[Mapping[Hashable, Union[Hashable, List[Hashable]]]] = None, | ||
| retain_replaced_keys: bool = False, |
There was a problem hiding this comment.
I know it's a big change in a different direction but what if you split this into two specs, rename and copy_value specs. They could reuse this guy under the hood but it might make the api a bit simpler.
There was a problem hiding this comment.
How would the copy_value spec work?
There was a problem hiding this comment.
copy_value_spec would be rename_spec but hwere retain_replaced_keys = True
Merged
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.
This PR adds a new "Spec" factory and conformer under
s.renamewhich allows callers to specify simple rename operations as a Spec factory. The Spec returned by this factory performs a simple type check that it's getting adict(this is configurable by a keyword argument). By default,s.renamealso ships with a validator that ensures no keys are overwritten during the rename (this can be disabled by setting the keyword argumentoverwrite_duplicate_keys=True). The default conformer will perform the rename operation. The intended use case here is as part of ans.all(...)chain with a mapping Spec to follow and validate the renamed keys.Fixes #60