summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2023-06-09 13:39:36 -0400
committerJeff Forcier <jeff@bitprophet.org>2023-06-09 13:41:08 -0400
commit96f4d5a7148283c96d0bef032c757ac9549c9454 (patch)
tree52a5554861ce88b0aa035e93a608d621ffb17ad9
parent6006598f558908a6a114faa60e608bbf355ef4c8 (diff)
Condense new docstring param entries for concurrent SFTP get reqs
Re #2058
-rw-r--r--paramiko/sftp_client.py9
-rw-r--r--paramiko/sftp_file.py18
2 files changed, 9 insertions, 18 deletions
diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py
index 8ebeb85e..d7c28f25 100644
--- a/paramiko/sftp_client.py
+++ b/paramiko/sftp_client.py
@@ -781,12 +781,9 @@ class SFTPClient(BaseSFTP, ClosingContextManager):
:param bool prefetch:
controls whether prefetching is performed (default: True)
:param int max_concurrent_prefetch_requests:
- The maximum number of concurrent read requests to prefetch.
- When this is ``None`` (the default), do not limit the number of
- concurrent prefetch requests. Note: OpenSSH's sftp internally
- imposes a limit of 64 concurrent requests, while Paramiko imposes
- no limit by default; consider setting a limit if a file can be
- successfully received with sftp but hangs with Paramiko.
+ The maximum number of concurrent read requests to prefetch. See
+ `.SFTPClient.get` (its ``max_concurrent_prefetch_requests`` param)
+ for details.
:return: the `number <int>` of bytes written to the opened file object
.. versionadded:: 1.10
diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py
index 86d9a560..94d62747 100644
--- a/paramiko/sftp_file.py
+++ b/paramiko/sftp_file.py
@@ -455,12 +455,9 @@ class SFTPFile(BufferedFile):
workaround, one may call `stat` explicitly and pass its value in
via this parameter.
:param int max_concurrent_requests:
- The maximum number of concurrent read requests to prefetch.
- When this is ``None`` (the default), do not limit the number of
- concurrent prefetch requests. Note: OpenSSH's sftp internally
- imposes a limit of 64 concurrent requests, while Paramiko imposes
- no limit by default; consider setting a limit if a file can be
- successfully received with sftp but hangs with Paramiko.
+ The maximum number of concurrent read requests to prefetch. See
+ `.SFTPClient.get` (its ``max_concurrent_prefetch_requests`` param)
+ for details.
.. versionadded:: 1.5.1
.. versionchanged:: 1.16.0
@@ -493,12 +490,9 @@ class SFTPFile(BufferedFile):
a list of ``(offset, length)`` tuples indicating which sections of
the file to read
:param int max_concurrent_prefetch_requests:
- The maximum number of concurrent read requests to prefetch.
- When this is ``None`` (the default), do not limit the number of
- concurrent prefetch requests. Note: OpenSSH's sftp internally
- imposes a limit of 64 concurrent requests, while Paramiko imposes
- no limit by default; consider setting a limit if a file can be
- successfully received with sftp but hangs with Paramiko.
+ The maximum number of concurrent read requests to prefetch. See
+ `.SFTPClient.get` (its ``max_concurrent_prefetch_requests`` param)
+ for details.
:return: a list of blocks read, in the same order as in ``chunks``
.. versionadded:: 1.5.4