Self-Contained JSON file format #412
Merged
Conversation
This file contains hidden or 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
added 2 commits
November 13, 2023 17:40
|
Merging to
|
changed from `get_self_contained_json` to `get_expanded_json`
* added comments * renamed variables to be more self documenting and obvious * added type hinting where it would help * renamed test to be more self documenting and make more sense
* changed name from `mybigsmiles` that triggered spelling error CI to something that would not trigger it and is more explicit and better anyways. * replaced it with `my material 1 bigsmiles` and `my material 2 bigsmiles`
Json file format additions/upgrades
nh916
previously approved these changes
Nov 15, 2023
| 1. A complex project node can be serialized into an expanded JSON string, without UUID placeholders. | ||
| 2. The expanded JSON can be deserialized into a node that is equivalent to the original node. | ||
| """ | ||
| expanded_project_json: str = complex_project_node.get_expanded_json() |
There was a problem hiding this comment.
in hindsight, I probably should have named this project_expanded_json to make more sense, but I think it'll pass for now
Merged
nh916
approved these changes
Nov 15, 2023
| # assert the expanded JSON was correctly deserialized to project node | ||
| assert deserialized_project_node == complex_project_node | ||
|
|
||
| short_json: str = complex_project_node.json |
There was a problem hiding this comment.
this should have also been condensed_json instead to make it more self documenting and clearer
| >>> # ============= Get long form JSON ============= | ||
| >>> long_form_json = my_project.get_expanded_json(indent=4) | ||
|
|
||
| ???+ info "Short JSON VS Long JSON" |
There was a problem hiding this comment.
We should have called this section Condensed JSON VS Expanded JSON, but it is okay for now and we can come back to it later
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.
Description
The SDK can produce fully self-contained JSON string for node graphs.
Such a node graph does not contain any UUID reference (self-contained) and can be super helpful for users if they want to store their work in a JSON file before uploading it to CRIPT.
@bearmit expressed that he would like this feature.
Changes
Also added a hint about using
kwargsto beautify JSON strings into the documentation.Tests
A test is included to ensures that self-containing JSON can be parsed by
cript.load_nodes_from_json.Known Issues
Notes
Checklist
CONTRIBUTORS.md) in the pull request source branch.