feat: add method to add child/children elements to objects #115
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
- also adds a corresponding method to get some information about them
The function is added to `BaseWithoutId` and so should be inherited by
everything.
The `add` method:
- gets the list of the members defined by generateDS for each each class
- checks the type of the object being added to the types of the members
to find the right member to add to. If a member with the type cannot
be found, an Exception is raised.
- if a member is found, it can either be a child member (can only have
one value) or a children member (can have multiple values in a list).
- For child members a check is made to see if a value is already set. If
not, the value is set to the given object.
- For children members, a check is made to see if the object has already
been added. If not, the object is added.
- If either test fails, an Exception is raised (since one does not need
to re-add objects to update their value)
- A `force` option allows overwriting and readdition, but is set to
`False` by default.
So, example usage would be of this type:
```
cell = neuroml.Cell(id="acell")
biprop = neuroml.BiophysicalProperties(id="biprop")
cell.add(biprop) # success
cell.add(biprop) # will throw an Exception unless `force=True`
cell.add("a string") # will throw an Exception since no member has a type "str"
```
Note: we have a few ComponentTypes which don't inherit from anywhere,
and we need to check if these are correctly defined in the XSD file
(Location is an example).
sanjayankur31
force-pushed
the
feat/generic-add-method
branch
from
5dcea7a
to
6ab810c
Compare
This will be useful for testing purposes.
- get_member_info - add
|
Note: we could probably use a better name than "get_info |
So users can primarily just use `add()`.
|
tweaked the function names to:
if |
Attempting to readd an object is harmless, so make this a warning. Also fixes the comparison to not use `is` because it doesn't only compare the reference, it also compares the value.
We want a copy of the object to add other inherited member_data_types_ to. If we use `=`, we get a reference to `self.member_data_types_` object and end up modifying it, which we do not want to do. Not only does that change the nml.py representation, it also means that all the "expanded" lists of `member_data_types_` is held in memory for every neuroml object which greatly increases the memory foot print of models. So, calculate the complete list of member_data_types_ when required and then forget about it, which will allow memory to be garbage collected and freed up.
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.
Opening this against the existing generateds PR since it'll cause conflicts otherwise. (#110)
TODO: