filenbmanager.py
474 lines
| 17.8 KiB
| text/x-python
|
PythonLexer
|
r4609 | """A notebook manager that uses the local file system for storage. | ||
Authors: | ||||
* Brian Granger | ||||
|
r13046 | * Zach Sailer | ||
|
r4609 | """ | ||
|
r4484 | #----------------------------------------------------------------------------- | ||
|
r8180 | # Copyright (C) 2011 The IPython Development Team | ||
|
r4484 | # | ||
# Distributed under the terms of the BSD License. The full license is in | ||||
|
r4609 | # the file COPYING, distributed as part of this software. | ||
|
r4484 | #----------------------------------------------------------------------------- | ||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
|
r6030 | import io | ||
|
r4484 | import os | ||
|
r4624 | import glob | ||
|
r10497 | import shutil | ||
|
r12984 | |||
|
r4484 | from tornado import web | ||
|
r8194 | from .nbmanager import NotebookManager | ||
|
r14907 | from IPython.nbformat import current | ||
|
r8180 | from IPython.utils.traitlets import Unicode, Dict, Bool, TraitError | ||
|
r15420 | from IPython.utils.py3compat import getcwd | ||
|
r11145 | from IPython.utils import tz | ||
|
r15420 | from IPython.html.utils import is_hidden, to_os_path | ||
|
r4484 | |||
#----------------------------------------------------------------------------- | ||||
|
r5758 | # Classes | ||
#----------------------------------------------------------------------------- | ||||
|
r4484 | |||
|
r8194 | class FileNotebookManager(NotebookManager): | ||
|
r5653 | |||
save_script = Bool(False, config=True, | ||||
|
r5760 | help="""Automatically create a Python script when saving the notebook. | ||
|
r5653 | |||
|
r6765 | For easier use of import, %run and %load across notebooks, a | ||
|
r5758 | <notebook-name>.py script will be created next to any | ||
<notebook-name>.ipynb on each save. This can also be set with the | ||||
short `--script` flag. | ||||
|
r5653 | """ | ||
) | ||||
|
r15420 | notebook_dir = Unicode(getcwd(), config=True) | ||
|
r5653 | |||
|
r15420 | def _notebook_dir_changed(self, name, old, new): | ||
"""Do a bit of validation of the notebook dir.""" | ||||
if not os.path.isabs(new): | ||||
# If we receive a non-absolute path, make it absolute. | ||||
self.notebook_dir = os.path.abspath(new) | ||||
return | ||||
if not os.path.exists(new) or not os.path.isdir(new): | ||||
raise TraitError("notebook dir %r is not a directory" % new) | ||||
|
r10497 | checkpoint_dir = Unicode(config=True, | ||
help="""The location in which to keep notebook checkpoints | ||||
By default, it is notebook-dir/.ipynb_checkpoints | ||||
""" | ||||
) | ||||
def _checkpoint_dir_default(self): | ||||
return os.path.join(self.notebook_dir, '.ipynb_checkpoints') | ||||
def _checkpoint_dir_changed(self, name, old, new): | ||||
"""do a bit of validation of the checkpoint dir""" | ||||
if not os.path.isabs(new): | ||||
# If we receive a non-absolute path, make it absolute. | ||||
abs_new = os.path.abspath(new) | ||||
self.checkpoint_dir = abs_new | ||||
return | ||||
if os.path.exists(new) and not os.path.isdir(new): | ||||
raise TraitError("checkpoint dir %r is not a directory" % new) | ||||
if not os.path.exists(new): | ||||
self.log.info("Creating checkpoint dir %s", new) | ||||
try: | ||||
os.mkdir(new) | ||||
except: | ||||
raise TraitError("Couldn't create checkpoint dir %r" % new) | ||||
|
r4484 | |||
|
r13067 | def get_notebook_names(self, path=''): | ||
|
r13051 | """List all notebook names in the notebook dir and path.""" | ||
|
r13078 | path = path.strip('/') | ||
|
r15420 | if not os.path.isdir(self._get_os_path(path=path)): | ||
|
r13100 | raise web.HTTPError(404, 'Directory not found: ' + path) | ||
|
r15420 | names = glob.glob(self._get_os_path('*'+self.filename_ext, path)) | ||
|
r12984 | names = [os.path.basename(name) | ||
|
r4623 | for name in names] | ||
|
r8180 | return names | ||
|
r12997 | |||
|
r13070 | def path_exists(self, path): | ||
"""Does the API-style path (directory) actually exist? | ||||
|
r13059 | |||
|
r13070 | Parameters | ||
---------- | ||||
path : string | ||||
The path to check. This is an API path (`/` separated, | ||||
relative to base notebook-dir). | ||||
Returns | ||||
------- | ||||
exists : bool | ||||
Whether the path is indeed a directory. | ||||
""" | ||||
|
r13078 | path = path.strip('/') | ||
|
r15420 | os_path = self._get_os_path(path=path) | ||
|
r13070 | return os.path.isdir(os_path) | ||
|
r15097 | |||
def is_hidden(self, path): | ||||
"""Does the API style path correspond to a hidden directory or file? | ||||
Parameters | ||||
---------- | ||||
path : string | ||||
The path to check. This is an API path (`/` separated, | ||||
relative to base notebook-dir). | ||||
Returns | ||||
------- | ||||
exists : bool | ||||
Whether the path is hidden. | ||||
""" | ||||
path = path.strip('/') | ||||
|
r15420 | os_path = self._get_os_path(path=path) | ||
|
r15108 | return is_hidden(os_path, self.notebook_dir) | ||
|
r15097 | |||
|
r15420 | def _get_os_path(self, name=None, path=''): | ||
|
r13070 | """Given a notebook name and a URL path, return its file system | ||
path. | ||||
Parameters | ||||
---------- | ||||
name : string | ||||
The name of a notebook file with the .ipynb extension | ||||
path : string | ||||
The relative URL path (with '/' as separator) to the named | ||||
notebook. | ||||
Returns | ||||
------- | ||||
path : string | ||||
A file system path that combines notebook_dir (location where | ||||
server started), the relative path, and the filename with the | ||||
current operating system's url. | ||||
""" | ||||
if name is not None: | ||||
|
r15420 | path = path + '/' + name | ||
return to_os_path(path, self.notebook_dir) | ||||
|
r13070 | |||
|
r13067 | def notebook_exists(self, name, path=''): | ||
|
r13032 | """Returns a True if the notebook exists. Else, returns False. | ||
|
r13046 | |||
|
r13032 | Parameters | ||
---------- | ||||
name : string | ||||
The name of the notebook you are checking. | ||||
path : string | ||||
The relative path to the notebook (with '/' as separator) | ||||
|
r13046 | |||
|
r13032 | Returns | ||
------- | ||||
bool | ||||
""" | ||||
|
r13078 | path = path.strip('/') | ||
|
r15420 | nbpath = self._get_os_path(name, path=path) | ||
|
r13067 | return os.path.isfile(nbpath) | ||
|
r12984 | |||
|
r15079 | # TODO: Remove this after we create the contents web service and directories are | ||
# no longer listed by the notebook web service. | ||||
|
r15069 | def list_dirs(self, path): | ||
"""List the directories for a given API style path.""" | ||||
path = path.strip('/') | ||||
|
r15420 | os_path = self._get_os_path('', path) | ||
|
r15108 | if not os.path.isdir(os_path) or is_hidden(os_path, self.notebook_dir): | ||
|
r15097 | raise web.HTTPError(404, u'directory does not exist: %r' % os_path) | ||
|
r15069 | dir_names = os.listdir(os_path) | ||
dirs = [] | ||||
for name in dir_names: | ||||
|
r15420 | os_path = self._get_os_path(name, path) | ||
|
r15108 | if os.path.isdir(os_path) and not is_hidden(os_path, self.notebook_dir): | ||
|
r15093 | try: | ||
model = self.get_dir_model(name, path) | ||||
except IOError: | ||||
pass | ||||
|
r15069 | dirs.append(model) | ||
dirs = sorted(dirs, key=lambda item: item['name']) | ||||
return dirs | ||||
|
r15079 | # TODO: Remove this after we create the contents web service and directories are | ||
# no longer listed by the notebook web service. | ||||
|
r15069 | def get_dir_model(self, name, path=''): | ||
"""Get the directory model given a directory name and its API style path""" | ||||
path = path.strip('/') | ||||
|
r15420 | os_path = self._get_os_path(name, path) | ||
|
r15069 | if not os.path.isdir(os_path): | ||
raise IOError('directory does not exist: %r' % os_path) | ||||
info = os.stat(os_path) | ||||
last_modified = tz.utcfromtimestamp(info.st_mtime) | ||||
created = tz.utcfromtimestamp(info.st_ctime) | ||||
# Create the notebook model. | ||||
model ={} | ||||
model['name'] = name | ||||
model['path'] = path | ||||
model['last_modified'] = last_modified | ||||
model['created'] = created | ||||
model['type'] = 'directory' | ||||
return model | ||||
|
r13046 | def list_notebooks(self, path): | ||
|
r13048 | """Returns a list of dictionaries that are the standard model | ||
for all notebooks in the relative 'path'. | ||||
Parameters | ||||
---------- | ||||
path : str | ||||
the URL path that describes the relative path for the | ||||
listed notebooks | ||||
Returns | ||||
------- | ||||
notebooks : list of dicts | ||||
a list of the notebook models without 'content' | ||||
""" | ||||
|
r13078 | path = path.strip('/') | ||
|
r13046 | notebook_names = self.get_notebook_names(path) | ||
|
r15290 | notebooks = [self.get_notebook(name, path, content=False) for name in notebook_names] | ||
|
r13046 | notebooks = sorted(notebooks, key=lambda item: item['name']) | ||
return notebooks | ||||
|
r15290 | def get_notebook(self, name, path='', content=True): | ||
|
r13827 | """ Takes a path and name for a notebook and returns its model | ||
|
r13048 | |||
Parameters | ||||
---------- | ||||
name : str | ||||
the name of the notebook | ||||
path : str | ||||
the URL path that describes the relative path for | ||||
the notebook | ||||
Returns | ||||
------- | ||||
model : dict | ||||
the notebook model. If contents=True, returns the 'contents' | ||||
dict in the model as well. | ||||
""" | ||||
|
r13078 | path = path.strip('/') | ||
|
r13072 | if not self.notebook_exists(name=name, path=path): | ||
|
r13046 | raise web.HTTPError(404, u'Notebook does not exist: %s' % name) | ||
|
r15420 | os_path = self._get_os_path(name, path) | ||
|
r13046 | info = os.stat(os_path) | ||
|
r11145 | last_modified = tz.utcfromtimestamp(info.st_mtime) | ||
|
r13072 | created = tz.utcfromtimestamp(info.st_ctime) | ||
|
r13046 | # Create the notebook model. | ||
model ={} | ||||
model['name'] = name | ||||
model['path'] = path | ||||
|
r13051 | model['last_modified'] = last_modified | ||
|
r13143 | model['created'] = created | ||
|
r15093 | model['type'] = 'notebook' | ||
|
r14856 | if content: | ||
|
r13112 | with io.open(os_path, 'r', encoding='utf-8') as f: | ||
|
r13046 | try: | ||
|
r13051 | nb = current.read(f, u'json') | ||
except Exception as e: | ||||
raise web.HTTPError(400, u"Unreadable Notebook: %s %s" % (os_path, e)) | ||||
|
r14907 | self.mark_trusted_cells(nb, path, name) | ||
|
r13046 | model['content'] = nb | ||
return model | ||||
|
r12997 | |||
|
r15290 | def save_notebook(self, model, name='', path=''): | ||
|
r13046 | """Save the notebook model and return the model with no content.""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13046 | |||
if 'content' not in model: | ||||
raise web.HTTPError(400, u'No notebook JSON data provided') | ||||
|
r15093 | |||
|
r13245 | # One checkpoint should always exist | ||
if self.notebook_exists(name, path) and not self.list_checkpoints(name, path): | ||||
self.create_checkpoint(name, path) | ||||
|
r13046 | |||
|
r13067 | new_path = model.get('path', path).strip('/') | ||
|
r13046 | new_name = model.get('name', name) | ||
if path != new_path or name != new_name: | ||||
self.rename_notebook(name, path, new_name, new_path) | ||||
|
r11052 | |||
|
r13046 | # Save the notebook file | ||
|
r15420 | os_path = self._get_os_path(new_name, new_path) | ||
|
r13051 | nb = current.to_notebook_json(model['content']) | ||
|
r14856 | |||
|
r14907 | self.check_and_sign(nb, new_path, new_name) | ||
|
r14856 | |||
|
r13046 | if 'name' in nb['metadata']: | ||
nb['metadata']['name'] = u'' | ||||
|
r4484 | try: | ||
|
r13051 | self.log.debug("Autosaving notebook %s", os_path) | ||
|
r13112 | with io.open(os_path, 'w', encoding='utf-8') as f: | ||
|
r4633 | current.write(nb, f, u'json') | ||
|
r5709 | except Exception as e: | ||
|
r13051 | raise web.HTTPError(400, u'Unexpected error while autosaving notebook: %s %s' % (os_path, e)) | ||
|
r8180 | |||
|
r13046 | # Save .py script as well | ||
|
r5653 | if self.save_script: | ||
|
r13051 | py_path = os.path.splitext(os_path)[0] + '.py' | ||
self.log.debug("Writing script %s", py_path) | ||||
|
r5653 | try: | ||
|
r13051 | with io.open(py_path, 'w', encoding='utf-8') as f: | ||
|
r13513 | current.write(nb, f, u'py') | ||
|
r5709 | except Exception as e: | ||
|
r13051 | raise web.HTTPError(400, u'Unexpected error while saving notebook as script: %s %s' % (py_path, e)) | ||
|
r13046 | |||
|
r15290 | model = self.get_notebook(new_name, new_path, content=False) | ||
|
r13046 | return model | ||
|
r15290 | def update_notebook(self, model, name, path=''): | ||
|
r13046 | """Update the notebook's path and/or name""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13046 | new_name = model.get('name', name) | ||
|
r13078 | new_path = model.get('path', path).strip('/') | ||
|
r13046 | if path != new_path or name != new_name: | ||
self.rename_notebook(name, path, new_name, new_path) | ||||
|
r15290 | model = self.get_notebook(new_name, new_path, content=False) | ||
|
r13046 | return model | ||
|
r15290 | def delete_notebook(self, name, path=''): | ||
|
r13046 | """Delete notebook by name and path.""" | ||
|
r13078 | path = path.strip('/') | ||
|
r15420 | os_path = self._get_os_path(name, path) | ||
|
r13051 | if not os.path.isfile(os_path): | ||
raise web.HTTPError(404, u'Notebook does not exist: %s' % os_path) | ||||
|
r10497 | |||
# clear checkpoints | ||||
|
r13051 | for checkpoint in self.list_checkpoints(name, path): | ||
|
r13122 | checkpoint_id = checkpoint['id'] | ||
|
r13046 | cp_path = self.get_checkpoint_path(checkpoint_id, name, path) | ||
if os.path.isfile(cp_path): | ||||
self.log.debug("Unlinking checkpoint %s", cp_path) | ||||
os.unlink(cp_path) | ||||
|
r10518 | |||
|
r13052 | self.log.debug("Unlinking notebook %s", os_path) | ||
os.unlink(os_path) | ||||
|
r4484 | |||
|
r13046 | def rename_notebook(self, old_name, old_path, new_name, new_path): | ||
"""Rename a notebook.""" | ||||
|
r13078 | old_path = old_path.strip('/') | ||
new_path = new_path.strip('/') | ||||
|
r13046 | if new_name == old_name and new_path == old_path: | ||
return | ||||
|
r5877 | |||
|
r15420 | new_os_path = self._get_os_path(new_name, new_path) | ||
old_os_path = self._get_os_path(old_name, old_path) | ||||
|
r13046 | |||
# Should we proceed with the move? | ||||
|
r13051 | if os.path.isfile(new_os_path): | ||
|
r13056 | raise web.HTTPError(409, u'Notebook with name already exists: %s' % new_os_path) | ||
|
r13046 | if self.save_script: | ||
|
r13051 | old_py_path = os.path.splitext(old_os_path)[0] + '.py' | ||
new_py_path = os.path.splitext(new_os_path)[0] + '.py' | ||||
if os.path.isfile(new_py_path): | ||||
raise web.HTTPError(409, u'Python script with name already exists: %s' % new_py_path) | ||||
|
r13046 | |||
# Move the notebook file | ||||
try: | ||||
|
r13051 | os.rename(old_os_path, new_os_path) | ||
except Exception as e: | ||||
|
r13072 | raise web.HTTPError(500, u'Unknown error renaming notebook: %s %s' % (old_os_path, e)) | ||
|
r13046 | |||
# Move the checkpoints | ||||
old_checkpoints = self.list_checkpoints(old_name, old_path) | ||||
for cp in old_checkpoints: | ||||
|
r13122 | checkpoint_id = cp['id'] | ||
|
r13056 | old_cp_path = self.get_checkpoint_path(checkpoint_id, old_name, old_path) | ||
new_cp_path = self.get_checkpoint_path(checkpoint_id, new_name, new_path) | ||||
|
r13046 | if os.path.isfile(old_cp_path): | ||
self.log.debug("Renaming checkpoint %s -> %s", old_cp_path, new_cp_path) | ||||
os.rename(old_cp_path, new_cp_path) | ||||
# Move the .py script | ||||
if self.save_script: | ||||
|
r13051 | os.rename(old_py_path, new_py_path) | ||
|
r13046 | |||
|
r10497 | # Checkpoint-related utilities | ||
|
r13078 | def get_checkpoint_path(self, checkpoint_id, name, path=''): | ||
|
r13046 | """find the path to a checkpoint""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13244 | basename, _ = os.path.splitext(name) | ||
|
r10777 | filename = u"{name}-{checkpoint_id}{ext}".format( | ||
|
r13244 | name=basename, | ||
|
r10497 | checkpoint_id=checkpoint_id, | ||
ext=self.filename_ext, | ||||
) | ||||
|
r13046 | cp_path = os.path.join(path, self.checkpoint_dir, filename) | ||
return cp_path | ||||
|
r13078 | def get_checkpoint_model(self, checkpoint_id, name, path=''): | ||
|
r10500 | """construct the info dict for a given checkpoint""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13046 | cp_path = self.get_checkpoint_path(checkpoint_id, name, path) | ||
stats = os.stat(cp_path) | ||||
|
r11145 | last_modified = tz.utcfromtimestamp(stats.st_mtime) | ||
|
r10500 | info = dict( | ||
|
r13122 | id = checkpoint_id, | ||
|
r10500 | last_modified = last_modified, | ||
) | ||||
return info | ||||
|
r10497 | # public checkpoint API | ||
|
r13078 | def create_checkpoint(self, name, path=''): | ||
|
r10497 | """Create a checkpoint from the current state of a notebook""" | ||
|
r13078 | path = path.strip('/') | ||
|
r15420 | nb_path = self._get_os_path(name, path) | ||
|
r10500 | # only the one checkpoint ID: | ||
|
r10777 | checkpoint_id = u"checkpoint" | ||
|
r13046 | cp_path = self.get_checkpoint_path(checkpoint_id, name, path) | ||
self.log.debug("creating checkpoint for notebook %s", name) | ||||
|
r10497 | if not os.path.exists(self.checkpoint_dir): | ||
os.mkdir(self.checkpoint_dir) | ||||
shutil.copy2(nb_path, cp_path) | ||||
|
r10500 | |||
# return the checkpoint info | ||||
|
r13046 | return self.get_checkpoint_model(checkpoint_id, name, path) | ||
|
r10497 | |||
|
r13078 | def list_checkpoints(self, name, path=''): | ||
|
r10497 | """list the checkpoints for a given notebook | ||
|
r10019 | |||
|
r10497 | This notebook manager currently only supports one checkpoint per notebook. | ||
""" | ||||
|
r13078 | path = path.strip('/') | ||
|
r12984 | checkpoint_id = "checkpoint" | ||
|
r13046 | path = self.get_checkpoint_path(checkpoint_id, name, path) | ||
|
r10500 | if not os.path.exists(path): | ||
|
r10497 | return [] | ||
|
r10500 | else: | ||
|
r13046 | return [self.get_checkpoint_model(checkpoint_id, name, path)] | ||
|
r10500 | |||
|
r10497 | |||
|
r13078 | def restore_checkpoint(self, checkpoint_id, name, path=''): | ||
|
r10497 | """restore a notebook to a checkpointed state""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13046 | self.log.info("restoring Notebook %s from checkpoint %s", name, checkpoint_id) | ||
|
r15420 | nb_path = self._get_os_path(name, path) | ||
|
r13046 | cp_path = self.get_checkpoint_path(checkpoint_id, name, path) | ||
|
r10497 | if not os.path.isfile(cp_path): | ||
|
r10500 | self.log.debug("checkpoint file does not exist: %s", cp_path) | ||
|
r10497 | raise web.HTTPError(404, | ||
|
r13046 | u'Notebook checkpoint does not exist: %s-%s' % (name, checkpoint_id) | ||
|
r10497 | ) | ||
# ensure notebook is readable (never restore from an unreadable notebook) | ||||
|
r13112 | with io.open(cp_path, 'r', encoding='utf-8') as f: | ||
|
r13046 | nb = current.read(f, u'json') | ||
|
r10497 | shutil.copy2(cp_path, nb_path) | ||
self.log.debug("copying %s -> %s", cp_path, nb_path) | ||||
|
r13078 | def delete_checkpoint(self, checkpoint_id, name, path=''): | ||
|
r10497 | """delete a notebook's checkpoint""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13046 | cp_path = self.get_checkpoint_path(checkpoint_id, name, path) | ||
if not os.path.isfile(cp_path): | ||||
|
r10497 | raise web.HTTPError(404, | ||
|
r13051 | u'Notebook checkpoint does not exist: %s%s-%s' % (path, name, checkpoint_id) | ||
|
r10497 | ) | ||
|
r13046 | self.log.debug("unlinking %s", cp_path) | ||
os.unlink(cp_path) | ||||
|
r10497 | |||
|
r10019 | def info_string(self): | ||
return "Serving notebooks from local directory: %s" % self.notebook_dir | ||||