Fix type annotation and docs of temp_fs parameter of archive FS

Author: althonos

fs/tarfs.py

@@ -66,10 +66,10 @@ def _get_member_info(member, encoding):
 class TarFS(WrapFS):
     """Read and write tar files.
 
-    There are two ways to open a TarFS for the use cases of reading
+    There are two ways to open a `TarFS` for the use cases of reading
     a tar file, and creating a new one.
 
-    If you open the TarFS with  ``write`` set to `False` (the
+    If you open the `TarFS` with  ``write`` set to `False` (the
     default), then the filesystem will be a read only filesystem which
     maps to the files and directories within the tar file. Files are
     decompressed on the fly when you open them.
@@ -79,9 +79,9 @@ class TarFS(WrapFS):
         with TarFS('foo.tar.gz') as tar_fs:
             readme = tar_fs.readtext('readme.txt')
 
-    If you open the TarFS with ``write`` set to `True`, then the TarFS
+    If you open the TarFS with ``write`` set to `True`, then the `TarFS`
     will be a empty temporary filesystem. Any files / directories you
-    create in the TarFS will be written in to a tar file when the TarFS
+    create in the `TarFS` will be written in to a tar file when the `TarFS`
     is closed. The compression is set from the new file name but may be
     set manually with the ``compression`` argument.
 
@@ -100,8 +100,9 @@ class TarFS(WrapFS):
             use default (`False`) to read an existing tar file.
         compression (str, optional): Compression to use (one of the formats
             supported by `tarfile`: ``xz``, ``gz``, ``bz2``, or `None`).
-        temp_fs (str): An FS URL for the temporary filesystem
-            used to store data prior to tarring.
+        temp_fs (str): An FS URL or an FS instance to use to store
+            data prior to tarring. Defaults to creating a new
+            `~fs.tempfs.TempFS`.
 
     """
 
@@ -118,7 +119,7 @@ def __new__(  # type: ignore
         write=False,  # type: bool
         compression=None,  # type: Optional[Text]
         encoding="utf-8",  # type: Text
-        temp_fs="temp://__tartemp__",  # type: Text
+        temp_fs="temp://__tartemp__",  # type: Union[Text, FS]
     ):
         # type: (...) -> FS
         if isinstance(file, (six.text_type, six.binary_type)):
@@ -164,7 +165,7 @@ def __init__(
         file,  # type: Union[Text, BinaryIO]
         compression=None,  # type: Optional[Text]
         encoding="utf-8",  # type: Text
-        temp_fs="temp://__tartemp__",  # type: Text
+        temp_fs="temp://__tartemp__",  # type: Union[Text, FS]
     ):  # noqa: D107
         # type: (...) -> None
         self._file = file  # type: Union[Text, BinaryIO]

fs/zipfs.py

@@ -124,11 +124,11 @@ def tell(self):
 class ZipFS(WrapFS):
     """Read and write zip files.
 
-    There are two ways to open a ZipFS for the use cases of reading
+    There are two ways to open a `ZipFS` for the use cases of reading
     a zip file, and creating a new one.
 
-    If you open the ZipFS with  ``write`` set to `False` (the default)
-    then the filesystem will be a read only filesystem which maps to
+    If you open the `ZipFS` with  ``write`` set to `False` (the default)
+    then the filesystem will be a read-only filesystem which maps to
     the files and directories within the zip file. Files are
     decompressed on the fly when you open them.
 
@@ -137,12 +137,12 @@ class ZipFS(WrapFS):
         with ZipFS('foo.zip') as zip_fs:
             readme = zip_fs.readtext('readme.txt')
 
-    If you open the ZipFS with ``write`` set to `True`, then the ZipFS
-    will be a empty temporary filesystem. Any files / directories you
-    create in the ZipFS will be written in to a zip file when the ZipFS
+    If you open the `ZipFS` with ``write`` set to `True`, then the `ZipFS`
+    will be an empty temporary filesystem. Any files / directories you
+    create in the `ZipFS` will be written in to a zip file when the `ZipFS`
     is closed.
 
-    Here's how you might write a new zip file containing a readme.txt
+    Here's how you might write a new zip file containing a ``readme.txt``
     file::
 
         with ZipFS('foo.zip', write=True) as new_zip:
@@ -158,8 +158,9 @@ class ZipFS(WrapFS):
             (default) to read an existing zip file.
         compression (int): Compression to use (one of the constants
             defined in the `zipfile` module in the stdlib).
-        temp_fs (str): An FS URL for the temporary filesystem used to
-            store data prior to zipping.
+        temp_fs (str or FS): An FS URL or an FS instance to use to
+            store data prior to zipping. Defaults to creating a new
+            `~fs.tempfs.TempFS`.
 
     """
 
@@ -170,7 +171,7 @@ def __new__(  # type: ignore
         write=False,  # type: bool
         compression=zipfile.ZIP_DEFLATED,  # type: int
         encoding="utf-8",  # type: Text
-        temp_fs="temp://__ziptemp__",  # type: Text
+        temp_fs="temp://__ziptemp__",  # type: Union[Text, FS]
     ):
         # type: (...) -> FS
         # This magic returns a different class instance based on the
@@ -205,7 +206,7 @@ def __init__(
         file,  # type: Union[Text, BinaryIO]
         compression=zipfile.ZIP_DEFLATED,  # type: int
         encoding="utf-8",  # type: Text
-        temp_fs="temp://__ziptemp__",  # type: Text
+        temp_fs="temp://__ziptemp__",  # type: Union[Text, FS]
     ):  # noqa: D107
         # type: (...) -> None
         self._file = file