Multiple fixes for cascade=True save issues #2615
Open
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 multiple issues when cascade=True in the Document save method:
Modifications:
Below is some code (based on new pytest test_cascade_save_with_cycles) to demonstrate how cascade saves can now work:
Personal Notes:
It is my personal opinion that these changes make the code look cleaner as you don't have .save() calls all over the place and you can also avoid the habit of over-saving documents (which I have been guilty of due to a lack of trust in cascade saving). This also removes the burden from the developer to keep track of what has and has not been saved.
I also believe this makes the code look less like ORM code as you only require one save at the end of all data creation/manipulation for complex objects.
I feel a bit shaky about how I implimented the _is_saving flag that is now used during a cascade save. This flag must be set to false when the save method has completed (either regularly or if there was an error thrown). I acomplished this with a wrapper try-catch and the use of a finally clause.