nbmanager.py
235 lines
| 8.2 KiB
| text/x-python
|
PythonLexer
|
r8180 | """A base class notebook manager. | ||
Authors: | ||||
* Brian Granger | ||||
|
r13046 | * Zach Sailer | ||
|
r8180 | """ | ||
#----------------------------------------------------------------------------- | ||||
# Copyright (C) 2011 The IPython Development Team | ||||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
#----------------------------------------------------------------------------- | ||||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
|
r8181 | import os | ||
|
r8180 | |||
from IPython.config.configurable import LoggingConfigurable | ||||
|
r14857 | from IPython.nbformat import current, sign | ||
|
r13447 | from IPython.utils import py3compat | ||
|
r14857 | from IPython.utils.traitlets import Instance, Unicode, TraitError | ||
|
r8180 | |||
#----------------------------------------------------------------------------- | ||||
# Classes | ||||
#----------------------------------------------------------------------------- | ||||
|
r8194 | class NotebookManager(LoggingConfigurable): | ||
|
r8180 | |||
|
r8181 | # Todo: | ||
# The notebook_dir attribute is used to mean a couple of different things: | ||||
# 1. Where the notebooks are stored if FileNotebookManager is used. | ||||
# 2. The cwd of the kernel for a project. | ||||
# Right now we use this attribute in a number of different places and | ||||
|
r10497 | # we are going to have to disentangle all of this. | ||
|
r13447 | notebook_dir = Unicode(py3compat.getcwd(), config=True, help=""" | ||
|
r12984 | The directory to use for notebooks. | ||
""") | ||||
|
r13026 | |||
|
r13046 | filename_ext = Unicode(u'.ipynb') | ||
|
r13067 | |||
|
r14857 | notary = Instance(sign.NotebookNotary) | ||
def _notary_default(self): | ||||
return sign.NotebookNotary(parent=self) | ||||
|
r14856 | |||
|
r14907 | def check_and_sign(self, nb, path, name): | ||
"""Check for trusted cells, and sign the notebook. | ||||
Called as a part of saving notebooks. | ||||
""" | ||||
if self.notary.check_cells(nb): | ||||
self.notary.sign(nb) | ||||
else: | ||||
self.log.warn("Saving untrusted notebook %s/%s", path, name) | ||||
def mark_trusted_cells(self, nb, path, name): | ||||
"""Mark cells as trusted if the notebook signature matches. | ||||
Called as a part of loading notebooks. | ||||
""" | ||||
trusted = self.notary.check_signature(nb) | ||||
if not trusted: | ||||
self.log.warn("Notebook %s/%s is not trusted", path, name) | ||||
self.notary.mark_cells(nb, trusted) | ||||
|
r13067 | def path_exists(self, path): | ||
"""Does the API-style path (directory) actually exist? | ||||
|
r13070 | Override this method in subclasses. | ||
|
r13067 | |||
|
r13026 | Parameters | ||
---------- | ||||
|
r13067 | path : string | ||
The | ||||
|
r13026 | Returns | ||
------- | ||||
|
r13067 | exists : bool | ||
Whether the path does indeed exist. | ||||
|
r13026 | """ | ||
|
r13070 | raise NotImplementedError | ||
|
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. | ||||
""" | ||||
raise NotImplementedError | ||||
|
r13046 | def _notebook_dir_changed(self, name, old, new): | ||
"""Do a bit of validation of the notebook dir.""" | ||||
|
r8453 | if not os.path.isabs(new): | ||
# If we receive a non-absolute path, make it absolute. | ||||
|
r13066 | self.notebook_dir = os.path.abspath(new) | ||
|
r8453 | return | ||
|
r8181 | if os.path.exists(new) and not os.path.isdir(new): | ||
raise TraitError("notebook dir %r is not a directory" % new) | ||||
if not os.path.exists(new): | ||||
self.log.info("Creating notebook dir %s", new) | ||||
try: | ||||
os.mkdir(new) | ||||
except: | ||||
raise TraitError("Couldn't create notebook dir %r" % new) | ||||
|
r8180 | |||
|
r13046 | # Main notebook API | ||
|
r8180 | |||
|
r13067 | def increment_filename(self, basename, path=''): | ||
|
r13046 | """Increment a notebook filename without the .ipynb to make it unique. | ||
Parameters | ||||
---------- | ||||
basename : unicode | ||||
The name of a notebook without the ``.ipynb`` file extension. | ||||
path : unicode | ||||
The URL path of the notebooks directory | ||||
|
r8180 | """ | ||
|
r13046 | return basename | ||
|
r8180 | |||
|
r15093 | # TODO: Remove this after we create the contents web service and directories are | ||
# no longer listed by the notebook web service. | ||||
def list_dirs(self, path): | ||||
"""List the directory models for a given API style path.""" | ||||
raise NotImplementedError('must be implemented in a subclass') | ||||
# TODO: Remove this after we create the contents web service and directories are | ||||
# no longer listed by the notebook web service. | ||||
def get_dir_model(self, name, path=''): | ||||
"""Get the directory model given a directory name and its API style path. | ||||
The keys in the model should be: | ||||
* name | ||||
* path | ||||
* last_modified | ||||
* created | ||||
* type='directory' | ||||
""" | ||||
raise NotImplementedError('must be implemented in a subclass') | ||||
|
r13074 | def list_notebooks(self, path=''): | ||
|
r13046 | """Return a list of notebook dicts without content. | ||
|
r8180 | |||
This returns a list of dicts, each of the form:: | ||||
dict(notebook_id=notebook,name=name) | ||||
This list of dicts should be sorted by name:: | ||||
data = sorted(data, key=lambda item: item['name']) | ||||
""" | ||||
raise NotImplementedError('must be implemented in a subclass') | ||||
|
r13067 | def get_notebook_model(self, name, path='', content=True): | ||
|
r13046 | """Get the notebook model with or without content.""" | ||
|
r8180 | raise NotImplementedError('must be implemented in a subclass') | ||
|
r13067 | def save_notebook_model(self, model, name, path=''): | ||
|
r13046 | """Save the notebook model and return the model with no content.""" | ||
raise NotImplementedError('must be implemented in a subclass') | ||||
|
r8180 | |||
|
r13067 | def update_notebook_model(self, model, name, path=''): | ||
|
r13046 | """Update the notebook model and return the model with no content.""" | ||
|
r8180 | raise NotImplementedError('must be implemented in a subclass') | ||
|
r13074 | def delete_notebook_model(self, name, path=''): | ||
|
r13046 | """Delete notebook by name and path.""" | ||
|
r8180 | raise NotImplementedError('must be implemented in a subclass') | ||
|
r13067 | def create_notebook_model(self, model=None, path=''): | ||
|
r13245 | """Create a new notebook and return its model with no content.""" | ||
|
r13078 | path = path.strip('/') | ||
|
r13046 | if model is None: | ||
model = {} | ||||
|
r13074 | if 'content' not in model: | ||
|
r13046 | metadata = current.new_metadata(name=u'') | ||
|
r13074 | model['content'] = current.new_notebook(metadata=metadata) | ||
if 'name' not in model: | ||||
model['name'] = self.increment_filename('Untitled', path) | ||||
model['path'] = path | ||||
model = self.save_notebook_model(model, model['name'], model['path']) | ||||
|
r13046 | return model | ||
|
r8180 | |||
|
r13123 | def copy_notebook(self, from_name, to_name=None, path=''): | ||
"""Copy an existing notebook and return its new model. | ||||
If to_name not specified, increment `from_name-Copy#.ipynb`. | ||||
""" | ||||
|
r13078 | path = path.strip('/') | ||
|
r13123 | model = self.get_notebook_model(from_name, path) | ||
if not to_name: | ||||
base = os.path.splitext(from_name)[0] + '-Copy' | ||||
to_name = self.increment_filename(base, path) | ||||
model['name'] = to_name | ||||
model = self.save_notebook_model(model, to_name, path) | ||||
|
r13046 | return model | ||
|
r10497 | |||
# Checkpoint-related | ||||
|
r13074 | def create_checkpoint(self, name, path=''): | ||
|
r10497 | """Create a checkpoint of the current state of a notebook | ||
Returns a checkpoint_id for the new checkpoint. | ||||
""" | ||||
raise NotImplementedError("must be implemented in a subclass") | ||||
|
r13074 | def list_checkpoints(self, name, path=''): | ||
|
r10497 | """Return a list of checkpoints for a given notebook""" | ||
return [] | ||||
|
r13074 | def restore_checkpoint(self, checkpoint_id, name, path=''): | ||
|
r10497 | """Restore a notebook from one of its checkpoints""" | ||
raise NotImplementedError("must be implemented in a subclass") | ||||
|
r8181 | |||
|
r13074 | def delete_checkpoint(self, checkpoint_id, name, path=''): | ||
|
r10497 | """delete a checkpoint for a notebook""" | ||
raise NotImplementedError("must be implemented in a subclass") | ||||
|
r8181 | def log_info(self): | ||
|
r10019 | self.log.info(self.info_string()) | ||
def info_string(self): | ||||
|
r13051 | return "Serving notebooks" | ||