Typing (#194)

* typing fixes

* typing fixes

* readme fix

* explicit check for permissions

Author: willmcgugan

README.md

@@ -82,6 +82,7 @@ def count_py_loc(path):
             if name.endswith('.py'):
                 with open(os.path.join(root, name), 'rt') as python_file:
                     count += sum(1 for line in python_file if line.strip())
+    return count
 ```
 
 This version is similar to the PyFilesystem code above, but would only

fs/_fscompat.py

@@ -5,7 +5,7 @@
 try:
     from os import fsencode, fsdecode
 except ImportError:
-    from backports.os import fsencode, fsdecode
+    from backports.os import fsencode, fsdecode  # type: ignore
 
 try:
     from os import fspath

fs/_typing.py

@@ -8,14 +8,13 @@
 
 _PY = sys.version_info
 
+from typing import overload  # type: ignore
 
 if _PY.major == 3 and _PY.minor == 5 and _PY.micro in (0, 1):
     def overload(func):  # pragma: no cover
         return func
-else:
-    from typing import overload
 
 try:
     from typing import Text
 except ImportError:  # pragma: no cover
-    Text = six.text_type
+    Text = six.text_type  # type: ignore

fs/compress.py

@@ -90,7 +90,8 @@ def write_zip(src_fs,                            # type: FS
             zip_info = zipfile.ZipInfo(zip_name, zip_time)  # type: ignore
 
             try:
-                zip_info.external_attr = info.permissions.mode << 16
+                if info.permissions is not None:
+                    zip_info.external_attr = info.permissions.mode << 16
             except MissingInfoNamespace:
                 pass
 

fs/ftpfs.py

@@ -16,6 +16,7 @@
 from ftplib import FTP
 from ftplib import error_perm
 from ftplib import error_temp
+from typing import cast
 
 from six import PY2
 from six import text_type
@@ -82,7 +83,7 @@ def ftp_errors(fs, path=None):
                 msg=message
             )
         elif code in ('501', '550'):
-            raise errors.ResourceNotFound(path=path)
+            raise errors.ResourceNotFound(path=cast(str, path))
         raise errors.PermissionDenied(
             msg=message
         )

fs/info.py

@@ -6,6 +6,7 @@
 from __future__ import unicode_literals
 
 import typing
+from typing import cast
 from copy import deepcopy
 
 import six
@@ -15,12 +16,11 @@
 from .errors import MissingInfoNamespace
 from .permissions import Permissions
 from .time import epoch_to_datetime
-from ._typing import overload
+from ._typing import overload, Text
 
 if False:  # typing.TYPE_CHECKING
     from datetime import datetime
-    from typing import Callable, List, Mapping, Optional
-    from ._typing import Text
+    from typing import Any, Callable, List, Mapping, Optional, Union
     RawInfo = Mapping[Text, Mapping[Text, object]]
     ToDatetime = Callable[[int], datetime]
     T = typing.TypeVar("T")
@@ -82,23 +82,18 @@ def _make_datetime(self, t):
         else:
             return None
 
-    @overload
-    def get(self, namespace, key, default=None):  # pragma: no cover
-        # type: (Text, Text, Optional[T]) -> Optional[T]
-        pass
-
     @overload
     def get(self, namespace, key):  # pragma: no cover
-        # type: (Text, Text) -> Optional[T]
+        # type: (Text, Text) -> Any
         pass
 
     @overload
     def get(self, namespace, key, default):  # pragma: no cover
-        # type: (Text, Text, T) -> T
+        # type: (Text, Text, T) -> Union[Any, T]
         pass
 
     def get(self, namespace, key, default=None):
-        # type: (Text, Text, Optional[T]) -> Optional[T]
+        # type: (Text, Text, Optional[Any]) -> Optional[Any]
         """Get a raw info value.
 
         Arguments:
@@ -187,7 +182,7 @@ def name(self):
         # type: () -> Text
         """`str`: the resource name.
         """
-        return self.get('basic', 'name')
+        return cast(Text, self.get('basic', 'name'))
 
     @property
     def suffix(self):
@@ -245,14 +240,14 @@ def is_dir(self):
         # type: () -> bool
         """`bool`: `True` if the resource references a directory.
         """
-        return self.get('basic', 'is_dir')
+        return cast(bool, self.get('basic', 'is_dir'))
 
     @property
     def is_file(self):
         # type: () -> bool
         """`bool`: `True` if the resource references a file.
         """
-        return not self.get('basic', 'is_dir')
+        return not cast(bool, self.get('basic', 'is_dir'))
 
     @property
     def is_link(self):
@@ -381,7 +376,7 @@ def size(self):
 
         """
         self._require_namespace('details')
-        return self.get('details', 'size')
+        return cast(int, self.get('details', 'size'))
 
     @property
     def user(self):

fs/move.py

@@ -16,7 +16,7 @@
 
 
 def move_fs(src_fs, dst_fs, workers=0):
-    # type: (Union[Text, FS], Union[Text, FS]) -> None
+    # type: (Union[Text, FS], Union[Text, FS], int) -> None
     """Move the contents of a filesystem to another filesystem.
 
     Arguments:

fs/tarfs.py

@@ -9,6 +9,7 @@
 import tarfile
 import typing
 from collections import OrderedDict
+from typing import cast, IO
 
 import six
 
@@ -23,6 +24,7 @@
 from .wrapfs import WrapFS
 from .permissions import Permissions
 
+
 if False:  # typing.TYPE_CHECKING
     from tarfile import TarInfo
     from typing import (
@@ -401,7 +403,7 @@ def openbin(self, path, mode="r", buffering=-1, **options):
         if not member.isfile():
             raise errors.FileExpected(path)
 
-        rw = RawWrapper(self._tar.extractfile(member))
+        rw = RawWrapper(cast(IO, self._tar.extractfile(member)))
 
         if six.PY2: # Patch nonexistent file.flush in Python2
             def _flush():