Simplify implementation of TemporaryWorkingDirectory.

Closes gh-5160

IPython/nbconvert/tests/base.py

@@ -1,164 +1,164 b''
 """
 Contains base test class for nbconvert
 """
 #-----------------------------------------------------------------------------
 #Copyright (c) 2013, the IPython Development Team.
 #
 #Distributed under the terms of the Modified BSD License.
 #
 #The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import io
 import os
 import glob
 import shutil
 import unittest
 
 import IPython
 from IPython.nbformat import current
 from IPython.utils.tempdir import TemporaryWorkingDirectory
 from IPython.utils.path import get_ipython_package_dir
 from IPython.utils.process import get_output_error_code
 from IPython.testing.tools import get_ipython_cmd
 
 # a trailing space allows for simpler concatenation with the other arguments
 ipy_cmd = get_ipython_cmd(as_string=True) + " "
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 
 class TestsBase(unittest.TestCase):
     """Base tests class.  Contains useful fuzzy comparison and nbconvert
     functions."""
 
 
     def fuzzy_compare(self, a, b, newlines_are_spaces=True, tabs_are_spaces=True, 
                       fuzzy_spacing=True, ignore_spaces=False, 
                       ignore_newlines=False, case_sensitive=False, leave_padding=False):
         """
         Performs a fuzzy comparison of two strings.  A fuzzy comparison is a
         comparison that ignores insignificant differences in the two comparands.
         The significance of certain differences can be specified via the keyword
         parameters of this method.
         """
 
         if not leave_padding:
             a = a.strip()
             b = b.strip()
 
         if ignore_newlines:
             a = a.replace('\n', '')
             b = b.replace('\n', '')
 
         if newlines_are_spaces:
             a = a.replace('\n', ' ')
             b = b.replace('\n', ' ')
 
         if tabs_are_spaces:
             a = a.replace('\t', ' ')
             b = b.replace('\t', ' ')
 
         if ignore_spaces:
             a = a.replace(' ', '')
             b = b.replace(' ', '')
 
         if fuzzy_spacing:
             a = self.recursive_replace(a, '  ', ' ')
             b = self.recursive_replace(b, '  ', ' ')
 
         if not case_sensitive:
             a = a.lower()
             b = b.lower()
 
         self.assertEqual(a, b)
 
 
     def recursive_replace(self, text, search, replacement):
         """
         Performs a recursive replacement operation.  Replaces all instances
         of a search string in a text string with a replacement string until
         the search string no longer exists.  Recursion is needed because the
         replacement string may generate additional search strings.
 
         For example:
            Replace "ii" with "i" in the string "Hiiii" yields "Hii"
            Another replacement cds "Hi" (the desired output)
 
         Parameters
         ----------
         text : string
             Text to replace in.
         search : string
             String to search for within "text"
         replacement : string
             String to replace "search" with
         """
         while search in text:
             text = text.replace(search, replacement)
         return text
 
     def create_temp_cwd(self, copy_filenames=None):
         temp_dir = TemporaryWorkingDirectory()
 
         #Copy the files if requested.
         if copy_filenames is not None:
-            self.copy_files_to(copy_filenames)
+            self.copy_files_to(copy_filenames, dest=temp_dir.name)
 
         #Return directory handler
         return temp_dir
     
     def create_empty_notebook(self, path):
         nb = current.new_notebook()
         nb.worksheets.append(current.new_worksheet())
         with io.open(path, 'w', encoding='utf-8') as f:
             current.write(nb, f, 'json')
 
 
     def copy_files_to(self, copy_filenames, dest='.'):
         "Copy test files into the destination directory"
         if not os.path.isdir(dest):
             os.makedirs(dest)
         files_path = self._get_files_path()
         for pattern in copy_filenames:
             for match in glob.glob(os.path.join(files_path, pattern)):
                 shutil.copyfile(match, os.path.join(dest, os.path.basename(match)))
 
 
     def _get_files_path(self):
 
         #Get the relative path to this module in the IPython directory.
         names = self.__module__.split('.')[1:-1]
         names.append('files')
         
         #Build a path using the IPython directory and the relative path we just
         #found.
         path = get_ipython_package_dir()
         for name in names:
             path = os.path.join(path, name)
         return path
 
 
     def call(self, parameters, ignore_return_code=False):
         """
         Execute a, IPython shell command, listening for both Errors and non-zero
         return codes.
 
         Parameters
         ----------
         parameters : str
             List of parameters to pass to IPython.
         ignore_return_code : optional bool (default False)
             Throw an OSError if the return code 
         """
 
         stdout, stderr, retcode = get_output_error_code(ipy_cmd + parameters)
         if not (retcode == 0 or ignore_return_code):
             raise OSError(stderr)
         return stdout, stderr

IPython/utils/tempdir.py

@@ -1,151 +1,145 b''
 """TemporaryDirectory class, copied from Python 3.2.
 
 This is copied from the stdlib and will be standard in Python 3.2 and onwards.
 """
 from __future__ import print_function
 
 import os as _os
 import warnings as _warnings
 import sys as _sys
 
 # This code should only be used in Python versions < 3.2, since after that we
 # can rely on the stdlib itself.
 try:
     from tempfile import TemporaryDirectory
 
 except ImportError:
     from tempfile import mkdtemp, template
 
     class TemporaryDirectory(object):
         """Create and return a temporary directory.  This has the same
         behavior as mkdtemp but can be used as a context manager.  For
         example:
 
             with TemporaryDirectory() as tmpdir:
                 ...
 
         Upon exiting the context, the directory and everthing contained
         in it are removed.
         """
 
         def __init__(self, suffix="", prefix=template, dir=None):
             self.name = mkdtemp(suffix, prefix, dir)
             self._closed = False
 
         def __enter__(self):
             return self.name
 
         def cleanup(self, _warn=False):
             if self.name and not self._closed:
                 try:
                     self._rmtree(self.name)
                 except (TypeError, AttributeError) as ex:
                     # Issue #10188: Emit a warning on stderr
                     # if the directory could not be cleaned
                     # up due to missing globals
                     if "None" not in str(ex):
                         raise
                     print("ERROR: {!r} while cleaning up {!r}".format(ex, self,),
                           file=_sys.stderr)
                     return
                 self._closed = True
                 if _warn:
                     self._warn("Implicitly cleaning up {!r}".format(self),
                                Warning)
 
         def __exit__(self, exc, value, tb):
             self.cleanup()
 
         def __del__(self):
             # Issue a ResourceWarning if implicit cleanup needed
             self.cleanup(_warn=True)
 
 
         # XXX (ncoghlan): The following code attempts to make
         # this class tolerant of the module nulling out process
         # that happens during CPython interpreter shutdown
         # Alas, it doesn't actually manage it. See issue #10188
         _listdir = staticmethod(_os.listdir)
         _path_join = staticmethod(_os.path.join)
         _isdir = staticmethod(_os.path.isdir)
         _remove = staticmethod(_os.remove)
         _rmdir = staticmethod(_os.rmdir)
         _os_error = _os.error
         _warn = _warnings.warn
 
         def _rmtree(self, path):
             # Essentially a stripped down version of shutil.rmtree.  We can't
             # use globals because they may be None'ed out at shutdown.
             for name in self._listdir(path):
                 fullname = self._path_join(path, name)
                 try:
                     isdir = self._isdir(fullname)
                 except self._os_error:
                     isdir = False
                 if isdir:
                     self._rmtree(fullname)
                 else:
                     try:
                         self._remove(fullname)
                     except self._os_error:
                         pass
             try:
                 self._rmdir(path)
             except self._os_error:
                 pass
 
 
 class NamedFileInTemporaryDirectory(object):
 
     def __init__(self, filename, mode='w+b', bufsize=-1, **kwds):
         """
         Open a file named `filename` in a temporary directory.
 
         This context manager is preferred over `NamedTemporaryFile` in
         stdlib `tempfile` when one needs to reopen the file.
 
         Arguments `mode` and `bufsize` are passed to `open`.
         Rest of the arguments are passed to `TemporaryDirectory`.
 
         """
         self._tmpdir = TemporaryDirectory(**kwds)
         path = _os.path.join(self._tmpdir.name, filename)
         self.file = open(path, mode, bufsize)
 
     def cleanup(self):
         self.file.close()
         self._tmpdir.cleanup()
 
     __del__ = cleanup
 
     def __enter__(self):
         return self.file
 
     def __exit__(self, type, value, traceback):
         self.cleanup()
 
 
 class TemporaryWorkingDirectory(TemporaryDirectory):
     """
     Creates a temporary directory and sets the cwd to that directory.
     Automatically reverts to previous cwd upon cleanup.
     Usage example:
 
-        with TemporaryWorakingDirectory() as tmpdir:
+        with TemporaryWorkingDirectory() as tmpdir:
             ...
     """
-
-    def __init__(self, **kw):
-        super(TemporaryWorkingDirectory, self).__init__(**kw)
-
-        #Change cwd to new temp dir.  Remember old cwd.
+    def __enter__(self):
         self.old_wd = _os.getcwd()
         _os.chdir(self.name)
+        return super(TemporaryWorkingDirectory, self).__enter__()
 
-
-    def cleanup(self, _warn=False):
-        #Revert to old cwd.
+    def __exit__(self, exc, value, tb):
         _os.chdir(self.old_wd)
+        return super(TemporaryWorkingDirectory, self).__exit__(exc, value, tb)
 
-        #Cleanup
-        super(TemporaryWorkingDirectory, self).cleanup(_warn=_warn)