Enable timeout in URI (#173)

* Honor `create` option in opener

Ported fix from fs.sshfs

All credit to @althonos

althonos/fs.sshfs@48664f2

* Switch to CreateFailed.catch_all decorator as suggested

* Enable `timeout` in URI

I almost exclusively use the URI syntax for filesystems, and I have at least 2 FTP servers that are occasionally slow to respond.

This allows me to specify a timeout in the URI for those servers.

* Fixed open_ftp* tests and added test

Fixed the open_ftp* tests and added an additional test for the `timeout` parameter

* Renamed test to conform to standard

* Added URL Parameter decode test

Author: geoffjukes

fs/opener/ftpfs.py

@@ -45,7 +45,8 @@ def open_fs(self,
             port=ftp_port,
             user=parse_result.username,
             passwd=parse_result.password,
-            proxy=parse_result.params.get('proxy')
+            proxy=parse_result.params.get('proxy'),
+            timeout=int(parse_result.params.get('timeout', '10'))
         )
         if dir_path:
             if create:

tests/test_opener.py

@@ -102,6 +102,20 @@ def test_parse_params_multiple(self):
         )
         self.assertEqual(expected, parsed)
 
+    def test_parse_params_timeout(self):
+        parsed = opener.parse('ftp://ftp.example.org?timeout=30')
+        expected = ParseResult(
+            'ftp',
+            None,
+            None,
+            'ftp.example.org',
+            {
+                'timeout':'30'
+            },
+            None
+        )
+        self.assertEqual(expected, parsed)
+
     def test_parse_user_password_proxy(self):
         parsed = opener.parse('ftp://user:[email protected]?proxy=ftp.proxy.org')
         expected = ParseResult(
@@ -140,6 +154,20 @@ def test_parse_resource_decode(self):
         )
         self.assertEqual(expected, parsed)
 
+    def test_parse_params_decode(self):
+        parsed = opener.parse('ftp://ftp.example.org?decode=is%20working')
+        expected = ParseResult(
+            'ftp',
+            None,
+            None,
+            'ftp.example.org',
+            {
+                'decode':'is working'
+            },
+            None
+        )
+        self.assertEqual(expected, parsed)
+
 
 class TestRegistry(unittest.TestCase):
 
@@ -309,10 +337,12 @@ def test_user_data_opener(self):
     @mock.patch("fs.ftpfs.FTPFS")
     def test_open_ftp(self, mock_FTPFS):
         open_fs('ftp://foo:[email protected]')
-        mock_FTPFS.assert_called_once_with('ftp.example.org', passwd='bar', port=21, user='foo', proxy=None)
+        mock_FTPFS.assert_called_once_with('ftp.example.org', passwd='bar', port=21, user='foo', proxy=None,
+                                           timeout=10)
 
     @mock.patch("fs.ftpfs.FTPFS")
     def test_open_ftp_proxy(self, mock_FTPFS):
         open_fs('ftp://foo:[email protected]?proxy=ftp.proxy.org')
-        mock_FTPFS.assert_called_once_with('ftp.example.org', passwd='bar', port=21, user='foo', proxy='ftp.proxy.org')
+        mock_FTPFS.assert_called_once_with('ftp.example.org', passwd='bar', port=21, user='foo', proxy='ftp.proxy.org',
+                                           timeout=10)