`simvx.editor.autosave`¶

Editor autosave + crash recovery.

The editor’s autosave is conceptually distinct from :class:~simvx.core.SaveManager:

SaveManager snapshots only Property descriptors flagged persist=True – a deliberately narrow contract for in-game state.
The editor’s autosave needs the full scene structure so that, after a crash, no newly-added nodes are lost. We therefore reuse the engine’s in-memory scene snapshot helper (:func:simvx.core._scene_internal._serialize_node) and pickle that dict. Restoring goes through :func:_deserialize_node.

Both paths share :func:simvx.core.save_manager.pickle_atomic for the write-tmp + fsync + rename + two-deep .bak/.bak2 rotation, so the crash-safety guarantees are identical.

The autosave file lives at $XDG_DATA_HOME/simvx/editor/autosave.sav (falling back to ~/.local/share/simvx/editor/autosave.sav). One file – the most-recent project’s working tree – because the editor only ever has one foreground workspace.

Module Contents¶

Classes¶

`Autosave`	Periodic full-tree autosave with crash-recovery on launch.
`AutosaveRecoveryDialog`	Modal prompt shown on startup when a fresh autosave is available.

Functions¶

format_recovery_message

Build the human-readable message body for :class:AutosaveRecoveryDialog.

Data¶

log

API¶

simvx.editor.autosave.log¶: ‘getLogger(…)’

class simvx.editor.autosave.Autosave(state, autosave_dir: pathlib.Path | None = None)[source]¶

Periodic full-tree autosave with crash-recovery on launch.

Polled each frame via :meth:poll. When the autosave interval has elapsed and the editor’s scene is marked modified, a pickle of

Func:: _serialize_node(scene_root) is written atomically to <autosave_dir>/autosave.sav. On startup, :meth:check_recovery returns the autosave envelope when it is newer than the most-recently opened project file (if any).

Initialization

INTERVAL¶: 60.0

property autosave_path: pathlib.Path[source]¶: Single canonical autosave file path.

poll(now: float = 0.0) → None[source]¶: Save the working tree if the interval has elapsed and it’s dirty.

check_recovery(project_path: pathlib.Path | None = None) → dict | None[source]¶

Return the autosave envelope when recovery should be offered.

Returns None when:

no autosave file exists, or
a project_path was supplied and the autosave is older than the project file (i.e. the project’s on-disk state is already fresher).

Otherwise returns the decoded envelope dict (caller decides whether to show a dialog and/or restore).

restore(envelope: dict)[source]¶

Reconstruct a Node tree from a recovery envelope.

The caller is responsible for swapping the returned root into the editor’s active scene tab. Raises RuntimeError if the envelope is malformed (missing scene key); strict per the engine’s error philosophy.

discard() → None[source]¶: Delete the live autosave file (keeps .bak / .bak2).

class simvx.editor.autosave.AutosaveRecoveryDialog(**kwargs)[source]¶

Bases: simvx.core.Panel

Modal prompt shown on startup when a fresh autosave is available.

Three outcomes, exposed as signals:

attr:

restore_requested – user wants the autosaved tree swapped in.
attr:

discard_requested – delete the autosave and continue with the project file as-is.
attr:

cancelled – close the dialog without acting (e.g. user wants to inspect things first; autosave is left intact for later).