-
Notifications
You must be signed in to change notification settings - Fork 13
Introduce a new Persistable
mixin
#266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
falkoschindler
wants to merge
20
commits into
main
Choose a base branch
from
persistable
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
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.
This PR implements a
Persistable
mixin as an alternative to the existing persistence mechanism. It works as a standalone module without the need for a globally managed registry. To avoid cyclic imports, it doesn't even use RoSys'on_repeat
andon_shutdown
hooks, but uses NiceGUI'sapp.timer
andapp.on_shutdown
instead.A new example demonstrates the intended use:
Persistable
if they want to support persistence. If so, they need to overwrite the abstract methodsbackup_to_dict()
andrestore_to_dict()
to define the serialization and deserialization.persistent()
to make individual objects persistent (builder pattern). This opt-in approach gives full control to the user and allows more customization (key, path, intervals, ...) than before.At the moment I see the following remaining tasks:
app.on_shutdown(self.sync_backup)
--> orapp.on_shutdown(self. _sync_backup_if_requested)
delete_persistence()
export_button
andimport_button
for persistables?Persistable
for builtin RoSys modulesPersistable
, add.persistent()
calls, rename backup and restore methodsPersistentModule
class