allow passing kwargs to sftp client

Author: ttomasz

sshfs/pools/base.py

@@ -38,6 +38,8 @@ def __init__(
         self.unsafe_terminate = unsafe_terminate
         self._stack = AsyncExitStack()
 
+        self.other_init_params = kwargs or {}
+
     async def _maybe_new_channel(self):
         # If there is no hard limit or the limit is not hit yet
         # try to create a new channel
@@ -47,7 +49,7 @@ async def _maybe_new_channel(self):
         ):
             try:
                 return await self._stack.enter_async_context(
-                    self.client.start_sftp_client()
+                    self.client.start_sftp_client(**self.other_init_params)
                 )
             except ChannelOpenError:
                 # If we can't create any more channels, then change

sshfs/spec.py

@@ -45,7 +45,9 @@ def __init__(
             SSH host to connect.
         **kwargs: Any
             Any option that will be passed to either the top level
-            `AsyncFileSystem` or the `asyncssh.connect`.
+            `AsyncFileSystem` (e.g. timeout)
+            or `asyncssh.SSHClientConnection.start_sftp_client` (e.g. env, send_env, path_encoding, path_errors, sftp_version)
+            or the `asyncssh.connect`.
         pool_type: sshfs.pools.base.BaseSFTPChannelPool
             Pool manager to use (when doing concurrent operations together,
             pool managers offer the flexibility of prioritizing channels
@@ -54,6 +56,17 @@ def __init__(
 
         super().__init__(self, **kwargs)
 
+        _sftp_client_args = {
+            k: kwargs.pop(k) for k in kwargs.copy().keys()
+            if k in {
+                "env",
+                "send_env",
+                "path_encoding",
+                "path_errors",
+                "sftp_version",
+            }
+        }
+        _timeout = kwargs.pop("timeout", None)
         max_sessions = kwargs.pop("max_sessions", _DEFAULT_MAX_SESSIONS)
         if max_sessions <= _SHELL_CHANNELS:
             raise ValueError(
@@ -68,7 +81,9 @@ def __init__(
             host,
             pool_type,
             max_sftp_channels=max_sessions - _SHELL_CHANNELS,
-            **_client_args,
+            timeout=_timeout,  # goes to sync_wrapper
+            connect_args=_client_args,  # for asyncssh.connect
+            sftp_client_args=_sftp_client_args,  # for asyncssh.SSHClientConnection.start_sftp_client
         )
         weakref.finalize(
             self, sync, self.loop, self._finalize, self._pool, self._stack
@@ -89,13 +104,13 @@ def _get_kwargs_from_urls(urlpath):
 
     @wrap_exceptions
     async def _connect(
-        self, host, pool_type, max_sftp_channels, **client_args
+        self, host, pool_type, max_sftp_channels, connect_args, sftp_client_args
     ):
         self._client_lock = asyncio.Semaphore(_SHELL_CHANNELS)
 
-        _raw_client = asyncssh.connect(host, **client_args)
+        _raw_client = asyncssh.connect(host, **connect_args)
         client = await self._stack.enter_async_context(_raw_client)
-        pool = pool_type(client, max_channels=max_sftp_channels)
+        pool = pool_type(client, max_channels=max_sftp_channels, **sftp_client_args)
         return client, pool
 
     connect = sync_wrapper(_connect)