diff options
| author | Michael Williamson <mike@zwobble.org> | 2013-09-29 17:45:12 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2014-09-07 18:35:52 +0100 |
| commit | e92b82eb8a2a08259f21eb711e8943382e0020f1 (patch) | |
| tree | e156afb04034054d29a8ddafbe005eb808eb7096 | |
| parent | cd07ddbfbb34a2482e90f3b95de97a1584ee8a9f (diff) | |
Document that classes can be used as context managers
| -rw-r--r-- | paramiko/channel.py | 2 | ||||
| -rw-r--r-- | paramiko/sftp_client.py | 2 | ||||
| -rw-r--r-- | paramiko/transport.py | 2 |
3 files changed, 6 insertions, 0 deletions
diff --git a/paramiko/channel.py b/paramiko/channel.py index 144edefd..95116fb7 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -57,6 +57,8 @@ class Channel (ClosingContextManager): flow-controlled independently.) Similarly, if the server isn't reading data you send, calls to `send` may block, unless you set a timeout. This is exactly like a normal network socket, so it shouldn't be too surprising. + + Instances of this class may be used as context managers. """ def __init__(self, chanid): diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index b45ad442..195d1ad5 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -65,6 +65,8 @@ class SFTPClient(BaseSFTP, ClosingContextManager): Used to open an SFTP session across an open SSH `.Transport` and perform remote file operations. + + Instances of this class may be used as context managers. """ def __init__(self, sock): """ diff --git a/paramiko/transport.py b/paramiko/transport.py index eb68211f..a8dae49b 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -84,6 +84,8 @@ class Transport (threading.Thread, ClosingContextManager): `channels <.Channel>`, across the session. Multiple channels can be multiplexed across a single session (and often are, in the case of port forwardings). + + Instances of this class may be used as context managers. """ _PROTO_ID = '2.0' _CLIENT_ID = 'paramiko_%s' % paramiko.__version__ |