Add some examples showing how to build a TempFS

Author: althonos

fs/tempfs.py

@@ -27,7 +27,31 @@
 
 @six.python_2_unicode_compatible
 class TempFS(OSFS):
-    """A temporary filesystem on the OS."""
+    """A temporary filesystem on the OS.
+
+    Temporary filesystems are created using the `tempfile.mkdtemp`
+    function to obtain a temporary folder in an OS-specific location.
+    You can provide an alternative location with the ``temp_dir``
+    argument of the constructor.
+
+    Examples:
+        Create with the constructor::
+
+            >>> from fs.tempfs import TempFS
+            >>> tmp_fs = TempFS()
+
+        Or via an FS URL::
+
+            >>> import fs
+            >>> tmp_fs = fs.open_fs("temp://")
+
+        Use a specific identifier for the temporary folder to better
+        illustrate its purpose::
+
+            >>> named_tmp_fs = fs.open_fs("temp://local_copy")
+            >>> named_tmp_fs = TempFS(identifier="local_copy")
+
+    """
 
     def __init__(
         self,
@@ -43,7 +67,7 @@ def __init__(
             identifier (str): A string to distinguish the directory within
                 the OS temp location, used as part of the directory name.
             temp_dir (str, optional): An OS path to your temp directory
-                (leave as `None` to auto-detect)
+                (leave as `None` to auto-detect).
             auto_clean (bool): If `True` (the default), the directory
                 contents will be wiped on close.
             ignore_clean_errors (bool): If `True` (the default), any errors

tests/test_doctest.py

@@ -5,7 +5,6 @@
 import importlib
 import os
 import pkgutil
-import sys
 import types
 import warnings
 import tempfile
@@ -50,7 +49,7 @@ def _open_fs(path):
         if parse_result.path is not None:
             home_fs = home_fs.opendir(parse_result.path, factory=ClosingSubFS)
         return home_fs
-    elif parse_result.protocol in {"ftp", "ftps", "mem"}:
+    elif parse_result.protocol in {"ftp", "ftps", "mem", "temp"}:
         return MemoryFS()
     else:
         raise RuntimeError("not allowed in doctests: {}".format(path))