Add public to_json_snapshot method to Client | Fixes #4143 #4755
+18
−0
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 #4143
Problem
Users need to get a JSON snapshot of the Client as a dictionary for sharing experiments programmatically (e.g., storing in databases, sending over network) without writing to a file. Currently they have to use the private method
_to_json_snapshot().Solution
Added a public
to_json_snapshot()method toClientinax/api/client.pythat returns the JSON-serializable dictionary.Usage
Previous Behavior
Users had to use the private method
client._to_json_snapshot()which is not part of the public API and could change without notice.New Behavior
Users can use the public method
client.to_json_snapshot()which is part of the supported API.