Shortening a dict should not change its type #200
Merged
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 #197
#176 added request.POST to the keys that we might shorten. It turns out that we shorten things basically by turning them into a string representation of themselves with an ellipses. This is problematic as it pertains to types. A string
"{'a': 1, ...}"
is not a valid JSON object even if it is reified. The problem with shortening dictionaries that they are unordered, so we have to make some arbitrary choice about what to leave in versus out. In this PR I chose to useobj.items()[:max_items]
as the selection of the maximum number of keys. The current implementation uses whatever reprlib decides to do. In this way, I construct a new dict by pulling the key/value pairs from the old object.Problems with this are that the result is not obviously truncated. We could add something like
{"truncated": true}
to the object or{"...": "..."}
to make it obvious. The other alternative is to not truncate request.POST. Any other place that we might truncate a dictionary is probably fine to turn it into a string but the API will reject an item with a string value at request.POST.