hiro/emacs-ipython-notebook
1
0
Fork 0
mirror of https://github.com/vale981/emacs-ipython-notebook synced 2025-03-05 09:01:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Autosaving and checkpoints as distinct actions.

Browse source 
Saving a notebook and creating a checkpoint are related, but distinct
activities. EIN does better now with this distinction. See updates to
the documentaiton (which should get pushed to github any day now).
This commit is contained in:
John Miller 2016-10-21 12:10:49 -05:00
parent bdc140e446
commit 701ddbe39c
3 changed files with 70 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/source/index.rst
View file

@ -258,9 +258,10 @@ The following keybinds are available in notebook buffers.
.. el:function:: ein:junk-rename
.. el:function:: ein:notebook-kill-all-buffers
.. el:function:: ein:iexec-mode
.. el:function:: ein:notebook-enable-checkpoints
.. el:function:: ein:notebook-disable-checkpoints
.. el.function:: ein:notebook-create-checkpoint
.. el:function:: ein:notebook-restore-to-checkpoint
.. el:function:: ein:notebook-enable-autosaves
.. el:function:: ein:notebook-disable-autosaves
Connected buffer
^^^^^^^^^^^^^^^^
@ -386,7 +387,8 @@ Notebook
.. el:variable:: ein:output-type-preference
.. el:variable:: ein:shr-env
.. el.variable:: ein:worksheet-show-slide-data
.. el.variable:: ein:notebook-checkpoint-frequency
.. el.variable:: ein:notebook-autosave-frequency
.. el.variable:: ein:notebook-create-checkpoint-on-save
Console
^^^^^^^

90
lisp/ein-notebook.el
View file

@ -62,17 +62,30 @@
(make-obsolete-variable 'ein:notebook-discard-output-on-save nil "0.2.0")
(defcustom ein:notebook-checkpoint-frequency 60
"Sets the frequency (in seconds) at which checkpoints (i.e.
autosaves) are generated for the current notebook.
(defcustom ein:notebook-autosave-frequency 60
"Sets the frequency (in seconds) at which the notebook is
automatically saved.
Autosaves are automatically enabled when a notebook is opened,
but can be controlled manually via `ein:notebook-enable-autosave'
and `ein:notebook-disable-autosave'.
If this parameter is changed than you must call
`ein:notebook-disable-autosave' and then
`ein:notebook-enable-autosave' on all open notebooks for the
changes to take effect.
Autosaves are automatically enabled when a notebook is opened, but
can be controlled manually via `ein:notebook-enable-checkpoints' and
`ein:notebook-disable-checkpoints'.
"
:type 'number
:group 'ein)
(defcustom ein:notebook-create-checkpoint-on-save t
"If non-nil a checkpoint will be created every time the
notebook is saved. Otherwise checkpoints must be created manually
via `ein:notebook-create-checkpoint'."
:type 'boolean
:group 'ein)
(defcustom ein:notebook-discard-output-on-save 'no
"Configure if the output part of the cell should be saved or not.
@ -238,7 +251,7 @@ Current buffer for these functions is set to the notebook buffer.")
worksheets
scratchsheets
api-version
checkpoint-timer
autosave-timer
checkpoints)
(ein:deflocal ein:%notebook% nil
@ -412,7 +425,7 @@ See `ein:notebook-open' for more information."
(cons #'ein:notebook-buffer-list notebook)))
(ein:notebook-put-opened-notebook notebook)
(ein:notebook--check-nbformat (ein:$content-raw-content content))
(ein:notebook-enable-checkpoints notebook)
(ein:notebook-enable-autosaves notebook)
(ein:log 'info "Notebook %s is ready"
(ein:$notebook-notebook-name notebook))))
@ -447,9 +460,8 @@ of minor mode."
;;; Initialization.
(defun ein:notebook-enable-checkpoints (notebook)
"Enable automatic saving of checkpoints to the Jupter server
for notebook."
(defun ein:notebook-enable-autosaves (notebook)
"Enable automatic, periodic saving for notebook."
(interactive
(let* ((notebook (or (ein:get-notebook)
(completing-read
@ -458,14 +470,14 @@ for notebook."
(list notebook)))
(if (stringp notebook)
(error "Fix me!")) ;; FIXME
(setf (ein:$notebook-checkpoint-timer notebook)
(run-at-time 0 ein:notebook-checkpoint-frequency #'ein:notebook-save-checkpoint notebook))
(ein:log 'info "Enabling checkpoints for %s with frequency %s seconds."
(setf (ein:$notebook-autosave-timer notebook)
(run-at-time 0 ein:notebook-autosave-frequency #'ein:notebook-save-notebook notebook 0))
(ein:log 'info "Enabling autosaves for %s with frequency %s seconds."
(ein:$notebook-notebook-name notebook)
ein:notebook-checkpoint-frequency))
ein:notebook-autosave-frequency))
(defun ein:notebook-disable-checkpoints (notebook)
"Disable automatic saving of checkpoints for current notebook."
(defun ein:notebook-disable-autosaves (notebook)
"Disable automatic, periodic saving for current notebook."
(interactive
(let* ((notebook (or (ein:get-notebook)
(completing-read
@ -473,8 +485,8 @@ for notebook."
(ein:notebook-opened-buffer-names)))))
(list notebook)))
(ein:log 'info "Disabling auto checkpoints for notebook %s" (ein:$notebook-notebook-name notebook))
(when (ein:$notebook-checkpoint-timer notebook)
(cancel-timer (ein:$notebook-checkpoint-timer notebook))))
(when (ein:$notebook-autosave-timer notebook)
(cancel-timer (ein:$notebook-autosave-timer notebook))))
(defun ein:notebook-bind-events (notebook events)
"Bind events related to PAGER to the event handler EVENTS."
@ -817,8 +829,8 @@ This is equivalent to do ``C-c`` in the console program."
(ein:content-save content
#'ein:notebook-save-notebook-success
(list notebook callback cbargs)
#'ein:notebook-save-notebook-error
(list notebook))))
#'ein:notebook-save-notebook-error
(list notebook))))
(defun ein:notebook-save-notebook-command ()
"Save the notebook."
@ -858,7 +870,10 @@ This is equivalent to do ``C-c`` in the console program."
(ein:worksheet-set-modified-p ws nil))
(ein:$notebook-worksheets notebook))
(ein:events-trigger (ein:$notebook-events notebook)
'notebook_saved.Notebook))
'notebook_saved.Notebook)
(when ein:notebook-create-checkpoint-on-save
(ein:notebook-create-checkpoint notebook)))
;; .. [#] Consider the following case.
;; (1) Open worksheet WS0 and other worksheets.
;; (2) Edit worksheet WS0 then save the notebook.
@ -938,16 +953,23 @@ notebook worksheets."
:type "notebook"
:ipython-version (ein:$notebook-api-version notebook)))
(defun ein:notebook-save-checkpoint (notebook)
(let ((content (ein:fast-content-from-notebook notebook)))
(ein:content-create-checkpoint content
(lexical-let ((notebook notebook))
#'(lambda (content)
(ein:log 'info "Checkpoint %s for %s generated."
(plist-get (first (ein:$content-checkpoints content)) :id)
(ein:$notebook-notebook-name notebook))
(setf (ein:$notebook-checkpoints notebook)
(ein:$content-checkpoints content)))))))
(defun ein:notebook-create-checkpoint (notebook)
"Create checkpoint for current notebook based on most recent save."
(interactive
(let* ((notebook (ein:get-notebook)))
(list notebook)))
(ein:events-trigger (ein:$notebook-events notebook)
'notebook_create_checkpoint.Notebook)
(ein:content-create-checkpoint (ein:fast-content-from-notebook notebook)
(lexical-let ((notebook notebook))
#'(lambda (content)
(ein:log 'info "Checkpoint %s for %s generated."
(plist-get (first (ein:$content-checkpoints content)) :id)
(ein:$notebook-notebook-name notebook))
(ein:events-trigger (ein:$notebook-events notebook)
'notebook_checkpoint_created.Notebook)
(setf (ein:$notebook-checkpoints notebook)
(ein:$content-checkpoints content))))))
(defun ein:notebook-list-checkpoint-ids (notebook)
(unless (ein:$notebook-checkpoints notebook)
@ -958,7 +980,7 @@ notebook worksheets."
(ein:$content-checkpoints content)))))
(sleep-for 0.5))
(loop for cp in (ein:$notebook-checkpoints notebook)
collecting (plist-get cp :id)))
collecting (plist-get cp :last_modified)))
(defun ein:notebook-restore-to-checkpoint (notebook checkpoint)
"Restore notebook to previous checkpoint saved on the Jupyter
@ -1671,7 +1693,7 @@ Called via `kill-emacs-query-functions'."
(defun ein:notebook-kill-buffer-callback ()
"Call notebook destructor. This function is called via `kill-buffer-hook'."
(when (ein:$notebook-p ein:%notebook%)
(ein:notebook-disable-checkpoints ein:%notebook%)
(ein:notebook-disable-autosaves ein:%notebook%)
(ein:notebook-close-worksheet ein:%notebook% ein:%worksheet%)))
(defun ein:notebook-setup-kill-buffer-hook ()

9
lisp/ein-notification.el
View file

@ -87,7 +87,9 @@ S-mouse-1/3 (Shift + left/right click): move this tab to left/right"
"NotebookStatus"
:s2m
'((notebook_saving.Notebook . "Saving Notebook...")
(notebook_create_checkpoint.Notebook . "Creating Checkpoint...")
(notebook_saved.Notebook . "Notebook is saved")
(notebook_checkpoint_created.Notebook . "Checkpoint created.")
(notebook_save_failed.Notebook . "Failed to save Notebook!")))
:type ein:notification-status)
(kernel
@ -121,6 +123,13 @@ where NS is `:kernel' or `:notebook' slot of NOTIFICATION."
st ; = event-type
#'ein:notification--callback
(cons ns st))))
(ein:events-on events
'notebook_checkpoint_created.Notebook
#'ein:notification--fadeout-callback
(list (oref notification :notebook)
"Checkpoint created."
'notebook_checkpoint_created.Notebook
nil))
(ein:events-on events
'notebook_saved.Notebook
#'ein:notification--fadeout-callback