feat: add a depth-limited repr function #657
Open
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
Should help reduce the size of reprs of instances of ORM-mapped classes.
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 #656 .
This PR shows a way to reduce the size of reprs of ORM objects. It implements a custom repr function which is depth-limited. It's a simple generic way to "prune" the repr. If you try again the script given in the issue, the result should much smaller.
This PR also overrides __repr__() for three ORM classes: Queue, Resource, Tag as an example.
The function is implemented in a pretty generic way, so you could use it with simple types and generic data structures as well, but the depth limiting is specifically implemented in terms of nested ORM objects, since it is written to solve the ORM object repr problem.