Dict-like methods of Dataset.
#153
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
…n into dict-like-methods
jl-wynen
reviewed
Oct 2, 2023
src/scitacean/dataset.py
Outdated
| def keys(self) -> Iterable[str]: | ||
| """Dict-like keys(names of fields) method. | ||
|
|
||
| .. versionadded:: RELEASE_PLACEHOLDER |
There was a problem hiding this comment.
Please move those directives to the very end of the docstring.
There was a problem hiding this comment.
It seems like it doesn't work if it is not above the sub-titles...?
There was a problem hiding this comment.
This is an annoyance with restructured text. You need two empty lines to 'return' from the previous section. I just added this to the coding conventions: https://github.com/SciCatProject/scitacean/blob/main/docs/developer/coding-conventions.rst
|
Can you add a release note? |
Co-authored-by: Jan-Lukas Wynen <jan-lukas.wynen@ess.eu>
Co-authored-by: Jan-Lukas Wynen <jan-lukas.wynen@ess.eu>
jl-wynen
approved these changes
Oct 6, 2023
|
@jl-wynen I'm not authorized to merge this PR...! |
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.
Fixes #76
During the sprint
Dict-like methods:
keysvaluesitems__getitem____setitem__setdefaultHelper method to check if the key to the
__(get/set)item__is valid:_validate_field_namekeys/values/itemskeysreturn names of fields that belong to the currenttypeof theDatasetobject and other fields that only belong to the othertypeonly if they are notNone.valuesanditemsare usingkeys, hence using same set of fields.__getitem__/__setitem__/setdefaultThese methods check if the
key(field_name) is one of names of fields defined in theDatasetBase._FIELD_SPEC.If not valid, raise
KeyErrorwith custom error message.But these methods don't check if they are valid fields of the current
type.Manual fields
Fields that are not defined in the
DatasetBase._FIELD_SPECare excluded for now. See #151 for more detail.