### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# Module: `html.services.notebooks.filenbmanager`

A notebook manager that uses the local file system for storage.

Authors:

- Brian Granger

## 1 Class

class `IPython.html.services.notebooks.filenbmanager.``FileNotebookManager`(**kwargs)

  Bases: `IPython.html.services.notebooks.nbmanager.NotebookManager`

  `create_checkpoint`(notebook_id)

    Create a checkpoint from the current state of a notebook

  `delete_checkpoint`(notebook_id, checkpoint_id)

    delete a notebook’s checkpoint

  `delete_notebook`(notebook_id)

    Delete notebook by notebook_id.

  `delete_notebook_id`(notebook_id)

    Delete a notebook’s id in the mapping.

  `get_checkpoint_info`(notebook_id, checkpoint_id)

    construct the info dict for a given checkpoint

  `get_checkpoint_path`(notebook_id, checkpoint_id)

    find the path to a checkpoint

  `get_checkpoint_path_by_name`(name, checkpoint_id)

    Return a full path to a notebook checkpoint, given its name and checkpoint id.

  `get_name`(notebook_id)

    get a notebook name, raising 404 if not found

  `get_notebook_names`()

    List all notebook names in the notebook dir.

  `get_path`(notebook_id)

    Return a full path to a notebook given its notebook_id.

  `get_path_by_name`(name)

    Return a full path to a notebook given its name.

  `increment_filename`(basename)

    Return a non-used filename of the form basename<int>.

    This searches through the filenames (basename0, basename1, ...) until is find one that is not already being used. It is used to create Untitled and Copy names that are unique.

  `list_checkpoints`(notebook_id)

    list the checkpoints for a given notebook

    This notebook manager currently only supports one checkpoint per notebook.

  `list_notebooks`()

    List all notebooks in the notebook dir.

  `new_notebook_id`(name)

    Generate a new notebook_id for a name and store its mappings.

  `notebook_exists`(notebook_id)

    Does a notebook exist?

  `read_notebook_object`(notebook_id)

    Get the Notebook representation of a notebook by notebook_id.

  `read_notebook_object_from_path`(path)

    read a notebook object from a path

  `restore_checkpoint`(notebook_id, checkpoint_id)

    restore a notebook to a checkpointed state

  `write_notebook_object`(nb, notebook_id=None)

    Save an existing notebook object by notebook_id.

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »