|
|
"""Contains writer for writing nbconvert output to filesystem."""
|
|
|
|
|
|
# Copyright (c) IPython Development Team.
|
|
|
# Distributed under the terms of the Modified BSD License.
|
|
|
|
|
|
import io
|
|
|
import os
|
|
|
import glob
|
|
|
|
|
|
from IPython.utils.traitlets import Unicode
|
|
|
from IPython.utils.path import link_or_copy, ensure_dir_exists
|
|
|
from IPython.utils.py3compat import unicode_type
|
|
|
|
|
|
from .base import WriterBase
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Classes
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
class FilesWriter(WriterBase):
|
|
|
"""Consumes nbconvert output and produces files."""
|
|
|
|
|
|
|
|
|
build_directory = Unicode("", config=True,
|
|
|
help="""Directory to write output to. Leave blank
|
|
|
to output to the current directory""")
|
|
|
|
|
|
relpath = Unicode(
|
|
|
"", config=True,
|
|
|
help="""When copying files that the notebook depends on, copy them in
|
|
|
relation to this path, such that the destination filename will be
|
|
|
os.path.relpath(filename, relpath). If FilesWriter is operating on a
|
|
|
notebook that already exists elsewhere on disk, then the default will be
|
|
|
the directory containing that notebook.""")
|
|
|
|
|
|
|
|
|
# Make sure that the output directory exists.
|
|
|
def _build_directory_changed(self, name, old, new):
|
|
|
if new:
|
|
|
ensure_dir_exists(new)
|
|
|
|
|
|
|
|
|
def __init__(self, **kw):
|
|
|
super(FilesWriter, self).__init__(**kw)
|
|
|
self._build_directory_changed('build_directory', self.build_directory,
|
|
|
self.build_directory)
|
|
|
|
|
|
def _makedir(self, path):
|
|
|
"""Make a directory if it doesn't already exist"""
|
|
|
if path:
|
|
|
self.log.info("Making directory %s", path)
|
|
|
ensure_dir_exists(path)
|
|
|
|
|
|
def write(self, output, resources, notebook_name=None, **kw):
|
|
|
"""
|
|
|
Consume and write Jinja output to the file system. Output directory
|
|
|
is set via the 'build_directory' variable of this instance (a
|
|
|
configurable).
|
|
|
|
|
|
See base for more...
|
|
|
"""
|
|
|
|
|
|
# Verify that a notebook name is provided.
|
|
|
if notebook_name is None:
|
|
|
raise TypeError('notebook_name')
|
|
|
|
|
|
# Pull the extension and subdir from the resources dict.
|
|
|
output_extension = resources.get('output_extension', None)
|
|
|
|
|
|
# Get the relative path for copying files
|
|
|
if self.relpath == '':
|
|
|
relpath = resources.get('metadata', {}).get('path', '')
|
|
|
else:
|
|
|
relpath = self.relpath
|
|
|
|
|
|
# Write all of the extracted resources to the destination directory.
|
|
|
# NOTE: WE WRITE EVERYTHING AS-IF IT'S BINARY. THE EXTRACT FIG
|
|
|
# PREPROCESSOR SHOULD HANDLE UNIX/WINDOWS LINE ENDINGS...
|
|
|
for filename, data in resources.get('outputs', {}).items():
|
|
|
|
|
|
# Determine where to write the file to
|
|
|
dest = os.path.join(self.build_directory, filename)
|
|
|
path = os.path.dirname(dest)
|
|
|
self._makedir(path)
|
|
|
|
|
|
# Write file
|
|
|
self.log.debug("Writing %i bytes to support file %s", len(data), dest)
|
|
|
with io.open(dest, 'wb') as f:
|
|
|
f.write(data)
|
|
|
|
|
|
# Copy referenced files to output directory
|
|
|
if self.build_directory:
|
|
|
for filename in self.files:
|
|
|
|
|
|
# Copy files that match search pattern
|
|
|
for matching_filename in glob.glob(filename):
|
|
|
|
|
|
# compute the relative path for the filename
|
|
|
if relpath != '':
|
|
|
dest_filename = os.path.relpath(matching_filename, relpath)
|
|
|
else:
|
|
|
dest_filename = matching_filename
|
|
|
|
|
|
# Make sure folder exists.
|
|
|
dest = os.path.join(self.build_directory, dest_filename)
|
|
|
path = os.path.dirname(dest)
|
|
|
self._makedir(path)
|
|
|
|
|
|
# Copy if destination is different.
|
|
|
if not os.path.normpath(dest) == os.path.normpath(matching_filename):
|
|
|
self.log.info("Linking %s -> %s", matching_filename, dest)
|
|
|
link_or_copy(matching_filename, dest)
|
|
|
|
|
|
# Determine where to write conversion results.
|
|
|
if output_extension is not None:
|
|
|
dest = notebook_name + output_extension
|
|
|
else:
|
|
|
dest = notebook_name
|
|
|
if self.build_directory:
|
|
|
dest = os.path.join(self.build_directory, dest)
|
|
|
|
|
|
# Write conversion results.
|
|
|
self.log.info("Writing %i bytes to %s", len(output), dest)
|
|
|
if isinstance(output, unicode_type):
|
|
|
with io.open(dest, 'w', encoding='utf-8') as f:
|
|
|
f.write(output)
|
|
|
else:
|
|
|
with io.open(dest, 'wb') as f:
|
|
|
f.write(output)
|
|
|
|
|
|
return dest
|
|
|
|
