-

cool-RR · cool-RR · commit fda0f090fb55 · 2014-01-05T01:02:26.000+02:00
diff --git a/source_py2/python_toolbox/os_tools.py b/source_py2/python_toolbox/os_tools.py
@@ -6,6 +6,7 @@
 import subprocess
 import sys
 import os.path
+import pathlib
 
 
 def start_file(path):
@@ -24,4 +25,9 @@ def start_file(path):
     else:
         raise NotImplementedError(
             "Your operating system `%s` isn't supported by "
-            "`start_file`." % sys.platform)
+            "`start_file`." % sys.platform)    
+    
+_is_windows = (os.name == 'nt')
+null_path = pathlib.Path('\\Device\\Null') if _is_windows \
+                                                 else pathlib.Path('/dev/null')
+path_type = pathlib.WindowsPath if _is_windows else pathlib.PosixPath
diff --git a/source_py2/python_toolbox/temp_file_tools.py b/source_py2/python_toolbox/temp_file_tools.py
@@ -3,58 +3,80 @@
 
 '''Defines various tools related to temporary files.'''
 
-
 import tempfile
 import shutil
 import os
+import pathlib
 
+from python_toolbox import address_tools
+from python_toolbox import os_tools 
 from python_toolbox.context_management import ContextManager
 
 
-
-class TemporaryFolder(ContextManager):
+class TemporaryFolder(ContextManager, os_tools.path_type):
     '''
     Context manager that creates a temporary folder and deletes it after usage.
     
     After the suite finishes, the temporary folder and all its files and
     subfolders will be deleted.
     
+    The `TemporaryFolder` object is also a `pathlib.Path` object, so all
+    operations that can be done on paths, can be done on it seamlessly.
+    
     Example:
     
-        with TemporaryFolder() as temporary_folder_path:
+        with TemporaryFolder() as temporary_folder:
             
             # We have a temporary folder!
-            assert os.path.isdir(temporary_folder_path)
+            assert temporary_folder.is_dir()
             
             # We can create files in it:
-            open(os.path.join(temporary_folder_path, 'my_file'), 'w')
+            with (temporary_folder / 'my_file').open('w') as my_file:
+                my_file.write('whatever')
             
         # The suite is finished, now it's all cleaned:
-        assert not os.path.exists(temporary_folder_path)
+        assert not temporary_folder.exists()
        
     Use the `suffix` and `prefix` string arguments to dictate a suffix and/or a
     prefix to the temporary folder's name in the filesystem.        
     '''
 
-    def __init__(self, suffix='', prefix=tempfile.template):
-        self.suffix = suffix
-        self.prefix = prefix
+    _was_entered = False
+    
+    def __init__(self, prefix=tempfile.template, suffix=''):
+        self.temporary_folder_prefix = prefix
+        self.temporary_folder_suffix = suffix
         self.path = None
         self._closed = False
+        self.__set_path(str(os_tools.null_path))
+        self._init()
 
         
     def __enter__(self):
         assert not self._closed
-        self.path = tempfile.mkdtemp(suffix=self.suffix, prefix=self.prefix)
-        assert os.path.isdir(self.path)
-        return self.path
+        self.__set_path(
+            tempfile.mkdtemp(prefix=self.temporary_folder_prefix,
+                             suffix=self.temporary_folder_suffix,)
+        )
+        
+        assert self.is_dir()
+        self._was_entered = True
+        return self
 
     
     def __exit__(self, exc_type, exc_value, exc_traceback):
         assert not self._closed
-        shutil.rmtree(self.path)
+        shutil.rmtree(str(self))
         self._closed = True
         
+    def __set_path(self, path):
+        self._drv, self._root, self._parts = self._parse_args((path,))
+        self._str = \
+                  self._format_parsed_parts(self._drv, self._root, self._parts)
     
-    def __str__(self):        
-        return self.path or ''
+        
+    def __repr__(self):
+        return '<%s: %s>' % (
+            address_tools.describe(type(self), shorten=True),
+            str(self) if self._was_entered else '(Not created yet)',
+        )
diff --git a/source_py2/test_python_toolbox/test_temp_file_tools/test_temporary_folder.py b/source_py2/test_python_toolbox/test_temp_file_tools/test_temporary_folder.py
@@ -5,6 +5,7 @@
 
 import tempfile
 import os.path
+import pathlib
 
 import nose.tools
 
@@ -14,25 +15,56 @@
 
 
 def test_basic():
-    '''Test the basic working of `TemporaryFolder`.'''
-    with TemporaryFolder() as tf1path:
-        assert isinstance(tf1path, str)
-        assert os.path.exists(tf1path)
-        assert os.path.isdir(tf1path)
+    with TemporaryFolder() as tf1:
+        assert isinstance(tf1, pathlib.Path)
+        assert tf1.exists()
+        assert tf1.is_dir()
         
         tf2 = TemporaryFolder()
-        with tf2 as tf2path:
-            assert str(tf2) == tf2.path == tf2path
+        with tf2 as tf2:
+            assert isinstance(tf2, pathlib.Path)
+            assert tf2.exists()
+            assert tf2.is_dir()
+            
+        assert not tf2.exists()
+        assert not tf2.is_dir()
+                
+        assert tf1.exists()
+        assert tf1.is_dir()
+        file_path = (tf1 / 'my_file')
+        with file_path.open('w') as my_file:
+            my_file.write(u'Woo hoo!')
+        
+        assert file_path.exists()
+        assert file_path.is_file()
+        
+        with file_path.open('r') as my_file:
+            assert my_file.read() == 'Woo hoo!'
+            
+    assert not tf1.exists()
+    assert not tf1.is_dir()
+    
+    assert not file_path.exists()
+    assert not file_path.is_file()
+    
+
+def test_without_pathlib():
+    with TemporaryFolder() as tf1:
+        assert os.path.exists(str(tf1))
+        assert os.path.isdir(str(tf1))
+        
+        tf2 = TemporaryFolder()
+        with tf2 as tf2:
             assert os.path.exists(str(tf2))
             assert os.path.isdir(str(tf2))
             
         assert not os.path.exists(str(tf2))
-        assert not os.path.isdir(tf2path)
+        assert not os.path.isdir(str(tf2))
                 
-        assert os.path.exists(tf1path)
-        assert os.path.isdir(tf1path)
+        assert os.path.exists(str(tf1))
+        assert os.path.isdir(str(tf1))
         
-        file_path = os.path.join(tf1path, 'my_file')
+        file_path = os.path.join(str(tf1), 'my_file')
         with open(file_path, 'w') as my_file:
             my_file.write('Woo hoo!')
         
@@ -42,10 +74,17 @@ def test_basic():
         with open(file_path, 'r') as my_file:
             assert my_file.read() == 'Woo hoo!'
             
-    assert not os.path.exists(tf1path)
-    assert not os.path.isdir(tf1path)
+    assert not os.path.exists(str(tf1))
+    assert not os.path.isdir(str(tf1))
     
     assert not os.path.exists(file_path)
     assert not os.path.isdir(file_path)
     
 
+
+def test_repr():
+    tf = TemporaryFolder()
+    assert '(Not created yet)' in repr(tf)
+    with tf:
+        assert '(Not created yet)' not in repr(tf)
+        
