Remove object references cycle in LinkDescription #374
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.
Currently,
LinkDescription
has the attributes parent and children that are LinkDescription. This creates a reference where aLinkDescription
references its parent, which references back to theLinkDescription
.This can create infinite recursion in case we call a function on the attributes of
LinkDescription
recursively, for example in__repr__
,__hash__
ordataclasses.asdict
.The last one is needed to implement a Gymnax environment, which I believe is a common use case.
In this PR, I changed the parent attribute to be the parent's name, instead of the object itself. This doesn't create a problem since most of the time we only need the name and there is a dictionary mapping names to LinkDescription.
To reproduce the issue:
📚 Documentation preview 📚: https://jaxsim--374.org.readthedocs.build//374/