From 24635609dc5ab8aff2e7fa3f34c4993cbc424579 Mon Sep 17 00:00:00 2001 From: Olle Lundberg Date: Thu, 23 Jan 2014 11:32:59 +0100 Subject: Epydoc -> Sphinx. --- paramiko/__init__.py | 22 +- paramiko/agent.py | 20 +- paramiko/auth_handler.py | 2 +- paramiko/buffered_pipe.py | 52 ++--- paramiko/channel.py | 418 ++++++++++++++++++------------------ paramiko/client.py | 210 +++++++++--------- paramiko/config.py | 38 ++-- paramiko/dsskey.py | 16 +- paramiko/file.py | 104 ++++----- paramiko/hostkeys.py | 84 ++++---- paramiko/kex_gex.py | 2 +- paramiko/message.py | 98 ++++----- paramiko/packet.py | 20 +- paramiko/pkey.py | 210 +++++++++--------- paramiko/primes.py | 2 +- paramiko/proxy.py | 22 +- paramiko/resource.py | 18 +- paramiko/rsakey.py | 16 +- paramiko/server.py | 514 ++++++++++++++++++++++---------------------- paramiko/sftp_attr.py | 26 +-- paramiko/sftp_client.py | 380 ++++++++++++++++----------------- paramiko/sftp_file.py | 144 ++++++------- paramiko/sftp_handle.py | 80 +++---- paramiko/sftp_server.py | 48 ++--- paramiko/sftp_si.py | 220 +++++++++---------- paramiko/ssh_exception.py | 42 ++-- paramiko/transport.py | 534 +++++++++++++++++++++++----------------------- paramiko/util.py | 42 ++-- sites/docs/api.rst | 8 + sites/docs/conf.py | 3 + 30 files changed, 1703 insertions(+), 1692 deletions(-) create mode 100644 sites/docs/api.rst diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 924e8bb5..c6f555a9 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -17,35 +17,35 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -I{Paramiko} (a combination of the esperanto words for "paranoid" and "friend") +Paramiko (a combination of the esperanto words for "paranoid" and "friend") is a module for python 2.5 or greater that implements the SSH2 protocol for secure (encrypted and authenticated) connections to remote machines. Unlike SSL (aka TLS), the SSH2 protocol does not require hierarchical certificates signed by a powerful central authority. You may know SSH2 as the protocol that -replaced C{telnet} and C{rsh} for secure access to remote shells, but the +replaced ``telnet`` and ``rsh`` for secure access to remote shells, but the protocol also includes the ability to open arbitrary channels to remote -services across an encrypted tunnel. (This is how C{sftp} works, for example.) +services across an encrypted tunnel. (This is how ``sftp`` works, for example.) -The high-level client API starts with creation of an L{SSHClient} object. +The high-level client API starts with creation of an :class:`SSHClient` object. For more direct control, pass a socket (or socket-like object) to a -L{Transport}, and use L{start_server } or -L{start_client } to negoatite +:class:`Transport`, and use :class:`start_server ` or +:class:`start_client ` to negoatite with the remote host as either a server or client. As a client, you are responsible for authenticating using a password or private key, and checking -the server's host key. I{(Key signature and verification is done by paramiko, +the server's host key. (Key signature and verification is done by paramiko, but you will need to provide private keys and check that the content of a -public key matches what you expected to see.)} As a server, you are +public key matches what you expected to see.) As a server, you are responsible for deciding which users, passwords, and keys to allow, and what kind of channels to allow. -Once you have finished, either side may request flow-controlled L{Channel}s to -the other side, which are python objects that act like sockets, but send and +Once you have finished, either side may request flow-controlled :class:`channels ` +to the other side, which are python objects that act like sockets, but send and receive data over the encrypted session. Paramiko is written entirely in python (no C or platform-dependent code) and is released under the GNU Lesser General Public License (LGPL). -Website: U{https://github.com/paramiko/paramiko/} +Website: https://github.com/paramiko/paramiko/ """ import sys diff --git a/paramiko/agent.py b/paramiko/agent.py index 23a5a2e4..a09851bc 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -44,7 +44,7 @@ class AgentSSH(object): """ Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to - connect to it and retreive L{PKey} objects which can be used when + connect to it and retreive :class:`PKey` objects which can be used when attempting to authenticate to remote SSH servers. Because the SSH agent protocol uses environment variables and unix-domain @@ -61,8 +61,8 @@ class AgentSSH(object): no SSH agent was running (or it couldn't be contacted), an empty list will be returned. - @return: a list of keys available on the SSH agent - @rtype: tuple of L{AgentKey} + :return: a list of keys available on the SSH agent + :rtype: tuple of :class:`AgentKey` """ return self._keys @@ -238,9 +238,9 @@ class AgentClientProxy(object): class AgentServerProxy(AgentSSH): """ - @param t : transport used for the Forward for SSH Agent communication + :param t : transport used for the Forward for SSH Agent communication - @raise SSHException: mostly if we lost the agent + :raises SSHException: mostly if we lost the agent """ def __init__(self, t): AgentSSH.__init__(self) @@ -276,8 +276,8 @@ class AgentServerProxy(AgentSSH): """ Helper for the environnement under unix - @return: the SSH_AUTH_SOCK Environnement variables - @rtype: dict + :return: the SSH_AUTH_SOCK Environnement variables + :rtype: dict """ env = {} env['SSH_AUTH_SOCK'] = self._get_filename() @@ -307,7 +307,7 @@ class Agent(AgentSSH): """ Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to - connect to it and retreive L{PKey} objects which can be used when + connect to it and retreive :class:`PKey` objects which can be used when attempting to authenticate to remote SSH servers. Because the SSH agent protocol uses environment variables and unix-domain @@ -318,10 +318,10 @@ class Agent(AgentSSH): def __init__(self): """ Open a session with the local machine's SSH agent, if one is running. - If no agent is running, initialization will succeed, but L{get_keys} + If no agent is running, initialization will succeed, but :class:`get_keys` will return an empty tuple. - @raise SSHException: if an SSH agent is found, but speaks an + :raises SSHException: if an SSH agent is found, but speaks an incompatible protocol """ AgentSSH.__init__(self) diff --git a/paramiko/auth_handler.py b/paramiko/auth_handler.py index acb7c8b8..56bd37d5 100644 --- a/paramiko/auth_handler.py +++ b/paramiko/auth_handler.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{AuthHandler} +:class:`AuthHandler` """ import threading diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index 4ef5cf74..23ed9f44 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -29,7 +29,7 @@ import time class PipeTimeout (IOError): """ - Indicates that a timeout was reached on a read from a L{BufferedPipe}. + Indicates that a timeout was reached on a read from a :class:`BufferedPipe`. """ pass @@ -38,7 +38,7 @@ class BufferedPipe (object): """ A buffer that obeys normal read (with timeout) & close semantics for a file or socket, but is fed data from another thread. This is used by - L{Channel}. + :class:`Channel`. """ def __init__(self): @@ -54,8 +54,8 @@ class BufferedPipe (object): buffer has been closed), the event will be set. When no data is ready, the event will be cleared. - @param event: the event to set/clear - @type event: Event + :param event: the event to set/clear + :type event: Event """ self._event = event if len(self._buffer) > 0: @@ -68,8 +68,8 @@ class BufferedPipe (object): Feed new data into this pipe. This method is assumed to be called from a separate thread, so synchronization is done. - @param data: the data to add - @type data: str + :param data: the data to add + :type data: str """ self._lock.acquire() try: @@ -83,12 +83,12 @@ class BufferedPipe (object): def read_ready(self): """ Returns true if data is buffered and ready to be read from this - feeder. A C{False} result does not mean that the feeder has closed; + feeder. A ``False`` result does not mean that the feeder has closed; it means you may need to wait before more data arrives. - @return: C{True} if a L{read} call would immediately return at least - one byte; C{False} otherwise. - @rtype: bool + :return: ``True`` if a :class:`read` call would immediately return at least + one byte; ``False`` otherwise. + :rtype: bool """ self._lock.acquire() try: @@ -102,23 +102,23 @@ class BufferedPipe (object): """ Read data from the pipe. The return value is a string representing the data received. The maximum amount of data to be received at once - is specified by C{nbytes}. If a string of length zero is returned, + is specified by ``nbytes``. If a string of length zero is returned, the pipe has been closed. - The optional C{timeout} argument can be a nonnegative float expressing - seconds, or C{None} for no timeout. If a float is given, a - C{PipeTimeout} will be raised if the timeout period value has + The optional ``timeout`` argument can be a nonnegative float expressing + seconds, or ``None`` for no timeout. If a float is given, a + ``PipeTimeout`` will be raised if the timeout period value has elapsed before any data arrives. - @param nbytes: maximum number of bytes to read - @type nbytes: int - @param timeout: maximum seconds to wait (or C{None}, the default, to + :param nbytes: maximum number of bytes to read + :type nbytes: int + :param timeout: maximum seconds to wait (or ``None``, the default, to wait forever) - @type timeout: float - @return: data - @rtype: str + :type timeout: float + :return: data + :rtype: str - @raise PipeTimeout: if a timeout was specified and no data was ready + :raises PipeTimeout: if a timeout was specified and no data was ready before that timeout """ out = '' @@ -158,8 +158,8 @@ class BufferedPipe (object): """ Clear out the buffer and return all data that was in it. - @return: any data that was in the buffer prior to clearing it out - @rtype: str + :return: any data that was in the buffer prior to clearing it out + :rtype: str """ self._lock.acquire() try: @@ -173,7 +173,7 @@ class BufferedPipe (object): def close(self): """ - Close this pipe object. Future calls to L{read} after the buffer + Close this pipe object. Future calls to :class:`read` after the buffer has been emptied will return immediately with an empty string. """ self._lock.acquire() @@ -189,8 +189,8 @@ class BufferedPipe (object): """ Return the number of bytes buffered. - @return: number of bytes bufferes - @rtype: int + :return: number of bytes bufferes + :rtype: int """ self._lock.acquire() try: diff --git a/paramiko/channel.py b/paramiko/channel.py index c680e44b..7a430435 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -42,7 +42,7 @@ MIN_PACKET_SIZE = 1024 class Channel (object): """ - A secure tunnel across an SSH L{Transport}. A Channel is meant to behave + A secure tunnel across an SSH :class:`Transport`. A Channel is meant to behave like a socket, and has an API that should be indistinguishable from the python socket API. @@ -51,20 +51,20 @@ class Channel (object): you any more data until you read some of it. (This won't affect other channels on the same transport -- all channels on a single transport are flow-controlled independently.) Similarly, if the server isn't reading - data you send, calls to L{send} may block, unless you set a timeout. This + data you send, calls to :class:`send` may block, unless you set a timeout. This is exactly like a normal network socket, so it shouldn't be too surprising. """ def __init__(self, chanid): """ Create a new channel. The channel is not associated with any - particular session or L{Transport} until the Transport attaches it. + particular session or :class:`Transport` until the Transport attaches it. Normally you would only call this method from the constructor of a - subclass of L{Channel}. + subclass of :class:`Channel`. - @param chanid: the ID of this channel, as passed by an existing - L{Transport}. - @type chanid: int + :param chanid: the ID of this channel, as passed by an existing + :class:`Transport`. + :type chanid: int """ self.chanid = chanid self.remote_chanid = 0 @@ -105,7 +105,7 @@ class Channel (object): """ Return a string representation of this object, for debugging. - @rtype: str + :rtype: str """ out = '' diff --git a/paramiko/client.py b/paramiko/client.py index be896091..19a09c2d 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SSHClient}. +:class:`SSHClient`. """ from binascii import hexlify @@ -40,19 +40,19 @@ from paramiko.util import retry_on_signal class MissingHostKeyPolicy (object): """ - Interface for defining the policy that L{SSHClient} should use when the + Interface for defining the policy that :class:`SSHClient` should use when the SSH server's hostname is not in either the system host keys or the application's keys. Pre-made classes implement policies for automatically - adding the key to the application's L{HostKeys} object (L{AutoAddPolicy}), - and for automatically rejecting the key (L{RejectPolicy}). + adding the key to the application's :class:`HostKeys` object (:class:`AutoAddPolicy`), + and for automatically rejecting the key (:class:`RejectPolicy`). This function may be used to ask the user to verify the key, for example. """ def missing_host_key(self, client, hostname, key): """ - Called when an L{SSHClient} receives a server key for a server that - isn't in either the system or local L{HostKeys} object. To accept + Called when an :class:`SSHClient` receives a server key for a server that + isn't in either the system or local :class:`HostKeys` object. To accept the key, simply return. To reject, raised an exception (which will be passed to the calling application). """ @@ -62,7 +62,7 @@ class MissingHostKeyPolicy (object): class AutoAddPolicy (MissingHostKeyPolicy): """ Policy for automatically adding the hostname and new host key to the - local L{HostKeys} object, and saving it. This is used by L{SSHClient}. + local :class:`HostKeys` object, and saving it. This is used by :class:`SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -76,7 +76,7 @@ class AutoAddPolicy (MissingHostKeyPolicy): class RejectPolicy (MissingHostKeyPolicy): """ Policy for automatically rejecting the unknown hostname & key. This is - used by L{SSHClient}. + used by :class:`SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -88,7 +88,7 @@ class RejectPolicy (MissingHostKeyPolicy): class WarningPolicy (MissingHostKeyPolicy): """ Policy for logging a python-style warning for an unknown host key, but - accepting it. This is used by L{SSHClient}. + accepting it. This is used by :class:`SSHClient`. """ def missing_host_key(self, client, hostname, key): warnings.warn('Unknown %s host key for %s: %s' % @@ -98,7 +98,7 @@ class WarningPolicy (MissingHostKeyPolicy): class SSHClient (object): """ A high-level representation of a session with an SSH server. This class - wraps L{Transport}, L{Channel}, and L{SFTPClient} to take care of most + wraps :class:`Transport`, :class:`Channel`, and :class:`SFTPClient` to take care of most aspects of authenticating and opening channels. A typical use case is:: client = SSHClient() @@ -110,7 +110,7 @@ class SSHClient (object): checking. The default mechanism is to try to use local key files or an SSH agent (if one is running). - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self): @@ -128,21 +128,21 @@ class SSHClient (object): def load_system_host_keys(self, filename=None): """ Load host keys from a system (read-only) file. Host keys read with - this method will not be saved back by L{save_host_keys}. + this method will not be saved back by :class:`save_host_keys`. This method can be called multiple times. Each new set of host keys will be merged with the existing set (new replacing old if there are conflicts). - If C{filename} is left as C{None}, an attempt will be made to read + If ``filename`` is left as ``None``, an attempt will be made to read keys from the user's local "known hosts" file, as used by OpenSSH, and no exception will be raised if the file can't be read. This is probably only useful on posix. - @param filename: the filename to read, or C{None} - @type filename: str + :param filename: the filename to read, or ``None`` + :type filename: str - @raise IOError: if a filename was provided and the file could not be + :raises IOError: if a filename was provided and the file could not be read """ if filename is None: @@ -158,19 +158,19 @@ class SSHClient (object): def load_host_keys(self, filename): """ Load host keys from a local host-key file. Host keys read with this - method will be checked I{after} keys loaded via L{load_system_host_keys}, - but will be saved back by L{save_host_keys} (so they can be modified). - The missing host key policy L{AutoAddPolicy} adds keys to this set and + method will be checked after keys loaded via :class:`load_system_host_keys`, + but will be saved back by :class:`save_host_keys` (so they can be modified). + The missing host key policy :class:`AutoAddPolicy` adds keys to this set and saves them, when connecting to a previously-unknown server. This method can be called multiple times. Each new set of host keys will be merged with the existing set (new replacing old if there are conflicts). When automatically saving, the last hostname is used. - @param filename: the filename to read - @type filename: str + :param filename: the filename to read + :type filename: str - @raise IOError: if the filename could not be read + :raises IOError: if the filename could not be read """ self._host_keys_filename = filename self._host_keys.load(filename) @@ -178,13 +178,13 @@ class SSHClient (object): def save_host_keys(self, filename): """ Save the host keys back to a file. Only the host keys loaded with - L{load_host_keys} (plus any added directly) will be saved -- not any - host keys loaded with L{load_system_host_keys}. + :class:`load_host_keys` (plus any added directly) will be saved -- not any + host keys loaded with :class:`load_system_host_keys`. - @param filename: the filename to save to - @type filename: str + :param filename: the filename to save to + :type filename: str - @raise IOError: if the file could not be written + :raises IOError: if the file could not be written """ # update local host keys from file (in case other SSH clients @@ -200,34 +200,34 @@ class SSHClient (object): def get_host_keys(self): """ - Get the local L{HostKeys} object. This can be used to examine the + Get the local :class:`HostKeys` object. This can be used to examine the local host keys or change them. - @return: the local host keys - @rtype: L{HostKeys} + :return: the local host keys + :rtype: :class:`HostKeys` """ return self._host_keys def set_log_channel(self, name): """ - Set the channel for logging. The default is C{"paramiko.transport"} + Set the channel for logging. The default is ``"paramiko.transport"`` but it can be set to anything you want. - @param name: new channel name for logging - @type name: str + :param name: new channel name for logging + :type name: str """ self._log_channel = name def set_missing_host_key_policy(self, policy): """ Set the policy to use when connecting to a server that doesn't have a - host key in either the system or local L{HostKeys} objects. The - default policy is to reject all unknown servers (using L{RejectPolicy}). - You may substitute L{AutoAddPolicy} or write your own policy class. + host key in either the system or local :class:`HostKeys` objects. The + default policy is to reject all unknown servers (using :class:`RejectPolicy`). + You may substitute :class:`AutoAddPolicy` or write your own policy class. - @param policy: the policy to use when receiving a host key from a + :param policy: the policy to use when receiving a host key from a previously-unknown server - @type policy: L{MissingHostKeyPolicy} + :type policy: :class:`MissingHostKeyPolicy` """ self._policy = policy @@ -236,56 +236,56 @@ class SSHClient (object): compress=False, sock=None): """ Connect to an SSH server and authenticate to it. The server's host key - is checked against the system host keys (see L{load_system_host_keys}) - and any local host keys (L{load_host_keys}). If the server's hostname + is checked against the system host keys (see :class:`load_system_host_keys`) + and any local host keys (:class:`load_host_keys`). If the server's hostname is not found in either set of host keys, the missing host key policy - is used (see L{set_missing_host_key_policy}). The default policy is - to reject the key and raise an L{SSHException}. + is used (see :class:`set_missing_host_key_policy`). The default policy is + to reject the key and raise an :class:`SSHException`. Authentication is attempted in the following order of priority: - - The C{pkey} or C{key_filename} passed in (if any) + - The ``pkey`` or ``key_filename`` passed in (if any) - Any key we can find through an SSH agent - - Any "id_rsa" or "id_dsa" key discoverable in C{~/.ssh/} + - Any "id_rsa" or "id_dsa" key discoverable in ``~/.ssh/`` - Plain username/password auth, if a password was given If a private key requires a password to unlock it, and a password is passed in, that password will be used to attempt to unlock the key. - @param hostname: the server to connect to - @type hostname: str - @param port: the server port to connect to - @type port: int - @param username: the username to authenticate as (defaults to the + :param hostname: the server to connect to + :type hostname: str + :param port: the server port to connect to + :type port: int + :param username: the username to authenticate as (defaults to the current local username) - @type username: str - @param password: a password to use for authentication or for unlocking + :type username: str + :param password: a password to use for authentication or for unlocking a private key - @type password: str - @param pkey: an optional private key to use for authentication - @type pkey: L{PKey} - @param key_filename: the filename, or list of filenames, of optional + :type password: str + :param pkey: an optional private key to use for authentication + :type pkey: :class:`PKey` + :param key_filename: the filename, or list of filenames, of optional private key(s) to try for authentication - @type key_filename: str or list(str) - @param timeout: an optional timeout (in seconds) for the TCP connect - @type timeout: float - @param allow_agent: set to False to disable connecting to the SSH agent - @type allow_agent: bool - @param look_for_keys: set to False to disable searching for discoverable - private key files in C{~/.ssh/} - @type look_for_keys: bool - @param compress: set to True to turn on compression - @type compress: bool - @param sock: an open socket or socket-like object (such as a - L{Channel}) to use for communication to the target host - @type sock: socket - - @raise BadHostKeyException: if the server's host key could not be + :type key_filename: str or list(str) + :param timeout: an optional timeout (in seconds) for the TCP connect + :type timeout: float + :param allow_agent: set to False to disable connecting to the SSH agent + :type allow_agent: bool + :param look_for_keys: set to False to disable searching for discoverable + private key files in ``~/.ssh/`` + :type look_for_keys: bool + :param compress: set to True to turn on compression + :type compress: bool + :param sock: an open socket or socket-like object (such as a + :class:`Channel`) to use for communication to the target host + :type sock: socket + + :raises BadHostKeyException: if the server's host key could not be verified - @raise AuthenticationException: if authentication failed - @raise SSHException: if there was any other error connecting or + :raises AuthenticationException: if authentication failed + :raises SSHException: if there was any other error connecting or establishing an SSH session - @raise socket.error: if a socket error occurred while connecting + :raises socket.error: if a socket error occurred while connecting """ if not sock: for (family, socktype, proto, canonname, sockaddr) in socket.getaddrinfo(hostname, port, socket.AF_UNSPEC, socket.SOCK_STREAM): @@ -343,7 +343,7 @@ class SSHClient (object): def close(self): """ - Close this SSHClient and its underlying L{Transport}. + Close this SSHClient and its underlying :class:`Transport`. """ if self._transport is None: return @@ -356,21 +356,21 @@ class SSHClient (object): def exec_command(self, command, bufsize=-1, timeout=None, get_pty=False): """ - Execute a command on the SSH server. A new L{Channel} is opened and + Execute a command on the SSH server. A new :class:`Channel` is opened and the requested command is executed. The command's input and output - streams are returned as python C{file}-like objects representing + streams are returned as python ``file``-like objects representing stdin, stdout, and stderr. - @param command: the command to execute - @type command: str - @param bufsize: interpreted the same way as by the built-in C{file()} function in python - @type bufsize: int - @param timeout: set command's channel timeout. See L{Channel.settimeout}.settimeout - @type timeout: int - @return: the stdin, stdout, and stderr of the executing command - @rtype: tuple(L{ChannelFile}, L{ChannelFile}, L{ChannelFile}) + :param command: the command to execute + :type command: str + :param bufsize: interpreted the same way as by the built-in ``file()`` function in python + :type bufsize: int + :param timeout: set command's channel timeout. See :class:`Channel.settimeout`.settimeout + :type timeout: int + :return: the stdin, stdout, and stderr of the executing command + :rtype: tuple(:class:`ChannelFile`, :class:`ChannelFile`, :class:`ChannelFile`) - @raise SSHException: if the server fails to execute the command + :raises SSHException: if the server fails to execute the command """ chan = self._transport.open_session() if(get_pty): @@ -385,24 +385,24 @@ class SSHClient (object): def invoke_shell(self, term='vt100', width=80, height=24, width_pixels=0, height_pixels=0): """ - Start an interactive shell session on the SSH server. A new L{Channel} + Start an interactive shell session on the SSH server. A new :class:`Channel` is opened and connected to a pseudo-terminal using the requested terminal type and size. - @param term: the terminal type to emulate (for example, C{"vt100"}) - @type term: str - @param width: the width (in characters) of the terminal window - @type width: int - @param height: the height (in characters) of the terminal window - @type height: int - @param width_pixels: the width (in pixels) of the terminal window - @type width_pixels: int - @param height_pixels: the height (in pixels) of the terminal window - @type height_pixels: int - @return: a new channel connected to the remote shell - @rtype: L{Channel} - - @raise SSHException: if the server fails to invoke a shell + :param term: the terminal type to emulate (for example, ``"vt100"``) + :type term: str + :param width: the width (in characters) of the terminal window + :type width: int + :param height: the height (in characters) of the terminal window + :type height: int + :param width_pixels: the width (in pixels) of the terminal window + :type width_pixels: int + :param height_pixels: the height (in pixels) of the terminal window + :type height_pixels: int + :return: a new channel connected to the remote shell + :rtype: :class:`Channel` + + :raises SSHException: if the server fails to invoke a shell """ chan = self._transport.open_session() chan.get_pty(term, width, height, width_pixels, height_pixels) @@ -413,19 +413,19 @@ class SSHClient (object): """ Open an SFTP session on the SSH server. - @return: a new SFTP session object - @rtype: L{SFTPClient} + :return: a new SFTP session object + :rtype: :class:`SFTPClient` """ return self._transport.open_sftp_client() def get_transport(self): """ - Return the underlying L{Transport} object for this SSH connection. + Return the underlying :class:`Transport` object for this SSH connection. This can be used to perform lower-level tasks, like opening specific kinds of channels. - @return: the Transport for this connection - @rtype: L{Transport} + :return: the Transport for this connection + :rtype: :class:`Transport` """ return self._transport diff --git a/paramiko/config.py b/paramiko/config.py index 1705de76..05f59813 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -18,7 +18,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SSHConfig}. +:class:`SSHConfig`. """ import fnmatch @@ -87,12 +87,12 @@ class LazyFqdn(object): class SSHConfig (object): """ Representation of config information as stored in the format used by - OpenSSH. Queries can be made via L{lookup}. The format is described in - OpenSSH's C{ssh_config} man page. This class is provided primarily as a + OpenSSH. Queries can be made via :class:`lookup`. The format is described in + OpenSSH's ``ssh_config`` man page. This class is provided primarily as a convenience to posix users (since the OpenSSH format is a de-facto standard on posix) but should work fine on Windows too. - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self): @@ -105,8 +105,8 @@ class SSHConfig (object): """ Read an OpenSSH config from the given file object. - @param file_obj: a file-like object to read the config file from - @type file_obj: file + :param file_obj: a file-like object to read the config file from + :type file_obj: file """ host = {"host": ['*'], "config": {}} for line in file_obj: @@ -152,20 +152,20 @@ class SSHConfig (object): """ Return a dict of config options for a given hostname. - The host-matching rules of OpenSSH's C{ssh_config} man page are used, + The host-matching rules of OpenSSH's ``ssh_config`` man page are used, which means that all configuration options from matching host specifications are merged, with more specific hostmasks taking - precedence. In other words, if C{"Port"} is set under C{"Host *"} - and also C{"Host *.example.com"}, and the lookup is for - C{"ssh.example.com"}, then the port entry for C{"Host *.example.com"} + precedence. In other words, if ``"Port"`` is set under ``"Host *"`` + and also ``"Host *.example.com"``, and the lookup is for + ``"ssh.example.com"``, then the port entry for ``"Host *.example.com"`` will win out. The keys in the returned dict are all normalized to lowercase (look for - C{"port"}, not C{"Port"}. The values are processed according to the - rules for substitution variable expansion in C{ssh_config}. + ``"port"``, not ``"Port"``. The values are processed according to the + rules for substitution variable expansion in ``ssh_config``. - @param hostname: the hostname to lookup - @type hostname: str + :param hostname: the hostname to lookup + :type hostname: str """ matches = [config for config in self._config if @@ -199,13 +199,13 @@ class SSHConfig (object): Return a dict of config options with expanded substitutions for a given hostname. - Please refer to man C{ssh_config} for the parameters that + Please refer to man ``ssh_config`` for the parameters that are replaced. - @param config: the config for the hostname - @type hostname: dict - @param hostname: the hostname that the config belongs to - @type hostname: str + :param config: the config for the hostname + :type hostname: dict + :param hostname: the hostname that the config belongs to + :type hostname: str """ if 'hostname' in config: diff --git a/paramiko/dsskey.py b/paramiko/dsskey.py index f6ecb2a7..2d9f6cef 100644 --- a/paramiko/dsskey.py +++ b/paramiko/dsskey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{DSSKey} +:class:`DSSKey` """ from Crypto.PublicKey import DSA @@ -153,13 +153,13 @@ class DSSKey (PKey): Generate a new private DSS key. This factory function can be used to generate a new host key or authentication key. - @param bits: number of bits the generated key should be. - @type bits: int - @param progress_func: an optional function to call at key points in - key generation (used by C{pyCrypto.PublicKey}). - @type progress_func: function - @return: new private key - @rtype: L{DSSKey} + :param bits: number of bits the generated key should be. + :type bits: int + :param progress_func: an optional function to call at key points in + key generation (used by ``pyCrypto.PublicKey``). + :type progress_func: function + :return: new private key + :rtype: :class:`DSSKey` """ dsa = DSA.generate(bits, rng.read, progress_func) key = DSSKey(vals=(dsa.p, dsa.q, dsa.g, dsa.y)) diff --git a/paramiko/file.py b/paramiko/file.py index 5fd81cfe..58d9f8bb 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -67,10 +67,10 @@ class BufferedFile (object): file. This iterator happens to return the file itself, since a file is its own iterator. - @raise ValueError: if the file is closed. + :raises ValueError: if the file is closed. - @return: an interator. - @rtype: iterator + :return: an interator. + :rtype: iterator """ if self._closed: raise ValueError('I/O operation on closed file') @@ -94,14 +94,14 @@ class BufferedFile (object): def next(self): """ - Returns the next line from the input, or raises L{StopIteration} when + Returns the next line from the input, or raises :class:`StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to - C{next} and L{readline}. + ``next`` and :class:`readline`. - @raise StopIteration: when the end of the file is reached. + :raises StopIteration: when the end of the file is reached. - @return: a line read from the file. - @rtype: str + :return: a line read from the file. + :rtype: str """ line = self.readline() if not line: @@ -110,15 +110,15 @@ class BufferedFile (object): def read(self, size=None): """ - Read at most C{size} bytes from the file (less if we hit the end of the - file first). If the C{size} argument is negative or omitted, read all + Read at most ``size`` bytes from the file (less if we hit the end of the + file first). If the ``size`` argument is negative or omitted, read all the remaining data in the file. - @param size: maximum number of bytes to read - @type size: int - @return: data read from the file, or an empty string if EOF was + :param size: maximum number of bytes to read + :type size: int + :return: data read from the file, or an empty string if EOF was encountered immediately - @rtype: str + :rtype: str """ if self._closed: raise IOError('File is closed') @@ -171,14 +171,14 @@ class BufferedFile (object): incomplete line may be returned. An empty string is returned only when EOF is encountered immediately. - @note: Unlike stdio's C{fgets()}, the returned string contains null - characters (C{'\\0'}) if they occurred in the input. + .. note:: Unlike stdio's ``fgets()``, the returned string contains null + characters (``'\\0'``) if they occurred in the input. - @param size: maximum length of returned string. - @type size: int - @return: next line of the file, or an empty string if the end of the + :param size: maximum length of returned string. + :type size: int + :return: next line of the file, or an empty string if the end of the file has been reached. - @rtype: str + :rtype: str """ # it's almost silly how complex this function is. if self._closed: @@ -243,15 +243,15 @@ class BufferedFile (object): def readlines(self, sizehint=None): """ - Read all remaining lines using L{readline} and return them as a list. - If the optional C{sizehint} argument is present, instead of reading up + Read all remaining lines using :class:`readline` and return them as a list. + If the optional ``sizehint`` argument is present, instead of reading up to EOF, whole lines totalling approximately sizehint bytes (possibly after rounding up to an internal buffer size) are read. - @param sizehint: desired maximum number of bytes to read. - @type sizehint: int - @return: list of lines read from the file. - @rtype: list + :param sizehint: desired maximum number of bytes to read. + :type sizehint: int + :return: list of lines read from the file. + :rtype: list """ lines = [] bytes = 0 @@ -267,21 +267,21 @@ class BufferedFile (object): def seek(self, offset, whence=0): """ - Set the file's current position, like stdio's C{fseek}. Not all file + Set the file's current position, like stdio's ``fseek``. Not all file objects support seeking. - @note: If a file is opened in append mode (C{'a'} or C{'a+'}), any seek + .. note:: If a file is opened in append mode (``'a'`` or ``'a+'``), any seek operations will be undone at the next write (as the file position will move back to the end of the file). - @param offset: position to move to within the file, relative to - C{whence}. - @type offset: int - @param whence: type of movement: 0 = absolute; 1 = relative to the + :param offset: position to move to within the file, relative to + ``whence``. + :type offset: int + :param whence: type of movement: 0 = absolute; 1 = relative to the current position; 2 = relative to the end of the file. - @type whence: int + :type whence: int - @raise IOError: if the file doesn't support random access. + :raises IOError: if the file doesn't support random access. """ raise IOError('File does not support seeking.') @@ -291,20 +291,20 @@ class BufferedFile (object): useful if the underlying file doesn't support random access, or was opened in append mode. - @return: file position (in bytes). - @rtype: int + :return: file position (in bytes). + :rtype: int """ return self._pos def write(self, data): """ - Write data to the file. If write buffering is on (C{bufsize} was + Write data to the file. If write buffering is on (``bufsize`` was specified and non-zero), some or all of the data may not actually be - written yet. (Use L{flush} or L{close} to force buffered data to be + written yet. (Use :class:`flush` or :class:`close` to force buffered data to be written out.) - @param data: data to write. - @type data: str + :param data: data to write. + :type data: str """ if self._closed: raise IOError('File is closed') @@ -334,11 +334,11 @@ class BufferedFile (object): """ Write a sequence of strings to the file. The sequence can be any iterable object producing strings, typically a list of strings. (The - name is intended to match L{readlines}; C{writelines} does not add line + name is intended to match :class:`readlines`; ``writelines`` does not add line separators.) - @param sequence: an iterable sequence of strings. - @type sequence: sequence + :param sequence: an iterable sequence of strings. + :type sequence: sequence """ for line in sequence: self.write(line) @@ -346,11 +346,11 @@ class BufferedFile (object): def xreadlines(self): """ - Identical to C{iter(f)}. This is a deprecated file interface that + Identical to ``iter(f)``. This is a deprecated file interface that predates python iterator support. - @return: an iterator. - @rtype: iterator + :return: an iterator. + :rtype: iterator """ return self @@ -364,25 +364,25 @@ class BufferedFile (object): def _read(self, size): """ - I{(subclass override)} - Read data from the stream. Return C{None} or raise C{EOFError} to + (subclass override) + Read data from the stream. Return ``None`` or raise ``EOFError`` to indicate EOF. """ raise EOFError() def _write(self, data): """ - I{(subclass override)} + (subclass override) Write data into the stream. """ raise IOError('write not implemented') def _get_size(self): """ - I{(subclass override)} - Return the size of the file. This is called from within L{_set_mode} + (subclass override) + Return the size of the file. This is called from within :class:`_set_mode` if the file is opened in append mode, so the file position can be - tracked and L{seek} and L{tell} will work correctly. If the file is + tracked and :class:`seek` and :class:`tell` will work correctly. If the file is a stream that can't be randomly accessed, you don't need to override this method, """ diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index f967a3da..a26e1fb2 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{HostKeys} +:class:`HostKeys` """ import base64 @@ -59,8 +59,8 @@ class HostKeyEntry: We don't bother to check for comments or empty lines. All of that should be taken care of before sending the line to us. - @param line: a line from an OpenSSH known_hosts file - @type line: str + :param line: a line from an OpenSSH known_hosts file + :type line: str """ log = get_logger('paramiko.hostkeys') fields = line.split(' ') @@ -112,9 +112,9 @@ class HostKeys (UserDict.DictMixin): verify server keys during SSH negotiation. A HostKeys object can be treated like a dict; any dict lookup is equivalent - to calling L{lookup}. + to calling :class:`lookup`. - @since: 1.5.3 + .. versionadded:: 1.5.3 """ def __init__(self, filename=None): @@ -122,8 +122,8 @@ class HostKeys (UserDict.DictMixin): Create a new HostKeys object, optionally loading keys from an openssh style host-key file. - @param filename: filename to load host keys from, or C{None} - @type filename: str + :param filename: filename to load host keys from, or ``None`` + :type filename: str """ # emulate a dict of { hostname: { keytype: PKey } } self._entries = [] @@ -133,14 +133,14 @@ class HostKeys (UserDict.DictMixin): def add(self, hostname, keytype, key): """ Add a host key entry to the table. Any existing entry for a - C{(hostname, keytype)} pair will be replaced. - - @param hostname: the hostname (or IP) to add - @type hostname: str - @param keytype: key type (C{"ssh-rsa"} or C{"ssh-dss"}) - @type keytype: str - @param key: the key to add - @type key: L{PKey} + ``(hostname, keytype)`` pair will be replaced. + + :param hostname: the hostname (or IP) to add + :type hostname: str + :param keytype: key type (``"ssh-rsa"`` or ``"ssh-dss"``) + :type keytype: str + :param key: the key to add + :type key: :class:`PKey` """ for e in self._entries: if (hostname in e.hostnames) and (e.key.get_name() == keytype): @@ -153,16 +153,16 @@ class HostKeys (UserDict.DictMixin): Read a file of known SSH host keys, in the format used by openssh. This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in - C{os.path.expanduser("~/.ssh/known_hosts")}. + ``os.path.expanduser("~/.ssh/known_hosts")``. If this method is called multiple times, the host keys are merged, - not cleared. So multiple calls to C{load} will just call L{add}, + not cleared. So multiple calls to ``load`` will just call :class:`add`, replacing any existing entries and adding new ones. - @param filename: name of the file to read host keys from - @type filename: str + :param filename: name of the file to read host keys from + :type filename: str - @raise IOError: if there was an error reading the file + :raises IOError: if there was an error reading the file """ f = open(filename, 'r') for lineno, line in enumerate(f): @@ -186,12 +186,12 @@ class HostKeys (UserDict.DictMixin): loaded from a file originally). The single exception is that combined lines will be split into individual key lines, which is arguably a bug. - @param filename: name of the file to write - @type filename: str + :param filename: name of the file to write + :type filename: str - @raise IOError: if there was an error writing the file + :raises IOError: if there was an error writing the file - @since: 1.6.1 + .. versionadded:: 1.6.1 """ f = open(filename, 'w') for e in self._entries: @@ -203,13 +203,13 @@ class HostKeys (UserDict.DictMixin): def lookup(self, hostname): """ Find a hostkey entry for a given hostname or IP. If no entry is found, - C{None} is returned. Otherwise a dictionary of keytype to key is - returned. The keytype will be either C{"ssh-rsa"} or C{"ssh-dss"}. + ``None`` is returned. Otherwise a dictionary of keytype to key is + returned. The keytype will be either ``"ssh-rsa"`` or ``"ssh-dss"``. - @param hostname: the hostname (or IP) to lookup - @type hostname: str - @return: keys associated with this host (or C{None}) - @rtype: dict(str, L{PKey}) + :param hostname: the hostname (or IP) to lookup + :type hostname: str + :return: keys associated with this host (or ``None``) + :rtype: dict(str, :class:`PKey`) """ class SubDict (UserDict.DictMixin): def __init__(self, hostname, entries, hostkeys): @@ -254,13 +254,13 @@ class HostKeys (UserDict.DictMixin): Return True if the given key is associated with the given hostname in this dictionary. - @param hostname: hostname (or IP) of the SSH server - @type hostname: str - @param key: the key to check - @type key: L{PKey} - @return: C{True} if the key is associated with the hostname; C{False} + :param hostname: hostname (or IP) of the SSH server + :type hostname: str + :param key: the key to check + :type key: :class:`PKey` + :return: ``True`` if the key is associated with the hostname; ``False`` if not - @rtype: bool + :rtype: bool """ k = self.lookup(hostname) if k is None: @@ -317,12 +317,12 @@ class HostKeys (UserDict.DictMixin): Return a "hashed" form of the hostname, as used by openssh when storing hashed hostnames in the known_hosts file. - @param hostname: the hostname to hash - @type hostname: str - @param salt: optional salt to use when hashing (must be 20 bytes long) - @type salt: str - @return: the hashed hostname - @rtype: str + :param hostname: the hostname to hash + :type hostname: str + :param salt: optional salt to use when hashing (must be 20 bytes long) + :type salt: str + :return: the hashed hostname + :rtype: str """ if salt is None: salt = rng.read(SHA.digest_size) diff --git a/paramiko/kex_gex.py b/paramiko/kex_gex.py index c0455a1f..c0b24453 100644 --- a/paramiko/kex_gex.py +++ b/paramiko/kex_gex.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Variant on L{KexGroup1 } where the prime "p" and +Variant on :class:`KexGroup1 ` where the prime "p" and generator "g" are provided by the server. A bit more work is required on the client side, and a B{lot} more on the server side. """ diff --git a/paramiko/message.py b/paramiko/message.py index c0e8692b..85fb3c09 100644 --- a/paramiko/message.py +++ b/paramiko/message.py @@ -28,9 +28,9 @@ from paramiko import util class Message (object): """ - An SSH2 I{Message} is a stream of bytes that encodes some combination of + An SSH2 Message is a stream of bytes that encodes some combination of strings, integers, bools, and infinite-precision integers (known in python - as I{long}s). This class builds or breaks down such a byte stream. + as longs). This class builds or breaks down such a byte stream. Normally you don't need to deal with anything this low-level, but it's exposed for people implementing custom extensions, or features that @@ -41,9 +41,9 @@ class Message (object): """ Create a new SSH2 Message. - @param content: the byte stream to use as the Message content (passed + :param content: the byte stream to use as the Message content (passed in only when decomposing a Message). - @type content: string + :type content: string """ if content != None: self.packet = cStringIO.StringIO(content) @@ -54,8 +54,8 @@ class Message (object): """ Return the byte stream content of this Message, as a string. - @return: the contents of this Message. - @rtype: string + :return: the contents of this Message. + :rtype: string """ return self.packet.getvalue() @@ -63,7 +63,7 @@ class Message (object): """ Returns a string representation of this object, for debugging. - @rtype: string + :rtype: string """ return 'paramiko.Message(' + repr(self.packet.getvalue()) + ')' @@ -79,8 +79,8 @@ class Message (object): Return the bytes of this Message that haven't already been parsed and returned. - @return: a string of the bytes not parsed yet. - @rtype: string + :return: a string of the bytes not parsed yet. + :rtype: string """ position = self.packet.tell() remainder = self.packet.read() @@ -91,10 +91,10 @@ class Message (object): """ Returns the bytes of this Message that have been parsed and returned. The string passed into a Message's constructor can be regenerated by - concatenating C{get_so_far} and L{get_remainder}. + concatenating ``get_so_far`` and :class:`get_remainder`. - @return: a string of the bytes parsed so far. - @rtype: string + :return: a string of the bytes parsed so far. + :rtype: string """ position = self.packet.tell() self.rewind() @@ -102,12 +102,12 @@ class Message (object): def get_bytes(self, n): """ - Return the next C{n} bytes of the Message, without decomposing into + Return the next ``n`` bytes of the Message, without decomposing into an int, string, etc. Just the raw bytes are returned. - @return: a string of the next C{n} bytes of the Message, or a string - of C{n} zero bytes, if there aren't C{n} bytes remaining. - @rtype: string + :return: a string of the next ``n`` bytes of the Message, or a string + of ``n`` zero bytes, if there aren't ``n`` bytes remaining. + :rtype: string """ b = self.packet.read(n) max_pad_size = 1<<20 # Limit padding to 1 MB @@ -118,11 +118,11 @@ class Message (object): def get_byte(self): """ Return the next byte of the Message, without decomposing it. This - is equivalent to L{get_bytes(1)}. + is equivalent to :class:`get_bytes(1)`. - @return: the next byte of the Message, or C{'\000'} if there aren't + :return: the next byte of the Message, or ``'\000'`` if there aren't any bytes remaining. - @rtype: string + :rtype: string """ return self.get_bytes(1) @@ -130,8 +130,8 @@ class Message (object): """ Fetch a boolean from the stream. - @return: C{True} or C{False} (from the Message). - @rtype: bool + :return: ``True`` or ``False`` (from the Message). + :rtype: bool """ b = self.get_bytes(1) return b != '\x00' @@ -140,8 +140,8 @@ class Message (object): """ Fetch an int from the stream. - @return: a 32-bit unsigned integer. - @rtype: int + :return: a 32-bit unsigned integer. + :rtype: int """ return struct.unpack('>I', self.get_bytes(4))[0] @@ -149,8 +149,8 @@ class Message (object): """ Fetch a 64-bit int from the stream. - @return: a 64-bit unsigned integer. - @rtype: long + :return: a 64-bit unsigned integer. + :rtype: long """ return struct.unpack('>Q', self.get_bytes(8))[0] @@ -158,8 +158,8 @@ class Message (object): """ Fetch a long int (mpint) from the stream. - @return: an arbitrary-length integer. - @rtype: long + :return: an arbitrary-length integer. + :rtype: long """ return util.inflate_long(self.get_string()) @@ -169,8 +169,8 @@ class Message (object): contain unprintable characters. (It's not unheard of for a string to contain another byte-stream Message.) - @return: a string. - @rtype: string + :return: a string. + :rtype: string """ return self.get_bytes(self.get_int()) @@ -179,8 +179,8 @@ class Message (object): Fetch a list of strings from the stream. These are trivially encoded as comma-separated values in a string. - @return: a list of strings. - @rtype: list of strings + :return: a list of strings. + :rtype: list of strings """ return self.get_string().split(',') @@ -188,8 +188,8 @@ class Message (object): """ Write bytes to the stream, without any formatting. - @param b: bytes to add - @type b: str + :param b: bytes to add + :type b: str """ self.packet.write(b) return self @@ -198,8 +198,8 @@ class Message (object): """ Write a single byte to the stream, without any formatting. - @param b: byte to add - @type b: str + :param b: byte to add + :type b: str """ self.packet.write(b) return self @@ -208,8 +208,8 @@ class Message (object): """ Add a boolean value to the stream. - @param b: boolean value to add - @type b: bool + :param b: boolean value to add + :type b: bool """ if b: self.add_byte('\x01') @@ -221,8 +221,8 @@ class Message (object): """ Add an integer to the stream. - @param n: integer to add - @type n: int + :param n: integer to add + :type n: int """ self.packet.write(struct.pack('>I', n)) return self @@ -231,8 +231,8 @@ class Message (object): """ Add a 64-bit int to the stream. - @param n: long int to add - @type n: long + :param n: long int to add + :type n: long """ self.packet.write(struct.pack('>Q', n)) return self @@ -242,8 +242,8 @@ class Message (object): Add a long int to the stream, encoded as an infinite-precision integer. This method only works on positive numbers. - @param z: long int to add - @type z: long + :param z: long int to add + :type z: long """ self.add_string(util.deflate_long(z)) return self @@ -252,8 +252,8 @@ class Message (object): """ Add a string to the stream. - @param s: string to add - @type s: str + :param s: string to add + :type s: str """ self.add_int(len(s)) self.packet.write(s) @@ -265,8 +265,8 @@ class Message (object): a single string of values separated by commas. (Yes, really, that's how SSH2 does it.) - @param l: list of strings to add - @type l: list(str) + :param l: list of strings to add + :type l: list(str) """ self.add_string(','.join(l)) return self @@ -293,8 +293,8 @@ class Message (object): Add a sequence of items to the stream. The values are encoded based on their type: str, int, bool, list, or long. - @param seq: the sequence of items - @type seq: sequence + :param seq: the sequence of items + :type seq: sequence @bug: longs are encoded non-deterministically. Don't use this method. """ diff --git a/paramiko/packet.py b/paramiko/packet.py index 3f85d668..90293d34 100644 --- a/paramiko/packet.py +++ b/paramiko/packet.py @@ -168,17 +168,17 @@ class Packetizer (object): def need_rekey(self): """ - Returns C{True} if a new set of keys needs to be negotiated. This + Returns ``True`` if a new set of keys needs to be negotiated. This will be triggered during a packet read or write, so it should be checked after every read or write, or at least after every few. - @return: C{True} if a new set of keys needs to be negotiated + :return: ``True`` if a new set of keys needs to be negotiated """ return self.__need_rekey def set_keepalive(self, interval, callback): """ - Turn on/off the callback keepalive. If C{interval} seconds pass with + Turn on/off the callback keepalive. If ``interval`` seconds pass with no data read from or written to the socket, the callback will be executed and the timer will be reset. """ @@ -190,11 +190,11 @@ class Packetizer (object): """ Read as close to N bytes as possible, blocking as long as necessary. - @param n: number of bytes to read - @type n: int - @return: the data read - @rtype: str - @raise EOFError: if the socket was closed before all the bytes could + :param n: number of bytes to read + :type n: int + :return: the data read + :rtype: str + :raises EOFError: if the socket was closed before all the bytes could be read """ out = '' @@ -332,8 +332,8 @@ class Packetizer (object): Only one thread should ever be in this function (no other locking is done). - @raise SSHException: if the packet is mangled - @raise NeedRekeyException: if the transport should rekey + :raises SSHException: if the packet is mangled + :raises NeedRekeyException: if the transport should rekey """ header = self.read_all(self.__block_size_in, check_rekey=True) if self.__block_engine_in != None: diff --git a/paramiko/pkey.py b/paramiko/pkey.py index b1199df8..bfe7b116 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -47,30 +47,30 @@ class PKey (object): def __init__(self, msg=None, data=None): """ - Create a new instance of this public key type. If C{msg} is given, + Create a new instance of this public key type. If ``msg`` is given, the key's public part(s) will be filled in from the message. If - C{data} is given, the key's public part(s) will be filled in from + ``data`` is given, the key's public part(s) will be filled in from the string. - @param msg: an optional SSH L{Message} containing a public key of this + :param msg: an optional SSH :class:`Message` containing a public key of this type. - @type msg: L{Message} - @param data: an optional string containing a public key of this type - @type data: str + :type msg: :class:`Message` + :param data: an optional string containing a public key of this type + :type data: str - @raise SSHException: if a key cannot be created from the C{data} or - C{msg} given, or no key was passed in. + :raises SSHException: if a key cannot be created from the ``data`` or + ``msg`` given, or no key was passed in. """ pass def __str__(self): """ - Return a string of an SSH L{Message} made up of the public part(s) of - this key. This string is suitable for passing to L{__init__} to + Return a string of an SSH :class:`Message` made up of the public part(s) of + this key. This string is suitable for passing to :class:`__init__` to re-create the key object later. - @return: string representation of an SSH key message. - @rtype: str + :return: string representation of an SSH key message. + :rtype: str """ return '' @@ -81,10 +81,10 @@ class PKey (object): of the key are compared, so a public key will compare equal to its corresponding private key. - @param other: key to compare to. - @type other: L{PKey} - @return: 0 if the two keys are equivalent, non-0 otherwise. - @rtype: int + :param other: key to compare to. + :type other: :class:`PKey` + :return: 0 if the two keys are equivalent, non-0 otherwise. + :rtype: int """ hs = hash(self) ho = hash(other) @@ -96,9 +96,9 @@ class PKey (object): """ Return the name of this private key implementation. - @return: name of this private key type, in SSH terminology (for - example, C{"ssh-rsa"}). - @rtype: str + :return: name of this private key type, in SSH terminology (for + example, ``"ssh-rsa"``). + :rtype: str """ return '' @@ -107,18 +107,18 @@ class PKey (object): Return the number of significant bits in this key. This is useful for judging the relative security of a key. - @return: bits in the key. - @rtype: int + :return: bits in the key. + :rtype: int """ return 0 def can_sign(self): """ - Return C{True} if this key has the private part necessary for signing + Return ``True`` if this key has the private part necessary for signing data. - @return: C{True} if this is a private key. - @rtype: bool + :return: ``True`` if this is a private key. + :rtype: bool """ return False @@ -127,9 +127,9 @@ class PKey (object): Return an MD5 fingerprint of the public part of this key. Nothing secret is revealed. - @return: a 16-byte string (binary) of the MD5 fingerprint, in SSH + :return: a 16-byte string (binary) of the MD5 fingerprint, in SSH format. - @rtype: str + :rtype: str """ return MD5.new(str(self)).digest() @@ -139,22 +139,22 @@ class PKey (object): secret is revealed. This format is compatible with that used to store public key files or recognized host keys. - @return: a base64 string containing the public part of the key. - @rtype: str + :return: a base64 string containing the public part of the key. + :rtype: str """ return base64.encodestring(str(self)).replace('\n', '') def sign_ssh_data(self, rng, data): """ - Sign a blob of data with this private key, and return a L{Message} + Sign a blob of data with this private key, and return a :class:`Message` representing an SSH signature message. - @param rng: a secure random number generator. - @type rng: L{Crypto.Util.rng.RandomPool} - @param data: the data to sign. - @type data: str - @return: an SSH signature message. - @rtype: L{Message} + :param rng: a secure random number generator. + :type rng: :class:`Crypto.Util.rng.RandomPool` + :param data: the data to sign. + :type data: str + :return: an SSH signature message. + :rtype: :class:`Message` """ return '' @@ -163,37 +163,37 @@ class PKey (object): Given a blob of data, and an SSH message representing a signature of that data, verify that it was signed with this key. - @param data: the data that was signed. - @type data: str - @param msg: an SSH signature message - @type msg: L{Message} - @return: C{True} if the signature verifies correctly; C{False} + :param data: the data that was signed. + :type data: str + :param msg: an SSH signature message + :type msg: :class:`Message` + :return: ``True`` if the signature verifies correctly; ``False`` otherwise. - @rtype: boolean + :rtype: boolean """ return False def from_private_key_file(cls, filename, password=None): """ Create a key object by reading a private key file. If the private - key is encrypted and C{password} is not C{None}, the given password - will be used to decrypt the key (otherwise L{PasswordRequiredException} + key is encrypted and ``password`` is not ``None``, the given password + will be used to decrypt the key (otherwise :class:`PasswordRequiredException` is thrown). Through the magic of python, this factory method will - exist in all subclasses of PKey (such as L{RSAKey} or L{DSSKey}), but + exist in all subclasses of PKey (such as :class:`RSAKey` or :class:`DSSKey`), but is useless on the abstract PKey class. - @param filename: name of the file to read - @type filename: str - @param password: an optional password to use to decrypt the key file, + :param filename: name of the file to read + :type filename: str + :param password: an optional password to use to decrypt the key file, if it's encrypted - @type password: str - @return: a new key object based on the given private key - @rtype: L{PKey} + :type password: str + :return: a new key object based on the given private key + :rtype: :class:`PKey` - @raise IOError: if there was an error reading the file - @raise PasswordRequiredException: if the private key file is - encrypted, and C{password} is C{None} - @raise SSHException: if the key file is invalid + :raises IOError: if there was an error reading the file + :raises PasswordRequiredException: if the private key file is + encrypted, and ``password`` is ``None`` + :raises SSHException: if the key file is invalid """ key = cls(filename=filename, password=password) return key @@ -202,22 +202,22 @@ class PKey (object): def from_private_key(cls, file_obj, password=None): """ Create a key object by reading a private key from a file (or file-like) - object. If the private key is encrypted and C{password} is not C{None}, + object. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt the key (otherwise - L{PasswordRequiredException} is thrown). + :class:`PasswordRequiredException` is thrown). - @param file_obj: the file to read from - @type file_obj: file - @param password: an optional password to use to decrypt the key, if it's + :param file_obj: the file to read from + :type file_obj: file + :param password: an optional password to use to decrypt the key, if it's encrypted - @type password: str - @return: a new key object based on the given private key - @rtype: L{PKey} + :type password: str + :return: a new key object based on the given private key + :rtype: :class:`PKey` - @raise IOError: if there was an error reading the key - @raise PasswordRequiredException: if the private key file is encrypted, - and C{password} is C{None} - @raise SSHException: if the key file is invalid + :raises IOError: if there was an error reading the key + :raises PasswordRequiredException: if the private key file is encrypted, + and ``password`` is ``None`` + :raises SSHException: if the key file is invalid """ key = cls(file_obj=file_obj, password=password) return key @@ -226,55 +226,55 @@ class PKey (object): def write_private_key_file(self, filename, password=None): """ Write private key contents into a file. If the password is not - C{None}, the key is encrypted before writing. + ``None``, the key is encrypted before writing. - @param filename: name of the file to write - @type filename: str - @param password: an optional password to use to encrypt the key file - @type password: str + :param filename: name of the file to write + :type filename: str + :param password: an optional password to use to encrypt the key file + :type password: str - @raise IOError: if there was an error writing the file - @raise SSHException: if the key is invalid + :raises IOError: if there was an error writing the file + :raises SSHException: if the key is invalid """ raise Exception('Not implemented in PKey') def write_private_key(self, file_obj, password=None): """ Write private key contents into a file (or file-like) object. If the - password is not C{None}, the key is encrypted before writing. + password is not ``None``, the key is encrypted before writing. - @param file_obj: the file object to write into - @type file_obj: file - @param password: an optional password to use to encrypt the key - @type password: str + :param file_obj: the file object to write into + :type file_obj: file + :param password: an optional password to use to encrypt the key + :type password: str - @raise IOError: if there was an error writing to the file - @raise SSHException: if the key is invalid + :raises IOError: if there was an error writing to the file + :raises SSHException: if the key is invalid """ raise Exception('Not implemented in PKey') def _read_private_key_file(self, tag, filename, password=None): """ Read an SSH2-format private key file, looking for a string of the type - C{"BEGIN xxx PRIVATE KEY"} for some C{xxx}, base64-decode the text we + ``"BEGIN xxx PRIVATE KEY"`` for some ``xxx``, base64-decode the text we find, and return it as a string. If the private key is encrypted and - C{password} is not C{None}, the given password will be used to decrypt - the key (otherwise L{PasswordRequiredException} is thrown). - - @param tag: C{"RSA"} or C{"DSA"}, the tag used to mark the data block. - @type tag: str - @param filename: name of the file to read. - @type filename: str - @param password: an optional password to use to decrypt the key file, + ``password`` is not ``None``, the given password will be used to decrypt + the key (otherwise :class:`PasswordRequiredException` is thrown). + + :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. + :type tag: str + :param filename: name of the file to read. + :type filename: str + :param password: an optional password to use to decrypt the key file, if it's encrypted. - @type password: str - @return: data blob that makes up the private key. - @rtype: str + :type password: str + :return: data blob that makes up the private key. + :rtype: str - @raise IOError: if there was an error reading the file. - @raise PasswordRequiredException: if the private key file is - encrypted, and C{password} is C{None}. - @raise SSHException: if the key file is invalid. + :raises IOError: if there was an error reading the file. + :raises PasswordRequiredException: if the private key file is + encrypted, and ``password`` is ``None``. + :raises SSHException: if the key file is invalid. """ f = open(filename, 'r') data = self._read_private_key(tag, f, password) @@ -335,16 +335,16 @@ class PKey (object): a trivially-encoded format (base64) which is completely insecure. If a password is given, DES-EDE3-CBC is used. - @param tag: C{"RSA"} or C{"DSA"}, the tag used to mark the data block. - @type tag: str - @param filename: name of the file to write. - @type filename: str - @param data: data blob that makes up the private key. - @type data: str - @param password: an optional password to use to encrypt the file. - @type password: str + :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. + :type tag: str + :param filename: name of the file to write. + :type filename: str + :param data: data blob that makes up the private key. + :type data: str + :param password: an optional password to use to encrypt the file. + :type password: str - @raise IOError: if there was an error writing the file. + :raises IOError: if there was an error writing the file. """ f = open(filename, 'w', 0600) # grrr... the mode doesn't always take hold diff --git a/paramiko/primes.py b/paramiko/primes.py index 9419cd6b..86b9953a 100644 --- a/paramiko/primes.py +++ b/paramiko/primes.py @@ -109,7 +109,7 @@ class ModulusPack (object): def read_file(self, filename): """ - @raise IOError: passed from any file operations that fail. + :raises IOError: passed from any file operations that fail. """ self.pack = {} f = open(filename, 'r') diff --git a/paramiko/proxy.py b/paramiko/proxy.py index 218b76e2..08abe9a6 100644 --- a/paramiko/proxy.py +++ b/paramiko/proxy.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{ProxyCommand}. +:class:`ProxyCommand`. """ import os @@ -33,18 +33,18 @@ class ProxyCommand(object): Wraps a subprocess running ProxyCommand-driven programs. This class implements a the socket-like interface needed by the - L{Transport} and L{Packetizer} classes. Using this class instead of a + :class:`Transport` and :class:`Packetizer` classes. Using this class instead of a regular socket makes it possible to talk with a Popen'd command that will proxy traffic between the client and a server hosted in another machine. """ def __init__(self, command_line): """ Create a new CommandProxy instance. The instance created by this - class can be passed as an argument to the L{Transport} class. + class can be passed as an argument to the :class:`Transport` class. - @param command_line: the command that should be executed and + :param command_line: the command that should be executed and used as the proxy. - @type command_line: str + :type command_line: str """ self.cmd = shlsplit(command_line) self.process = Popen(self.cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE) @@ -54,8 +54,8 @@ class ProxyCommand(object): Write the content received from the SSH client to the standard input of the forked command. - @param content: string to be sent to the forked command - @type content: str + :param content: string to be sent to the forked command + :type content: str """ try: self.process.stdin.write(content) @@ -71,11 +71,11 @@ class ProxyCommand(object): """ Read from the standard output of the forked program. - @param size: how many chars should be read - @type size: int + :param size: how many chars should be read + :type size: int - @return: the length of the read content - @rtype: int + :return: the length of the read content + :rtype: int """ try: return os.read(self.process.stdout.fileno(), size) diff --git a/paramiko/resource.py b/paramiko/resource.py index 6ef86d8c..1d1f8da4 100644 --- a/paramiko/resource.py +++ b/paramiko/resource.py @@ -28,13 +28,13 @@ class ResourceManager (object): A registry of objects and resources that should be closed when those objects are deleted. - This is meant to be a safer alternative to python's C{__del__} method, + This is meant to be a safer alternative to python's ``__del__`` method, which can cause reference cycles to never be collected. Objects registered with the ResourceManager can be collected but still free resources when they die. - Resources are registered using L{register}, and when an object is garbage - collected, each registered resource is closed by having its C{close()} + Resources are registered using :class:`register`, and when an object is garbage + collected, each registered resource is closed by having its ``close()`` method called. Multiple resources may be registered per object, but a resource will only be closed once, even if multiple objects register it. (The last object to register it wins.) @@ -47,14 +47,14 @@ class ResourceManager (object): """ Register a resource to be closed with an object is collected. - When the given C{obj} is garbage-collected by the python interpreter, - the C{resource} will be closed by having its C{close()} method called. + When the given ``obj`` is garbage-collected by the python interpreter, + the ``resource`` will be closed by having its ``close()`` method called. Any exceptions are ignored. - @param obj: the object to track - @type obj: object - @param resource: the resource to close when the object is collected - @type resource: object + :param obj: the object to track + :type obj: object + :param resource: the resource to close when the object is collected + :type resource: object """ def callback(ref): try: diff --git a/paramiko/rsakey.py b/paramiko/rsakey.py index c7500f85..46c37d69 100644 --- a/paramiko/rsakey.py +++ b/paramiko/rsakey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{RSAKey} +:class:`RSAKey` """ from Crypto.PublicKey import RSA @@ -129,13 +129,13 @@ class RSAKey (PKey): Generate a new private RSA key. This factory function can be used to generate a new host key or authentication key. - @param bits: number of bits the generated key should be. - @type bits: int - @param progress_func: an optional function to call at key points in - key generation (used by C{pyCrypto.PublicKey}). - @type progress_func: function - @return: new private key - @rtype: L{RSAKey} + :param bits: number of bits the generated key should be. + :type bits: int + :param progress_func: an optional function to call at key points in + key generation (used by ``pyCrypto.PublicKey``). + :type progress_func: function + :return: new private key + :rtype: :class:`RSAKey` """ rsa = RSA.generate(bits, rng.read, progress_func) key = RSAKey(vals=(rsa.e, rsa.n)) diff --git a/paramiko/server.py b/paramiko/server.py index d737e056..380831ea 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{ServerInterface} is an interface to override for server support. +:class:`ServerInterface` is an interface to override for server support. """ import threading @@ -35,14 +35,14 @@ class InteractiveQuery (object): Create a new interactive query to send to the client. The name and instructions are optional, but are generally displayed to the end user. A list of prompts may be included, or they may be added via - the L{add_prompt} method. + the :class:`add_prompt` method. - @param name: name of this query - @type name: str - @param instructions: user instructions (usually short) about this query - @type instructions: str - @param prompts: one or more authentication prompts - @type prompts: str + :param name: name of this query + :type name: str + :param instructions: user instructions (usually short) about this query + :type instructions: str + :param prompts: one or more authentication prompts + :type prompts: str """ self.name = name self.instructions = instructions @@ -58,11 +58,11 @@ class InteractiveQuery (object): Add a prompt to this query. The prompt should be a (reasonably short) string. Multiple prompts can be added to the same query. - @param prompt: the user prompt - @type prompt: str - @param echo: C{True} (default) if the user's response should be echoed; - C{False} if not (for a password or similar) - @type echo: bool + :param prompt: the user prompt + :type prompt: str + :param echo: ``True`` (default) if the user's response should be echoed; + ``False`` if not (for a password or similar) + :type echo: bool """ self.prompts.append((prompt, echo)) @@ -80,7 +80,7 @@ class ServerInterface (object): def check_channel_request(self, kind, chanid): """ Determine if a channel request of a given type will be granted, and - return C{OPEN_SUCCEEDED} or an error code. This method is + return ``OPEN_SUCCEEDED`` or an error code. This method is called in server mode when the client requests a channel, after authentication is complete. @@ -88,37 +88,37 @@ class ServerInterface (object): useless), you should also override some of the channel request methods below, which are used to determine which services will be allowed on a given channel: - - L{check_channel_pty_request} - - L{check_channel_shell_request} - - L{check_channel_subsystem_request} - - L{check_channel_window_change_request} - - L{check_channel_x11_request} - - L{check_channel_forward_agent_request} - - The C{chanid} parameter is a small number that uniquely identifies the - channel within a L{Transport}. A L{Channel} object is not created - unless this method returns C{OPEN_SUCCEEDED} -- once a - L{Channel} object is created, you can call L{Channel.get_id} to + - :class:`check_channel_pty_request` + - :class:`check_channel_shell_request` + - :class:`check_channel_subsystem_request` + - :class:`check_channel_window_change_request` + - :class:`check_channel_x11_request` + - :class:`check_channel_forward_agent_request` + + The ``chanid`` parameter is a small number that uniquely identifies the + channel within a :class:`Transport`. A :class:`Channel` object is not created + unless this method returns ``OPEN_SUCCEEDED`` -- once a + :class:`Channel` object is created, you can call :class:`Channel.get_id` to retrieve the channel ID. - The return value should either be C{OPEN_SUCCEEDED} (or - C{0}) to allow the channel request, or one of the following error + The return value should either be ``OPEN_SUCCEEDED`` (or + ``0``) to allow the channel request, or one of the following error codes to reject it: - - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED} - - C{OPEN_FAILED_CONNECT_FAILED} - - C{OPEN_FAILED_UNKNOWN_CHANNEL_TYPE} - - C{OPEN_FAILED_RESOURCE_SHORTAGE} + - ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED`` + - ``OPEN_FAILED_CONNECT_FAILED`` + - ``OPEN_FAILED_UNKNOWN_CHANNEL_TYPE`` + - ``OPEN_FAILED_RESOURCE_SHORTAGE`` The default implementation always returns - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}. + ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED``. - @param kind: the kind of channel the client would like to open - (usually C{"session"}). - @type kind: str - @param chanid: ID of the channel - @type chanid: int - @return: a success or failure code (listed above) - @rtype: int + :param kind: the kind of channel the client would like to open + (usually ``"session"``). + :type kind: str + :param chanid: ID of the channel + :type chanid: int + :return: a success or failure code (listed above) + :rtype: int """ return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED @@ -129,15 +129,15 @@ class ServerInterface (object): of authentication methods that might be successful. The "list" is actually a string of comma-separated names of types of - authentication. Possible values are C{"password"}, C{"publickey"}, - and C{"none"}. + authentication. Possible values are ``"password"``, ``"publickey"``, + and ``"none"``. - The default implementation always returns C{"password"}. + The default implementation always returns ``"password"``. - @param username: the username requesting authentication. - @type username: str - @return: a comma-separated list of authentication types - @rtype: str + :param username: the username requesting authentication. + :type username: str + :return: a comma-separated list of authentication types + :rtype: str """ return 'password' @@ -146,17 +146,17 @@ class ServerInterface (object): Determine if a client may open channels with no (further) authentication. - Return L{AUTH_FAILED} if the client must authenticate, or - L{AUTH_SUCCESSFUL} if it's okay for the client to not + Return :class:`AUTH_FAILED` if the client must authenticate, or + :class:`AUTH_SUCCESSFUL` if it's okay for the client to not authenticate. - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param username: the username of the client. - @type username: str - @return: L{AUTH_FAILED} if the authentication fails; - L{AUTH_SUCCESSFUL} if it succeeds. - @rtype: int + :param username: the username of the client. + :type username: str + :return: :class:`AUTH_FAILED` if the authentication fails; + :class:`AUTH_SUCCESSFUL` if it succeeds. + :rtype: int """ return AUTH_FAILED @@ -165,25 +165,25 @@ class ServerInterface (object): Determine if a given username and password supplied by the client is acceptable for use in authentication. - Return L{AUTH_FAILED} if the password is not accepted, - L{AUTH_SUCCESSFUL} if the password is accepted and completes - the authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your + Return :class:`AUTH_FAILED` if the password is not accepted, + :class:`AUTH_SUCCESSFUL` if the password is accepted and completes + the authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this key is accepted for authentication, but more authentication is required. (In this latter - case, L{get_allowed_auths} will be called to report to the client what + case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param username: the username of the authenticating client. - @type username: str - @param password: the password given by the client. - @type password: str - @return: L{AUTH_FAILED} if the authentication fails; - L{AUTH_SUCCESSFUL} if it succeeds; - L{AUTH_PARTIALLY_SUCCESSFUL} if the password auth is + :param username: the username of the authenticating client. + :type username: str + :param password: the password given by the client. + :type password: str + :return: :class:`AUTH_FAILED` if the authentication fails; + :class:`AUTH_SUCCESSFUL` if it succeeds; + :class:`AUTH_PARTIALLY_SUCCESSFUL` if the password auth is successful, but authentication must continue. - @rtype: int + :rtype: int """ return AUTH_FAILED @@ -194,29 +194,29 @@ class ServerInterface (object): check the username and key and decide if you would accept a signature made using this key. - Return L{AUTH_FAILED} if the key is not accepted, - L{AUTH_SUCCESSFUL} if the key is accepted and completes the - authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your + Return :class:`AUTH_FAILED` if the key is not accepted, + :class:`AUTH_SUCCESSFUL` if the key is accepted and completes the + authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this password is accepted for authentication, but more authentication is required. (In this latter - case, L{get_allowed_auths} will be called to report to the client what + case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) Note that you don't have to actually verify any key signtature here. If you're willing to accept the key, paramiko will do the work of verifying the client's signature. - The default implementation always returns L{AUTH_FAILED}. - - @param username: the username of the authenticating client - @type username: str - @param key: the key object provided by the client - @type key: L{PKey } - @return: L{AUTH_FAILED} if the client can't authenticate - with this key; L{AUTH_SUCCESSFUL} if it can; - L{AUTH_PARTIALLY_SUCCESSFUL} if it can authenticate with + The default implementation always returns :class:`AUTH_FAILED`. + + :param username: the username of the authenticating client + :type username: str + :param key: the key object provided by the client + :type key: :class:`PKey ` + :return: :class:`AUTH_FAILED` if the client can't authenticate + with this key; :class:`AUTH_SUCCESSFUL` if it can; + :class:`AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with this key but must continue with authentication - @rtype: int + :rtype: int """ return AUTH_FAILED @@ -224,24 +224,24 @@ class ServerInterface (object): """ Begin an interactive authentication challenge, if supported. You should override this method in server mode if you want to support the - C{"keyboard-interactive"} auth type, which requires you to send a + ``"keyboard-interactive"`` auth type, which requires you to send a series of questions for the client to answer. - Return L{AUTH_FAILED} if this auth method isn't supported. Otherwise, - you should return an L{InteractiveQuery} object containing the prompts + Return :class:`AUTH_FAILED` if this auth method isn't supported. Otherwise, + you should return an :class:`InteractiveQuery` object containing the prompts and instructions for the user. The response will be sent via a call - to L{check_auth_interactive_response}. + to :class:`check_auth_interactive_response`. - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param username: the username of the authenticating client - @type username: str - @param submethods: a comma-separated list of methods preferred by the + :param username: the username of the authenticating client + :type username: str + :param submethods: a comma-separated list of methods preferred by the client (usually empty) - @type submethods: str - @return: L{AUTH_FAILED} if this auth method isn't supported; otherwise + :type submethods: str + :return: :class:`AUTH_FAILED` if this auth method isn't supported; otherwise an object containing queries for the user - @rtype: int or L{InteractiveQuery} + :rtype: int or :class:`InteractiveQuery` """ return AUTH_FAILED @@ -249,31 +249,31 @@ class ServerInterface (object): """ Continue or finish an interactive authentication challenge, if supported. You should override this method in server mode if you want - to support the C{"keyboard-interactive"} auth type. + to support the ``"keyboard-interactive"`` auth type. - Return L{AUTH_FAILED} if the responses are not accepted, - L{AUTH_SUCCESSFUL} if the responses are accepted and complete - the authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your + Return :class:`AUTH_FAILED` if the responses are not accepted, + :class:`AUTH_SUCCESSFUL` if the responses are accepted and complete + the authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this set of responses is accepted for authentication, but more authentication is required. (In this latter - case, L{get_allowed_auths} will be called to report to the client what + case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) If you wish to continue interactive authentication with more questions, - you may return an L{InteractiveQuery} object, which should cause the + you may return an :class:`InteractiveQuery` object, which should cause the client to respond with more answers, calling this method again. This cycle can continue indefinitely. - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param responses: list of responses from the client - @type responses: list(str) - @return: L{AUTH_FAILED} if the authentication fails; - L{AUTH_SUCCESSFUL} if it succeeds; - L{AUTH_PARTIALLY_SUCCESSFUL} if the interactive auth is + :param responses: list of responses from the client + :type responses: list(str) + :return: :class:`AUTH_FAILED` if the authentication fails; + :class:`AUTH_SUCCESSFUL` if it succeeds; + :class:`AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is successful, but authentication must continue; otherwise an object containing queries for the user - @rtype: int or L{InteractiveQuery} + :rtype: int or :class:`InteractiveQuery` """ return AUTH_FAILED @@ -281,22 +281,22 @@ class ServerInterface (object): """ Handle a request for port forwarding. The client is asking that connections to the given address and port be forwarded back across - this ssh connection. An address of C{"0.0.0.0"} indicates a global - address (any address associated with this server) and a port of C{0} + this ssh connection. An address of ``"0.0.0.0"`` indicates a global + address (any address associated with this server) and a port of ``0`` indicates that no specific port is requested (usually the OS will pick a port). - The default implementation always returns C{False}, rejecting the + The default implementation always returns ``False``, rejecting the port forwarding request. If the request is accepted, you should return the port opened for listening. - @param address: the requested address - @type address: str - @param port: the requested port - @type port: int - @return: the port number that was opened for listening, or C{False} to + :param address: the requested address + :type address: str + :param port: the requested port + :type port: int + :return: the port number that was opened for listening, or ``False`` to reject - @rtype: int + :rtype: int """ return False @@ -306,19 +306,19 @@ class ServerInterface (object): If the given address and port is being forwarded across this ssh connection, the port should be closed. - @param address: the forwarded address - @type address: str - @param port: the forwarded port - @type port: int + :param address: the forwarded address + :type address: str + :param port: the forwarded port + :type port: int """ pass def check_global_request(self, kind, msg): """ - Handle a global request of the given C{kind}. This method is called + Handle a global request of the given ``kind``. This method is called in server mode and client mode, whenever the remote host makes a global request. If there are any arguments to the request, they will be in - C{msg}. + ``msg``. There aren't any useful global requests defined, aside from port forwarding, so usually this type of request is an extension to the @@ -329,19 +329,19 @@ class ServerInterface (object): sent back with the successful result. (Note that the items in the tuple can only be strings, ints, longs, or bools.) - The default implementation always returns C{False}, indicating that it + The default implementation always returns ``False``, indicating that it does not support any global requests. - @note: Port forwarding requests are handled separately, in - L{check_port_forward_request}. + .. note:: Port forwarding requests are handled separately, in + :class:`check_port_forward_request`. - @param kind: the kind of global request being made. - @type kind: str - @param msg: any extra arguments to the request. - @type msg: L{Message} - @return: C{True} or a tuple of data if the request was granted; - C{False} otherwise. - @rtype: bool + :param kind: the kind of global request being made. + :type kind: str + :param msg: any extra arguments to the request. + :type msg: :class:`Message` + :return: ``True`` or a tuple of data if the request was granted; + ``False`` otherwise. + :rtype: bool """ return False @@ -355,89 +355,89 @@ class ServerInterface (object): Determine if a pseudo-terminal of the given dimensions (usually requested for shell access) can be provided on the given channel. - The default implementation always returns C{False}. - - @param channel: the L{Channel} the pty request arrived on. - @type channel: L{Channel} - @param term: type of terminal requested (for example, C{"vt100"}). - @type term: str - @param width: width of screen in characters. - @type width: int - @param height: height of screen in characters. - @type height: int - @param pixelwidth: width of screen in pixels, if known (may be C{0} if + The default implementation always returns ``False``. + + :param channel: the :class:`Channel` the pty request arrived on. + :type channel: :class:`Channel` + :param term: type of terminal requested (for example, ``"vt100"``). + :type term: str + :param width: width of screen in characters. + :type width: int + :param height: height of screen in characters. + :type height: int + :param pixelwidth: width of screen in pixels, if known (may be ``0`` if unknown). - @type pixelwidth: int - @param pixelheight: height of screen in pixels, if known (may be C{0} + :type pixelwidth: int + :param pixelheight: height of screen in pixels, if known (may be ``0`` if unknown). - @type pixelheight: int - @return: C{True} if the psuedo-terminal has been allocated; C{False} + :type pixelheight: int + :return: ``True`` if the psuedo-terminal has been allocated; ``False`` otherwise. - @rtype: bool + :rtype: bool """ return False def check_channel_shell_request(self, channel): """ Determine if a shell will be provided to the client on the given - channel. If this method returns C{True}, the channel should be + channel. If this method returns ``True``, the channel should be connected to the stdin/stdout of a shell (or something that acts like a shell). - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the request arrived on. - @type channel: L{Channel} - @return: C{True} if this channel is now hooked up to a shell; C{False} + :param channel: the :class:`Channel` the request arrived on. + :type channel: :class:`Channel` + :return: ``True`` if this channel is now hooked up to a shell; ``False`` if a shell can't or won't be provided. - @rtype: bool + :rtype: bool """ return False def check_channel_exec_request(self, channel, command): """ Determine if a shell command will be executed for the client. If this - method returns C{True}, the channel should be connected to the stdin, + method returns ``True``, the channel should be connected to the stdin, stdout, and stderr of the shell command. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the request arrived on. - @type channel: L{Channel} - @param command: the command to execute. - @type command: str - @return: C{True} if this channel is now hooked up to the stdin, - stdout, and stderr of the executing command; C{False} if the + :param channel: the :class:`Channel` the request arrived on. + :type channel: :class:`Channel` + :param command: the command to execute. + :type command: str + :return: ``True`` if this channel is now hooked up to the stdin, + stdout, and stderr of the executing command; ``False`` if the command will not be executed. - @rtype: bool + :rtype: bool - @since: 1.1 + .. versionadded:: 1.1 """ return False def check_channel_subsystem_request(self, channel, name): """ Determine if a requested subsystem will be provided to the client on - the given channel. If this method returns C{True}, all future I/O + the given channel. If this method returns ``True``, all future I/O through this channel will be assumed to be connected to the requested - subsystem. An example of a subsystem is C{sftp}. + subsystem. An example of a subsystem is ``sftp``. The default implementation checks for a subsystem handler assigned via - L{Transport.set_subsystem_handler}. + :class:`Transport.set_subsystem_handler`. If one has been set, the handler is invoked and this method returns - C{True}. Otherwise it returns C{False}. + ``True``. Otherwise it returns ``False``. - @note: Because the default implementation uses the L{Transport} to + .. note:: Because the default implementation uses the :class:`Transport` to identify valid subsystems, you probably won't need to override this method. - @param channel: the L{Channel} the pty request arrived on. - @type channel: L{Channel} - @param name: name of the requested subsystem. - @type name: str - @return: C{True} if this channel is now hooked up to the requested - subsystem; C{False} if that subsystem can't or won't be provided. - @rtype: bool + :param channel: the :class:`Channel` the pty request arrived on. + :type channel: :class:`Channel` + :param name: name of the requested subsystem. + :type name: str + :return: ``True`` if this channel is now hooked up to the requested + subsystem; ``False`` if that subsystem can't or won't be provided. + :rtype: bool """ handler_class, larg, kwarg = channel.get_transport()._get_subsystem_handler(name) if handler_class is None: @@ -451,102 +451,102 @@ class ServerInterface (object): Determine if the pseudo-terminal on the given channel can be resized. This only makes sense if a pty was previously allocated on it. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the pty request arrived on. - @type channel: L{Channel} - @param width: width of screen in characters. - @type width: int - @param height: height of screen in characters. - @type height: int - @param pixelwidth: width of screen in pixels, if known (may be C{0} if + :param channel: the :class:`Channel` the pty request arrived on. + :type channel: :class:`Channel` + :param width: width of screen in characters. + :type width: int + :param height: height of screen in characters. + :type height: int + :param pixelwidth: width of screen in pixels, if known (may be ``0`` if unknown). - @type pixelwidth: int - @param pixelheight: height of screen in pixels, if known (may be C{0} + :type pixelwidth: int + :param pixelheight: height of screen in pixels, if known (may be ``0`` if unknown). - @type pixelheight: int - @return: C{True} if the terminal was resized; C{False} if not. - @rtype: bool + :type pixelheight: int + :return: ``True`` if the terminal was resized; ``False`` if not. + :rtype: bool """ return False def check_channel_x11_request(self, channel, single_connection, auth_protocol, auth_cookie, screen_number): """ Determine if the client will be provided with an X11 session. If this - method returns C{True}, X11 applications should be routed through new - SSH channels, using L{Transport.open_x11_channel}. + method returns ``True``, X11 applications should be routed through new + SSH channels, using :class:`Transport.open_x11_channel`. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the X11 request arrived on - @type channel: L{Channel} - @param single_connection: C{True} if only a single X11 channel should + :param channel: the :class:`Channel` the X11 request arrived on + :type channel: :class:`Channel` + :param single_connection: ``True`` if only a single X11 channel should be opened - @type single_connection: bool - @param auth_protocol: the protocol used for X11 authentication - @type auth_protocol: str - @param auth_cookie: the cookie used to authenticate to X11 - @type auth_cookie: str - @param screen_number: the number of the X11 screen to connect to - @type screen_number: int - @return: C{True} if the X11 session was opened; C{False} if not - @rtype: bool + :type single_connection: bool + :param auth_protocol: the protocol used for X11 authentication + :type auth_protocol: str + :param auth_cookie: the cookie used to authenticate to X11 + :type auth_cookie: str + :param screen_number: the number of the X11 screen to connect to + :type screen_number: int + :return: ``True`` if the X11 session was opened; ``False`` if not + :rtype: bool """ return False def check_channel_forward_agent_request(self, channel): """ Determine if the client will be provided with an forward agent session. - If this method returns C{True}, the server will allow SSH Agent + If this method returns ``True``, the server will allow SSH Agent forwarding. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the request arrived on - @type channel: L{Channel} - @return: C{True} if the AgentForward was loaded; C{False} if not - @rtype: bool + :param channel: the :class:`Channel` the request arrived on + :type channel: :class:`Channel` + :return: ``True`` if the AgentForward was loaded; ``False`` if not + :rtype: bool """ return False def check_channel_direct_tcpip_request(self, chanid, origin, destination): """ Determine if a local port forwarding channel will be granted, and - return C{OPEN_SUCCEEDED} or an error code. This method is + return ``OPEN_SUCCEEDED`` or an error code. This method is called in server mode when the client requests a channel, after authentication is complete. - The C{chanid} parameter is a small number that uniquely identifies the - channel within a L{Transport}. A L{Channel} object is not created - unless this method returns C{OPEN_SUCCEEDED} -- once a - L{Channel} object is created, you can call L{Channel.get_id} to + The ``chanid`` parameter is a small number that uniquely identifies the + channel within a :class:`Transport`. A :class:`Channel` object is not created + unless this method returns ``OPEN_SUCCEEDED`` -- once a + :class:`Channel` object is created, you can call :class:`Channel.get_id` to retrieve the channel ID. The origin and destination parameters are (ip_address, port) tuples that correspond to both ends of the TCP connection in the forwarding tunnel. - The return value should either be C{OPEN_SUCCEEDED} (or - C{0}) to allow the channel request, or one of the following error + The return value should either be ``OPEN_SUCCEEDED`` (or + ``0``) to allow the channel request, or one of the following error codes to reject it: - - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED} - - C{OPEN_FAILED_CONNECT_FAILED} - - C{OPEN_FAILED_UNKNOWN_CHANNEL_TYPE} - - C{OPEN_FAILED_RESOURCE_SHORTAGE} + - ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED`` + - ``OPEN_FAILED_CONNECT_FAILED`` + - ``OPEN_FAILED_UNKNOWN_CHANNEL_TYPE`` + - ``OPEN_FAILED_RESOURCE_SHORTAGE`` The default implementation always returns - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}. + ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED``. - @param chanid: ID of the channel - @type chanid: int - @param origin: 2-tuple containing the IP address and port of the + :param chanid: ID of the channel + :type chanid: int + :param origin: 2-tuple containing the IP address and port of the originator (client side) - @type origin: tuple - @param destination: 2-tuple containing the IP address and port of the + :type origin: tuple + :param destination: 2-tuple containing the IP address and port of the destination (server side) - @type destination: tuple - @return: a success or failure code (listed above) - @rtype: int + :type destination: tuple + :return: a success or failure code (listed above) + :rtype: int """ return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED @@ -555,33 +555,33 @@ class SubsystemHandler (threading.Thread): """ Handler for a subsytem in server mode. If you create a subclass of this class and pass it to - L{Transport.set_subsystem_handler}, + :class:`Transport.set_subsystem_handler`, an object of this class will be created for each request for this subsystem. Each new object - will be executed within its own new thread by calling L{start_subsystem}. + will be executed within its own new thread by calling :class:`start_subsystem`. When that method completes, the channel is closed. - For example, if you made a subclass C{MP3Handler} and registered it as the - handler for subsystem C{"mp3"}, then whenever a client has successfully - authenticated and requests subsytem C{"mp3"}, an object of class - C{MP3Handler} will be created, and L{start_subsystem} will be called on + For example, if you made a subclass ``MP3Handler`` and registered it as the + handler for subsystem ``"mp3"``, then whenever a client has successfully + authenticated and requests subsytem ``"mp3"``, an object of class + ``MP3Handler`` will be created, and :class:`start_subsystem` will be called on it from a new thread. """ def __init__(self, channel, name, server): """ - Create a new handler for a channel. This is used by L{ServerInterface} + Create a new handler for a channel. This is used by :class:`ServerInterface` to start up a new handler when a channel requests this subsystem. You don't need to override this method, but if you do, be sure to pass the - C{channel} and C{name} parameters through to the original C{__init__} + ``channel`` and ``name`` parameters through to the original ``__init__`` method here. - @param channel: the channel associated with this subsystem request. - @type channel: L{Channel} - @param name: name of the requested subsystem. - @type name: str - @param server: the server object for the session that started this + :param channel: the channel associated with this subsystem request. + :type channel: :class:`Channel` + :param name: name of the requested subsystem. + :type name: str + :param server: the server object for the session that started this subsystem - @type server: L{ServerInterface} + :type server: :class:`ServerInterface` """ threading.Thread.__init__(self, target=self._run) self.__channel = channel @@ -591,10 +591,10 @@ class SubsystemHandler (threading.Thread): def get_server(self): """ - Return the L{ServerInterface} object associated with this channel and + Return the :class:`ServerInterface` object associated with this channel and subsystem. - @rtype: L{ServerInterface} + :rtype: :class:`ServerInterface` """ return self.__server @@ -619,22 +619,22 @@ class SubsystemHandler (threading.Thread): subsystem is finished, this method will return. After this method returns, the channel is closed. - The combination of C{transport} and C{channel} are unique; this handler - corresponds to exactly one L{Channel} on one L{Transport}. + The combination of ``transport`` and ``channel`` are unique; this handler + corresponds to exactly one :class:`Channel` on one :class:`Transport`. - @note: It is the responsibility of this method to exit if the - underlying L{Transport} is closed. This can be done by checking - L{Transport.is_active} or noticing an EOF - on the L{Channel}. If this method loops forever without checking + .. note:: It is the responsibility of this method to exit if the + underlying :class:`Transport` is closed. This can be done by checking + :class:`Transport.is_active` or noticing an EOF + on the :class:`Channel`. If this method loops forever without checking for this case, your python interpreter may refuse to exit because this thread will still be running. - @param name: name of the requested subsystem. - @type name: str - @param transport: the server-mode L{Transport}. - @type transport: L{Transport} - @param channel: the channel associated with this subsystem request. - @type channel: L{Channel} + :param name: name of the requested subsystem. + :type name: str + :param transport: the server-mode :class:`Transport`. + :type transport: :class:`Transport` + :param channel: the channel associated with this subsystem request. + :type channel: :class:`Channel` """ pass @@ -643,6 +643,6 @@ class SubsystemHandler (threading.Thread): Perform any cleanup at the end of a subsystem. The default implementation just closes the channel. - @since: 1.1 + .. versionadded:: 1.1 """ self.__channel.close() diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index b459b04b..267bc3ab 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -26,8 +26,8 @@ class SFTPAttributes (object): """ Representation of the attributes of a file (or proxied file) for SFTP in client or server mode. It attemps to mirror the object returned by - C{os.stat} as closely as possible, so it may have the following fields, - with the same meanings as those returned by an C{os.stat} object: + ``os.stat`` as closely as possible, so it may have the following fields, + with the same meanings as those returned by an ``os.stat`` object: - st_size - st_uid - st_gid @@ -36,8 +36,8 @@ class SFTPAttributes (object): - st_mtime Because SFTP allows flags to have other arbitrary named attributes, these - are stored in a dict named C{attr}. Occasionally, the filename is also - stored, in C{filename}. + are stored in a dict named ``attr``. Occasionally, the filename is also + stored, in ``filename``. """ FLAG_SIZE = 1 @@ -61,15 +61,15 @@ class SFTPAttributes (object): def from_stat(cls, obj, filename=None): """ - Create an SFTPAttributes object from an existing C{stat} object (an - object returned by C{os.stat}). - - @param obj: an object returned by C{os.stat} (or equivalent). - @type obj: object - @param filename: the filename associated with this file. - @type filename: str - @return: new L{SFTPAttributes} object with the same attribute fields. - @rtype: L{SFTPAttributes} + Create an SFTPAttributes object from an existing ``stat`` object (an + object returned by ``os.stat``). + + :param obj: an object returned by ``os.stat`` (or equivalent). + :type obj: object + :param filename: the filename associated with this file. + :type filename: str + :return: new :class:`SFTPAttributes` object with the same attribute fields. + :rtype: :class:`SFTPAttributes` """ attr = cls() attr.st_size = obj.st_size diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index d9215743..895ca49c 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -51,22 +51,22 @@ def _to_unicode(s): class SFTPClient (BaseSFTP): """ - SFTP client object. C{SFTPClient} is used to open an sftp session across - an open ssh L{Transport} and do remote file operations. + SFTP client object. ``SFTPClient`` is used to open an sftp session across + an open ssh :class:`Transport` and do remote file operations. """ def __init__(self, sock): """ - Create an SFTP client from an existing L{Channel}. The channel - should already have requested the C{"sftp"} subsystem. + Create an SFTP client from an existing :class:`Channel`. The channel + should already have requested the ``"sftp"`` subsystem. An alternate way to create an SFTP client context is by using - L{from_transport}. + :class:`from_transport`. - @param sock: an open L{Channel} using the C{"sftp"} subsystem - @type sock: L{Channel} + :param sock: an open :class:`Channel` using the ``"sftp"`` subsystem + :type sock: :class:`Channel` - @raise SSHException: if there's an exception while negotiating + :raises SSHException: if there's an exception while negotiating sftp """ BaseSFTP.__init__(self) @@ -91,13 +91,13 @@ class SFTPClient (BaseSFTP): def from_transport(cls, t): """ - Create an SFTP client channel from an open L{Transport}. + Create an SFTP client channel from an open :class:`Transport`. - @param t: an open L{Transport} which is already authenticated - @type t: L{Transport} - @return: a new L{SFTPClient} object, referring to an sftp session + :param t: an open :class:`Transport` which is already authenticated + :type t: :class:`Transport` + :return: a new :class:`SFTPClient` object, referring to an sftp session (channel) across the transport - @rtype: L{SFTPClient} + :rtype: :class:`SFTPClient` """ chan = t.open_session() if chan is None: @@ -117,56 +117,56 @@ class SFTPClient (BaseSFTP): """ Close the SFTP session and its underlying channel. - @since: 1.4 + .. versionadded:: 1.4 """ self._log(INFO, 'sftp session closed.') self.sock.close() def get_channel(self): """ - Return the underlying L{Channel} object for this SFTP session. This + Return the underlying :class:`Channel` object for this SFTP session. This might be useful for doing things like setting a timeout on the channel. - @return: the SSH channel - @rtype: L{Channel} + :return: the SSH channel + :rtype: :class:`Channel` - @since: 1.7.1 + .. versionadded:: 1.7.1 """ return self.sock def listdir(self, path='.'): """ - Return a list containing the names of the entries in the given C{path}. + Return a list containing the names of the entries in the given ``path``. The list is in arbitrary order. It does not include the special - entries C{'.'} and C{'..'} even if they are present in the folder. - This method is meant to mirror C{os.listdir} as closely as possible. - For a list of full L{SFTPAttributes} objects, see L{listdir_attr}. + entries ``'.'`` and ``'..'`` even if they are present in the folder. + This method is meant to mirror ``os.listdir`` as closely as possible. + For a list of full :class:`SFTPAttributes` objects, see :class:`listdir_attr`. - @param path: path to list (defaults to C{'.'}) - @type path: str - @return: list of filenames - @rtype: list of str + :param path: path to list (defaults to ``'.'``) + :type path: str + :return: list of filenames + :rtype: list of str """ return [f.filename for f in self.listdir_attr(path)] def listdir_attr(self, path='.'): """ - Return a list containing L{SFTPAttributes} objects corresponding to - files in the given C{path}. The list is in arbitrary order. It does - not include the special entries C{'.'} and C{'..'} even if they are + Return a list containing :class:`SFTPAttributes` objects corresponding to + files in the given ``path``. The list is in arbitrary order. It does + not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. - The returned L{SFTPAttributes} objects will each have an additional - field: C{longname}, which may contain a formatted string of the file's + The returned :class:`SFTPAttributes` objects will each have an additional + field: ``longname``, which may contain a formatted string of the file's attributes, in unix format. The content of this string will probably depend on the SFTP server implementation. - @param path: path to list (defaults to C{'.'}) - @type path: str - @return: list of attributes - @rtype: list of L{SFTPAttributes} + :param path: path to list (defaults to ``'.'``) + :type path: str + :return: list of attributes + :rtype: list of :class:`SFTPAttributes` - @since: 1.2 + .. versionadded:: 1.2 """ path = self._adjust_cwd(path) self._log(DEBUG, 'listdir(%r)' % path) @@ -196,37 +196,37 @@ class SFTPClient (BaseSFTP): def open(self, filename, mode='r', bufsize=-1): """ Open a file on the remote server. The arguments are the same as for - python's built-in C{file} (aka C{open}). A file-like object is + python's built-in ``file`` (aka ``open``). A file-like object is returned, which closely mimics the behavior of a normal python file object, including the ability to be used as a context manager. - The mode indicates how the file is to be opened: C{'r'} for reading, - C{'w'} for writing (truncating an existing file), C{'a'} for appending, - C{'r+'} for reading/writing, C{'w+'} for reading/writing (truncating an - existing file), C{'a+'} for reading/appending. The python C{'b'} flag - is ignored, since SSH treats all files as binary. The C{'U'} flag is + The mode indicates how the file is to be opened: ``'r'`` for reading, + ``'w'`` for writing (truncating an existing file), ``'a'`` for appending, + ``'r+'`` for reading/writing, ``'w+'`` for reading/writing (truncating an + existing file), ``'a+'`` for reading/appending. The python ``'b'`` flag + is ignored, since SSH treats all files as binary. The ``'U'`` flag is supported in a compatible way. - Since 1.5.2, an C{'x'} flag indicates that the operation should only + Since 1.5.2, an ``'x'`` flag indicates that the operation should only succeed if the file was created and did not previously exist. This has no direct mapping to python's file flags, but is commonly known as the - C{O_EXCL} flag in posix. + ``O_EXCL`` flag in posix. The file will be buffered in standard python style by default, but - can be altered with the C{bufsize} parameter. C{0} turns off - buffering, C{1} uses line buffering, and any number greater than 1 - (C{>1}) uses that specific buffer size. + can be altered with the ``bufsize`` parameter. ``0`` turns off + buffering, ``1`` uses line buffering, and any number greater than 1 + (``>1``) uses that specific buffer size. - @param filename: name of the file to open - @type filename: str - @param mode: mode (python-style) to open in - @type mode: str - @param bufsize: desired buffering (-1 = default buffer size) - @type bufsize: int - @return: a file object representing the open file - @rtype: SFTPFile + :param filename: name of the file to open + :type filename: str + :param mode: mode (python-style) to open in + :type mode: str + :param bufsize: desired buffering (-1 = default buffer size) + :type bufsize: int + :return: a file object representing the open file + :rtype: SFTPFile - @raise IOError: if the file could not be opened. + :raises IOError: if the file could not be opened. """ filename = self._adjust_cwd(filename) self._log(DEBUG, 'open(%r, %r)' % (filename, mode)) @@ -255,12 +255,12 @@ class SFTPClient (BaseSFTP): def remove(self, path): """ Remove the file at the given path. This only works on files; for - removing folders (directories), use L{rmdir}. + removing folders (directories), use :class:`rmdir`. - @param path: path (absolute or relative) of the file to remove - @type path: str + :param path: path (absolute or relative) of the file to remove + :type path: str - @raise IOError: if the path refers to a folder (directory) + :raises IOError: if the path refers to a folder (directory) """ path = self._adjust_cwd(path) self._log(DEBUG, 'remove(%r)' % path) @@ -270,14 +270,14 @@ class SFTPClient (BaseSFTP): def rename(self, oldpath, newpath): """ - Rename a file or folder from C{oldpath} to C{newpath}. + Rename a file or folder from ``oldpath`` to ``newpath``. - @param oldpath: existing name of the file or folder - @type oldpath: str - @param newpath: new name for the file or folder - @type newpath: str + :param oldpath: existing name of the file or folder + :type oldpath: str + :param newpath: new name for the file or folder + :type newpath: str - @raise IOError: if C{newpath} is a folder, or something else goes + :raises IOError: if ``newpath`` is a folder, or something else goes wrong """ oldpath = self._adjust_cwd(oldpath) @@ -287,14 +287,14 @@ class SFTPClient (BaseSFTP): def mkdir(self, path, mode=0777): """ - Create a folder (directory) named C{path} with numeric mode C{mode}. + Create a folder (directory) named ``path`` with numeric mode ``mode``. The default mode is 0777 (octal). On some systems, mode is ignored. Where it is used, the current umask value is first masked out. - @param path: name of the folder to create - @type path: str - @param mode: permissions (posix-style) for the newly-created folder - @type mode: int + :param path: name of the folder to create + :type path: str + :param mode: permissions (posix-style) for the newly-created folder + :type mode: int """ path = self._adjust_cwd(path) self._log(DEBUG, 'mkdir(%r, %r)' % (path, mode)) @@ -304,10 +304,10 @@ class SFTPClient (BaseSFTP): def rmdir(self, path): """ - Remove the folder named C{path}. + Remove the folder named ``path``. - @param path: name of the folder to remove - @type path: str + :param path: name of the folder to remove + :type path: str """ path = self._adjust_cwd(path) self._log(DEBUG, 'rmdir(%r)' % path) @@ -317,20 +317,20 @@ class SFTPClient (BaseSFTP): """ Retrieve information about a file on the remote system. The return value is an object whose attributes correspond to the attributes of - python's C{stat} structure as returned by C{os.stat}, except that it + python's ``stat`` structure as returned by ``os.stat``, except that it contains fewer fields. An SFTP server may return as much or as little info as it wants, so the results may vary from server to server. - Unlike a python C{stat} object, the result may not be accessed as a + Unlike a python ``stat`` object, the result may not be accessed as a tuple. This is mostly due to the author's slack factor. - The fields supported are: C{st_mode}, C{st_size}, C{st_uid}, C{st_gid}, - C{st_atime}, and C{st_mtime}. + The fields supported are: ``st_mode``, ``st_size``, ``st_uid``, ``st_gid``, + ``st_atime``, and ``st_mtime``. - @param path: the filename to stat - @type path: str - @return: an object containing attributes about the given file - @rtype: SFTPAttributes + :param path: the filename to stat + :type path: str + :return: an object containing attributes about the given file + :rtype: SFTPAttributes """ path = self._adjust_cwd(path) self._log(DEBUG, 'stat(%r)' % path) @@ -343,12 +343,12 @@ class SFTPClient (BaseSFTP): """ Retrieve information about a file on the remote system, without following symbolic links (shortcuts). This otherwise behaves exactly - the same as L{stat}. + the same as :class:`stat`. - @param path: the filename to stat - @type path: str - @return: an object containing attributes about the given file - @rtype: SFTPAttributes + :param path: the filename to stat + :type path: str + :return: an object containing attributes about the given file + :rtype: SFTPAttributes """ path = self._adjust_cwd(path) self._log(DEBUG, 'lstat(%r)' % path) @@ -359,13 +359,13 @@ class SFTPClient (BaseSFTP): def symlink(self, source, dest): """ - Create a symbolic link (shortcut) of the C{source} path at - C{destination}. + Create a symbolic link (shortcut) of the ``source`` path at + ``destination``. - @param source: path of the original file - @type source: str - @param dest: path of the newly created symlink - @type dest: str + :param source: path of the original file + :type source: str + :param dest: path of the newly created symlink + :type dest: str """ dest = self._adjust_cwd(dest) self._log(DEBUG, 'symlink(%r, %r)' % (source, dest)) @@ -376,13 +376,13 @@ class SFTPClient (BaseSFTP): def chmod(self, path, mode): """ Change the mode (permissions) of a file. The permissions are - unix-style and identical to those used by python's C{os.chmod} + unix-style and identical to those used by python's ``os.chmod`` function. - @param path: path of the file to change the permissions of - @type path: str - @param mode: new permissions - @type mode: int + :param path: path of the file to change the permissions of + :type path: str + :param mode: new permissions + :type mode: int """ path = self._adjust_cwd(path) self._log(DEBUG, 'chmod(%r, %r)' % (path, mode)) @@ -392,17 +392,17 @@ class SFTPClient (BaseSFTP): def chown(self, path, uid, gid): """ - Change the owner (C{uid}) and group (C{gid}) of a file. As with - python's C{os.chown} function, you must pass both arguments, so if you - only want to change one, use L{stat} first to retrieve the current + Change the owner (``uid``) and group (``gid``) of a file. As with + python's ``os.chown`` function, you must pass both arguments, so if you + only want to change one, use :class:`stat` first to retrieve the current owner and group. - @param path: path of the file to change the owner and group of - @type path: str - @param uid: new owner's uid - @type uid: int - @param gid: new group id - @type gid: int + :param path: path of the file to change the owner and group of + :type path: str + :param uid: new owner's uid + :type uid: int + :param gid: new group id + :type gid: int """ path = self._adjust_cwd(path) self._log(DEBUG, 'chown(%r, %r, %r)' % (path, uid, gid)) @@ -412,18 +412,18 @@ class SFTPClient (BaseSFTP): def utime(self, path, times): """ - Set the access and modified times of the file specified by C{path}. If - C{times} is C{None}, then the file's access and modified times are set - to the current time. Otherwise, C{times} must be a 2-tuple of numbers, - of the form C{(atime, mtime)}, which is used to set the access and + Set the access and modified times of the file specified by ``path``. If + ``times`` is ``None``, then the file's access and modified times are set + to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, + of the form ``(atime, mtime)``, which is used to set the access and modified times, respectively. This bizarre API is mimicked from python for the sake of consistency -- I apologize. - @param path: path of the file to modify - @type path: str - @param times: C{None} or a tuple of (access time, modified time) in + :param path: path of the file to modify + :type path: str + :param times: ``None`` or a tuple of (access time, modified time) in standard internet epoch time (seconds since 01 January 1970 GMT) - @type times: tuple(int) + :type times: tuple(int) """ path = self._adjust_cwd(path) if times is None: @@ -435,14 +435,14 @@ class SFTPClient (BaseSFTP): def truncate(self, path, size): """ - Change the size of the file specified by C{path}. This usually extends - or shrinks the size of the file, just like the C{truncate()} method on + Change the size of the file specified by ``path``. This usually extends + or shrinks the size of the file, just like the ``truncate()`` method on python file objects. - @param path: path of the file to modify - @type path: str - @param size: the new size of the file - @type size: int or long + :param path: path of the file to modify + :type path: str + :param size: the new size of the file + :type size: int or long """ path = self._adjust_cwd(path) self._log(DEBUG, 'truncate(%r, %r)' % (path, size)) @@ -453,13 +453,13 @@ class SFTPClient (BaseSFTP): def readlink(self, path): """ Return the target of a symbolic link (shortcut). You can use - L{symlink} to create these. The result may be either an absolute or + :class:`symlink` to create these. The result may be either an absolute or relative pathname. - @param path: path of the symbolic link file - @type path: str - @return: target path - @rtype: str + :param path: path of the symbolic link file + :type path: str + :return: target path + :rtype: str """ path = self._adjust_cwd(path) self._log(DEBUG, 'readlink(%r)' % path) @@ -477,15 +477,15 @@ class SFTPClient (BaseSFTP): """ Return the normalized path (on the server) of a given path. This can be used to quickly resolve symbolic links or determine what the - server is considering to be the "current folder" (by passing C{'.'} - as C{path}). + server is considering to be the "current folder" (by passing ``'.'`` + as ``path``). - @param path: path to be normalized - @type path: str - @return: normalized form of the given path - @rtype: str + :param path: path to be normalized + :type path: str + :return: normalized form of the given path + :rtype: str - @raise IOError: if the path can't be resolved on the server + :raises IOError: if the path can't be resolved on the server """ path = self._adjust_cwd(path) self._log(DEBUG, 'normalize(%r)' % path) @@ -503,15 +503,15 @@ class SFTPClient (BaseSFTP): doesn't really have the concept of a current working directory, this is emulated by paramiko. Once you use this method to set a working directory, all operations on this SFTPClient object will be relative - to that path. You can pass in C{None} to stop using a current working + to that path. You can pass in ``None`` to stop using a current working directory. - @param path: new current working directory - @type path: str + :param path: new current working directory + :type path: str - @raise IOError: if the requested path doesn't exist on the server + :raises IOError: if the requested path doesn't exist on the server - @since: 1.4 + .. versionadded:: 1.4 """ if path is None: self._cwd = None @@ -523,43 +523,43 @@ class SFTPClient (BaseSFTP): def getcwd(self): """ Return the "current working directory" for this SFTP session, as - emulated by paramiko. If no directory has been set with L{chdir}, - this method will return C{None}. + emulated by paramiko. If no directory has been set with :class:`chdir`, + this method will return ``None``. - @return: the current working directory on the server, or C{None} - @rtype: str + :return: the current working directory on the server, or ``None`` + :rtype: str - @since: 1.4 + .. versionadded:: 1.4 """ return self._cwd def putfo(self, fl, remotepath, file_size=0, callback=None, confirm=True): """ - Copy the contents of an open file object (C{fl}) to the SFTP server as - C{remotepath}. Any exception raised by operations will be passed through. + Copy the contents of an open file object (``fl``) to the SFTP server as + ``remotepath``. Any exception raised by operations will be passed through. The SFTP operations use pipelining for speed. - @param fl: opened file or file-like object to copy - @type localpath: object - @param remotepath: the destination path on the SFTP server - @type remotepath: str - @param file_size: optional size parameter passed to callback. If none is + :param fl: opened file or file-like object to copy + :type localpath: object + :param remotepath: the destination path on the SFTP server + :type remotepath: str + :param file_size: optional size parameter passed to callback. If none is specified, size defaults to 0 - @type file_size: int - @param callback: optional callback function that accepts the bytes + :type file_size: int + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) - @param confirm: whether to do a stat() on the file afterwards to + :type callback: function(int, int) + :param confirm: whether to do a stat() on the file afterwards to confirm the file size (since 1.7.7) - @type confirm: bool + :type confirm: bool - @return: an object containing attributes about the given file + :return: an object containing attributes about the given file (since 1.7.4) - @rtype: SFTPAttributes + :rtype: SFTPAttributes - @since: 1.4 + .. versionadded:: 1.4 """ fr = self.file(remotepath, 'wb') fr.set_pipelined(True) @@ -585,29 +585,29 @@ class SFTPClient (BaseSFTP): def put(self, localpath, remotepath, callback=None, confirm=True): """ - Copy a local file (C{localpath}) to the SFTP server as C{remotepath}. + Copy a local file (``localpath``) to the SFTP server as ``remotepath``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. The SFTP operations use pipelining for speed. - @param localpath: the local file to copy - @type localpath: str - @param remotepath: the destination path on the SFTP server - @type remotepath: str - @param callback: optional callback function that accepts the bytes + :param localpath: the local file to copy + :type localpath: str + :param remotepath: the destination path on the SFTP server + :type remotepath: str + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) - @param confirm: whether to do a stat() on the file afterwards to + :type callback: function(int, int) + :param confirm: whether to do a stat() on the file afterwards to confirm the file size (since 1.7.7) - @type confirm: bool + :type confirm: bool - @return: an object containing attributes about the given file + :return: an object containing attributes about the given file (since 1.7.4) - @rtype: SFTPAttributes + :rtype: SFTPAttributes - @since: 1.4 + .. versionadded:: 1.4 """ file_size = os.stat(localpath).st_size fl = file(localpath, 'rb') @@ -618,23 +618,23 @@ class SFTPClient (BaseSFTP): def getfo(self, remotepath, fl, callback=None): """ - Copy a remote file (C{remotepath}) from the SFTP server and write to - an open file or file-like object, C{fl}. Any exception raised by + Copy a remote file (``remotepath``) from the SFTP server and write to + an open file or file-like object, ``fl``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. - @param remotepath: opened file or file-like object to copy to - @type remotepath: object - @param fl: the destination path on the local host or open file + :param remotepath: opened file or file-like object to copy to + :type remotepath: object + :param fl: the destination path on the local host or open file object - @type localpath: str - @param callback: optional callback function that accepts the bytes + :type localpath: str + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) - @return: the number of bytes written to the opened file object + :type callback: function(int, int) + :return: the number of bytes written to the opened file object - @since: 1.4 + .. versionadded:: 1.4 """ fr = self.file(remotepath, 'rb') file_size = self.stat(remotepath).st_size @@ -655,20 +655,20 @@ class SFTPClient (BaseSFTP): def get(self, remotepath, localpath, callback=None): """ - Copy a remote file (C{remotepath}) from the SFTP server to the local - host as C{localpath}. Any exception raised by operations will be + Copy a remote file (``remotepath``) from the SFTP server to the local + host as ``localpath``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. - @param remotepath: the remote file to copy - @type remotepath: str - @param localpath: the destination path on the local host - @type localpath: str - @param callback: optional callback function that accepts the bytes + :param remotepath: the remote file to copy + :type remotepath: str + :param localpath: the destination path on the local host + :type localpath: str + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) + :type callback: function(int, int) - @since: 1.4 + .. versionadded:: 1.4 """ file_size = self.stat(remotepath).st_size fl = file(localpath, 'wb') @@ -783,5 +783,5 @@ class SFTPClient (BaseSFTP): class SFTP (SFTPClient): - "an alias for L{SFTPClient} for backwards compatability" + "an alias for :class:`SFTPClient` for backwards compatability" pass diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index 4ec936d0..fd82ae60 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SFTPFile} +:class:`SFTPFile` """ from binascii import hexlify @@ -178,34 +178,34 @@ class SFTPFile (BufferedFile): def settimeout(self, timeout): """ Set a timeout on read/write operations on the underlying socket or - ssh L{Channel}. + ssh :class:`Channel`. - @see: L{Channel.settimeout} - @param timeout: seconds to wait for a pending read/write operation - before raising C{socket.timeout}, or C{None} for no timeout - @type timeout: float + .. seealso:: :class:`Channel.settimeout` + :param timeout: seconds to wait for a pending read/write operation + before raising ``socket.timeout``, or ``None`` for no timeout + :type timeout: float """ self.sftp.sock.settimeout(timeout) def gettimeout(self): """ Returns the timeout in seconds (as a float) associated with the socket - or ssh L{Channel} used for this file. + or ssh :class:`Channel` used for this file. - @see: L{Channel.gettimeout} - @rtype: float + .. seealso:: :class:`Channel.gettimeout` + :rtype: float """ return self.sftp.sock.gettimeout() def setblocking(self, blocking): """ Set blocking or non-blocking mode on the underiying socket or ssh - L{Channel}. + :class:`Channel`. - @see: L{Channel.setblocking} - @param blocking: 0 to set non-blocking mode; non-0 to set blocking + .. seealso:: :class:`Channel.setblocking` + :param blocking: 0 to set non-blocking mode; non-0 to set blocking mode. - @type blocking: int + :type blocking: int """ self.sftp.sock.setblocking(blocking) @@ -223,11 +223,11 @@ class SFTPFile (BufferedFile): def stat(self): """ Retrieve information about this file from the remote system. This is - exactly like L{SFTP.stat}, except that it operates on an already-open + exactly like :class:`SFTP.stat`, except that it operates on an already-open file. - @return: an object containing attributes about this file. - @rtype: SFTPAttributes + :return: an object containing attributes about this file. + :rtype: SFTPAttributes """ t, msg = self.sftp._request(CMD_FSTAT, self.handle) if t != CMD_ATTRS: @@ -237,11 +237,11 @@ class SFTPFile (BufferedFile): def chmod(self, mode): """ Change the mode (permissions) of this file. The permissions are - unix-style and identical to those used by python's C{os.chmod} + unix-style and identical to those used by python's ``os.chmod`` function. - @param mode: new permissions - @type mode: int + :param mode: new permissions + :type mode: int """ self.sftp._log(DEBUG, 'chmod(%s, %r)' % (hexlify(self.handle), mode)) attr = SFTPAttributes() @@ -250,15 +250,15 @@ class SFTPFile (BufferedFile): def chown(self, uid, gid): """ - Change the owner (C{uid}) and group (C{gid}) of this file. As with - python's C{os.chown} function, you must pass both arguments, so if you - only want to change one, use L{stat} first to retrieve the current + Change the owner (``uid``) and group (``gid``) of this file. As with + python's ``os.chown`` function, you must pass both arguments, so if you + only want to change one, use :class:`stat` first to retrieve the current owner and group. - @param uid: new owner's uid - @type uid: int - @param gid: new group id - @type gid: int + :param uid: new owner's uid + :type uid: int + :param gid: new group id + :type gid: int """ self.sftp._log(DEBUG, 'chown(%s, %r, %r)' % (hexlify(self.handle), uid, gid)) attr = SFTPAttributes() @@ -268,15 +268,15 @@ class SFTPFile (BufferedFile): def utime(self, times): """ Set the access and modified times of this file. If - C{times} is C{None}, then the file's access and modified times are set - to the current time. Otherwise, C{times} must be a 2-tuple of numbers, - of the form C{(atime, mtime)}, which is used to set the access and + ``times`` is ``None``, then the file's access and modified times are set + to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, + of the form ``(atime, mtime)``, which is used to set the access and modified times, respectively. This bizarre API is mimicked from python for the sake of consistency -- I apologize. - @param times: C{None} or a tuple of (access time, modified time) in + :param times: ``None`` or a tuple of (access time, modified time) in standard internet epoch time (seconds since 01 January 1970 GMT) - @type times: tuple(int) + :type times: tuple(int) """ if times is None: times = (time.time(), time.time()) @@ -288,11 +288,11 @@ class SFTPFile (BufferedFile): def truncate(self, size): """ Change the size of this file. This usually extends - or shrinks the size of the file, just like the C{truncate()} method on + or shrinks the size of the file, just like the ``truncate()`` method on python file objects. - @param size: the new size of the file - @type size: int or long + :param size: the new size of the file + :type size: int or long """ self.sftp._log(DEBUG, 'truncate(%s, %r)' % (hexlify(self.handle), size)) attr = SFTPAttributes() @@ -305,46 +305,46 @@ class SFTPFile (BufferedFile): to verify a successful upload or download, or for various rsync-like operations. - The file is hashed from C{offset}, for C{length} bytes. If C{length} - is 0, the remainder of the file is hashed. Thus, if both C{offset} - and C{length} are zero, the entire file is hashed. + The file is hashed from ``offset``, for ``length`` bytes. If ``length`` + is 0, the remainder of the file is hashed. Thus, if both ``offset`` + and ``length`` are zero, the entire file is hashed. - Normally, C{block_size} will be 0 (the default), and this method will + Normally, ``block_size`` will be 0 (the default), and this method will return a byte string representing the requested hash (for example, a string of length 16 for MD5, or 20 for SHA-1). If a non-zero - C{block_size} is given, each chunk of the file (from C{offset} to - C{offset + length}) of C{block_size} bytes is computed as a separate + ``block_size`` is given, each chunk of the file (from ``offset`` to + ``offset + length``) of ``block_size`` bytes is computed as a separate hash. The hash results are all concatenated and returned as a single string. - For example, C{check('sha1', 0, 1024, 512)} will return a string of + For example, ``check('sha1', 0, 1024, 512)`` will return a string of length 40. The first 20 bytes will be the SHA-1 of the first 512 bytes of the file, and the last 20 bytes will be the SHA-1 of the next 512 bytes. - @param hash_algorithm: the name of the hash algorithm to use (normally - C{"sha1"} or C{"md5"}) - @type hash_algorithm: str - @param offset: offset into the file to begin hashing (0 means to start + :param hash_algorithm: the name of the hash algorithm to use (normally + ``"sha1"`` or ``"md5"``) + :type hash_algorithm: str + :param offset: offset into the file to begin hashing (0 means to start from the beginning) - @type offset: int or long - @param length: number of bytes to hash (0 means continue to the end of + :type offset: int or long + :param length: number of bytes to hash (0 means continue to the end of the file) - @type length: int or long - @param block_size: number of bytes to hash per result (must not be less + :type length: int or long + :param block_size: number of bytes to hash per result (must not be less than 256; 0 means to compute only one hash of the entire segment) - @type block_size: int - @return: string of bytes representing the hash of each block, + :type block_size: int + :return: string of bytes representing the hash of each block, concatenated together - @rtype: str + :rtype: str - @note: Many (most?) servers don't support this extension yet. + .. note:: Many (most?) servers don't support this extension yet. - @raise IOError: if the server doesn't support the "check-file" + :raises IOError: if the server doesn't support the "check-file" extension, or possibly doesn't support the hash algorithm requested - @since: 1.4 + .. versionadded:: 1.4 """ t, msg = self.sftp._request(CMD_EXTENDED, 'check-file', self.handle, hash_algorithm, long(offset), long(length), block_size) @@ -358,34 +358,34 @@ class SFTPFile (BufferedFile): Turn on/off the pipelining of write operations to this file. When pipelining is on, paramiko won't wait for the server response after each write operation. Instead, they're collected as they come in. - At the first non-write operation (including L{close}), all remaining + At the first non-write operation (including :class:`close`), all remaining server responses are collected. This means that if there was an error with one of your later writes, an exception might be thrown from - within L{close} instead of L{write}. + within :class:`close` instead of :class:`write`. - By default, files are I{not} pipelined. + By default, files are not pipelined. - @param pipelined: C{True} if pipelining should be turned on for this - file; C{False} otherwise - @type pipelined: bool + :param pipelined: ``True`` if pipelining should be turned on for this + file; ``False`` otherwise + :type pipelined: bool - @since: 1.5 + .. versionadded:: 1.5 """ self.pipelined = pipelined def prefetch(self): """ Pre-fetch the remaining contents of this file in anticipation of - future L{read} calls. If reading the entire file, pre-fetching can + future :class:`read` calls. If reading the entire file, pre-fetching can dramatically improve the download speed by avoiding roundtrip latency. The file's contents are incrementally buffered in a background thread. - The prefetched data is stored in a buffer until read via the L{read} + The prefetched data is stored in a buffer until read via the :class:`read` method. Once data has been read, it's removed from the buffer. The - data may be read in a random order (using L{seek}); chunks of the + data may be read in a random order (using :class:`seek`); chunks of the buffer that haven't been read will continue to be buffered. - @since: 1.5.1 + .. versionadded:: 1.5.1 """ size = self.stat().st_size # queue up async reads for the rest of the file @@ -401,17 +401,17 @@ class SFTPFile (BufferedFile): def readv(self, chunks): """ Read a set of blocks from the file by (offset, length). This is more - efficient than doing a series of L{seek} and L{read} calls, since the + efficient than doing a series of :class:`seek` and :class:`read` calls, since the prefetch machinery is used to retrieve all the requested blocks at once. - @param chunks: a list of (offset, length) tuples indicating which + :param chunks: a list of (offset, length) tuples indicating which sections of the file to read - @type chunks: list(tuple(long, int)) - @return: a list of blocks read, in the same order as in C{chunks} - @rtype: list(str) + :type chunks: list(tuple(long, int)) + :return: a list of blocks read, in the same order as in ``chunks`` + :rtype: list(str) - @since: 1.5.4 + .. versionadded:: 1.5.4 """ self.sftp._log(DEBUG, 'readv(%s, %r)' % (hexlify(self.handle), chunks)) diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 29d3d0d8..c591b318 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -33,16 +33,16 @@ class SFTPHandle (object): by the client to refer to the underlying file. Server implementations can (and should) subclass SFTPHandle to implement - features of a file handle, like L{stat} or L{chattr}. + features of a file handle, like :class:`stat` or :class:`chattr`. """ def __init__(self, flags=0): """ Create a new file handle representing a local file being served over - SFTP. If C{flags} is passed in, it's used to determine if the file + SFTP. If ``flags`` is passed in, it's used to determine if the file is open in append mode. - @param flags: optional flags as passed to L{SFTPServerInterface.open} - @type flags: int + :param flags: optional flags as passed to :class:`SFTPServerInterface.open` + :type flags: int """ self.__flags = flags self.__name = None @@ -56,10 +56,10 @@ class SFTPHandle (object): Normally you would use this method to close the underlying OS level file object(s). - The default implementation checks for attributes on C{self} named - C{readfile} and/or C{writefile}, and if either or both are present, - their C{close()} methods are called. This means that if you are - using the default implementations of L{read} and L{write}, this + The default implementation checks for attributes on ``self`` named + ``readfile`` and/or ``writefile``, and if either or both are present, + their ``close()`` methods are called. This means that if you are + using the default implementations of :class:`read` and :class:`write`, this method's default implementation should be fine also. """ readfile = getattr(self, 'readfile', None) @@ -71,24 +71,24 @@ class SFTPHandle (object): def read(self, offset, length): """ - Read up to C{length} bytes from this file, starting at position - C{offset}. The offset may be a python long, since SFTP allows it + Read up to ``length`` bytes from this file, starting at position + ``offset``. The offset may be a python long, since SFTP allows it to be 64 bits. If the end of the file has been reached, this method may return an - empty string to signify EOF, or it may also return L{SFTP_EOF}. + empty string to signify EOF, or it may also return :class:`SFTP_EOF`. - The default implementation checks for an attribute on C{self} named - C{readfile}, and if present, performs the read operation on the python + The default implementation checks for an attribute on ``self`` named + ``readfile``, and if present, performs the read operation on the python file-like object found there. (This is meant as a time saver for the common case where you are wrapping a python file object.) - @param offset: position in the file to start reading from. - @type offset: int or long - @param length: number of bytes to attempt to read. - @type length: int - @return: data read from the file, or an SFTP error code. - @rtype: str + :param offset: position in the file to start reading from. + :type offset: int or long + :param length: number of bytes to attempt to read. + :type length: int + :return: data read from the file, or an SFTP error code. + :rtype: str """ readfile = getattr(self, 'readfile', None) if readfile is None: @@ -108,23 +108,23 @@ class SFTPHandle (object): def write(self, offset, data): """ - Write C{data} into this file at position C{offset}. Extending the + Write ``data`` into this file at position ``offset``. Extending the file past its original end is expected. Unlike python's normal - C{write()} methods, this method cannot do a partial write: it must - write all of C{data} or else return an error. + ``write()`` methods, this method cannot do a partial write: it must + write all of ``data`` or else return an error. - The default implementation checks for an attribute on C{self} named - C{writefile}, and if present, performs the write operation on the + The default implementation checks for an attribute on ``self`` named + ``writefile``, and if present, performs the write operation on the python file-like object found there. The attribute is named - differently from C{readfile} to make it easy to implement read-only + differently from ``readfile`` to make it easy to implement read-only (or write-only) files, but if both attributes are present, they should refer to the same file. - @param offset: position in the file to start reading from. - @type offset: int or long - @param data: data to write into the file. - @type data: str - @return: an SFTP error code like L{SFTP_OK}. + :param offset: position in the file to start reading from. + :type offset: int or long + :param data: data to write into the file. + :type data: str + :return: an SFTP error code like :class:`SFTP_OK`. """ writefile = getattr(self, 'writefile', None) if writefile is None: @@ -148,26 +148,26 @@ class SFTPHandle (object): def stat(self): """ - Return an L{SFTPAttributes} object referring to this open file, or an - error code. This is equivalent to L{SFTPServerInterface.stat}, except + Return an :class:`SFTPAttributes` object referring to this open file, or an + error code. This is equivalent to :class:`SFTPServerInterface.stat`, except it's called on an open file instead of a path. - @return: an attributes object for the given file, or an SFTP error - code (like L{SFTP_PERMISSION_DENIED}). - @rtype: L{SFTPAttributes} I{or error code} + :return: an attributes object for the given file, or an SFTP error + code (like :class:`SFTP_PERMISSION_DENIED`). + :rtype: :class:`SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED def chattr(self, attr): """ - Change the attributes of this file. The C{attr} object will contain + Change the attributes of this file. The ``attr`` object will contain only those fields provided by the client in its request, so you should check for the presence of fields before using them. - @param attr: the attributes to change on this file. - @type attr: L{SFTPAttributes} - @return: an error code like L{SFTP_OK}. - @rtype: int + :param attr: the attributes to change on this file. + :type attr: :class:`SFTPAttributes` + :return: an error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index 1833c2e8..867acbcb 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -40,28 +40,28 @@ _hash_class = { class SFTPServer (BaseSFTP, SubsystemHandler): """ - Server-side SFTP subsystem support. Since this is a L{SubsystemHandler}, - it can be (and is meant to be) set as the handler for C{"sftp"} requests. - Use L{Transport.set_subsystem_handler} to activate this class. + Server-side SFTP subsystem support. Since this is a :class:`SubsystemHandler`, + it can be (and is meant to be) set as the handler for ``"sftp"`` requests. + Use :class:`Transport.set_subsystem_handler` to activate this class. """ def __init__(self, channel, name, server, sftp_si=SFTPServerInterface, *largs, **kwargs): """ The constructor for SFTPServer is meant to be called from within the - L{Transport} as a subsystem handler. C{server} and any additional + :class:`Transport` as a subsystem handler. ``server`` and any additional parameters or keyword parameters are passed from the original call to - L{Transport.set_subsystem_handler}. + :class:`Transport.set_subsystem_handler`. - @param channel: channel passed from the L{Transport}. - @type channel: L{Channel} - @param name: name of the requested subsystem. - @type name: str - @param server: the server object associated with this channel and + :param channel: channel passed from the :class:`Transport`. + :type channel: :class:`Channel` + :param name: name of the requested subsystem. + :type name: str + :param server: the server object associated with this channel and subsystem - @type server: L{ServerInterface} - @param sftp_si: a subclass of L{SFTPServerInterface} to use for handling + :type server: :class:`ServerInterface` + :param sftp_si: a subclass of :class:`SFTPServerInterface` to use for handling individual requests. - @type sftp_si: class + :type sftp_si: class """ BaseSFTP.__init__(self) SubsystemHandler.__init__(self, channel, name, server) @@ -122,14 +122,14 @@ class SFTPServer (BaseSFTP, SubsystemHandler): def convert_errno(e): """ - Convert an errno value (as from an C{OSError} or C{IOError}) into a + Convert an errno value (as from an ``OSError`` or ``IOError``) into a standard SFTP result code. This is a convenience function for trapping exceptions in server code and returning an appropriate result. - @param e: an errno code, as from C{OSError.errno}. - @type e: int - @return: an SFTP error code like L{SFTP_NO_SUCH_FILE}. - @rtype: int + :param e: an errno code, as from ``OSError.errno``. + :type e: int + :return: an SFTP error code like :class:`SFTP_NO_SUCH_FILE`. + :rtype: int """ if e == errno.EACCES: # permission denied @@ -144,18 +144,18 @@ class SFTPServer (BaseSFTP, SubsystemHandler): def set_file_attr(filename, attr): """ Change a file's attributes on the local filesystem. The contents of - C{attr} are used to change the permissions, owner, group ownership, + ``attr`` are used to change the permissions, owner, group ownership, and/or modification & access time of the file, depending on which - attributes are present in C{attr}. + attributes are present in ``attr``. This is meant to be a handy helper function for translating SFTP file requests into local file operations. - @param filename: name of the file to alter (should usually be an + :param filename: name of the file to alter (should usually be an absolute path). - @type filename: str - @param attr: attributes to change. - @type attr: L{SFTPAttributes} + :type filename: str + :param attr: attributes to change. + :type attr: :class:`SFTPAttributes` """ if sys.platform != 'win32': # mode operations are meaningless on win32 diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index b0ee3c42..b203aea0 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SFTPServerInterface} is an interface to override for SFTP server support. +:class:`SFTPServerInterface` is an interface to override for SFTP server support. """ import os @@ -29,7 +29,7 @@ from paramiko.sftp import * class SFTPServerInterface (object): """ This class defines an interface for controlling the behavior of paramiko - when using the L{SFTPServer} subsystem to provide an SFTP server. + when using the :class:`SFTPServer` subsystem to provide an SFTP server. Methods on this class are called from the SFTP session's thread, so you can block as long as necessary without affecting other sessions (even other @@ -46,9 +46,9 @@ class SFTPServerInterface (object): Create a new SFTPServerInterface object. This method does nothing by default and is meant to be overridden by subclasses. - @param server: the server object associated with this channel and + :param server: the server object associated with this channel and SFTP subsystem - @type server: L{ServerInterface} + :type server: :class:`ServerInterface` """ super(SFTPServerInterface, self).__init__(*largs, **kwargs) @@ -64,7 +64,7 @@ class SFTPServerInterface (object): """ The SFTP server session has just ended, either cleanly or via an exception. This method is meant to be overridden to perform any - necessary cleanup before this C{SFTPServerInterface} object is + necessary cleanup before this ``SFTPServerInterface`` object is destroyed. """ pass @@ -72,67 +72,67 @@ class SFTPServerInterface (object): def open(self, path, flags, attr): """ Open a file on the server and create a handle for future operations - on that file. On success, a new object subclassed from L{SFTPHandle} + on that file. On success, a new object subclassed from :class:`SFTPHandle` should be returned. This handle will be used for future operations on the file (read, write, etc). On failure, an error code such as - L{SFTP_PERMISSION_DENIED} should be returned. - - C{flags} contains the requested mode for opening (read-only, - write-append, etc) as a bitset of flags from the C{os} module: - - C{os.O_RDONLY} - - C{os.O_WRONLY} - - C{os.O_RDWR} - - C{os.O_APPEND} - - C{os.O_CREAT} - - C{os.O_TRUNC} - - C{os.O_EXCL} - (One of C{os.O_RDONLY}, C{os.O_WRONLY}, or C{os.O_RDWR} will always + :class:`SFTP_PERMISSION_DENIED` should be returned. + + ``flags`` contains the requested mode for opening (read-only, + write-append, etc) as a bitset of flags from the ``os`` module: + - ``os.O_RDONLY`` + - ``os.O_WRONLY`` + - ``os.O_RDWR`` + - ``os.O_APPEND`` + - ``os.O_CREAT`` + - ``os.O_TRUNC`` + - ``os.O_EXCL`` + (One of ``os.O_RDONLY``, ``os.O_WRONLY``, or ``os.O_RDWR`` will always be set.) - The C{attr} object contains requested attributes of the file if it + The ``attr`` object contains requested attributes of the file if it has to be created. Some or all attribute fields may be missing if the client didn't specify them. - @note: The SFTP protocol defines all files to be in "binary" mode. + .. note:: The SFTP protocol defines all files to be in "binary" mode. There is no equivalent to python's "text" mode. - @param path: the requested path (relative or absolute) of the file + :param path: the requested path (relative or absolute) of the file to be opened. - @type path: str - @param flags: flags or'd together from the C{os} module indicating the + :type path: str + :param flags: flags or'd together from the ``os`` module indicating the requested mode for opening the file. - @type flags: int - @param attr: requested attributes of the file if it is newly created. - @type attr: L{SFTPAttributes} - @return: a new L{SFTPHandle} I{or error code}. - @rtype L{SFTPHandle} + :type flags: int + :param attr: requested attributes of the file if it is newly created. + :type attr: :class:`SFTPAttributes` + :return: a new :class:`SFTPHandle` or error code. + :rtype :class:`SFTPHandle` """ return SFTP_OP_UNSUPPORTED def list_folder(self, path): """ - Return a list of files within a given folder. The C{path} will use - posix notation (C{"/"} separates folder names) and may be an absolute + Return a list of files within a given folder. The ``path`` will use + posix notation (``"/"`` separates folder names) and may be an absolute or relative path. - The list of files is expected to be a list of L{SFTPAttributes} + The list of files is expected to be a list of :class:`SFTPAttributes` objects, which are similar in structure to the objects returned by - C{os.stat}. In addition, each object should have its C{filename} + ``os.stat``. In addition, each object should have its ``filename`` field filled in, since this is important to a directory listing and - not normally present in C{os.stat} results. The method - L{SFTPAttributes.from_stat} will usually do what you want. + not normally present in ``os.stat`` results. The method + :class:`SFTPAttributes.from_stat` will usually do what you want. - In case of an error, you should return one of the C{SFTP_*} error - codes, such as L{SFTP_PERMISSION_DENIED}. + In case of an error, you should return one of the ``SFTP_*`` error + codes, such as :class:`SFTP_PERMISSION_DENIED`. - @param path: the requested path (relative or absolute) to be listed. - @type path: str - @return: a list of the files in the given folder, using - L{SFTPAttributes} objects. - @rtype: list of L{SFTPAttributes} I{or error code} + :param path: the requested path (relative or absolute) to be listed. + :type path: str + :return: a list of the files in the given folder, using + :class:`SFTPAttributes` objects. + :rtype: list of :class:`SFTPAttributes` or error code - @note: You should normalize the given C{path} first (see the - C{os.path} module) and check appropriate permissions before returning + .. note:: You should normalize the given ``path`` first (see the + ``os.path`` module) and check appropriate permissions before returning the list of files. Be careful of malicious clients attempting to use relative paths to escape restricted folders, if you're doing a direct translation from the SFTP server path to your local filesystem. @@ -141,34 +141,34 @@ class SFTPServerInterface (object): def stat(self, path): """ - Return an L{SFTPAttributes} object for a path on the server, or an + Return an :class:`SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as - "aliases"), you should follow them. (L{lstat} is the corresponding + "aliases"), you should follow them. (:class:`lstat` is the corresponding call that doesn't follow symlinks/aliases.) - @param path: the requested path (relative or absolute) to fetch + :param path: the requested path (relative or absolute) to fetch file statistics for. - @type path: str - @return: an attributes object for the given file, or an SFTP error - code (like L{SFTP_PERMISSION_DENIED}). - @rtype: L{SFTPAttributes} I{or error code} + :type path: str + :return: an attributes object for the given file, or an SFTP error + code (like :class:`SFTP_PERMISSION_DENIED`). + :rtype: :class:`SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED def lstat(self, path): """ - Return an L{SFTPAttributes} object for a path on the server, or an + Return an :class:`SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as - "aliases"), you should I{not} follow them -- instead, you should - return data on the symlink or alias itself. (L{stat} is the + "aliases"), you should not follow them -- instead, you should + return data on the symlink or alias itself. (:class:`stat` is the corresponding call that follows symlinks/aliases.) - @param path: the requested path (relative or absolute) to fetch + :param path: the requested path (relative or absolute) to fetch file statistics for. - @type path: str - @return: an attributes object for the given file, or an SFTP error - code (like L{SFTP_PERMISSION_DENIED}). - @rtype: L{SFTPAttributes} I{or error code} + :type path: str + :return: an attributes object for the given file, or an SFTP error + code (like :class:`SFTP_PERMISSION_DENIED`). + :rtype: :class:`SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -176,11 +176,11 @@ class SFTPServerInterface (object): """ Delete a file, if possible. - @param path: the requested path (relative or absolute) of the file + :param path: the requested path (relative or absolute) of the file to delete. - @type path: str - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type path: str + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -192,83 +192,83 @@ class SFTPServerInterface (object): probably a good idea to implement "move" in this method too, even for files that cross disk partition boundaries, if at all possible. - @note: You should return an error if a file with the same name as - C{newpath} already exists. (The rename operation should be + .. note:: You should return an error if a file with the same name as + ``newpath`` already exists. (The rename operation should be non-desctructive.) - @param oldpath: the requested path (relative or absolute) of the + :param oldpath: the requested path (relative or absolute) of the existing file. - @type oldpath: str - @param newpath: the requested new path of the file. - @type newpath: str - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type oldpath: str + :param newpath: the requested new path of the file. + :type newpath: str + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def mkdir(self, path, attr): """ - Create a new directory with the given attributes. The C{attr} + Create a new directory with the given attributes. The ``attr`` object may be considered a "hint" and ignored. - The C{attr} object will contain only those fields provided by the - client in its request, so you should use C{hasattr} to check for - the presense of fields before using them. In some cases, the C{attr} + The ``attr`` object will contain only those fields provided by the + client in its request, so you should use ``hasattr`` to check for + the presense of fields before using them. In some cases, the ``attr`` object may be completely empty. - @param path: requested path (relative or absolute) of the new + :param path: requested path (relative or absolute) of the new folder. - @type path: str - @param attr: requested attributes of the new folder. - @type attr: L{SFTPAttributes} - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type path: str + :param attr: requested attributes of the new folder. + :type attr: :class:`SFTPAttributes` + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def rmdir(self, path): """ - Remove a directory if it exists. The C{path} should refer to an + Remove a directory if it exists. The ``path`` should refer to an existing, empty folder -- otherwise this method should return an error. - @param path: requested path (relative or absolute) of the folder + :param path: requested path (relative or absolute) of the folder to remove. - @type path: str - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type path: str + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def chattr(self, path, attr): """ - Change the attributes of a file. The C{attr} object will contain + Change the attributes of a file. The ``attr`` object will contain only those fields provided by the client in its request, so you should check for the presence of fields before using them. - @param path: requested path (relative or absolute) of the file to + :param path: requested path (relative or absolute) of the file to change. - @type path: str - @param attr: requested attributes to change on the file. - @type attr: L{SFTPAttributes} - @return: an error code like L{SFTP_OK}. - @rtype: int + :type path: str + :param attr: requested attributes to change on the file. + :type attr: :class:`SFTPAttributes` + :return: an error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def canonicalize(self, path): """ Return the canonical form of a path on the server. For example, - if the server's home folder is C{/home/foo}, the path - C{"../betty"} would be canonicalized to C{"/home/betty"}. Note + if the server's home folder is ``/home/foo``, the path + ``"../betty"`` would be canonicalized to ``"/home/betty"``. Note the obvious security issues: if you're serving files only from a specific folder, you probably don't want this method to reveal path names outside that folder. - You may find the python methods in C{os.path} useful, especially - C{os.path.normpath} and C{os.path.realpath}. + You may find the python methods in ``os.path`` useful, especially + ``os.path.normpath`` and ``os.path.realpath``. - The default implementation returns C{os.path.normpath('/' + path)}. + The default implementation returns ``os.path.normpath('/' + path)``. """ if os.path.isabs(path): out = os.path.normpath(path) @@ -285,26 +285,26 @@ class SFTPServerInterface (object): If the specified path doesn't refer to a symbolic link, an error should be returned. - @param path: path (relative or absolute) of the symbolic link. - @type path: str - @return: the target path of the symbolic link, or an error code like - L{SFTP_NO_SUCH_FILE}. - @rtype: str I{or error code} + :param path: path (relative or absolute) of the symbolic link. + :type path: str + :return: the target path of the symbolic link, or an error code like + :class:`SFTP_NO_SUCH_FILE`. + :rtype: str or error code """ return SFTP_OP_UNSUPPORTED def symlink(self, target_path, path): """ - Create a symbolic link on the server, as new pathname C{path}, - with C{target_path} as the target of the link. + Create a symbolic link on the server, as new pathname ``path``, + with ``target_path`` as the target of the link. - @param target_path: path (relative or absolute) of the target for + :param target_path: path (relative or absolute) of the target for this new symbolic link. - @type target_path: str - @param path: path (relative or absolute) of the symbolic link to + :type target_path: str + :param path: path (relative or absolute) of the symbolic link to create. - @type path: str - @return: an error code like C{SFTP_OK}. - @rtype: int + :type path: str + :return: an error code like ``SFTP_OK``. + :rtype: int """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py index b502b563..5b9b4901 100644 --- a/paramiko/ssh_exception.py +++ b/paramiko/ssh_exception.py @@ -34,7 +34,7 @@ class AuthenticationException (SSHException): possible to retry with different credentials. (Other classes specify more specific reasons.) - @since: 1.6 + .. versionadded:: 1.6 """ pass @@ -52,12 +52,12 @@ class BadAuthenticationType (AuthenticationException): the server isn't allowing that type. (It may only allow public-key, for example.) - @ivar allowed_types: list of allowed authentication types provided by the - server (possible values are: C{"none"}, C{"password"}, and - C{"publickey"}). - @type allowed_types: list + :ivar allowed_types: list of allowed authentication types provided by the + server (possible values are: ``"none"``, ``"password"``, and + ``"publickey"``). + :type allowed_types: list - @since: 1.1 + .. versionadded:: 1.1 """ allowed_types = [] @@ -82,12 +82,12 @@ class PartialAuthentication (AuthenticationException): class ChannelException (SSHException): """ - Exception raised when an attempt to open a new L{Channel} fails. + Exception raised when an attempt to open a new :class:`Channel` fails. - @ivar code: the error code returned by the server - @type code: int + :ivar code: the error code returned by the server + :type code: int - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self, code, text): SSHException.__init__(self, text) @@ -98,14 +98,14 @@ class BadHostKeyException (SSHException): """ The host key given by the SSH server did not match what we were expecting. - @ivar hostname: the hostname of the SSH server - @type hostname: str - @ivar key: the host key presented by the server - @type key: L{PKey} - @ivar expected_key: the host key expected - @type expected_key: L{PKey} + :ivar hostname: the hostname of the SSH server + :type hostname: str + :ivar key: the host key presented by the server + :type key: :class:`PKey` + :ivar expected_key: the host key expected + :type expected_key: :class:`PKey` - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self, hostname, got_key, expected_key): SSHException.__init__(self, 'Host key for server %s does not match!' % hostname) @@ -118,10 +118,10 @@ class ProxyCommandFailure (SSHException): """ The "ProxyCommand" found in the .ssh/config file returned an error. - @ivar command: The command line that is generating this exception. - @type command: str - @ivar error: The error captured from the proxy command output. - @type error: str + :ivar command: The command line that is generating this exception. + :type command: str + :ivar error: The error captured from the proxy command output. + :type error: str """ def __init__(self, command, error): SSHException.__init__(self, diff --git a/paramiko/transport.py b/paramiko/transport.py index 6c42cc27..7cccd5ff 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{Transport} handles the core SSH2 protocol. +:class:`Transport` handles the core SSH2 protocol. """ import os @@ -73,10 +73,10 @@ class SecurityOptions (object): exchange algorithms, listed in order of preference. Changing the contents and/or order of these fields affects the underlying - L{Transport} (but only if you change them before starting the session). + :class:`Transport` (but only if you change them before starting the session). If you try to add an algorithm that paramiko doesn't recognize, - C{ValueError} will be raised. If you try to assign something besides a - tuple to one of the fields, C{TypeError} will be raised. + ``ValueError`` will be raised. If you try to assign something besides a + tuple to one of the fields, ``TypeError`` will be raised. """ __slots__ = [ 'ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport' ] @@ -87,7 +87,7 @@ class SecurityOptions (object): """ Returns a string representation of this object, for debugging. - @rtype: str + :rtype: str """ return '' % repr(self._transport) @@ -192,7 +192,7 @@ class Transport (threading.Thread): """ An SSH Transport attaches to a stream (usually a socket), negotiates an encrypted session, authenticates, and then creates stream tunnels, called - L{Channel}s, across the session. Multiple channels can be multiplexed + :class:`channels `, across the session. Multiple channels can be multiplexed across a single session (and often are, in the case of port forwardings). """ @@ -250,29 +250,29 @@ class Transport (threading.Thread): """ Create a new SSH session over an existing socket, or socket-like object. This only creates the Transport object; it doesn't begin the - SSH session yet. Use L{connect} or L{start_client} to begin a client - session, or L{start_server} to begin a server session. + SSH session yet. Use :class:`connect` or :class:`start_client` to begin a client + session, or :class:`start_server` to begin a server session. If the object is not actually a socket, it must have the following methods: - - C{send(str)}: Writes from 1 to C{len(str)} bytes, and + - ``send(str)``: Writes from 1 to ``len(str)`` bytes, and returns an int representing the number of bytes written. Returns - 0 or raises C{EOFError} if the stream has been closed. - - C{recv(int)}: Reads from 1 to C{int} bytes and returns them as a - string. Returns 0 or raises C{EOFError} if the stream has been + 0 or raises ``EOFError`` if the stream has been closed. + - ``recv(int)``: Reads from 1 to ``int`` bytes and returns them as a + string. Returns 0 or raises ``EOFError`` if the stream has been closed. - - C{close()}: Closes the socket. - - C{settimeout(n)}: Sets a (float) timeout on I/O operations. + - ``close()``: Closes the socket. + - ``settimeout(n)``: Sets a (float) timeout on I/O operations. For ease of use, you may also pass in an address (as a tuple) or a host - string as the C{sock} argument. (A host string is a hostname with an - optional port (separated by C{":"}) which will be converted into a - tuple of C{(hostname, port)}.) A socket will be connected to this - address and used for communication. Exceptions from the C{socket} call + string as the ``sock`` argument. (A host string is a hostname with an + optional port (separated by ``":"``) which will be converted into a + tuple of ``(hostname, port)``.) A socket will be connected to this + address and used for communication. Exceptions from the ``socket`` call may be thrown in this case. - @param sock: a socket or socket-like object to create the session over. - @type sock: socket + :param sock: a socket or socket-like object to create the session over. + :type sock: socket """ if isinstance(sock, (str, unicode)): # convert "host:port" into (host, port) @@ -372,7 +372,7 @@ class Transport (threading.Thread): """ Returns a string representation of this object, for debugging. - @rtype: str + :rtype: str """ out = '} or - L{auth_publickey }. + calling :class:`auth_password ` or + :class:`auth_publickey `. - @note: L{connect} is a simpler method for connecting as a client. + .. note:: :class:`connect` is a simpler method for connecting as a client. - @note: After calling this method (or L{start_server} or L{connect}), + .. note:: After calling this method (or :class:`start_server` or :class:`connect`), you should no longer directly read from or write to the original socket object. - @param event: an event to trigger when negotiation is complete + :param event: an event to trigger when negotiation is complete (optional) - @type event: threading.Event + :type event: threading.Event - @raise SSHException: if negotiation fails (and no C{event} was passed + :raises SSHException: if negotiation fails (and no ``event`` was passed in) """ self.active = True @@ -470,41 +470,41 @@ class Transport (threading.Thread): def start_server(self, event=None, server=None): """ Negotiate a new SSH2 session as a server. This is the first step after - creating a new L{Transport} and setting up your server host key(s). A + creating a new :class:`Transport` and setting up your server host key(s). A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When - negotiation is done (successful or not), the given C{Event} will - be triggered. On failure, L{is_active} will return C{False}. + negotiation is done (successful or not), the given ``Event`` will + be triggered. On failure, :class:`is_active` will return ``False``. - (Since 1.4) If C{event} is C{None}, this method will not return until + (Since 1.4) If ``event`` is ``None``, this method will not return until negotation is done. On success, the method returns normally. Otherwise an SSHException is raised. After a successful negotiation, the client will need to authenticate. Override the methods - L{get_allowed_auths }, - L{check_auth_none }, - L{check_auth_password }, and - L{check_auth_publickey } in the - given C{server} object to control the authentication process. + :class:`get_allowed_auths `, + :class:`check_auth_none `, + :class:`check_auth_password `, and + :class:`check_auth_publickey ` in the + given ``server`` object to control the authentication process. After a successful authentication, the client should request to open a channel. Override - L{check_channel_request } in the - given C{server} object to allow channels to be opened. + :class:`check_channel_request ` in the + given ``server`` object to allow channels to be opened. - @note: After calling this method (or L{start_client} or L{connect}), + .. note:: After calling this method (or :class:`start_client` or :class:`connect`), you should no longer directly read from or write to the original socket object. - @param event: an event to trigger when negotiation is complete. - @type event: threading.Event - @param server: an object used to perform authentication and create - L{Channel}s. - @type server: L{server.ServerInterface} + :param event: an event to trigger when negotiation is complete. + :type event: threading.Event + :param server: an object used to perform authentication and create + :class:`channels ` + :type server: :class:`server.ServerInterface` - @raise SSHException: if negotiation fails (and no C{event} was passed + :raises SSHException: if negotiation fails (and no ``event`` was passed in) """ if server is None: @@ -540,9 +540,9 @@ class Transport (threading.Thread): key info, not just the public half. Only one key of each type (RSA or DSS) is kept. - @param key: the host key to add, usually an L{RSAKey } or - L{DSSKey }. - @type key: L{PKey } + :param key: the host key to add, usually an :class:`RSAKey ` or + :class:`DSSKey `. + :type key: :class:`PKey ` """ self.server_key_dict[key.get_name()] = key @@ -550,15 +550,15 @@ class Transport (threading.Thread): """ Return the active host key, in server mode. After negotiating with the client, this method will return the negotiated host key. If only one - type of host key was set with L{add_server_key}, that's the only key + type of host key was set with :class:`add_server_key`, that's the only key that will ever be returned. But in cases where you have set more than one type of host key (for example, an RSA key and a DSS key), the key type will be negotiated by the client, and this method will return the key of the type agreed on. If the host key has not been negotiated - yet, C{None} is returned. In client mode, the behavior is undefined. + yet, ``None`` is returned. In client mode, the behavior is undefined. - @return: host key of the type negotiated by the client, or C{None}. - @rtype: L{PKey } + :return: host key of the type negotiated by the client, or ``None``. + :rtype: :class:`PKey ` """ try: return self.server_key_dict[self.host_key_type] @@ -568,7 +568,7 @@ class Transport (threading.Thread): def load_server_moduli(filename=None): """ - I{(optional)} + (optional) Load a file of prime moduli for use in doing group-exchange key negotiation in server mode. It's a rather obscure option and can be safely ignored. @@ -577,20 +577,20 @@ class Transport (threading.Thread): negotiation, which asks the server to send a random prime number that fits certain criteria. These primes are pretty difficult to compute, so they can't be generated on demand. But many systems contain a file - of suitable primes (usually named something like C{/etc/ssh/moduli}). - If you call C{load_server_moduli} and it returns C{True}, then this + of suitable primes (usually named something like ``/etc/ssh/moduli``). + If you call ``load_server_moduli`` and it returns ``True``, then this file of primes has been loaded and we will support "group-exchange" in server mode. Otherwise server mode will just claim that it doesn't support that method of key negotiation. - @param filename: optional path to the moduli file, if you happen to + :param filename: optional path to the moduli file, if you happen to know that it's not in a standard location. - @type filename: str - @return: True if a moduli file was successfully loaded; False + :type filename: str + :return: True if a moduli file was successfully loaded; False otherwise. - @rtype: bool + :rtype: bool - @note: This has no effect when used in client mode. + .. note:: This has no effect when used in client mode. """ Transport._modulus_pack = ModulusPack(rng) # places to look for the openssh "moduli" file @@ -624,15 +624,15 @@ class Transport (threading.Thread): """ Return the host key of the server (in client mode). - @note: Previously this call returned a tuple of (key type, key string). + .. note:: Previously this call returned a tuple of (key type, key string). You can get the same effect by calling - L{PKey.get_name } for the key type, and - C{str(key)} for the key string. + :class:`PKey.get_name ` for the key type, and + ``str(key)`` for the key string. - @raise SSHException: if no session is currently active. + :raises SSHException: if no session is currently active. - @return: public key of the remote server - @rtype: L{PKey } + :return: public key of the remote server + :rtype: :class:`PKey ` """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -642,37 +642,37 @@ class Transport (threading.Thread): """ Return true if this session is active (open). - @return: True if the session is still active (open); False if the + :return: True if the session is still active (open); False if the session is closed - @rtype: bool + :rtype: bool """ return self.active def open_session(self): """ - Request a new channel to the server, of type C{"session"}. This - is just an alias for C{open_channel('session')}. + Request a new channel to the server, of type ``"session"``. This + is just an alias for ``open_channel('session')``. - @return: a new L{Channel} - @rtype: L{Channel} + :return: a new :class:`Channel` + :rtype: :class:`Channel` - @raise SSHException: if the request is rejected or the session ends + :raises SSHException: if the request is rejected or the session ends prematurely """ return self.open_channel('session') def open_x11_channel(self, src_addr=None): """ - Request a new channel to the client, of type C{"x11"}. This - is just an alias for C{open_channel('x11', src_addr=src_addr)}. + Request a new channel to the client, of type ``"x11"``. This + is just an alias for ``open_channel('x11', src_addr=src_addr)``. - @param src_addr: the source address of the x11 server (port is the + :param src_addr: the source address of the x11 server (port is the x11 port, ie. 6010) - @type src_addr: (str, int) - @return: a new L{Channel} - @rtype: L{Channel} + :type src_addr: (str, int) + :return: a new :class:`Channel` + :rtype: :class:`Channel` - @raise SSHException: if the request is rejected or the session ends + :raises SSHException: if the request is rejected or the session ends prematurely """ return self.open_channel('x11', src_addr=src_addr) @@ -680,51 +680,51 @@ class Transport (threading.Thread): def open_forward_agent_channel(self): """ Request a new channel to the client, of type - C{"auth-agent@openssh.com"}. + ``"auth-agent@openssh.com"``. - This is just an alias for C{open_channel('auth-agent@openssh.com')}. - @return: a new L{Channel} - @rtype: L{Channel} + This is just an alias for ``open_channel('auth-agent@openssh.com')``. + :return: a new :class:`Channel` + :rtype: :class:`Channel` - @raise SSHException: if the request is rejected or the session ends + :raises SSHException: if the request is rejected or the session ends prematurely """ return self.open_channel('auth-agent@openssh.com') def open_forwarded_tcpip_channel(self, (src_addr, src_port), (dest_addr, dest_port)): """ - Request a new channel back to the client, of type C{"forwarded-tcpip"}. + Request a new channel back to the client, of type ``"forwarded-tcpip"``. This is used after a client has requested port forwarding, for sending incoming connections back to the client. - @param src_addr: originator's address - @param src_port: originator's port - @param dest_addr: local (server) connected address - @param dest_port: local (server) connected port + :param src_addr: originator's address + :param src_port: originator's port + :param dest_addr: local (server) connected address + :param dest_port: local (server) connected port """ return self.open_channel('forwarded-tcpip', (dest_addr, dest_port), (src_addr, src_port)) def open_channel(self, kind, dest_addr=None, src_addr=None): """ - Request a new channel to the server. L{Channel}s are socket-like + Request a new channel to the server. :class:`Channels ` are socket-like objects used for the actual transfer of data across the session. You may only request a channel after negotiating encryption (using - L{connect} or L{start_client}) and authenticating. + :class:`connect` or :class:`start_client`) and authenticating. - @param kind: the kind of channel requested (usually C{"session"}, - C{"forwarded-tcpip"}, C{"direct-tcpip"}, or C{"x11"}) - @type kind: str - @param dest_addr: the destination address of this port forwarding, - if C{kind} is C{"forwarded-tcpip"} or C{"direct-tcpip"} (ignored + :param kind: the kind of channel requested (usually ``"session"``, + ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"``) + :type kind: str + :param dest_addr: the destination address of this port forwarding, + if ``kind`` is ``"forwarded-tcpip"`` or ``"direct-tcpip"`` (ignored for other channel types) - @type dest_addr: (str, int) - @param src_addr: the source address of this port forwarding, if - C{kind} is C{"forwarded-tcpip"}, C{"direct-tcpip"}, or C{"x11"} - @type src_addr: (str, int) - @return: a new L{Channel} on success - @rtype: L{Channel} - - @raise SSHException: if the request is rejected or the session ends + :type dest_addr: (str, int) + :param src_addr: the source address of this port forwarding, if + ``kind`` is ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"`` + :type src_addr: (str, int) + :return: a new :class:`Channel` on success + :rtype: :class:`Channel` + + :raises SSHException: if the request is rejected or the session ends prematurely """ if not self.active: @@ -782,24 +782,24 @@ class Transport (threading.Thread): handler(channel, (origin_addr, origin_port), (server_addr, server_port)) - where C{server_addr} and C{server_port} are the address and port that + where ``server_addr`` and ``server_port`` are the address and port that the server was listening on. If no handler is set, the default behavior is to send new incoming forwarded connections into the accept queue, to be picked up via - L{accept}. + :class:`accept`. - @param address: the address to bind when forwarding - @type address: str - @param port: the port to forward, or 0 to ask the server to allocate + :param address: the address to bind when forwarding + :type address: str + :param port: the port to forward, or 0 to ask the server to allocate any port - @type port: int - @param handler: optional handler for incoming forwarded connections - @type handler: function(Channel, (str, int), (str, int)) - @return: the port # allocated by the server - @rtype: int + :type port: int + :param handler: optional handler for incoming forwarded connections + :type handler: function(Channel, (str, int), (str, int)) + :return: the port # allocated by the server + :rtype: int - @raise SSHException: if the server refused the TCP forward request + :raises SSHException: if the server refused the TCP forward request """ if not self.active: raise SSHException('SSH session not active') @@ -823,10 +823,10 @@ class Transport (threading.Thread): connections to the given address & port will be forwarded across this ssh connection. - @param address: the address to stop forwarding - @type address: str - @param port: the port to stop forwarding - @type port: int + :param address: the address to stop forwarding + :type address: str + :param port: the port to stop forwarding + :type port: int """ if not self.active: return @@ -839,9 +839,9 @@ class Transport (threading.Thread): an SFTP session will be opened with the remote host, and a new SFTPClient object will be returned. - @return: a new L{SFTPClient} object, referring to an sftp session + :return: a new :class:`SFTPClient` object, referring to an sftp session (channel) across this transport - @rtype: L{SFTPClient} + :rtype: :class:`SFTPClient` """ return SFTPClient.from_transport(self) @@ -852,9 +852,9 @@ class Transport (threading.Thread): also be used as a keep-alive for long lived connections traversing firewalls. - @param bytes: the number of random bytes to send in the payload of the + :param bytes: the number of random bytes to send in the payload of the ignored packet -- defaults to a random number from 10 to 41. - @type bytes: int + :type bytes: int """ m = Message() m.add_byte(chr(MSG_IGNORE)) @@ -872,7 +872,7 @@ class Transport (threading.Thread): traffic both ways as the two sides swap keys and do computations. This method returns when the session has switched to new keys. - @raise SSHException: if the key renegotiation failed (which causes the + :raises SSHException: if the key renegotiation failed (which causes the session to end) """ self.completion_event = threading.Event() @@ -891,13 +891,13 @@ class Transport (threading.Thread): def set_keepalive(self, interval): """ Turn on/off keepalive packets (default is off). If this is set, after - C{interval} seconds without sending any data over the connection, a + ``interval`` seconds without sending any data over the connection, a "keepalive" packet will be sent (and ignored by the remote host). This can be useful to keep connections alive over a NAT, for example. - @param interval: seconds to wait before sending a keepalive packet (or + :param interval: seconds to wait before sending a keepalive packet (or 0 to disable keepalives). - @type interval: int + :type interval: int """ self.packetizer.set_keepalive(interval, lambda x=weakref.proxy(self): x.global_request('keepalive@lag.net', wait=False)) @@ -907,18 +907,18 @@ class Transport (threading.Thread): Make a global request to the remote host. These are normally extensions to the SSH2 protocol. - @param kind: name of the request. - @type kind: str - @param data: an optional tuple containing additional data to attach + :param kind: name of the request. + :type kind: str + :param data: an optional tuple containing additional data to attach to the request. - @type data: tuple - @param wait: C{True} if this method should not return until a response - is received; C{False} otherwise. - @type wait: bool - @return: a L{Message} containing possible additional data if the - request was successful (or an empty L{Message} if C{wait} was - C{False}); C{None} if the request was denied. - @rtype: L{Message} + :type data: tuple + :param wait: ``True`` if this method should not return until a response + is received; ``False`` otherwise. + :type wait: bool + :return: a :class:`Message` containing possible additional data if the + request was successful (or an empty :class:`Message` if ``wait`` was + ``False``); ``None`` if the request was denied. + :rtype: :class:`Message` """ if wait: self.completion_event = threading.Event() @@ -943,14 +943,14 @@ class Transport (threading.Thread): def accept(self, timeout=None): """ Return the next channel opened by the client over this transport, in - server mode. If no channel is opened before the given timeout, C{None} + server mode. If no channel is opened before the given timeout, ``None`` is returned. - @param timeout: seconds to wait for a channel, or C{None} to wait + :param timeout: seconds to wait for a channel, or ``None`` to wait forever - @type timeout: int - @return: a new Channel opened by the client - @rtype: L{Channel} + :type timeout: int + :return: a new Channel opened by the client + :rtype: :class:`Channel` """ self.lock.acquire() try: @@ -971,34 +971,34 @@ class Transport (threading.Thread): """ Negotiate an SSH2 session, and optionally verify the server's host key and authenticate using a password or private key. This is a shortcut - for L{start_client}, L{get_remote_server_key}, and - L{Transport.auth_password} or L{Transport.auth_publickey}. Use those + for :class:`start_client`, :class:`get_remote_server_key`, and + :class:`Transport.auth_password` or :class:`Transport.auth_publickey`. Use those methods if you want more control. You can use this method immediately after creating a Transport to negotiate encryption with a server. If it fails, an exception will be thrown. On success, the method will return cleanly, and an encrypted - session exists. You may immediately call L{open_channel} or - L{open_session} to get a L{Channel} object, which is used for data + session exists. You may immediately call :class:`open_channel` or + :class:`open_session` to get a :class:`Channel` object, which is used for data transfer. - @note: If you fail to supply a password or private key, this method may - succeed, but a subsequent L{open_channel} or L{open_session} call may + .. note:: If you fail to supply a password or private key, this method may + succeed, but a subsequent :class:`open_channel` or :class:`open_session` call may fail because you haven't authenticated yet. - @param hostkey: the host key expected from the server, or C{None} if + :param hostkey: the host key expected from the server, or ``None`` if you don't want to do host key verification. - @type hostkey: L{PKey} - @param username: the username to authenticate as. - @type username: str - @param password: a password to use for authentication, if you want to - use password authentication; otherwise C{None}. - @type password: str - @param pkey: a private key to use for authentication, if you want to - use private key authentication; otherwise C{None}. - @type pkey: L{PKey} - - @raise SSHException: if the SSH2 negotiation fails, the host key + :type hostkey: :class:`PKey` + :param username: the username to authenticate as. + :type username: str + :param password: a password to use for authentication, if you want to + use password authentication; otherwise ``None``. + :type password: str + :param pkey: a private key to use for authentication, if you want to + use private key authentication; otherwise ``None``. + :type pkey: :class:`PKey` + + :raises SSHException: if the SSH2 negotiation fails, the host key supplied by the server is incorrect, or authentication fails. """ if hostkey is not None: @@ -1030,13 +1030,13 @@ class Transport (threading.Thread): """ Return any exception that happened during the last server request. This can be used to fetch more specific error information after using - calls like L{start_client}. The exception (if any) is cleared after + calls like :class:`start_client`. The exception (if any) is cleared after this call. - @return: an exception, or C{None} if there is no stored exception. - @rtype: Exception + :return: an exception, or ``None`` if there is no stored exception. + :rtype: Exception - @since: 1.1 + .. versionadded:: 1.1 """ self.lock.acquire() try: @@ -1050,17 +1050,17 @@ class Transport (threading.Thread): """ Set the handler class for a subsystem in server mode. If a request for this subsystem is made on an open ssh channel later, this handler - will be constructed and called -- see L{SubsystemHandler} for more + will be constructed and called -- see :class:`SubsystemHandler` for more detailed documentation. Any extra parameters (including keyword arguments) are saved and - passed to the L{SubsystemHandler} constructor later. + passed to the :class:`SubsystemHandler` constructor later. - @param name: name of the subsystem. - @type name: str - @param handler: subclass of L{SubsystemHandler} that handles this + :param name: name of the subsystem. + :type name: str + :param handler: subclass of :class:`SubsystemHandler` that handles this subsystem. - @type handler: class + :type handler: class """ try: self.lock.acquire() @@ -1072,10 +1072,10 @@ class Transport (threading.Thread): """ Return true if this session is active and authenticated. - @return: True if the session is still open and has been authenticated + :return: True if the session is still open and has been authenticated successfully; False if authentication failed and/or the session is closed. - @rtype: bool + :rtype: bool """ return self.active and (self.auth_handler is not None) and self.auth_handler.is_authenticated() @@ -1083,10 +1083,10 @@ class Transport (threading.Thread): """ Return the username this connection is authenticated for. If the session is not authenticated (or authentication failed), this method - returns C{None}. + returns ``None``. - @return: username that was authenticated, or C{None}. - @rtype: string + :return: username that was authenticated, or ``None``. + :rtype: string """ if not self.active or (self.auth_handler is None): return None @@ -1097,20 +1097,20 @@ class Transport (threading.Thread): Try to authenticate to the server using no authentication at all. This will almost always fail. It may be useful for determining the list of authentication types supported by the server, by catching the - L{BadAuthenticationType} exception raised. + :class:`BadAuthenticationType` exception raised. - @param username: the username to authenticate as - @type username: string - @return: list of auth types permissible for the next stage of + :param username: the username to authenticate as + :type username: string + :return: list of auth types permissible for the next stage of authentication (normally empty) - @rtype: list + :rtype: list - @raise BadAuthenticationType: if "none" authentication isn't allowed + :raises BadAuthenticationType: if "none" authentication isn't allowed by the server for this user - @raise SSHException: if the authentication failed due to a network + :raises SSHException: if the authentication failed due to a network error - @since: 1.5 + .. versionadded:: 1.5 """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -1124,16 +1124,16 @@ class Transport (threading.Thread): Authenticate to the server using a password. The username and password are sent over an encrypted link. - If an C{event} is passed in, this method will return immediately, and + If an ``event`` is passed in, this method will return immediately, and the event will be triggered once authentication succeeds or fails. On - success, L{is_authenticated} will return C{True}. On failure, you may - use L{get_exception} to get more detailed error information. + success, :class:`is_authenticated` will return ``True``. On failure, you may + use :class:`get_exception` to get more detailed error information. Since 1.1, if no event is passed, this method will block until the authentication succeeds or fails. On failure, an exception is raised. Otherwise, the method simply returns. - Since 1.5, if no event is passed and C{fallback} is C{True} (the + Since 1.5, if no event is passed and ``fallback`` is ``True`` (the default), if the server doesn't support plain password authentication but does support so-called "keyboard-interactive" mode, an attempt will be made to authenticate using this interactive mode. If it fails, @@ -1146,26 +1146,26 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - @param username: the username to authenticate as - @type username: str - @param password: the password to authenticate with - @type password: str or unicode - @param event: an event to trigger when the authentication attempt is + :param username: the username to authenticate as + :type username: str + :param password: the password to authenticate with + :type password: str or unicode + :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) - @type event: threading.Event - @param fallback: C{True} if an attempt at an automated "interactive" + :type event: threading.Event + :param fallback: ``True`` if an attempt at an automated "interactive" password auth should be made if the server doesn't support normal password auth - @type fallback: bool - @return: list of auth types permissible for the next stage of + :type fallback: bool + :return: list of auth types permissible for the next stage of authentication (normally empty) - @rtype: list + :rtype: list - @raise BadAuthenticationType: if password authentication isn't + :raises BadAuthenticationType: if password authentication isn't allowed by the server for this user (and no event was passed in) - @raise AuthenticationException: if the authentication failed (and no + :raises AuthenticationException: if the authentication failed (and no event was passed in) - @raise SSHException: if there was a network error + :raises SSHException: if there was a network error """ if (not self.active) or (not self.initial_kex_done): # we should never try to send the password unless we're on a secure link @@ -1207,10 +1207,10 @@ class Transport (threading.Thread): Authenticate to the server using a private key. The key is used to sign data from the server, so it must include the private part. - If an C{event} is passed in, this method will return immediately, and + If an ``event`` is passed in, this method will return immediately, and the event will be triggered once authentication succeeds or fails. On - success, L{is_authenticated} will return C{True}. On failure, you may - use L{get_exception} to get more detailed error information. + success, :class:`is_authenticated` will return ``True``. On failure, you may + use :class:`get_exception` to get more detailed error information. Since 1.1, if no event is passed, this method will block until the authentication succeeds or fails. On failure, an exception is raised. @@ -1220,22 +1220,22 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - @param username: the username to authenticate as - @type username: string - @param key: the private key to authenticate with - @type key: L{PKey } - @param event: an event to trigger when the authentication attempt is + :param username: the username to authenticate as + :type username: string + :param key: the private key to authenticate with + :type key: :class:`PKey ` + :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) - @type event: threading.Event - @return: list of auth types permissible for the next stage of + :type event: threading.Event + :return: list of auth types permissible for the next stage of authentication (normally empty) - @rtype: list + :rtype: list - @raise BadAuthenticationType: if public-key authentication isn't + :raises BadAuthenticationType: if public-key authentication isn't allowed by the server for this user (and no event was passed in) - @raise AuthenticationException: if the authentication failed (and no + :raises AuthenticationException: if the authentication failed (and no event was passed in) - @raise SSHException: if there was a network error + :raises SSHException: if there was a network error """ if (not self.active) or (not self.initial_kex_done): # we should never try to authenticate unless we're on a secure link @@ -1263,15 +1263,15 @@ class Transport (threading.Thread): if the server continues to ask questions. The handler is expected to be a callable that will handle calls of the - form: C{handler(title, instructions, prompt_list)}. The C{title} is - meant to be a dialog-window title, and the C{instructions} are user - instructions (both are strings). C{prompt_list} will be a list of - prompts, each prompt being a tuple of C{(str, bool)}. The string is + form: ``handler(title, instructions, prompt_list)``. The ``title`` is + meant to be a dialog-window title, and the ``instructions`` are user + instructions (both are strings). ``prompt_list`` will be a list of + prompts, each prompt being a tuple of ``(str, bool)``. The string is the prompt and the boolean indicates whether the user text should be echoed. A sample call would thus be: - C{handler('title', 'instructions', [('Password:', False)])}. + ``handler('title', 'instructions', [('Password:', False)])``. The handler should return a list or tuple of answers to the server's questions. @@ -1280,22 +1280,22 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - @param username: the username to authenticate as - @type username: string - @param handler: a handler for responding to server questions - @type handler: callable - @param submethods: a string list of desired submethods (optional) - @type submethods: str - @return: list of auth types permissible for the next stage of + :param username: the username to authenticate as + :type username: string + :param handler: a handler for responding to server questions + :type handler: callable + :param submethods: a string list of desired submethods (optional) + :type submethods: str + :return: list of auth types permissible for the next stage of authentication (normally empty). - @rtype: list + :rtype: list - @raise BadAuthenticationType: if public-key authentication isn't + :raises BadAuthenticationType: if public-key authentication isn't allowed by the server for this user - @raise AuthenticationException: if the authentication failed - @raise SSHException: if there was a network error + :raises AuthenticationException: if the authentication failed + :raises SSHException: if there was a network error - @since: 1.5 + .. versionadded:: 1.5 """ if (not self.active) or (not self.initial_kex_done): # we should never try to authenticate unless we're on a secure link @@ -1308,14 +1308,14 @@ class Transport (threading.Thread): def set_log_channel(self, name): """ Set the channel for this transport's logging. The default is - C{"paramiko.transport"} but it can be set to anything you want. - (See the C{logging} module for more info.) SSH Channels will log + ``"paramiko.transport"`` but it can be set to anything you want. + (See the ``logging`` module for more info.) SSH Channels will log to a sub-channel of the one specified. - @param name: new channel name for logging - @type name: str + :param name: new channel name for logging + :type name: str - @since: 1.1 + .. versionadded:: 1.1 """ self.log_name = name self.logger = util.get_logger(name) @@ -1325,10 +1325,10 @@ class Transport (threading.Thread): """ Return the channel name used for this transport's logging. - @return: channel name. - @rtype: str + :return: channel name. + :rtype: str - @since: 1.2 + .. versionadded:: 1.2 """ return self.log_name @@ -1338,35 +1338,35 @@ class Transport (threading.Thread): the logs. Normally you would want this off (which is the default), but if you are debugging something, it may be useful. - @param hexdump: C{True} to log protocol traffix (in hex) to the log; - C{False} otherwise. - @type hexdump: bool + :param hexdump: ``True`` to log protocol traffix (in hex) to the log; + ``False`` otherwise. + :type hexdump: bool """ self.packetizer.set_hexdump(hexdump) def get_hexdump(self): """ - Return C{True} if the transport is currently logging hex dumps of + Return ``True`` if the transport is currently logging hex dumps of protocol traffic. - @return: C{True} if hex dumps are being logged - @rtype: bool + :return: ``True`` if hex dumps are being logged + :rtype: bool - @since: 1.4 + .. versionadded:: 1.4 """ return self.packetizer.get_hexdump() def use_compression(self, compress=True): """ Turn on/off compression. This will only have an affect before starting - the transport (ie before calling L{connect}, etc). By default, + the transport (ie before calling :class:`connect`, etc). By default, compression is off since it negatively affects interactive sessions. - @param compress: C{True} to ask the remote client/server to compress - traffic; C{False} to refuse compression - @type compress: bool + :param compress: ``True`` to ask the remote client/server to compress + traffic; ``False`` to refuse compression + :type compress: bool - @since: 1.5.2 + .. versionadded:: 1.5.2 """ if compress: self._preferred_compression = ( 'zlib@openssh.com', 'zlib', 'none' ) @@ -1376,12 +1376,12 @@ class Transport (threading.Thread): def getpeername(self): """ Return the address of the remote side of this Transport, if possible. - This is effectively a wrapper around C{'getpeername'} on the underlying - socket. If the socket-like object has no C{'getpeername'} method, - then C{("unknown", 0)} is returned. + This is effectively a wrapper around ``'getpeername'`` on the underlying + socket. If the socket-like object has no ``'getpeername'`` method, + then ``("unknown", 0)`` is returned. - @return: the address if the remote host, if known - @rtype: tuple(str, int) + :return: the address if the remote host, if known + :rtype: tuple(str, int) """ gp = getattr(self.sock, 'getpeername', None) if gp is None: diff --git a/paramiko/util.py b/paramiko/util.py index 85ee6b06..65c16dc5 100644 --- a/paramiko/util.py +++ b/paramiko/util.py @@ -154,17 +154,17 @@ def generate_key_bytes(hashclass, salt, key, nbytes): through a secure hash into some keyworthy bytes. This specific algorithm is used for encrypting/decrypting private key files. - @param hashclass: class from L{Crypto.Hash} that can be used as a secure - hashing function (like C{MD5} or C{SHA}). - @type hashclass: L{Crypto.Hash} - @param salt: data to salt the hash with. - @type salt: string - @param key: human-entered password or passphrase. - @type key: string - @param nbytes: number of bytes to generate. - @type nbytes: int - @return: key data - @rtype: string + :param hashclass: class from :class:`Crypto.Hash` that can be used as a secure + hashing function (like ``MD5`` or ``SHA``). + :type hashclass: :class:`Crypto.Hash` + :param salt: data to salt the hash with. + :type salt: string + :param key: human-entered password or passphrase. + :type key: string + :param nbytes: number of bytes to generate. + :type nbytes: int + :return: key data + :rtype: string """ keydata = '' digest = '' @@ -185,26 +185,26 @@ def generate_key_bytes(hashclass, salt, key, nbytes): def load_host_keys(filename): """ Read a file of known SSH host keys, in the format used by openssh, and - return a compound dict of C{hostname -> keytype ->} L{PKey }. + return a compound dict of ``hostname -> keytype ->`` :class:`PKey `. The hostname may be an IP address or DNS name. The keytype will be either - C{"ssh-rsa"} or C{"ssh-dss"}. + ``"ssh-rsa"`` or ``"ssh-dss"``. This type of file unfortunately doesn't exist on Windows, but on posix, - it will usually be stored in C{os.path.expanduser("~/.ssh/known_hosts")}. + it will usually be stored in ``os.path.expanduser("~/.ssh/known_hosts")``. - Since 1.5.3, this is just a wrapper around L{HostKeys}. + Since 1.5.3, this is just a wrapper around :class:`HostKeys`. - @param filename: name of the file to read host keys from - @type filename: str - @return: dict of host keys, indexed by hostname and then keytype - @rtype: dict(hostname, dict(keytype, L{PKey })) + :param filename: name of the file to read host keys from + :type filename: str + :return: dict of host keys, indexed by hostname and then keytype + :rtype: dict(hostname, dict(keytype, :class:`PKey `)) """ from paramiko.hostkeys import HostKeys return HostKeys(filename) def parse_ssh_config(file_obj): """ - Provided only as a backward-compatible wrapper around L{SSHConfig}. + Provided only as a backward-compatible wrapper around :class:`SSHConfig`. """ config = SSHConfig() config.parse(file_obj) @@ -212,7 +212,7 @@ def parse_ssh_config(file_obj): def lookup_ssh_host_config(hostname, config): """ - Provided only as a backward-compatible wrapper around L{SSHConfig}. + Provided only as a backward-compatible wrapper around :class:`SSHConfig`. """ return config.lookup(hostname) diff --git a/sites/docs/api.rst b/sites/docs/api.rst new file mode 100644 index 00000000..47615709 --- /dev/null +++ b/sites/docs/api.rst @@ -0,0 +1,8 @@ +.. _api: + +API +=== + +.. automodule:: paramiko + :members: + :special-members: diff --git a/sites/docs/conf.py b/sites/docs/conf.py index 0c7ffe55..94267f0a 100644 --- a/sites/docs/conf.py +++ b/sites/docs/conf.py @@ -1,4 +1,7 @@ # Obtain shared config values import os, sys sys.path.append(os.path.abspath('..')) +sys.path.append(os.path.abspath('../..')) from shared_conf import * + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] -- cgit v1.2.3 From b140b29d542e9a0ee1d5c013e3612b8a16ca851b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 12:09:59 -0800 Subject: Hook API doc into index/toctree --- sites/docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 08b34320..7ec5825e 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -4,3 +4,6 @@ Welcome to Paramiko's documentation! This site covers Paramiko's usage & API documentation. For basic info on what Paramiko is, including its public changelog & how the project is maintained, please see `the main website `_. + +.. toctree:: + api -- cgit v1.2.3 From 2346f1a1e937f39343c2805d098b52f6c87f8fc9 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 13:33:22 -0800 Subject: Swap out all-in-one file with sphinx-apidoc generated stuff --- sites/docs/api.rst | 8 -------- sites/docs/api/agent.rst | 7 +++++++ sites/docs/api/auth_handler.rst | 7 +++++++ sites/docs/api/ber.rst | 7 +++++++ sites/docs/api/buffered_pipe.rst | 7 +++++++ sites/docs/api/channel.rst | 7 +++++++ sites/docs/api/client.rst | 7 +++++++ sites/docs/api/common.rst | 7 +++++++ sites/docs/api/compress.rst | 7 +++++++ sites/docs/api/config.rst | 7 +++++++ sites/docs/api/dsskey.rst | 7 +++++++ sites/docs/api/file.rst | 7 +++++++ sites/docs/api/hostkeys.rst | 7 +++++++ sites/docs/api/kex_gex.rst | 7 +++++++ sites/docs/api/kex_group1.rst | 7 +++++++ sites/docs/api/logging22.rst | 7 +++++++ sites/docs/api/message.rst | 7 +++++++ sites/docs/api/packet.rst | 7 +++++++ sites/docs/api/pipe.rst | 7 +++++++ sites/docs/api/pkey.rst | 7 +++++++ sites/docs/api/primes.rst | 7 +++++++ sites/docs/api/proxy.rst | 7 +++++++ sites/docs/api/resource.rst | 7 +++++++ sites/docs/api/rsakey.rst | 7 +++++++ sites/docs/api/server.rst | 7 +++++++ sites/docs/api/sftp.rst | 7 +++++++ sites/docs/api/sftp_attr.rst | 7 +++++++ sites/docs/api/sftp_client.rst | 7 +++++++ sites/docs/api/sftp_file.rst | 7 +++++++ sites/docs/api/sftp_handle.rst | 7 +++++++ sites/docs/api/sftp_server.rst | 7 +++++++ sites/docs/api/sftp_si.rst | 7 +++++++ sites/docs/api/ssh_exception.rst | 7 +++++++ sites/docs/api/transport.rst | 7 +++++++ sites/docs/api/util.rst | 7 +++++++ sites/docs/api/win_pageant.rst | 7 +++++++ sites/docs/index.rst | 4 +++- 37 files changed, 248 insertions(+), 9 deletions(-) delete mode 100644 sites/docs/api.rst create mode 100644 sites/docs/api/agent.rst create mode 100644 sites/docs/api/auth_handler.rst create mode 100644 sites/docs/api/ber.rst create mode 100644 sites/docs/api/buffered_pipe.rst create mode 100644 sites/docs/api/channel.rst create mode 100644 sites/docs/api/client.rst create mode 100644 sites/docs/api/common.rst create mode 100644 sites/docs/api/compress.rst create mode 100644 sites/docs/api/config.rst create mode 100644 sites/docs/api/dsskey.rst create mode 100644 sites/docs/api/file.rst create mode 100644 sites/docs/api/hostkeys.rst create mode 100644 sites/docs/api/kex_gex.rst create mode 100644 sites/docs/api/kex_group1.rst create mode 100644 sites/docs/api/logging22.rst create mode 100644 sites/docs/api/message.rst create mode 100644 sites/docs/api/packet.rst create mode 100644 sites/docs/api/pipe.rst create mode 100644 sites/docs/api/pkey.rst create mode 100644 sites/docs/api/primes.rst create mode 100644 sites/docs/api/proxy.rst create mode 100644 sites/docs/api/resource.rst create mode 100644 sites/docs/api/rsakey.rst create mode 100644 sites/docs/api/server.rst create mode 100644 sites/docs/api/sftp.rst create mode 100644 sites/docs/api/sftp_attr.rst create mode 100644 sites/docs/api/sftp_client.rst create mode 100644 sites/docs/api/sftp_file.rst create mode 100644 sites/docs/api/sftp_handle.rst create mode 100644 sites/docs/api/sftp_server.rst create mode 100644 sites/docs/api/sftp_si.rst create mode 100644 sites/docs/api/ssh_exception.rst create mode 100644 sites/docs/api/transport.rst create mode 100644 sites/docs/api/util.rst create mode 100644 sites/docs/api/win_pageant.rst diff --git a/sites/docs/api.rst b/sites/docs/api.rst deleted file mode 100644 index 47615709..00000000 --- a/sites/docs/api.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _api: - -API -=== - -.. automodule:: paramiko - :members: - :special-members: diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst new file mode 100644 index 00000000..cb966f2b --- /dev/null +++ b/sites/docs/api/agent.rst @@ -0,0 +1,7 @@ +paramiko.agent module +===================== + +.. automodule:: paramiko.agent + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/auth_handler.rst b/sites/docs/api/auth_handler.rst new file mode 100644 index 00000000..c35f5b66 --- /dev/null +++ b/sites/docs/api/auth_handler.rst @@ -0,0 +1,7 @@ +paramiko.auth_handler module +============================ + +.. automodule:: paramiko.auth_handler + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/ber.rst b/sites/docs/api/ber.rst new file mode 100644 index 00000000..3627528f --- /dev/null +++ b/sites/docs/api/ber.rst @@ -0,0 +1,7 @@ +paramiko.ber module +=================== + +.. automodule:: paramiko.ber + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/buffered_pipe.rst b/sites/docs/api/buffered_pipe.rst new file mode 100644 index 00000000..57411fc7 --- /dev/null +++ b/sites/docs/api/buffered_pipe.rst @@ -0,0 +1,7 @@ +paramiko.buffered_pipe module +============================= + +.. automodule:: paramiko.buffered_pipe + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/channel.rst b/sites/docs/api/channel.rst new file mode 100644 index 00000000..85848484 --- /dev/null +++ b/sites/docs/api/channel.rst @@ -0,0 +1,7 @@ +paramiko.channel module +======================= + +.. automodule:: paramiko.channel + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/client.rst b/sites/docs/api/client.rst new file mode 100644 index 00000000..50171371 --- /dev/null +++ b/sites/docs/api/client.rst @@ -0,0 +1,7 @@ +paramiko.client module +====================== + +.. automodule:: paramiko.client + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/common.rst b/sites/docs/api/common.rst new file mode 100644 index 00000000..0abcf986 --- /dev/null +++ b/sites/docs/api/common.rst @@ -0,0 +1,7 @@ +paramiko.common module +====================== + +.. automodule:: paramiko.common + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/compress.rst b/sites/docs/api/compress.rst new file mode 100644 index 00000000..9089efbd --- /dev/null +++ b/sites/docs/api/compress.rst @@ -0,0 +1,7 @@ +paramiko.compress module +======================== + +.. automodule:: paramiko.compress + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst new file mode 100644 index 00000000..fb587953 --- /dev/null +++ b/sites/docs/api/config.rst @@ -0,0 +1,7 @@ +paramiko.config module +====================== + +.. automodule:: paramiko.config + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/dsskey.rst b/sites/docs/api/dsskey.rst new file mode 100644 index 00000000..67fbd84e --- /dev/null +++ b/sites/docs/api/dsskey.rst @@ -0,0 +1,7 @@ +paramiko.dsskey module +====================== + +.. automodule:: paramiko.dsskey + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/file.rst b/sites/docs/api/file.rst new file mode 100644 index 00000000..044ceab0 --- /dev/null +++ b/sites/docs/api/file.rst @@ -0,0 +1,7 @@ +paramiko.file module +==================== + +.. automodule:: paramiko.file + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst new file mode 100644 index 00000000..0428fa92 --- /dev/null +++ b/sites/docs/api/hostkeys.rst @@ -0,0 +1,7 @@ +paramiko.hostkeys module +======================== + +.. automodule:: paramiko.hostkeys + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/kex_gex.rst b/sites/docs/api/kex_gex.rst new file mode 100644 index 00000000..749853b3 --- /dev/null +++ b/sites/docs/api/kex_gex.rst @@ -0,0 +1,7 @@ +paramiko.kex_gex module +======================= + +.. automodule:: paramiko.kex_gex + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/kex_group1.rst b/sites/docs/api/kex_group1.rst new file mode 100644 index 00000000..8bef58d0 --- /dev/null +++ b/sites/docs/api/kex_group1.rst @@ -0,0 +1,7 @@ +paramiko.kex_group1 module +========================== + +.. automodule:: paramiko.kex_group1 + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/logging22.rst b/sites/docs/api/logging22.rst new file mode 100644 index 00000000..55c17882 --- /dev/null +++ b/sites/docs/api/logging22.rst @@ -0,0 +1,7 @@ +paramiko.logging22 module +========================= + +.. automodule:: paramiko.logging22 + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/message.rst b/sites/docs/api/message.rst new file mode 100644 index 00000000..4f7b5838 --- /dev/null +++ b/sites/docs/api/message.rst @@ -0,0 +1,7 @@ +paramiko.message module +======================= + +.. automodule:: paramiko.message + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/packet.rst b/sites/docs/api/packet.rst new file mode 100644 index 00000000..6a127d7a --- /dev/null +++ b/sites/docs/api/packet.rst @@ -0,0 +1,7 @@ +paramiko.packet module +====================== + +.. automodule:: paramiko.packet + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/pipe.rst b/sites/docs/api/pipe.rst new file mode 100644 index 00000000..5ec75fa5 --- /dev/null +++ b/sites/docs/api/pipe.rst @@ -0,0 +1,7 @@ +paramiko.pipe module +==================== + +.. automodule:: paramiko.pipe + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/pkey.rst b/sites/docs/api/pkey.rst new file mode 100644 index 00000000..fb75e664 --- /dev/null +++ b/sites/docs/api/pkey.rst @@ -0,0 +1,7 @@ +paramiko.pkey module +==================== + +.. automodule:: paramiko.pkey + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/primes.rst b/sites/docs/api/primes.rst new file mode 100644 index 00000000..8dfe2a47 --- /dev/null +++ b/sites/docs/api/primes.rst @@ -0,0 +1,7 @@ +paramiko.primes module +====================== + +.. automodule:: paramiko.primes + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/proxy.rst b/sites/docs/api/proxy.rst new file mode 100644 index 00000000..5a0f5aff --- /dev/null +++ b/sites/docs/api/proxy.rst @@ -0,0 +1,7 @@ +paramiko.proxy module +===================== + +.. automodule:: paramiko.proxy + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/resource.rst b/sites/docs/api/resource.rst new file mode 100644 index 00000000..a4527ab1 --- /dev/null +++ b/sites/docs/api/resource.rst @@ -0,0 +1,7 @@ +paramiko.resource module +======================== + +.. automodule:: paramiko.resource + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/rsakey.rst b/sites/docs/api/rsakey.rst new file mode 100644 index 00000000..7ad995ce --- /dev/null +++ b/sites/docs/api/rsakey.rst @@ -0,0 +1,7 @@ +paramiko.rsakey module +====================== + +.. automodule:: paramiko.rsakey + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/server.rst b/sites/docs/api/server.rst new file mode 100644 index 00000000..3821c9be --- /dev/null +++ b/sites/docs/api/server.rst @@ -0,0 +1,7 @@ +paramiko.server module +====================== + +.. automodule:: paramiko.server + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp.rst b/sites/docs/api/sftp.rst new file mode 100644 index 00000000..1d65900a --- /dev/null +++ b/sites/docs/api/sftp.rst @@ -0,0 +1,7 @@ +paramiko.sftp module +==================== + +.. automodule:: paramiko.sftp + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp_attr.rst b/sites/docs/api/sftp_attr.rst new file mode 100644 index 00000000..114748c6 --- /dev/null +++ b/sites/docs/api/sftp_attr.rst @@ -0,0 +1,7 @@ +paramiko.sftp_attr module +========================= + +.. automodule:: paramiko.sftp_attr + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp_client.rst b/sites/docs/api/sftp_client.rst new file mode 100644 index 00000000..ee973df2 --- /dev/null +++ b/sites/docs/api/sftp_client.rst @@ -0,0 +1,7 @@ +paramiko.sftp_client module +=========================== + +.. automodule:: paramiko.sftp_client + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp_file.rst b/sites/docs/api/sftp_file.rst new file mode 100644 index 00000000..77756807 --- /dev/null +++ b/sites/docs/api/sftp_file.rst @@ -0,0 +1,7 @@ +paramiko.sftp_file module +========================= + +.. automodule:: paramiko.sftp_file + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp_handle.rst b/sites/docs/api/sftp_handle.rst new file mode 100644 index 00000000..0f563b16 --- /dev/null +++ b/sites/docs/api/sftp_handle.rst @@ -0,0 +1,7 @@ +paramiko.sftp_handle module +=========================== + +.. automodule:: paramiko.sftp_handle + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp_server.rst b/sites/docs/api/sftp_server.rst new file mode 100644 index 00000000..50e84b18 --- /dev/null +++ b/sites/docs/api/sftp_server.rst @@ -0,0 +1,7 @@ +paramiko.sftp_server module +=========================== + +.. automodule:: paramiko.sftp_server + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/sftp_si.rst b/sites/docs/api/sftp_si.rst new file mode 100644 index 00000000..e369d879 --- /dev/null +++ b/sites/docs/api/sftp_si.rst @@ -0,0 +1,7 @@ +paramiko.sftp_si module +======================= + +.. automodule:: paramiko.sftp_si + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/ssh_exception.rst b/sites/docs/api/ssh_exception.rst new file mode 100644 index 00000000..a4b6d2aa --- /dev/null +++ b/sites/docs/api/ssh_exception.rst @@ -0,0 +1,7 @@ +paramiko.ssh_exception module +============================= + +.. automodule:: paramiko.ssh_exception + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst new file mode 100644 index 00000000..19fb0e88 --- /dev/null +++ b/sites/docs/api/transport.rst @@ -0,0 +1,7 @@ +paramiko.transport module +========================= + +.. automodule:: paramiko.transport + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/util.rst b/sites/docs/api/util.rst new file mode 100644 index 00000000..ae3eae0f --- /dev/null +++ b/sites/docs/api/util.rst @@ -0,0 +1,7 @@ +paramiko.util module +==================== + +.. automodule:: paramiko.util + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/api/win_pageant.rst b/sites/docs/api/win_pageant.rst new file mode 100644 index 00000000..561a5143 --- /dev/null +++ b/sites/docs/api/win_pageant.rst @@ -0,0 +1,7 @@ +paramiko.win_pageant module +=========================== + +.. automodule:: paramiko.win_pageant + :members: + :undoc-members: + :show-inheritance: diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 7ec5825e..89c75831 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -6,4 +6,6 @@ Paramiko is, including its public changelog & how the project is maintained, please see `the main website `_. .. toctree:: - api + :glob: + + api/* -- cgit v1.2.3 From 4a98671bf67c3df92b9b60640480828053cda0eb Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 13:33:36 -0800 Subject: Tweak conf.py in prep for less boilerplatey versions of module files --- sites/docs/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sites/docs/conf.py b/sites/docs/conf.py index 94267f0a..c0f51f76 100644 --- a/sites/docs/conf.py +++ b/sites/docs/conf.py @@ -4,4 +4,8 @@ sys.path.append(os.path.abspath('..')) sys.path.append(os.path.abspath('../..')) from shared_conf import * -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] +# Enable autodoc, intersphinx +extensions.extend(['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']) + +# Autodoc settings +autodoc_default_flags = ['members', 'special-members'] -- cgit v1.2.3 From 95b5fd22559e3e24e125471a99962601b490b965 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 15:48:39 -0800 Subject: Remove autodoc boilerplate flags from automodule directives --- sites/docs/api/agent.rst | 3 --- sites/docs/api/auth_handler.rst | 3 --- sites/docs/api/ber.rst | 3 --- sites/docs/api/buffered_pipe.rst | 3 --- sites/docs/api/channel.rst | 3 --- sites/docs/api/client.rst | 3 --- sites/docs/api/common.rst | 3 --- sites/docs/api/compress.rst | 3 --- sites/docs/api/config.rst | 3 --- sites/docs/api/dsskey.rst | 3 --- sites/docs/api/file.rst | 3 --- sites/docs/api/hostkeys.rst | 3 --- sites/docs/api/kex_gex.rst | 3 --- sites/docs/api/kex_group1.rst | 3 --- sites/docs/api/logging22.rst | 3 --- sites/docs/api/message.rst | 3 --- sites/docs/api/packet.rst | 3 --- sites/docs/api/pipe.rst | 3 --- sites/docs/api/pkey.rst | 3 --- sites/docs/api/primes.rst | 3 --- sites/docs/api/proxy.rst | 3 --- sites/docs/api/resource.rst | 3 --- sites/docs/api/rsakey.rst | 3 --- sites/docs/api/server.rst | 3 --- sites/docs/api/sftp.rst | 3 --- sites/docs/api/sftp_attr.rst | 3 --- sites/docs/api/sftp_client.rst | 3 --- sites/docs/api/sftp_file.rst | 3 --- sites/docs/api/sftp_handle.rst | 3 --- sites/docs/api/sftp_server.rst | 3 --- sites/docs/api/sftp_si.rst | 3 --- sites/docs/api/ssh_exception.rst | 3 --- sites/docs/api/transport.rst | 3 --- sites/docs/api/util.rst | 3 --- sites/docs/api/win_pageant.rst | 3 --- 35 files changed, 105 deletions(-) diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst index cb966f2b..26d9c97a 100644 --- a/sites/docs/api/agent.rst +++ b/sites/docs/api/agent.rst @@ -2,6 +2,3 @@ paramiko.agent module ===================== .. automodule:: paramiko.agent - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/auth_handler.rst b/sites/docs/api/auth_handler.rst index c35f5b66..0fdb490f 100644 --- a/sites/docs/api/auth_handler.rst +++ b/sites/docs/api/auth_handler.rst @@ -2,6 +2,3 @@ paramiko.auth_handler module ============================ .. automodule:: paramiko.auth_handler - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/ber.rst b/sites/docs/api/ber.rst index 3627528f..20ab604e 100644 --- a/sites/docs/api/ber.rst +++ b/sites/docs/api/ber.rst @@ -2,6 +2,3 @@ paramiko.ber module =================== .. automodule:: paramiko.ber - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/buffered_pipe.rst b/sites/docs/api/buffered_pipe.rst index 57411fc7..a8cdb581 100644 --- a/sites/docs/api/buffered_pipe.rst +++ b/sites/docs/api/buffered_pipe.rst @@ -2,6 +2,3 @@ paramiko.buffered_pipe module ============================= .. automodule:: paramiko.buffered_pipe - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/channel.rst b/sites/docs/api/channel.rst index 85848484..db8280b5 100644 --- a/sites/docs/api/channel.rst +++ b/sites/docs/api/channel.rst @@ -2,6 +2,3 @@ paramiko.channel module ======================= .. automodule:: paramiko.channel - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/client.rst b/sites/docs/api/client.rst index 50171371..840ffec8 100644 --- a/sites/docs/api/client.rst +++ b/sites/docs/api/client.rst @@ -2,6 +2,3 @@ paramiko.client module ====================== .. automodule:: paramiko.client - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/common.rst b/sites/docs/api/common.rst index 0abcf986..fb99f218 100644 --- a/sites/docs/api/common.rst +++ b/sites/docs/api/common.rst @@ -2,6 +2,3 @@ paramiko.common module ====================== .. automodule:: paramiko.common - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/compress.rst b/sites/docs/api/compress.rst index 9089efbd..93e04231 100644 --- a/sites/docs/api/compress.rst +++ b/sites/docs/api/compress.rst @@ -2,6 +2,3 @@ paramiko.compress module ======================== .. automodule:: paramiko.compress - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst index fb587953..dc030b48 100644 --- a/sites/docs/api/config.rst +++ b/sites/docs/api/config.rst @@ -2,6 +2,3 @@ paramiko.config module ====================== .. automodule:: paramiko.config - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/dsskey.rst b/sites/docs/api/dsskey.rst index 67fbd84e..c4d8d652 100644 --- a/sites/docs/api/dsskey.rst +++ b/sites/docs/api/dsskey.rst @@ -2,6 +2,3 @@ paramiko.dsskey module ====================== .. automodule:: paramiko.dsskey - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/file.rst b/sites/docs/api/file.rst index 044ceab0..d16c834f 100644 --- a/sites/docs/api/file.rst +++ b/sites/docs/api/file.rst @@ -2,6 +2,3 @@ paramiko.file module ==================== .. automodule:: paramiko.file - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst index 0428fa92..5379a369 100644 --- a/sites/docs/api/hostkeys.rst +++ b/sites/docs/api/hostkeys.rst @@ -2,6 +2,3 @@ paramiko.hostkeys module ======================== .. automodule:: paramiko.hostkeys - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/kex_gex.rst b/sites/docs/api/kex_gex.rst index 749853b3..9b5ff543 100644 --- a/sites/docs/api/kex_gex.rst +++ b/sites/docs/api/kex_gex.rst @@ -2,6 +2,3 @@ paramiko.kex_gex module ======================= .. automodule:: paramiko.kex_gex - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/kex_group1.rst b/sites/docs/api/kex_group1.rst index 8bef58d0..47089326 100644 --- a/sites/docs/api/kex_group1.rst +++ b/sites/docs/api/kex_group1.rst @@ -2,6 +2,3 @@ paramiko.kex_group1 module ========================== .. automodule:: paramiko.kex_group1 - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/logging22.rst b/sites/docs/api/logging22.rst index 55c17882..fad43489 100644 --- a/sites/docs/api/logging22.rst +++ b/sites/docs/api/logging22.rst @@ -2,6 +2,3 @@ paramiko.logging22 module ========================= .. automodule:: paramiko.logging22 - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/message.rst b/sites/docs/api/message.rst index 4f7b5838..e660ef89 100644 --- a/sites/docs/api/message.rst +++ b/sites/docs/api/message.rst @@ -2,6 +2,3 @@ paramiko.message module ======================= .. automodule:: paramiko.message - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/packet.rst b/sites/docs/api/packet.rst index 6a127d7a..ab7c6b45 100644 --- a/sites/docs/api/packet.rst +++ b/sites/docs/api/packet.rst @@ -2,6 +2,3 @@ paramiko.packet module ====================== .. automodule:: paramiko.packet - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/pipe.rst b/sites/docs/api/pipe.rst index 5ec75fa5..220dbc87 100644 --- a/sites/docs/api/pipe.rst +++ b/sites/docs/api/pipe.rst @@ -2,6 +2,3 @@ paramiko.pipe module ==================== .. automodule:: paramiko.pipe - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/pkey.rst b/sites/docs/api/pkey.rst index fb75e664..418736b7 100644 --- a/sites/docs/api/pkey.rst +++ b/sites/docs/api/pkey.rst @@ -2,6 +2,3 @@ paramiko.pkey module ==================== .. automodule:: paramiko.pkey - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/primes.rst b/sites/docs/api/primes.rst index 8dfe2a47..4d7a1f58 100644 --- a/sites/docs/api/primes.rst +++ b/sites/docs/api/primes.rst @@ -2,6 +2,3 @@ paramiko.primes module ====================== .. automodule:: paramiko.primes - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/proxy.rst b/sites/docs/api/proxy.rst index 5a0f5aff..e3cf59ca 100644 --- a/sites/docs/api/proxy.rst +++ b/sites/docs/api/proxy.rst @@ -2,6 +2,3 @@ paramiko.proxy module ===================== .. automodule:: paramiko.proxy - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/resource.rst b/sites/docs/api/resource.rst index a4527ab1..c4c548f4 100644 --- a/sites/docs/api/resource.rst +++ b/sites/docs/api/resource.rst @@ -2,6 +2,3 @@ paramiko.resource module ======================== .. automodule:: paramiko.resource - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/rsakey.rst b/sites/docs/api/rsakey.rst index 7ad995ce..77dbd894 100644 --- a/sites/docs/api/rsakey.rst +++ b/sites/docs/api/rsakey.rst @@ -2,6 +2,3 @@ paramiko.rsakey module ====================== .. automodule:: paramiko.rsakey - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/server.rst b/sites/docs/api/server.rst index 3821c9be..f59b1216 100644 --- a/sites/docs/api/server.rst +++ b/sites/docs/api/server.rst @@ -2,6 +2,3 @@ paramiko.server module ====================== .. automodule:: paramiko.server - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp.rst b/sites/docs/api/sftp.rst index 1d65900a..731c2521 100644 --- a/sites/docs/api/sftp.rst +++ b/sites/docs/api/sftp.rst @@ -2,6 +2,3 @@ paramiko.sftp module ==================== .. automodule:: paramiko.sftp - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp_attr.rst b/sites/docs/api/sftp_attr.rst index 114748c6..98bce03a 100644 --- a/sites/docs/api/sftp_attr.rst +++ b/sites/docs/api/sftp_attr.rst @@ -2,6 +2,3 @@ paramiko.sftp_attr module ========================= .. automodule:: paramiko.sftp_attr - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp_client.rst b/sites/docs/api/sftp_client.rst index ee973df2..9892befe 100644 --- a/sites/docs/api/sftp_client.rst +++ b/sites/docs/api/sftp_client.rst @@ -2,6 +2,3 @@ paramiko.sftp_client module =========================== .. automodule:: paramiko.sftp_client - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp_file.rst b/sites/docs/api/sftp_file.rst index 77756807..7df6e12b 100644 --- a/sites/docs/api/sftp_file.rst +++ b/sites/docs/api/sftp_file.rst @@ -2,6 +2,3 @@ paramiko.sftp_file module ========================= .. automodule:: paramiko.sftp_file - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp_handle.rst b/sites/docs/api/sftp_handle.rst index 0f563b16..1d1c30ed 100644 --- a/sites/docs/api/sftp_handle.rst +++ b/sites/docs/api/sftp_handle.rst @@ -2,6 +2,3 @@ paramiko.sftp_handle module =========================== .. automodule:: paramiko.sftp_handle - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp_server.rst b/sites/docs/api/sftp_server.rst index 50e84b18..82a6976e 100644 --- a/sites/docs/api/sftp_server.rst +++ b/sites/docs/api/sftp_server.rst @@ -2,6 +2,3 @@ paramiko.sftp_server module =========================== .. automodule:: paramiko.sftp_server - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/sftp_si.rst b/sites/docs/api/sftp_si.rst index e369d879..d071e61a 100644 --- a/sites/docs/api/sftp_si.rst +++ b/sites/docs/api/sftp_si.rst @@ -2,6 +2,3 @@ paramiko.sftp_si module ======================= .. automodule:: paramiko.sftp_si - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/ssh_exception.rst b/sites/docs/api/ssh_exception.rst index a4b6d2aa..7faaf5f4 100644 --- a/sites/docs/api/ssh_exception.rst +++ b/sites/docs/api/ssh_exception.rst @@ -2,6 +2,3 @@ paramiko.ssh_exception module ============================= .. automodule:: paramiko.ssh_exception - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst index 19fb0e88..6f5b1cd9 100644 --- a/sites/docs/api/transport.rst +++ b/sites/docs/api/transport.rst @@ -2,6 +2,3 @@ paramiko.transport module ========================= .. automodule:: paramiko.transport - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/util.rst b/sites/docs/api/util.rst index ae3eae0f..de383ae1 100644 --- a/sites/docs/api/util.rst +++ b/sites/docs/api/util.rst @@ -2,6 +2,3 @@ paramiko.util module ==================== .. automodule:: paramiko.util - :members: - :undoc-members: - :show-inheritance: diff --git a/sites/docs/api/win_pageant.rst b/sites/docs/api/win_pageant.rst index 561a5143..9b488080 100644 --- a/sites/docs/api/win_pageant.rst +++ b/sites/docs/api/win_pageant.rst @@ -2,6 +2,3 @@ paramiko.win_pageant module =========================== .. automodule:: paramiko.win_pageant - :members: - :undoc-members: - :show-inheritance: -- cgit v1.2.3 From 3b0df60b6ae6453e7248f75625cc0d1ccc5b905b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 16:49:29 -0800 Subject: This handily explains why everything was really confusing in autodoc --- paramiko/__init__.py | 7 ------- 1 file changed, 7 deletions(-) diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 99123858..4bf0c7e6 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -86,13 +86,6 @@ from hostkeys import HostKeys from config import SSHConfig from proxy import ProxyCommand -# fix module names for epydoc -for c in locals().values(): - if issubclass(type(c), type) or type(c).__name__ == 'classobj': - # classobj for exceptions :/ - c.__module__ = __name__ -del c - from common import AUTH_SUCCESSFUL, AUTH_PARTIALLY_SUCCESSFUL, AUTH_FAILED, \ OPEN_SUCCEEDED, OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED, OPEN_FAILED_CONNECT_FAILED, \ OPEN_FAILED_UNKNOWN_CHANNEL_TYPE, OPEN_FAILED_RESOURCE_SHORTAGE -- cgit v1.2.3 From e0ff365388702492b83816a42cc6e692cd15c542 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 16:50:16 -0800 Subject: Agent title --- sites/docs/api/agent.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst index 26d9c97a..74edc184 100644 --- a/sites/docs/api/agent.rst +++ b/sites/docs/api/agent.rst @@ -1,4 +1,4 @@ -paramiko.agent module -===================== +Agent +===== .. automodule:: paramiko.agent -- cgit v1.2.3 From 70218ff852370e78e85425c22c100895f805c5a3 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 16:50:32 -0800 Subject: Auth handler is purely internal and has no docstrings --- sites/docs/api/auth_handler.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 sites/docs/api/auth_handler.rst diff --git a/sites/docs/api/auth_handler.rst b/sites/docs/api/auth_handler.rst deleted file mode 100644 index 0fdb490f..00000000 --- a/sites/docs/api/auth_handler.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.auth_handler module -============================ - -.. automodule:: paramiko.auth_handler -- cgit v1.2.3 From f855937d10857a39c63783b610a2838e2fa8400d Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 16:50:56 -0800 Subject: Ditto for BER --- sites/docs/api/ber.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 sites/docs/api/ber.rst diff --git a/sites/docs/api/ber.rst b/sites/docs/api/ber.rst deleted file mode 100644 index 20ab604e..00000000 --- a/sites/docs/api/ber.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.ber module -=================== - -.. automodule:: paramiko.ber -- cgit v1.2.3 From 34243a4aa28192c30e80a7d61271623d397deb86 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 16:51:59 -0800 Subject: Buffered pipe --- sites/docs/api/buffered_pipe.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/docs/api/buffered_pipe.rst b/sites/docs/api/buffered_pipe.rst index a8cdb581..54d87c59 100644 --- a/sites/docs/api/buffered_pipe.rst +++ b/sites/docs/api/buffered_pipe.rst @@ -1,4 +1,4 @@ -paramiko.buffered_pipe module -============================= +Buffered pipes +============== .. automodule:: paramiko.buffered_pipe -- cgit v1.2.3 From 6ff6e149789cbb8fb9a7791e601737044b931716 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 16:54:50 -0800 Subject: Moar headers. Going with plural where appropriate. --- sites/docs/api/agent.rst | 4 ++-- sites/docs/api/channel.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst index 74edc184..789f7b1d 100644 --- a/sites/docs/api/agent.rst +++ b/sites/docs/api/agent.rst @@ -1,4 +1,4 @@ -Agent -===== +SSH Agents +========== .. automodule:: paramiko.agent diff --git a/sites/docs/api/channel.rst b/sites/docs/api/channel.rst index db8280b5..3edb8ac7 100644 --- a/sites/docs/api/channel.rst +++ b/sites/docs/api/channel.rst @@ -1,4 +1,4 @@ -paramiko.channel module -======================= +Channels +======== .. automodule:: paramiko.channel -- cgit v1.2.3 From ef9c0a655ad08d74747281499081d0b8c92c936f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:02:13 -0800 Subject: Common module has no interesting docs in it Also no clear way to auto-display all data members versus using a bunch of awful explicit autodata:: directives. Can dig later if anybody cares. --- sites/docs/api/common.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 sites/docs/api/common.rst diff --git a/sites/docs/api/common.rst b/sites/docs/api/common.rst deleted file mode 100644 index fb99f218..00000000 --- a/sites/docs/api/common.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.common module -====================== - -.. automodule:: paramiko.common -- cgit v1.2.3 From a67142b1cae4fb04fc99df706b8b9b92337ee88f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:03:02 -0800 Subject: Moar header --- sites/docs/api/client.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/docs/api/client.rst b/sites/docs/api/client.rst index 840ffec8..a0784d09 100644 --- a/sites/docs/api/client.rst +++ b/sites/docs/api/client.rst @@ -1,4 +1,4 @@ -paramiko.client module -====================== +Clients +======= .. automodule:: paramiko.client -- cgit v1.2.3 From 6d412b06a16a12169f0f71927fbef11638242700 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:03:12 -0800 Subject: Another undocumented/internal module --- sites/docs/api/compress.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 sites/docs/api/compress.rst diff --git a/sites/docs/api/compress.rst b/sites/docs/api/compress.rst deleted file mode 100644 index 93e04231..00000000 --- a/sites/docs/api/compress.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.compress module -======================== - -.. automodule:: paramiko.compress -- cgit v1.2.3 From 48adf5c646c8a2fe86a6670f54a434533814ab89 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:05:05 -0800 Subject: Consolidate rsa/dss keys into one doc module --- sites/docs/api/dsskey.rst | 4 ---- sites/docs/api/keys.rst | 5 +++++ sites/docs/api/rsakey.rst | 4 ---- 3 files changed, 5 insertions(+), 8 deletions(-) delete mode 100644 sites/docs/api/dsskey.rst create mode 100644 sites/docs/api/keys.rst delete mode 100644 sites/docs/api/rsakey.rst diff --git a/sites/docs/api/dsskey.rst b/sites/docs/api/dsskey.rst deleted file mode 100644 index c4d8d652..00000000 --- a/sites/docs/api/dsskey.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.dsskey module -====================== - -.. automodule:: paramiko.dsskey diff --git a/sites/docs/api/keys.rst b/sites/docs/api/keys.rst new file mode 100644 index 00000000..ca09a878 --- /dev/null +++ b/sites/docs/api/keys.rst @@ -0,0 +1,5 @@ +Key handling +============ + +.. automodule:: paramiko.dsskey +.. automodule:: paramiko.rsakey diff --git a/sites/docs/api/rsakey.rst b/sites/docs/api/rsakey.rst deleted file mode 100644 index 77dbd894..00000000 --- a/sites/docs/api/rsakey.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.rsakey module -====================== - -.. automodule:: paramiko.rsakey -- cgit v1.2.3 From 370af8979145ef09dbf606677d1d4d7f61b67281 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:05:09 -0800 Subject: Header --- sites/docs/api/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst index dc030b48..0a9fa1dc 100644 --- a/sites/docs/api/config.rst +++ b/sites/docs/api/config.rst @@ -1,4 +1,4 @@ -paramiko.config module +Configuration handling ====================== .. automodule:: paramiko.config -- cgit v1.2.3 From 960b3c038da0b41d956a1e31a18827533b153ed8 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:08:30 -0800 Subject: More undocumented/internal modules --- sites/docs/api/kex_gex.rst | 4 ---- sites/docs/api/kex_group1.rst | 4 ---- 2 files changed, 8 deletions(-) delete mode 100644 sites/docs/api/kex_gex.rst delete mode 100644 sites/docs/api/kex_group1.rst diff --git a/sites/docs/api/kex_gex.rst b/sites/docs/api/kex_gex.rst deleted file mode 100644 index 9b5ff543..00000000 --- a/sites/docs/api/kex_gex.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.kex_gex module -======================= - -.. automodule:: paramiko.kex_gex diff --git a/sites/docs/api/kex_group1.rst b/sites/docs/api/kex_group1.rst deleted file mode 100644 index 47089326..00000000 --- a/sites/docs/api/kex_group1.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.kex_group1 module -========================== - -.. automodule:: paramiko.kex_group1 -- cgit v1.2.3 From da6d00dcb7f20ed0c37dcb94add875bd3c1c40d7 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:08:36 -0800 Subject: More headers --- sites/docs/api/file.rst | 4 ++-- sites/docs/api/hostkeys.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sites/docs/api/file.rst b/sites/docs/api/file.rst index d16c834f..199f3ecc 100644 --- a/sites/docs/api/file.rst +++ b/sites/docs/api/file.rst @@ -1,4 +1,4 @@ -paramiko.file module -==================== +Buffered files +============== .. automodule:: paramiko.file diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst index 5379a369..b57a2c6c 100644 --- a/sites/docs/api/hostkeys.rst +++ b/sites/docs/api/hostkeys.rst @@ -1,4 +1,4 @@ -paramiko.hostkeys module -======================== +Host key / known_hosts handling +=============================== .. automodule:: paramiko.hostkeys -- cgit v1.2.3 From b9d25a30b6e1f2691c5e716694d26fcfd4798502 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:08:59 -0800 Subject: LOL no --- sites/docs/api/logging22.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 sites/docs/api/logging22.rst diff --git a/sites/docs/api/logging22.rst b/sites/docs/api/logging22.rst deleted file mode 100644 index fad43489..00000000 --- a/sites/docs/api/logging22.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.logging22 module -========================= - -.. automodule:: paramiko.logging22 -- cgit v1.2.3 From ac63ed58a14dacf508b00a1df787cb41ed8b65dc Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:11:51 -0800 Subject: Missed one re: keys modules --- sites/docs/api/keys.rst | 1 + sites/docs/api/pkey.rst | 4 ---- 2 files changed, 1 insertion(+), 4 deletions(-) delete mode 100644 sites/docs/api/pkey.rst diff --git a/sites/docs/api/keys.rst b/sites/docs/api/keys.rst index ca09a878..af7b58c4 100644 --- a/sites/docs/api/keys.rst +++ b/sites/docs/api/keys.rst @@ -1,5 +1,6 @@ Key handling ============ +.. automodule:: paramiko.pkey .. automodule:: paramiko.dsskey .. automodule:: paramiko.rsakey diff --git a/sites/docs/api/pkey.rst b/sites/docs/api/pkey.rst deleted file mode 100644 index 418736b7..00000000 --- a/sites/docs/api/pkey.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.pkey module -==================== - -.. automodule:: paramiko.pkey -- cgit v1.2.3 From 29433436657381058a7da13aa8dcad2e27634a52 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:12:00 -0800 Subject: Yup. Headers. --- sites/docs/api/message.rst | 4 ++-- sites/docs/api/packet.rst | 4 ++-- sites/docs/api/pipe.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sites/docs/api/message.rst b/sites/docs/api/message.rst index e660ef89..986548b5 100644 --- a/sites/docs/api/message.rst +++ b/sites/docs/api/message.rst @@ -1,4 +1,4 @@ -paramiko.message module -======================= +Protocol messages +================= .. automodule:: paramiko.message diff --git a/sites/docs/api/packet.rst b/sites/docs/api/packet.rst index ab7c6b45..72ad5591 100644 --- a/sites/docs/api/packet.rst +++ b/sites/docs/api/packet.rst @@ -1,4 +1,4 @@ -paramiko.packet module -====================== +Packet handling +=============== .. automodule:: paramiko.packet diff --git a/sites/docs/api/pipe.rst b/sites/docs/api/pipe.rst index 220dbc87..e480446f 100644 --- a/sites/docs/api/pipe.rst +++ b/sites/docs/api/pipe.rst @@ -1,4 +1,4 @@ -paramiko.pipe module -==================== +Cross-platform pipe implementations +=================================== .. automodule:: paramiko.pipe -- cgit v1.2.3 From c8d97d78c44929be0bfd569425ff6027f225378b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:12:27 -0800 Subject: More internals --- sites/docs/api/primes.rst | 4 ---- sites/docs/api/resource.rst | 4 ---- 2 files changed, 8 deletions(-) delete mode 100644 sites/docs/api/primes.rst delete mode 100644 sites/docs/api/resource.rst diff --git a/sites/docs/api/primes.rst b/sites/docs/api/primes.rst deleted file mode 100644 index 4d7a1f58..00000000 --- a/sites/docs/api/primes.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.primes module -====================== - -.. automodule:: paramiko.primes diff --git a/sites/docs/api/resource.rst b/sites/docs/api/resource.rst deleted file mode 100644 index c4c548f4..00000000 --- a/sites/docs/api/resource.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.resource module -======================== - -.. automodule:: paramiko.resource -- cgit v1.2.3 From 09c0006a40598e224a3a925e894573d0d0cbb4c1 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:17:10 -0800 Subject: Consolidate SFTP docs --- sites/docs/api/sftp.rst | 10 ++++++++-- sites/docs/api/sftp_attr.rst | 4 ---- sites/docs/api/sftp_client.rst | 4 ---- sites/docs/api/sftp_file.rst | 4 ---- sites/docs/api/sftp_handle.rst | 4 ---- sites/docs/api/sftp_server.rst | 4 ---- sites/docs/api/sftp_si.rst | 4 ---- 7 files changed, 8 insertions(+), 26 deletions(-) delete mode 100644 sites/docs/api/sftp_attr.rst delete mode 100644 sites/docs/api/sftp_client.rst delete mode 100644 sites/docs/api/sftp_file.rst delete mode 100644 sites/docs/api/sftp_handle.rst delete mode 100644 sites/docs/api/sftp_server.rst delete mode 100644 sites/docs/api/sftp_si.rst diff --git a/sites/docs/api/sftp.rst b/sites/docs/api/sftp.rst index 731c2521..2eedecf8 100644 --- a/sites/docs/api/sftp.rst +++ b/sites/docs/api/sftp.rst @@ -1,4 +1,10 @@ -paramiko.sftp module -==================== +SFTP +==== .. automodule:: paramiko.sftp +.. automodule:: paramiko.sftp_attr +.. automodule:: paramiko.sftp_client +.. automodule:: paramiko.sftp_file +.. automodule:: paramiko.sftp_handle +.. automodule:: paramiko.sftp_server +.. automodule:: paramiko.sftp_si diff --git a/sites/docs/api/sftp_attr.rst b/sites/docs/api/sftp_attr.rst deleted file mode 100644 index 98bce03a..00000000 --- a/sites/docs/api/sftp_attr.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.sftp_attr module -========================= - -.. automodule:: paramiko.sftp_attr diff --git a/sites/docs/api/sftp_client.rst b/sites/docs/api/sftp_client.rst deleted file mode 100644 index 9892befe..00000000 --- a/sites/docs/api/sftp_client.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.sftp_client module -=========================== - -.. automodule:: paramiko.sftp_client diff --git a/sites/docs/api/sftp_file.rst b/sites/docs/api/sftp_file.rst deleted file mode 100644 index 7df6e12b..00000000 --- a/sites/docs/api/sftp_file.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.sftp_file module -========================= - -.. automodule:: paramiko.sftp_file diff --git a/sites/docs/api/sftp_handle.rst b/sites/docs/api/sftp_handle.rst deleted file mode 100644 index 1d1c30ed..00000000 --- a/sites/docs/api/sftp_handle.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.sftp_handle module -=========================== - -.. automodule:: paramiko.sftp_handle diff --git a/sites/docs/api/sftp_server.rst b/sites/docs/api/sftp_server.rst deleted file mode 100644 index 82a6976e..00000000 --- a/sites/docs/api/sftp_server.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.sftp_server module -=========================== - -.. automodule:: paramiko.sftp_server diff --git a/sites/docs/api/sftp_si.rst b/sites/docs/api/sftp_si.rst deleted file mode 100644 index d071e61a..00000000 --- a/sites/docs/api/sftp_si.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.sftp_si module -======================= - -.. automodule:: paramiko.sftp_si -- cgit v1.2.3 From a627ecfb1450150e79fd4443c44acdffec807efd Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:17:15 -0800 Subject: Even more headers --- sites/docs/api/proxy.rst | 4 ++-- sites/docs/api/server.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sites/docs/api/proxy.rst b/sites/docs/api/proxy.rst index e3cf59ca..8f3e3a8b 100644 --- a/sites/docs/api/proxy.rst +++ b/sites/docs/api/proxy.rst @@ -1,4 +1,4 @@ -paramiko.proxy module -===================== +ProxyCommand support +==================== .. automodule:: paramiko.proxy diff --git a/sites/docs/api/server.rst b/sites/docs/api/server.rst index f59b1216..7519ae99 100644 --- a/sites/docs/api/server.rst +++ b/sites/docs/api/server.rst @@ -1,4 +1,4 @@ -paramiko.server module -====================== +Server implementation +===================== .. automodule:: paramiko.server -- cgit v1.2.3 From 6e4829c20fbd7cb25b5689571ad2f296aa9dd3fe Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:18:06 -0800 Subject: More internals --- sites/docs/api/util.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 sites/docs/api/util.rst diff --git a/sites/docs/api/util.rst b/sites/docs/api/util.rst deleted file mode 100644 index de383ae1..00000000 --- a/sites/docs/api/util.rst +++ /dev/null @@ -1,4 +0,0 @@ -paramiko.util module -==================== - -.. automodule:: paramiko.util -- cgit v1.2.3 From 22766e96a65106cf8a3107bf432c0b8eb40cb681 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 17:18:36 -0800 Subject: Last of headers! --- sites/docs/api/ssh_exception.rst | 4 ++-- sites/docs/api/transport.rst | 2 +- sites/docs/api/win_pageant.rst | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/sites/docs/api/ssh_exception.rst b/sites/docs/api/ssh_exception.rst index 7faaf5f4..64872dc2 100644 --- a/sites/docs/api/ssh_exception.rst +++ b/sites/docs/api/ssh_exception.rst @@ -1,4 +1,4 @@ -paramiko.ssh_exception module -============================= +Exceptions +========== .. automodule:: paramiko.ssh_exception diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst index 6f5b1cd9..f68b77dc 100644 --- a/sites/docs/api/transport.rst +++ b/sites/docs/api/transport.rst @@ -1,4 +1,4 @@ -paramiko.transport module +Transport (core protocol) ========================= .. automodule:: paramiko.transport diff --git a/sites/docs/api/win_pageant.rst b/sites/docs/api/win_pageant.rst index 9b488080..c48da5c6 100644 --- a/sites/docs/api/win_pageant.rst +++ b/sites/docs/api/win_pageant.rst @@ -1,4 +1,4 @@ -paramiko.win_pageant module -=========================== +WinPageant support +================== .. automodule:: paramiko.win_pageant -- cgit v1.2.3 From 0af6df924add72313594c12418d0a2cb45291e4a Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 18:20:47 -0800 Subject: First stab at segmented TOCtrees. Makes sidebar TOC a little funny tho. --- sites/docs/api/transport.rst | 4 ++-- sites/docs/index.rst | 43 +++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 43 insertions(+), 4 deletions(-) diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst index f68b77dc..1b54f04e 100644 --- a/sites/docs/api/transport.rst +++ b/sites/docs/api/transport.rst @@ -1,4 +1,4 @@ -Transport (core protocol) -========================= +Transport +========= .. automodule:: paramiko.transport diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 89c75831..bca0e650 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -5,7 +5,46 @@ This site covers Paramiko's usage & API documentation. For basic info on what Paramiko is, including its public changelog & how the project is maintained, please see `the main website `_. + +API documentation +================= + +Core SSH protocol classes +------------------------- + +.. toctree:: + api/channel + api/client + api/message + api/packet + api/transport + + +Authentication & key handling +----------------------------- + .. toctree:: - :glob: + api/agent + api/hostkeys + api/keys + api/win_pageant - api/* + +Other primary functions +----------------------- + +.. toctree:: + api/config + api/proxy + api/server + api/sftp + + +Miscellany +---------- + +.. toctree:: + api/buffered_pipe + api/file + api/pipe + api/ssh_exception -- cgit v1.2.3 From a58cf80139ff0c8059eebe8bd0c55963a5a33f53 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 09:56:14 -0800 Subject: Un-derp header levels --- sites/docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/sites/docs/index.rst b/sites/docs/index.rst index bca0e650..5133c244 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -1,3 +1,4 @@ +==================================== Welcome to Paramiko's documentation! ==================================== -- cgit v1.2.3 From 88140996a7a259e9e028b022c037223ee97c4c87 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 09:58:19 -0800 Subject: Too much 'handling' --- sites/docs/api/config.rst | 4 ++-- sites/docs/api/hostkeys.rst | 4 ++-- sites/docs/index.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst index 0a9fa1dc..6f9d3ce3 100644 --- a/sites/docs/api/config.rst +++ b/sites/docs/api/config.rst @@ -1,4 +1,4 @@ -Configuration handling -====================== +Configuration +============= .. automodule:: paramiko.config diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst index b57a2c6c..0859fbed 100644 --- a/sites/docs/api/hostkeys.rst +++ b/sites/docs/api/hostkeys.rst @@ -1,4 +1,4 @@ -Host key / known_hosts handling -=============================== +Host keys / ``known_hosts`` files +================================= .. automodule:: paramiko.hostkeys diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 5133c244..98f4069a 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -21,8 +21,8 @@ Core SSH protocol classes api/transport -Authentication & key handling ------------------------------ +Authentication & keys +--------------------- .. toctree:: api/agent -- cgit v1.2.3 From 635108aab2e1f71024f68bfc47659cfea89496ea Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 10:05:40 -0800 Subject: Formatting --- sites/docs/api/proxy.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/docs/api/proxy.rst b/sites/docs/api/proxy.rst index 8f3e3a8b..489b14e7 100644 --- a/sites/docs/api/proxy.rst +++ b/sites/docs/api/proxy.rst @@ -1,4 +1,4 @@ -ProxyCommand support -==================== +``ProxyCommand`` support +======================== .. automodule:: paramiko.proxy -- cgit v1.2.3 From d4148ab6f30fbea9d42e6999fb793a557a4d0f92 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 10:20:57 -0800 Subject: Tweak core-class doc titles --- sites/docs/api/channel.rst | 4 ++-- sites/docs/api/client.rst | 4 ++-- sites/docs/api/message.rst | 4 ++-- sites/docs/api/packet.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/sites/docs/api/channel.rst b/sites/docs/api/channel.rst index 3edb8ac7..e71526f6 100644 --- a/sites/docs/api/channel.rst +++ b/sites/docs/api/channel.rst @@ -1,4 +1,4 @@ -Channels -======== +Channel +======= .. automodule:: paramiko.channel diff --git a/sites/docs/api/client.rst b/sites/docs/api/client.rst index a0784d09..1661f97d 100644 --- a/sites/docs/api/client.rst +++ b/sites/docs/api/client.rst @@ -1,4 +1,4 @@ -Clients -======= +Client +====== .. automodule:: paramiko.client diff --git a/sites/docs/api/message.rst b/sites/docs/api/message.rst index 986548b5..8d531e01 100644 --- a/sites/docs/api/message.rst +++ b/sites/docs/api/message.rst @@ -1,4 +1,4 @@ -Protocol messages -================= +Message +======= .. automodule:: paramiko.message diff --git a/sites/docs/api/packet.rst b/sites/docs/api/packet.rst index 72ad5591..4089203b 100644 --- a/sites/docs/api/packet.rst +++ b/sites/docs/api/packet.rst @@ -1,4 +1,4 @@ -Packet handling -=============== +Packetizer +========== .. automodule:: paramiko.packet -- cgit v1.2.3 From eb332c781bf26a96a472f970550938ccba118056 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 10:21:19 -0800 Subject: Reorganize Client so API doc flows better --- paramiko/client.py | 115 +++++++++++++++++++++++----------------------- sites/docs/api/client.rst | 1 + 2 files changed, 58 insertions(+), 58 deletions(-) diff --git a/paramiko/client.py b/paramiko/client.py index 19a09c2d..c7f9cfc8 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`SSHClient`. +SSH client & key policies """ from binascii import hexlify @@ -38,63 +38,6 @@ from paramiko.transport import Transport from paramiko.util import retry_on_signal -class MissingHostKeyPolicy (object): - """ - Interface for defining the policy that :class:`SSHClient` should use when the - SSH server's hostname is not in either the system host keys or the - application's keys. Pre-made classes implement policies for automatically - adding the key to the application's :class:`HostKeys` object (:class:`AutoAddPolicy`), - and for automatically rejecting the key (:class:`RejectPolicy`). - - This function may be used to ask the user to verify the key, for example. - """ - - def missing_host_key(self, client, hostname, key): - """ - Called when an :class:`SSHClient` receives a server key for a server that - isn't in either the system or local :class:`HostKeys` object. To accept - the key, simply return. To reject, raised an exception (which will - be passed to the calling application). - """ - pass - - -class AutoAddPolicy (MissingHostKeyPolicy): - """ - Policy for automatically adding the hostname and new host key to the - local :class:`HostKeys` object, and saving it. This is used by :class:`SSHClient`. - """ - - def missing_host_key(self, client, hostname, key): - client._host_keys.add(hostname, key.get_name(), key) - if client._host_keys_filename is not None: - client.save_host_keys(client._host_keys_filename) - client._log(DEBUG, 'Adding %s host key for %s: %s' % - (key.get_name(), hostname, hexlify(key.get_fingerprint()))) - - -class RejectPolicy (MissingHostKeyPolicy): - """ - Policy for automatically rejecting the unknown hostname & key. This is - used by :class:`SSHClient`. - """ - - def missing_host_key(self, client, hostname, key): - client._log(DEBUG, 'Rejecting %s host key for %s: %s' % - (key.get_name(), hostname, hexlify(key.get_fingerprint()))) - raise SSHException('Server %r not found in known_hosts' % hostname) - - -class WarningPolicy (MissingHostKeyPolicy): - """ - Policy for logging a python-style warning for an unknown host key, but - accepting it. This is used by :class:`SSHClient`. - """ - def missing_host_key(self, client, hostname, key): - warnings.warn('Unknown %s host key for %s: %s' % - (key.get_name(), hostname, hexlify(key.get_fingerprint()))) - - class SSHClient (object): """ A high-level representation of a session with an SSH server. This class @@ -536,3 +479,59 @@ class SSHClient (object): def _log(self, level, msg): self._transport._log(level, msg) + +class MissingHostKeyPolicy (object): + """ + Interface for defining the policy that :class:`SSHClient` should use when the + SSH server's hostname is not in either the system host keys or the + application's keys. Pre-made classes implement policies for automatically + adding the key to the application's :class:`HostKeys` object (:class:`AutoAddPolicy`), + and for automatically rejecting the key (:class:`RejectPolicy`). + + This function may be used to ask the user to verify the key, for example. + """ + + def missing_host_key(self, client, hostname, key): + """ + Called when an :class:`SSHClient` receives a server key for a server that + isn't in either the system or local :class:`HostKeys` object. To accept + the key, simply return. To reject, raised an exception (which will + be passed to the calling application). + """ + pass + + +class AutoAddPolicy (MissingHostKeyPolicy): + """ + Policy for automatically adding the hostname and new host key to the + local :class:`HostKeys` object, and saving it. This is used by :class:`SSHClient`. + """ + + def missing_host_key(self, client, hostname, key): + client._host_keys.add(hostname, key.get_name(), key) + if client._host_keys_filename is not None: + client.save_host_keys(client._host_keys_filename) + client._log(DEBUG, 'Adding %s host key for %s: %s' % + (key.get_name(), hostname, hexlify(key.get_fingerprint()))) + + +class RejectPolicy (MissingHostKeyPolicy): + """ + Policy for automatically rejecting the unknown hostname & key. This is + used by :class:`SSHClient`. + """ + + def missing_host_key(self, client, hostname, key): + client._log(DEBUG, 'Rejecting %s host key for %s: %s' % + (key.get_name(), hostname, hexlify(key.get_fingerprint()))) + raise SSHException('Server %r not found in known_hosts' % hostname) + + +class WarningPolicy (MissingHostKeyPolicy): + """ + Policy for logging a python-style warning for an unknown host key, but + accepting it. This is used by :class:`SSHClient`. + """ + def missing_host_key(self, client, hostname, key): + warnings.warn('Unknown %s host key for %s: %s' % + (key.get_name(), hostname, hexlify(key.get_fingerprint()))) diff --git a/sites/docs/api/client.rst b/sites/docs/api/client.rst index 1661f97d..b201812f 100644 --- a/sites/docs/api/client.rst +++ b/sites/docs/api/client.rst @@ -2,3 +2,4 @@ Client ====== .. automodule:: paramiko.client + :member-order: bysource -- cgit v1.2.3 From be4007fb896374bbace708ee20ce7e48fab5763e Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 10:25:45 -0800 Subject: Docstring tweak --- paramiko/packet.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paramiko/packet.py b/paramiko/packet.py index aab19e06..efdb2d04 100644 --- a/paramiko/packet.py +++ b/paramiko/packet.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Packetizer. +Packet handling """ import errno -- cgit v1.2.3 From f40bf59ff3d18e7a0d8cdf685df09efaeb3b126e Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 10:25:56 -0800 Subject: Source ordering updates for Transport --- paramiko/transport.py | 246 +++++++++++++++++++++---------------------- sites/docs/api/transport.rst | 1 + 2 files changed, 124 insertions(+), 123 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index 7cccd5ff..8be0ca37 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`Transport` handles the core SSH2 protocol. +Core protocol implementation """ import os @@ -66,128 +66,6 @@ import atexit atexit.register(_join_lingering_threads) -class SecurityOptions (object): - """ - Simple object containing the security preferences of an ssh transport. - These are tuples of acceptable ciphers, digests, key types, and key - exchange algorithms, listed in order of preference. - - Changing the contents and/or order of these fields affects the underlying - :class:`Transport` (but only if you change them before starting the session). - If you try to add an algorithm that paramiko doesn't recognize, - ``ValueError`` will be raised. If you try to assign something besides a - tuple to one of the fields, ``TypeError`` will be raised. - """ - __slots__ = [ 'ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport' ] - - def __init__(self, transport): - self._transport = transport - - def __repr__(self): - """ - Returns a string representation of this object, for debugging. - - :rtype: str - """ - return '' % repr(self._transport) - - def _get_ciphers(self): - return self._transport._preferred_ciphers - - def _get_digests(self): - return self._transport._preferred_macs - - def _get_key_types(self): - return self._transport._preferred_keys - - def _get_kex(self): - return self._transport._preferred_kex - - def _get_compression(self): - return self._transport._preferred_compression - - def _set(self, name, orig, x): - if type(x) is list: - x = tuple(x) - if type(x) is not tuple: - raise TypeError('expected tuple or list') - possible = getattr(self._transport, orig).keys() - forbidden = filter(lambda n: n not in possible, x) - if len(forbidden) > 0: - raise ValueError('unknown cipher') - setattr(self._transport, name, x) - - def _set_ciphers(self, x): - self._set('_preferred_ciphers', '_cipher_info', x) - - def _set_digests(self, x): - self._set('_preferred_macs', '_mac_info', x) - - def _set_key_types(self, x): - self._set('_preferred_keys', '_key_info', x) - - def _set_kex(self, x): - self._set('_preferred_kex', '_kex_info', x) - - def _set_compression(self, x): - self._set('_preferred_compression', '_compression_info', x) - - ciphers = property(_get_ciphers, _set_ciphers, None, - "Symmetric encryption ciphers") - digests = property(_get_digests, _set_digests, None, - "Digest (one-way hash) algorithms") - key_types = property(_get_key_types, _set_key_types, None, - "Public-key algorithms") - kex = property(_get_kex, _set_kex, None, "Key exchange algorithms") - compression = property(_get_compression, _set_compression, None, - "Compression algorithms") - - -class ChannelMap (object): - def __init__(self): - # (id -> Channel) - self._map = weakref.WeakValueDictionary() - self._lock = threading.Lock() - - def put(self, chanid, chan): - self._lock.acquire() - try: - self._map[chanid] = chan - finally: - self._lock.release() - - def get(self, chanid): - self._lock.acquire() - try: - return self._map.get(chanid, None) - finally: - self._lock.release() - - def delete(self, chanid): - self._lock.acquire() - try: - try: - del self._map[chanid] - except KeyError: - pass - finally: - self._lock.release() - - def values(self): - self._lock.acquire() - try: - return self._map.values() - finally: - self._lock.release() - - def __len__(self): - self._lock.acquire() - try: - return len(self._map) - finally: - self._lock.release() - - class Transport (threading.Thread): """ An SSH Transport attaches to a stream (usually a socket), negotiates an @@ -2154,3 +2032,125 @@ class Transport (threading.Thread): MSG_CHANNEL_EOF: Channel._handle_eof, MSG_CHANNEL_CLOSE: Channel._handle_close, } + + +class SecurityOptions (object): + """ + Simple object containing the security preferences of an ssh transport. + These are tuples of acceptable ciphers, digests, key types, and key + exchange algorithms, listed in order of preference. + + Changing the contents and/or order of these fields affects the underlying + :class:`Transport` (but only if you change them before starting the session). + If you try to add an algorithm that paramiko doesn't recognize, + ``ValueError`` will be raised. If you try to assign something besides a + tuple to one of the fields, ``TypeError`` will be raised. + """ + __slots__ = [ 'ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport' ] + + def __init__(self, transport): + self._transport = transport + + def __repr__(self): + """ + Returns a string representation of this object, for debugging. + + :rtype: str + """ + return '' % repr(self._transport) + + def _get_ciphers(self): + return self._transport._preferred_ciphers + + def _get_digests(self): + return self._transport._preferred_macs + + def _get_key_types(self): + return self._transport._preferred_keys + + def _get_kex(self): + return self._transport._preferred_kex + + def _get_compression(self): + return self._transport._preferred_compression + + def _set(self, name, orig, x): + if type(x) is list: + x = tuple(x) + if type(x) is not tuple: + raise TypeError('expected tuple or list') + possible = getattr(self._transport, orig).keys() + forbidden = filter(lambda n: n not in possible, x) + if len(forbidden) > 0: + raise ValueError('unknown cipher') + setattr(self._transport, name, x) + + def _set_ciphers(self, x): + self._set('_preferred_ciphers', '_cipher_info', x) + + def _set_digests(self, x): + self._set('_preferred_macs', '_mac_info', x) + + def _set_key_types(self, x): + self._set('_preferred_keys', '_key_info', x) + + def _set_kex(self, x): + self._set('_preferred_kex', '_kex_info', x) + + def _set_compression(self, x): + self._set('_preferred_compression', '_compression_info', x) + + ciphers = property(_get_ciphers, _set_ciphers, None, + "Symmetric encryption ciphers") + digests = property(_get_digests, _set_digests, None, + "Digest (one-way hash) algorithms") + key_types = property(_get_key_types, _set_key_types, None, + "Public-key algorithms") + kex = property(_get_kex, _set_kex, None, "Key exchange algorithms") + compression = property(_get_compression, _set_compression, None, + "Compression algorithms") + + +class ChannelMap (object): + def __init__(self): + # (id -> Channel) + self._map = weakref.WeakValueDictionary() + self._lock = threading.Lock() + + def put(self, chanid, chan): + self._lock.acquire() + try: + self._map[chanid] = chan + finally: + self._lock.release() + + def get(self, chanid): + self._lock.acquire() + try: + return self._map.get(chanid, None) + finally: + self._lock.release() + + def delete(self, chanid): + self._lock.acquire() + try: + try: + del self._map[chanid] + except KeyError: + pass + finally: + self._lock.release() + + def values(self): + self._lock.acquire() + try: + return self._map.values() + finally: + self._lock.release() + + def __len__(self): + self._lock.acquire() + try: + return len(self._map) + finally: + self._lock.release() diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst index 1b54f04e..7c9d9fd1 100644 --- a/sites/docs/api/transport.rst +++ b/sites/docs/api/transport.rst @@ -2,3 +2,4 @@ Transport ========= .. automodule:: paramiko.transport + :member-order: bysource -- cgit v1.2.3 From 3f9270c0be18b09cd39279730eac125776adbedc Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 11:11:10 -0800 Subject: Mass SnR of class refs with dotted ones. Boo on Sphinx for not letting me just change this behavior by default. There are a handful of incorrect items here that will get tweaked later. --- paramiko/__init__.py | 4 +- paramiko/agent.py | 6 +-- paramiko/auth_handler.py | 2 +- paramiko/buffered_pipe.py | 4 +- paramiko/channel.py | 26 +++++----- paramiko/client.py | 54 +++++++++---------- paramiko/config.py | 2 +- paramiko/dsskey.py | 4 +- paramiko/file.py | 2 +- paramiko/hostkeys.py | 8 +-- paramiko/pkey.py | 26 +++++----- paramiko/proxy.py | 6 +-- paramiko/rsakey.py | 4 +- paramiko/server.py | 130 +++++++++++++++++++++++----------------------- paramiko/sftp_attr.py | 4 +- paramiko/sftp_client.py | 32 ++++++------ paramiko/sftp_file.py | 8 +-- paramiko/sftp_handle.py | 14 ++--- paramiko/sftp_server.py | 16 +++--- paramiko/sftp_si.py | 52 +++++++++---------- paramiko/ssh_exception.py | 6 +-- paramiko/transport.py | 50 +++++++++--------- paramiko/util.py | 6 +-- 23 files changed, 233 insertions(+), 233 deletions(-) diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 4bf0c7e6..1f7f6bc3 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -26,9 +26,9 @@ replaced ``telnet`` and ``rsh`` for secure access to remote shells, but the protocol also includes the ability to open arbitrary channels to remote services across an encrypted tunnel. (This is how ``sftp`` works, for example.) -The high-level client API starts with creation of an :class:`SSHClient` object. +The high-level client API starts with creation of an :class:`.SSHClient` object. For more direct control, pass a socket (or socket-like object) to a -:class:`Transport`, and use :class:`start_server ` or +:class:`.Transport`, and use :class:`start_server ` or :class:`start_client ` to negoatite with the remote host as either a server or client. As a client, you are responsible for authenticating using a password or private key, and checking diff --git a/paramiko/agent.py b/paramiko/agent.py index a09851bc..a5413f74 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -44,7 +44,7 @@ class AgentSSH(object): """ Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to - connect to it and retreive :class:`PKey` objects which can be used when + connect to it and retreive :class:`.PKey` objects which can be used when attempting to authenticate to remote SSH servers. Because the SSH agent protocol uses environment variables and unix-domain @@ -62,7 +62,7 @@ class AgentSSH(object): will be returned. :return: a list of keys available on the SSH agent - :rtype: tuple of :class:`AgentKey` + :rtype: tuple of :class:`.AgentKey` """ return self._keys @@ -307,7 +307,7 @@ class Agent(AgentSSH): """ Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to - connect to it and retreive :class:`PKey` objects which can be used when + connect to it and retreive :class:`.PKey` objects which can be used when attempting to authenticate to remote SSH servers. Because the SSH agent protocol uses environment variables and unix-domain diff --git a/paramiko/auth_handler.py b/paramiko/auth_handler.py index 56bd37d5..2f73e5a3 100644 --- a/paramiko/auth_handler.py +++ b/paramiko/auth_handler.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`AuthHandler` +:class:`.AuthHandler` """ import threading diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index 23ed9f44..c400bb4b 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -29,7 +29,7 @@ import time class PipeTimeout (IOError): """ - Indicates that a timeout was reached on a read from a :class:`BufferedPipe`. + Indicates that a timeout was reached on a read from a :class:`.BufferedPipe`. """ pass @@ -38,7 +38,7 @@ class BufferedPipe (object): """ A buffer that obeys normal read (with timeout) & close semantics for a file or socket, but is fed data from another thread. This is used by - :class:`Channel`. + :class:`.Channel`. """ def __init__(self): diff --git a/paramiko/channel.py b/paramiko/channel.py index 7a430435..5cfa9059 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -42,7 +42,7 @@ MIN_PACKET_SIZE = 1024 class Channel (object): """ - A secure tunnel across an SSH :class:`Transport`. A Channel is meant to behave + A secure tunnel across an SSH :class:`.Transport`. A Channel is meant to behave like a socket, and has an API that should be indistinguishable from the python socket API. @@ -58,12 +58,12 @@ class Channel (object): def __init__(self, chanid): """ Create a new channel. The channel is not associated with any - particular session or :class:`Transport` until the Transport attaches it. + particular session or :class:`.Transport` until the Transport attaches it. Normally you would only call this method from the constructor of a - subclass of :class:`Channel`. + subclass of :class:`.Channel`. :param chanid: the ID of this channel, as passed by an existing - :class:`Transport`. + :class:`.Transport`. :type chanid: int """ self.chanid = chanid @@ -416,10 +416,10 @@ class Channel (object): def get_transport(self): """ - Return the :class:`Transport` associated with this channel. + Return the :class:`.Transport` associated with this channel. - :return: the :class:`Transport` that was used to create this channel. - :rtype: :class:`Transport` + :return: the :class:`.Transport` that was used to create this channel. + :rtype: :class:`.Transport` """ return self.transport @@ -446,7 +446,7 @@ class Channel (object): def get_id(self): """ Return the ID # for this channel. The channel ID is unique across - a :class:`Transport` and usually a small number. It's also the number + a :class:`.Transport` and usually a small number. It's also the number passed to :class:`ServerInterface.check_channel_request` when determining whether to accept a channel request in server mode. @@ -564,7 +564,7 @@ class Channel (object): """ Close the channel. All future read/write operations on the channel will fail. The remote end will receive no more data (after queued data - is flushed). Channels are automatically closed when their :class:`Transport` + is flushed). Channels are automatically closed when their :class:`.Transport` is closed or when they are garbage collected. """ self.lock.acquire() @@ -829,7 +829,7 @@ class Channel (object): the built-in ``file()`` function in python. :return: object which can be used for python file I/O. - :rtype: :class:`ChannelFile` + :rtype: :class:`.ChannelFile` """ return ChannelFile(*([self] + list(params))) @@ -845,7 +845,7 @@ class Channel (object): server, it only makes sense to open this file for writing. :return: object which can be used for python file I/O. - :rtype: :class:`ChannelFile` + :rtype: :class:`.ChannelFile` .. versionadded:: 1.1 """ @@ -1227,11 +1227,11 @@ class Channel (object): class ChannelFile (BufferedFile): """ - A file-like wrapper around :class:`Channel`. A ChannelFile is created by calling + A file-like wrapper around :class:`.Channel`. A ChannelFile is created by calling :class:`Channel.makefile`. @bug: To correctly emulate the file object created from a socket's - ``makefile`` method, a :class:`Channel` and its ``ChannelFile`` should be able + ``makefile`` method, a :class:`.Channel` and its ``ChannelFile`` should be able to be closed or garbage-collected independently. Currently, closing the ``ChannelFile`` does nothing but flush the buffer. """ diff --git a/paramiko/client.py b/paramiko/client.py index c7f9cfc8..0ebc4df8 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -41,7 +41,7 @@ from paramiko.util import retry_on_signal class SSHClient (object): """ A high-level representation of a session with an SSH server. This class - wraps :class:`Transport`, :class:`Channel`, and :class:`SFTPClient` to take care of most + wraps :class:`.Transport`, :class:`.Channel`, and :class:`.SFTPClient` to take care of most aspects of authenticating and opening channels. A typical use case is:: client = SSHClient() @@ -103,7 +103,7 @@ class SSHClient (object): Load host keys from a local host-key file. Host keys read with this method will be checked after keys loaded via :class:`load_system_host_keys`, but will be saved back by :class:`save_host_keys` (so they can be modified). - The missing host key policy :class:`AutoAddPolicy` adds keys to this set and + The missing host key policy :class:`.AutoAddPolicy` adds keys to this set and saves them, when connecting to a previously-unknown server. This method can be called multiple times. Each new set of host keys @@ -143,11 +143,11 @@ class SSHClient (object): def get_host_keys(self): """ - Get the local :class:`HostKeys` object. This can be used to examine the + Get the local :class:`.HostKeys` object. This can be used to examine the local host keys or change them. :return: the local host keys - :rtype: :class:`HostKeys` + :rtype: :class:`.HostKeys` """ return self._host_keys @@ -164,13 +164,13 @@ class SSHClient (object): def set_missing_host_key_policy(self, policy): """ Set the policy to use when connecting to a server that doesn't have a - host key in either the system or local :class:`HostKeys` objects. The - default policy is to reject all unknown servers (using :class:`RejectPolicy`). - You may substitute :class:`AutoAddPolicy` or write your own policy class. + host key in either the system or local :class:`.HostKeys` objects. The + default policy is to reject all unknown servers (using :class:`.RejectPolicy`). + You may substitute :class:`.AutoAddPolicy` or write your own policy class. :param policy: the policy to use when receiving a host key from a previously-unknown server - :type policy: :class:`MissingHostKeyPolicy` + :type policy: :class:`.MissingHostKeyPolicy` """ self._policy = policy @@ -183,7 +183,7 @@ class SSHClient (object): and any local host keys (:class:`load_host_keys`). If the server's hostname is not found in either set of host keys, the missing host key policy is used (see :class:`set_missing_host_key_policy`). The default policy is - to reject the key and raise an :class:`SSHException`. + to reject the key and raise an :class:`.SSHException`. Authentication is attempted in the following order of priority: @@ -206,7 +206,7 @@ class SSHClient (object): a private key :type password: str :param pkey: an optional private key to use for authentication - :type pkey: :class:`PKey` + :type pkey: :class:`.PKey` :param key_filename: the filename, or list of filenames, of optional private key(s) to try for authentication :type key_filename: str or list(str) @@ -220,7 +220,7 @@ class SSHClient (object): :param compress: set to True to turn on compression :type compress: bool :param sock: an open socket or socket-like object (such as a - :class:`Channel`) to use for communication to the target host + :class:`.Channel`) to use for communication to the target host :type sock: socket :raises BadHostKeyException: if the server's host key could not be @@ -286,7 +286,7 @@ class SSHClient (object): def close(self): """ - Close this SSHClient and its underlying :class:`Transport`. + Close this SSHClient and its underlying :class:`.Transport`. """ if self._transport is None: return @@ -299,7 +299,7 @@ class SSHClient (object): def exec_command(self, command, bufsize=-1, timeout=None, get_pty=False): """ - Execute a command on the SSH server. A new :class:`Channel` is opened and + Execute a command on the SSH server. A new :class:`.Channel` is opened and the requested command is executed. The command's input and output streams are returned as python ``file``-like objects representing stdin, stdout, and stderr. @@ -311,7 +311,7 @@ class SSHClient (object): :param timeout: set command's channel timeout. See :class:`Channel.settimeout`.settimeout :type timeout: int :return: the stdin, stdout, and stderr of the executing command - :rtype: tuple(:class:`ChannelFile`, :class:`ChannelFile`, :class:`ChannelFile`) + :rtype: tuple(:class:`.ChannelFile`, :class:`.ChannelFile`, :class:`.ChannelFile`) :raises SSHException: if the server fails to execute the command """ @@ -328,7 +328,7 @@ class SSHClient (object): def invoke_shell(self, term='vt100', width=80, height=24, width_pixels=0, height_pixels=0): """ - Start an interactive shell session on the SSH server. A new :class:`Channel` + Start an interactive shell session on the SSH server. A new :class:`.Channel` is opened and connected to a pseudo-terminal using the requested terminal type and size. @@ -343,7 +343,7 @@ class SSHClient (object): :param height_pixels: the height (in pixels) of the terminal window :type height_pixels: int :return: a new channel connected to the remote shell - :rtype: :class:`Channel` + :rtype: :class:`.Channel` :raises SSHException: if the server fails to invoke a shell """ @@ -357,18 +357,18 @@ class SSHClient (object): Open an SFTP session on the SSH server. :return: a new SFTP session object - :rtype: :class:`SFTPClient` + :rtype: :class:`.SFTPClient` """ return self._transport.open_sftp_client() def get_transport(self): """ - Return the underlying :class:`Transport` object for this SSH connection. + Return the underlying :class:`.Transport` object for this SSH connection. This can be used to perform lower-level tasks, like opening specific kinds of channels. :return: the Transport for this connection - :rtype: :class:`Transport` + :rtype: :class:`.Transport` """ return self._transport @@ -482,19 +482,19 @@ class SSHClient (object): class MissingHostKeyPolicy (object): """ - Interface for defining the policy that :class:`SSHClient` should use when the + Interface for defining the policy that :class:`.SSHClient` should use when the SSH server's hostname is not in either the system host keys or the application's keys. Pre-made classes implement policies for automatically - adding the key to the application's :class:`HostKeys` object (:class:`AutoAddPolicy`), - and for automatically rejecting the key (:class:`RejectPolicy`). + adding the key to the application's :class:`.HostKeys` object (:class:`.AutoAddPolicy`), + and for automatically rejecting the key (:class:`.RejectPolicy`). This function may be used to ask the user to verify the key, for example. """ def missing_host_key(self, client, hostname, key): """ - Called when an :class:`SSHClient` receives a server key for a server that - isn't in either the system or local :class:`HostKeys` object. To accept + Called when an :class:`.SSHClient` receives a server key for a server that + isn't in either the system or local :class:`.HostKeys` object. To accept the key, simply return. To reject, raised an exception (which will be passed to the calling application). """ @@ -504,7 +504,7 @@ class MissingHostKeyPolicy (object): class AutoAddPolicy (MissingHostKeyPolicy): """ Policy for automatically adding the hostname and new host key to the - local :class:`HostKeys` object, and saving it. This is used by :class:`SSHClient`. + local :class:`.HostKeys` object, and saving it. This is used by :class:`.SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -518,7 +518,7 @@ class AutoAddPolicy (MissingHostKeyPolicy): class RejectPolicy (MissingHostKeyPolicy): """ Policy for automatically rejecting the unknown hostname & key. This is - used by :class:`SSHClient`. + used by :class:`.SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -530,7 +530,7 @@ class RejectPolicy (MissingHostKeyPolicy): class WarningPolicy (MissingHostKeyPolicy): """ Policy for logging a python-style warning for an unknown host key, but - accepting it. This is used by :class:`SSHClient`. + accepting it. This is used by :class:`.SSHClient`. """ def missing_host_key(self, client, hostname, key): warnings.warn('Unknown %s host key for %s: %s' % diff --git a/paramiko/config.py b/paramiko/config.py index 05f59813..583c7e85 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -18,7 +18,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`SSHConfig`. +:class:`.SSHConfig`. """ import fnmatch diff --git a/paramiko/dsskey.py b/paramiko/dsskey.py index 2d9f6cef..9581ec82 100644 --- a/paramiko/dsskey.py +++ b/paramiko/dsskey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`DSSKey` +:class:`.DSSKey` """ from Crypto.PublicKey import DSA @@ -159,7 +159,7 @@ class DSSKey (PKey): key generation (used by ``pyCrypto.PublicKey``). :type progress_func: function :return: new private key - :rtype: :class:`DSSKey` + :rtype: :class:`.DSSKey` """ dsa = DSA.generate(bits, rng.read, progress_func) key = DSSKey(vals=(dsa.p, dsa.q, dsa.g, dsa.y)) diff --git a/paramiko/file.py b/paramiko/file.py index 58d9f8bb..334cff41 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -94,7 +94,7 @@ class BufferedFile (object): def next(self): """ - Returns the next line from the input, or raises :class:`StopIteration` when + Returns the next line from the input, or raises :class:`.StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to ``next`` and :class:`readline`. diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index 2767fb4c..704fe7e3 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`HostKeys` +:class:`.HostKeys` """ import base64 @@ -140,7 +140,7 @@ class HostKeys (UserDict.DictMixin): :param keytype: key type (``"ssh-rsa"`` or ``"ssh-dss"``) :type keytype: str :param key: the key to add - :type key: :class:`PKey` + :type key: :class:`.PKey` """ for e in self._entries: if (hostname in e.hostnames) and (e.key.get_name() == keytype): @@ -209,7 +209,7 @@ class HostKeys (UserDict.DictMixin): :param hostname: the hostname (or IP) to lookup :type hostname: str :return: keys associated with this host (or ``None``) - :rtype: dict(str, :class:`PKey`) + :rtype: dict(str, :class:`.PKey`) """ class SubDict (UserDict.DictMixin): def __init__(self, hostname, entries, hostkeys): @@ -257,7 +257,7 @@ class HostKeys (UserDict.DictMixin): :param hostname: hostname (or IP) of the SSH server :type hostname: str :param key: the key to check - :type key: :class:`PKey` + :type key: :class:`.PKey` :return: ``True`` if the key is associated with the hostname; ``False`` if not :rtype: bool diff --git a/paramiko/pkey.py b/paramiko/pkey.py index bfe7b116..a12fc519 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -52,9 +52,9 @@ class PKey (object): ``data`` is given, the key's public part(s) will be filled in from the string. - :param msg: an optional SSH :class:`Message` containing a public key of this + :param msg: an optional SSH :class:`.Message` containing a public key of this type. - :type msg: :class:`Message` + :type msg: :class:`.Message` :param data: an optional string containing a public key of this type :type data: str @@ -65,7 +65,7 @@ class PKey (object): def __str__(self): """ - Return a string of an SSH :class:`Message` made up of the public part(s) of + Return a string of an SSH :class:`.Message` made up of the public part(s) of this key. This string is suitable for passing to :class:`__init__` to re-create the key object later. @@ -82,7 +82,7 @@ class PKey (object): corresponding private key. :param other: key to compare to. - :type other: :class:`PKey` + :type other: :class:`.PKey` :return: 0 if the two keys are equivalent, non-0 otherwise. :rtype: int """ @@ -146,7 +146,7 @@ class PKey (object): def sign_ssh_data(self, rng, data): """ - Sign a blob of data with this private key, and return a :class:`Message` + Sign a blob of data with this private key, and return a :class:`.Message` representing an SSH signature message. :param rng: a secure random number generator. @@ -154,7 +154,7 @@ class PKey (object): :param data: the data to sign. :type data: str :return: an SSH signature message. - :rtype: :class:`Message` + :rtype: :class:`.Message` """ return '' @@ -166,7 +166,7 @@ class PKey (object): :param data: the data that was signed. :type data: str :param msg: an SSH signature message - :type msg: :class:`Message` + :type msg: :class:`.Message` :return: ``True`` if the signature verifies correctly; ``False`` otherwise. :rtype: boolean @@ -177,9 +177,9 @@ class PKey (object): """ Create a key object by reading a private key file. If the private key is encrypted and ``password`` is not ``None``, the given password - will be used to decrypt the key (otherwise :class:`PasswordRequiredException` + will be used to decrypt the key (otherwise :class:`.PasswordRequiredException` is thrown). Through the magic of python, this factory method will - exist in all subclasses of PKey (such as :class:`RSAKey` or :class:`DSSKey`), but + exist in all subclasses of PKey (such as :class:`.RSAKey` or :class:`.DSSKey`), but is useless on the abstract PKey class. :param filename: name of the file to read @@ -188,7 +188,7 @@ class PKey (object): if it's encrypted :type password: str :return: a new key object based on the given private key - :rtype: :class:`PKey` + :rtype: :class:`.PKey` :raises IOError: if there was an error reading the file :raises PasswordRequiredException: if the private key file is @@ -204,7 +204,7 @@ class PKey (object): Create a key object by reading a private key from a file (or file-like) object. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt the key (otherwise - :class:`PasswordRequiredException` is thrown). + :class:`.PasswordRequiredException` is thrown). :param file_obj: the file to read from :type file_obj: file @@ -212,7 +212,7 @@ class PKey (object): encrypted :type password: str :return: a new key object based on the given private key - :rtype: :class:`PKey` + :rtype: :class:`.PKey` :raises IOError: if there was an error reading the key :raises PasswordRequiredException: if the private key file is encrypted, @@ -259,7 +259,7 @@ class PKey (object): ``"BEGIN xxx PRIVATE KEY"`` for some ``xxx``, base64-decode the text we find, and return it as a string. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt - the key (otherwise :class:`PasswordRequiredException` is thrown). + the key (otherwise :class:`.PasswordRequiredException` is thrown). :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. :type tag: str diff --git a/paramiko/proxy.py b/paramiko/proxy.py index 08abe9a6..85c73a6b 100644 --- a/paramiko/proxy.py +++ b/paramiko/proxy.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`ProxyCommand`. +:class:`.ProxyCommand`. """ import os @@ -33,14 +33,14 @@ class ProxyCommand(object): Wraps a subprocess running ProxyCommand-driven programs. This class implements a the socket-like interface needed by the - :class:`Transport` and :class:`Packetizer` classes. Using this class instead of a + :class:`.Transport` and :class:`.Packetizer` classes. Using this class instead of a regular socket makes it possible to talk with a Popen'd command that will proxy traffic between the client and a server hosted in another machine. """ def __init__(self, command_line): """ Create a new CommandProxy instance. The instance created by this - class can be passed as an argument to the :class:`Transport` class. + class can be passed as an argument to the :class:`.Transport` class. :param command_line: the command that should be executed and used as the proxy. diff --git a/paramiko/rsakey.py b/paramiko/rsakey.py index 46c37d69..8e9774f8 100644 --- a/paramiko/rsakey.py +++ b/paramiko/rsakey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`RSAKey` +:class:`.RSAKey` """ from Crypto.PublicKey import RSA @@ -135,7 +135,7 @@ class RSAKey (PKey): key generation (used by ``pyCrypto.PublicKey``). :type progress_func: function :return: new private key - :rtype: :class:`RSAKey` + :rtype: :class:`.RSAKey` """ rsa = RSA.generate(bits, rng.read, progress_func) key = RSAKey(vals=(rsa.e, rsa.n)) diff --git a/paramiko/server.py b/paramiko/server.py index 380831ea..14f89760 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`ServerInterface` is an interface to override for server support. +:class:`.ServerInterface` is an interface to override for server support. """ import threading @@ -96,9 +96,9 @@ class ServerInterface (object): - :class:`check_channel_forward_agent_request` The ``chanid`` parameter is a small number that uniquely identifies the - channel within a :class:`Transport`. A :class:`Channel` object is not created + channel within a :class:`.Transport`. A :class:`.Channel` object is not created unless this method returns ``OPEN_SUCCEEDED`` -- once a - :class:`Channel` object is created, you can call :class:`Channel.get_id` to + :class:`.Channel` object is created, you can call :class:`Channel.get_id` to retrieve the channel ID. The return value should either be ``OPEN_SUCCEEDED`` (or @@ -146,16 +146,16 @@ class ServerInterface (object): Determine if a client may open channels with no (further) authentication. - Return :class:`AUTH_FAILED` if the client must authenticate, or - :class:`AUTH_SUCCESSFUL` if it's okay for the client to not + Return :class:`.AUTH_FAILED` if the client must authenticate, or + :class:`.AUTH_SUCCESSFUL` if it's okay for the client to not authenticate. - The default implementation always returns :class:`AUTH_FAILED`. + The default implementation always returns :class:`.AUTH_FAILED`. :param username: the username of the client. :type username: str - :return: :class:`AUTH_FAILED` if the authentication fails; - :class:`AUTH_SUCCESSFUL` if it succeeds. + :return: :class:`.AUTH_FAILED` if the authentication fails; + :class:`.AUTH_SUCCESSFUL` if it succeeds. :rtype: int """ return AUTH_FAILED @@ -165,23 +165,23 @@ class ServerInterface (object): Determine if a given username and password supplied by the client is acceptable for use in authentication. - Return :class:`AUTH_FAILED` if the password is not accepted, - :class:`AUTH_SUCCESSFUL` if the password is accepted and completes - the authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your + Return :class:`.AUTH_FAILED` if the password is not accepted, + :class:`.AUTH_SUCCESSFUL` if the password is accepted and completes + the authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this key is accepted for authentication, but more authentication is required. (In this latter case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) - The default implementation always returns :class:`AUTH_FAILED`. + The default implementation always returns :class:`.AUTH_FAILED`. :param username: the username of the authenticating client. :type username: str :param password: the password given by the client. :type password: str - :return: :class:`AUTH_FAILED` if the authentication fails; - :class:`AUTH_SUCCESSFUL` if it succeeds; - :class:`AUTH_PARTIALLY_SUCCESSFUL` if the password auth is + :return: :class:`.AUTH_FAILED` if the authentication fails; + :class:`.AUTH_SUCCESSFUL` if it succeeds; + :class:`.AUTH_PARTIALLY_SUCCESSFUL` if the password auth is successful, but authentication must continue. :rtype: int """ @@ -194,9 +194,9 @@ class ServerInterface (object): check the username and key and decide if you would accept a signature made using this key. - Return :class:`AUTH_FAILED` if the key is not accepted, - :class:`AUTH_SUCCESSFUL` if the key is accepted and completes the - authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your + Return :class:`.AUTH_FAILED` if the key is not accepted, + :class:`.AUTH_SUCCESSFUL` if the key is accepted and completes the + authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this password is accepted for authentication, but more authentication is required. (In this latter case, :class:`get_allowed_auths` will be called to report to the client what @@ -206,15 +206,15 @@ class ServerInterface (object): If you're willing to accept the key, paramiko will do the work of verifying the client's signature. - The default implementation always returns :class:`AUTH_FAILED`. + The default implementation always returns :class:`.AUTH_FAILED`. :param username: the username of the authenticating client :type username: str :param key: the key object provided by the client :type key: :class:`PKey ` - :return: :class:`AUTH_FAILED` if the client can't authenticate - with this key; :class:`AUTH_SUCCESSFUL` if it can; - :class:`AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with + :return: :class:`.AUTH_FAILED` if the client can't authenticate + with this key; :class:`.AUTH_SUCCESSFUL` if it can; + :class:`.AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with this key but must continue with authentication :rtype: int """ @@ -227,21 +227,21 @@ class ServerInterface (object): ``"keyboard-interactive"`` auth type, which requires you to send a series of questions for the client to answer. - Return :class:`AUTH_FAILED` if this auth method isn't supported. Otherwise, - you should return an :class:`InteractiveQuery` object containing the prompts + Return :class:`.AUTH_FAILED` if this auth method isn't supported. Otherwise, + you should return an :class:`.InteractiveQuery` object containing the prompts and instructions for the user. The response will be sent via a call to :class:`check_auth_interactive_response`. - The default implementation always returns :class:`AUTH_FAILED`. + The default implementation always returns :class:`.AUTH_FAILED`. :param username: the username of the authenticating client :type username: str :param submethods: a comma-separated list of methods preferred by the client (usually empty) :type submethods: str - :return: :class:`AUTH_FAILED` if this auth method isn't supported; otherwise + :return: :class:`.AUTH_FAILED` if this auth method isn't supported; otherwise an object containing queries for the user - :rtype: int or :class:`InteractiveQuery` + :rtype: int or :class:`.InteractiveQuery` """ return AUTH_FAILED @@ -251,29 +251,29 @@ class ServerInterface (object): supported. You should override this method in server mode if you want to support the ``"keyboard-interactive"`` auth type. - Return :class:`AUTH_FAILED` if the responses are not accepted, - :class:`AUTH_SUCCESSFUL` if the responses are accepted and complete - the authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your + Return :class:`.AUTH_FAILED` if the responses are not accepted, + :class:`.AUTH_SUCCESSFUL` if the responses are accepted and complete + the authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this set of responses is accepted for authentication, but more authentication is required. (In this latter case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) If you wish to continue interactive authentication with more questions, - you may return an :class:`InteractiveQuery` object, which should cause the + you may return an :class:`.InteractiveQuery` object, which should cause the client to respond with more answers, calling this method again. This cycle can continue indefinitely. - The default implementation always returns :class:`AUTH_FAILED`. + The default implementation always returns :class:`.AUTH_FAILED`. :param responses: list of responses from the client :type responses: list(str) - :return: :class:`AUTH_FAILED` if the authentication fails; - :class:`AUTH_SUCCESSFUL` if it succeeds; - :class:`AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is + :return: :class:`.AUTH_FAILED` if the authentication fails; + :class:`.AUTH_SUCCESSFUL` if it succeeds; + :class:`.AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is successful, but authentication must continue; otherwise an object containing queries for the user - :rtype: int or :class:`InteractiveQuery` + :rtype: int or :class:`.InteractiveQuery` """ return AUTH_FAILED @@ -338,7 +338,7 @@ class ServerInterface (object): :param kind: the kind of global request being made. :type kind: str :param msg: any extra arguments to the request. - :type msg: :class:`Message` + :type msg: :class:`.Message` :return: ``True`` or a tuple of data if the request was granted; ``False`` otherwise. :rtype: bool @@ -357,8 +357,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`Channel` the pty request arrived on. - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the pty request arrived on. + :type channel: :class:`.Channel` :param term: type of terminal requested (for example, ``"vt100"``). :type term: str :param width: width of screen in characters. @@ -386,8 +386,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`Channel` the request arrived on. - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the request arrived on. + :type channel: :class:`.Channel` :return: ``True`` if this channel is now hooked up to a shell; ``False`` if a shell can't or won't be provided. :rtype: bool @@ -402,8 +402,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`Channel` the request arrived on. - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the request arrived on. + :type channel: :class:`.Channel` :param command: the command to execute. :type command: str :return: ``True`` if this channel is now hooked up to the stdin, @@ -427,12 +427,12 @@ class ServerInterface (object): If one has been set, the handler is invoked and this method returns ``True``. Otherwise it returns ``False``. - .. note:: Because the default implementation uses the :class:`Transport` to + .. note:: Because the default implementation uses the :class:`.Transport` to identify valid subsystems, you probably won't need to override this method. - :param channel: the :class:`Channel` the pty request arrived on. - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the pty request arrived on. + :type channel: :class:`.Channel` :param name: name of the requested subsystem. :type name: str :return: ``True`` if this channel is now hooked up to the requested @@ -453,8 +453,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`Channel` the pty request arrived on. - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the pty request arrived on. + :type channel: :class:`.Channel` :param width: width of screen in characters. :type width: int :param height: height of screen in characters. @@ -478,8 +478,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`Channel` the X11 request arrived on - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the X11 request arrived on + :type channel: :class:`.Channel` :param single_connection: ``True`` if only a single X11 channel should be opened :type single_connection: bool @@ -502,8 +502,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`Channel` the request arrived on - :type channel: :class:`Channel` + :param channel: the :class:`.Channel` the request arrived on + :type channel: :class:`.Channel` :return: ``True`` if the AgentForward was loaded; ``False`` if not :rtype: bool """ @@ -517,9 +517,9 @@ class ServerInterface (object): authentication is complete. The ``chanid`` parameter is a small number that uniquely identifies the - channel within a :class:`Transport`. A :class:`Channel` object is not created + channel within a :class:`.Transport`. A :class:`.Channel` object is not created unless this method returns ``OPEN_SUCCEEDED`` -- once a - :class:`Channel` object is created, you can call :class:`Channel.get_id` to + :class:`.Channel` object is created, you can call :class:`Channel.get_id` to retrieve the channel ID. The origin and destination parameters are (ip_address, port) tuples @@ -569,19 +569,19 @@ class SubsystemHandler (threading.Thread): """ def __init__(self, channel, name, server): """ - Create a new handler for a channel. This is used by :class:`ServerInterface` + Create a new handler for a channel. This is used by :class:`.ServerInterface` to start up a new handler when a channel requests this subsystem. You don't need to override this method, but if you do, be sure to pass the ``channel`` and ``name`` parameters through to the original ``__init__`` method here. :param channel: the channel associated with this subsystem request. - :type channel: :class:`Channel` + :type channel: :class:`.Channel` :param name: name of the requested subsystem. :type name: str :param server: the server object for the session that started this subsystem - :type server: :class:`ServerInterface` + :type server: :class:`.ServerInterface` """ threading.Thread.__init__(self, target=self._run) self.__channel = channel @@ -591,10 +591,10 @@ class SubsystemHandler (threading.Thread): def get_server(self): """ - Return the :class:`ServerInterface` object associated with this channel and + Return the :class:`.ServerInterface` object associated with this channel and subsystem. - :rtype: :class:`ServerInterface` + :rtype: :class:`.ServerInterface` """ return self.__server @@ -620,21 +620,21 @@ class SubsystemHandler (threading.Thread): returns, the channel is closed. The combination of ``transport`` and ``channel`` are unique; this handler - corresponds to exactly one :class:`Channel` on one :class:`Transport`. + corresponds to exactly one :class:`.Channel` on one :class:`.Transport`. .. note:: It is the responsibility of this method to exit if the - underlying :class:`Transport` is closed. This can be done by checking + underlying :class:`.Transport` is closed. This can be done by checking :class:`Transport.is_active` or noticing an EOF - on the :class:`Channel`. If this method loops forever without checking + on the :class:`.Channel`. If this method loops forever without checking for this case, your python interpreter may refuse to exit because this thread will still be running. :param name: name of the requested subsystem. :type name: str - :param transport: the server-mode :class:`Transport`. - :type transport: :class:`Transport` + :param transport: the server-mode :class:`.Transport`. + :type transport: :class:`.Transport` :param channel: the channel associated with this subsystem request. - :type channel: :class:`Channel` + :type channel: :class:`.Channel` """ pass diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index 267bc3ab..9eb66b5a 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -68,8 +68,8 @@ class SFTPAttributes (object): :type obj: object :param filename: the filename associated with this file. :type filename: str - :return: new :class:`SFTPAttributes` object with the same attribute fields. - :rtype: :class:`SFTPAttributes` + :return: new :class:`.SFTPAttributes` object with the same attribute fields. + :rtype: :class:`.SFTPAttributes` """ attr = cls() attr.st_size = obj.st_size diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index ef64a9fe..c30805a6 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -52,19 +52,19 @@ def _to_unicode(s): class SFTPClient (BaseSFTP): """ SFTP client object. ``SFTPClient`` is used to open an sftp session across - an open ssh :class:`Transport` and do remote file operations. + an open ssh :class:`.Transport` and do remote file operations. """ def __init__(self, sock): """ - Create an SFTP client from an existing :class:`Channel`. The channel + Create an SFTP client from an existing :class:`.Channel`. The channel should already have requested the ``"sftp"`` subsystem. An alternate way to create an SFTP client context is by using :class:`from_transport`. - :param sock: an open :class:`Channel` using the ``"sftp"`` subsystem - :type sock: :class:`Channel` + :param sock: an open :class:`.Channel` using the ``"sftp"`` subsystem + :type sock: :class:`.Channel` :raises SSHException: if there's an exception while negotiating sftp @@ -91,13 +91,13 @@ class SFTPClient (BaseSFTP): def from_transport(cls, t): """ - Create an SFTP client channel from an open :class:`Transport`. + Create an SFTP client channel from an open :class:`.Transport`. - :param t: an open :class:`Transport` which is already authenticated - :type t: :class:`Transport` - :return: a new :class:`SFTPClient` object, referring to an sftp session + :param t: an open :class:`.Transport` which is already authenticated + :type t: :class:`.Transport` + :return: a new :class:`.SFTPClient` object, referring to an sftp session (channel) across the transport - :rtype: :class:`SFTPClient` + :rtype: :class:`.SFTPClient` """ chan = t.open_session() if chan is None: @@ -124,11 +124,11 @@ class SFTPClient (BaseSFTP): def get_channel(self): """ - Return the underlying :class:`Channel` object for this SFTP session. This + Return the underlying :class:`.Channel` object for this SFTP session. This might be useful for doing things like setting a timeout on the channel. :return: the SSH channel - :rtype: :class:`Channel` + :rtype: :class:`.Channel` .. versionadded:: 1.7.1 """ @@ -140,7 +140,7 @@ class SFTPClient (BaseSFTP): The list is in arbitrary order. It does not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. This method is meant to mirror ``os.listdir`` as closely as possible. - For a list of full :class:`SFTPAttributes` objects, see :class:`listdir_attr`. + For a list of full :class:`.SFTPAttributes` objects, see :class:`listdir_attr`. :param path: path to list (defaults to ``'.'``) :type path: str @@ -151,12 +151,12 @@ class SFTPClient (BaseSFTP): def listdir_attr(self, path='.'): """ - Return a list containing :class:`SFTPAttributes` objects corresponding to + Return a list containing :class:`.SFTPAttributes` objects corresponding to files in the given ``path``. The list is in arbitrary order. It does not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. - The returned :class:`SFTPAttributes` objects will each have an additional + The returned :class:`.SFTPAttributes` objects will each have an additional field: ``longname``, which may contain a formatted string of the file's attributes, in unix format. The content of this string will probably depend on the SFTP server implementation. @@ -164,7 +164,7 @@ class SFTPClient (BaseSFTP): :param path: path to list (defaults to ``'.'``) :type path: str :return: list of attributes - :rtype: list of :class:`SFTPAttributes` + :rtype: list of :class:`.SFTPAttributes` .. versionadded:: 1.2 """ @@ -783,5 +783,5 @@ class SFTPClient (BaseSFTP): class SFTP (SFTPClient): - "an alias for :class:`SFTPClient` for backwards compatability" + "an alias for :class:`.SFTPClient` for backwards compatability" pass diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index f8952889..3ff0d685 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`SFTPFile` +:class:`.SFTPFile` """ from __future__ import with_statement @@ -181,7 +181,7 @@ class SFTPFile (BufferedFile): def settimeout(self, timeout): """ Set a timeout on read/write operations on the underlying socket or - ssh :class:`Channel`. + ssh :class:`.Channel`. .. seealso:: :class:`Channel.settimeout` :param timeout: seconds to wait for a pending read/write operation @@ -193,7 +193,7 @@ class SFTPFile (BufferedFile): def gettimeout(self): """ Returns the timeout in seconds (as a float) associated with the socket - or ssh :class:`Channel` used for this file. + or ssh :class:`.Channel` used for this file. .. seealso:: :class:`Channel.gettimeout` :rtype: float @@ -203,7 +203,7 @@ class SFTPFile (BufferedFile): def setblocking(self, blocking): """ Set blocking or non-blocking mode on the underiying socket or ssh - :class:`Channel`. + :class:`.Channel`. .. seealso:: :class:`Channel.setblocking` :param blocking: 0 to set non-blocking mode; non-0 to set blocking diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index c591b318..3b3c6b45 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -76,7 +76,7 @@ class SFTPHandle (object): to be 64 bits. If the end of the file has been reached, this method may return an - empty string to signify EOF, or it may also return :class:`SFTP_EOF`. + empty string to signify EOF, or it may also return :class:`.SFTP_EOF`. The default implementation checks for an attribute on ``self`` named ``readfile``, and if present, performs the read operation on the python @@ -124,7 +124,7 @@ class SFTPHandle (object): :type offset: int or long :param data: data to write into the file. :type data: str - :return: an SFTP error code like :class:`SFTP_OK`. + :return: an SFTP error code like :class:`.SFTP_OK`. """ writefile = getattr(self, 'writefile', None) if writefile is None: @@ -148,13 +148,13 @@ class SFTPHandle (object): def stat(self): """ - Return an :class:`SFTPAttributes` object referring to this open file, or an + Return an :class:`.SFTPAttributes` object referring to this open file, or an error code. This is equivalent to :class:`SFTPServerInterface.stat`, except it's called on an open file instead of a path. :return: an attributes object for the given file, or an SFTP error - code (like :class:`SFTP_PERMISSION_DENIED`). - :rtype: :class:`SFTPAttributes` or error code + code (like :class:`.SFTP_PERMISSION_DENIED`). + :rtype: :class:`.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -165,8 +165,8 @@ class SFTPHandle (object): check for the presence of fields before using them. :param attr: the attributes to change on this file. - :type attr: :class:`SFTPAttributes` - :return: an error code like :class:`SFTP_OK`. + :type attr: :class:`.SFTPAttributes` + :return: an error code like :class:`.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index 867acbcb..89684c15 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -40,7 +40,7 @@ _hash_class = { class SFTPServer (BaseSFTP, SubsystemHandler): """ - Server-side SFTP subsystem support. Since this is a :class:`SubsystemHandler`, + Server-side SFTP subsystem support. Since this is a :class:`.SubsystemHandler`, it can be (and is meant to be) set as the handler for ``"sftp"`` requests. Use :class:`Transport.set_subsystem_handler` to activate this class. """ @@ -48,18 +48,18 @@ class SFTPServer (BaseSFTP, SubsystemHandler): def __init__(self, channel, name, server, sftp_si=SFTPServerInterface, *largs, **kwargs): """ The constructor for SFTPServer is meant to be called from within the - :class:`Transport` as a subsystem handler. ``server`` and any additional + :class:`.Transport` as a subsystem handler. ``server`` and any additional parameters or keyword parameters are passed from the original call to :class:`Transport.set_subsystem_handler`. - :param channel: channel passed from the :class:`Transport`. - :type channel: :class:`Channel` + :param channel: channel passed from the :class:`.Transport`. + :type channel: :class:`.Channel` :param name: name of the requested subsystem. :type name: str :param server: the server object associated with this channel and subsystem - :type server: :class:`ServerInterface` - :param sftp_si: a subclass of :class:`SFTPServerInterface` to use for handling + :type server: :class:`.ServerInterface` + :param sftp_si: a subclass of :class:`.SFTPServerInterface` to use for handling individual requests. :type sftp_si: class """ @@ -128,7 +128,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): :param e: an errno code, as from ``OSError.errno``. :type e: int - :return: an SFTP error code like :class:`SFTP_NO_SUCH_FILE`. + :return: an SFTP error code like :class:`.SFTP_NO_SUCH_FILE`. :rtype: int """ if e == errno.EACCES: @@ -155,7 +155,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): absolute path). :type filename: str :param attr: attributes to change. - :type attr: :class:`SFTPAttributes` + :type attr: :class:`.SFTPAttributes` """ if sys.platform != 'win32': # mode operations are meaningless on win32 diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index b203aea0..d1b24978 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`SFTPServerInterface` is an interface to override for SFTP server support. +:class:`.SFTPServerInterface` is an interface to override for SFTP server support. """ import os @@ -29,7 +29,7 @@ from paramiko.sftp import * class SFTPServerInterface (object): """ This class defines an interface for controlling the behavior of paramiko - when using the :class:`SFTPServer` subsystem to provide an SFTP server. + when using the :class:`.SFTPServer` subsystem to provide an SFTP server. Methods on this class are called from the SFTP session's thread, so you can block as long as necessary without affecting other sessions (even other @@ -48,7 +48,7 @@ class SFTPServerInterface (object): :param server: the server object associated with this channel and SFTP subsystem - :type server: :class:`ServerInterface` + :type server: :class:`.ServerInterface` """ super(SFTPServerInterface, self).__init__(*largs, **kwargs) @@ -72,10 +72,10 @@ class SFTPServerInterface (object): def open(self, path, flags, attr): """ Open a file on the server and create a handle for future operations - on that file. On success, a new object subclassed from :class:`SFTPHandle` + on that file. On success, a new object subclassed from :class:`.SFTPHandle` should be returned. This handle will be used for future operations on the file (read, write, etc). On failure, an error code such as - :class:`SFTP_PERMISSION_DENIED` should be returned. + :class:`.SFTP_PERMISSION_DENIED` should be returned. ``flags`` contains the requested mode for opening (read-only, write-append, etc) as a bitset of flags from the ``os`` module: @@ -103,9 +103,9 @@ class SFTPServerInterface (object): requested mode for opening the file. :type flags: int :param attr: requested attributes of the file if it is newly created. - :type attr: :class:`SFTPAttributes` - :return: a new :class:`SFTPHandle` or error code. - :rtype :class:`SFTPHandle` + :type attr: :class:`.SFTPAttributes` + :return: a new :class:`.SFTPHandle` or error code. + :rtype :class:`.SFTPHandle` """ return SFTP_OP_UNSUPPORTED @@ -115,7 +115,7 @@ class SFTPServerInterface (object): posix notation (``"/"`` separates folder names) and may be an absolute or relative path. - The list of files is expected to be a list of :class:`SFTPAttributes` + The list of files is expected to be a list of :class:`.SFTPAttributes` objects, which are similar in structure to the objects returned by ``os.stat``. In addition, each object should have its ``filename`` field filled in, since this is important to a directory listing and @@ -123,13 +123,13 @@ class SFTPServerInterface (object): :class:`SFTPAttributes.from_stat` will usually do what you want. In case of an error, you should return one of the ``SFTP_*`` error - codes, such as :class:`SFTP_PERMISSION_DENIED`. + codes, such as :class:`.SFTP_PERMISSION_DENIED`. :param path: the requested path (relative or absolute) to be listed. :type path: str :return: a list of the files in the given folder, using - :class:`SFTPAttributes` objects. - :rtype: list of :class:`SFTPAttributes` or error code + :class:`.SFTPAttributes` objects. + :rtype: list of :class:`.SFTPAttributes` or error code .. note:: You should normalize the given ``path`` first (see the ``os.path`` module) and check appropriate permissions before returning @@ -141,7 +141,7 @@ class SFTPServerInterface (object): def stat(self, path): """ - Return an :class:`SFTPAttributes` object for a path on the server, or an + Return an :class:`.SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as "aliases"), you should follow them. (:class:`lstat` is the corresponding call that doesn't follow symlinks/aliases.) @@ -150,14 +150,14 @@ class SFTPServerInterface (object): file statistics for. :type path: str :return: an attributes object for the given file, or an SFTP error - code (like :class:`SFTP_PERMISSION_DENIED`). - :rtype: :class:`SFTPAttributes` or error code + code (like :class:`.SFTP_PERMISSION_DENIED`). + :rtype: :class:`.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED def lstat(self, path): """ - Return an :class:`SFTPAttributes` object for a path on the server, or an + Return an :class:`.SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as "aliases"), you should not follow them -- instead, you should return data on the symlink or alias itself. (:class:`stat` is the @@ -167,8 +167,8 @@ class SFTPServerInterface (object): file statistics for. :type path: str :return: an attributes object for the given file, or an SFTP error - code (like :class:`SFTP_PERMISSION_DENIED`). - :rtype: :class:`SFTPAttributes` or error code + code (like :class:`.SFTP_PERMISSION_DENIED`). + :rtype: :class:`.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -179,7 +179,7 @@ class SFTPServerInterface (object): :param path: the requested path (relative or absolute) of the file to delete. :type path: str - :return: an SFTP error code like :class:`SFTP_OK`. + :return: an SFTP error code like :class:`.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -201,7 +201,7 @@ class SFTPServerInterface (object): :type oldpath: str :param newpath: the requested new path of the file. :type newpath: str - :return: an SFTP error code like :class:`SFTP_OK`. + :return: an SFTP error code like :class:`.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -220,8 +220,8 @@ class SFTPServerInterface (object): folder. :type path: str :param attr: requested attributes of the new folder. - :type attr: :class:`SFTPAttributes` - :return: an SFTP error code like :class:`SFTP_OK`. + :type attr: :class:`.SFTPAttributes` + :return: an SFTP error code like :class:`.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -235,7 +235,7 @@ class SFTPServerInterface (object): :param path: requested path (relative or absolute) of the folder to remove. :type path: str - :return: an SFTP error code like :class:`SFTP_OK`. + :return: an SFTP error code like :class:`.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -250,8 +250,8 @@ class SFTPServerInterface (object): change. :type path: str :param attr: requested attributes to change on the file. - :type attr: :class:`SFTPAttributes` - :return: an error code like :class:`SFTP_OK`. + :type attr: :class:`.SFTPAttributes` + :return: an error code like :class:`.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -288,7 +288,7 @@ class SFTPServerInterface (object): :param path: path (relative or absolute) of the symbolic link. :type path: str :return: the target path of the symbolic link, or an error code like - :class:`SFTP_NO_SUCH_FILE`. + :class:`.SFTP_NO_SUCH_FILE`. :rtype: str or error code """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py index 5b9b4901..5d9f43c5 100644 --- a/paramiko/ssh_exception.py +++ b/paramiko/ssh_exception.py @@ -82,7 +82,7 @@ class PartialAuthentication (AuthenticationException): class ChannelException (SSHException): """ - Exception raised when an attempt to open a new :class:`Channel` fails. + Exception raised when an attempt to open a new :class:`.Channel` fails. :ivar code: the error code returned by the server :type code: int @@ -101,9 +101,9 @@ class BadHostKeyException (SSHException): :ivar hostname: the hostname of the SSH server :type hostname: str :ivar key: the host key presented by the server - :type key: :class:`PKey` + :type key: :class:`.PKey` :ivar expected_key: the host key expected - :type expected_key: :class:`PKey` + :type expected_key: :class:`.PKey` .. versionadded:: 1.6 """ diff --git a/paramiko/transport.py b/paramiko/transport.py index 8be0ca37..201ae007 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -283,20 +283,20 @@ class Transport (threading.Thread): def get_security_options(self): """ - Return a :class:`SecurityOptions` object which can be used to tweak the + Return a :class:`.SecurityOptions` object which can be used to tweak the encryption algorithms this transport will permit, and the order of preference for them. :return: an object that can be used to change the preferred algorithms for encryption, digest (hash), public key, and key exchange. - :rtype: :class:`SecurityOptions` + :rtype: :class:`.SecurityOptions` """ return SecurityOptions(self) def start_client(self, event=None): """ Negotiate a new SSH2 session as a client. This is the first step after - creating a new :class:`Transport`. A separate thread is created for protocol + creating a new :class:`.Transport`. A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When @@ -348,7 +348,7 @@ class Transport (threading.Thread): def start_server(self, event=None, server=None): """ Negotiate a new SSH2 session as a server. This is the first step after - creating a new :class:`Transport` and setting up your server host key(s). A + creating a new :class:`.Transport` and setting up your server host key(s). A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When @@ -531,8 +531,8 @@ class Transport (threading.Thread): Request a new channel to the server, of type ``"session"``. This is just an alias for ``open_channel('session')``. - :return: a new :class:`Channel` - :rtype: :class:`Channel` + :return: a new :class:`.Channel` + :rtype: :class:`.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -547,8 +547,8 @@ class Transport (threading.Thread): :param src_addr: the source address of the x11 server (port is the x11 port, ie. 6010) :type src_addr: (str, int) - :return: a new :class:`Channel` - :rtype: :class:`Channel` + :return: a new :class:`.Channel` + :rtype: :class:`.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -561,8 +561,8 @@ class Transport (threading.Thread): ``"auth-agent@openssh.com"``. This is just an alias for ``open_channel('auth-agent@openssh.com')``. - :return: a new :class:`Channel` - :rtype: :class:`Channel` + :return: a new :class:`.Channel` + :rtype: :class:`.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -584,7 +584,7 @@ class Transport (threading.Thread): def open_channel(self, kind, dest_addr=None, src_addr=None): """ - Request a new channel to the server. :class:`Channels ` are socket-like + Request a new channel to the server. :class:`.Channels ` are socket-like objects used for the actual transfer of data across the session. You may only request a channel after negotiating encryption (using :class:`connect` or :class:`start_client`) and authenticating. @@ -599,8 +599,8 @@ class Transport (threading.Thread): :param src_addr: the source address of this port forwarding, if ``kind`` is ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"`` :type src_addr: (str, int) - :return: a new :class:`Channel` on success - :rtype: :class:`Channel` + :return: a new :class:`.Channel` on success + :rtype: :class:`.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -717,9 +717,9 @@ class Transport (threading.Thread): an SFTP session will be opened with the remote host, and a new SFTPClient object will be returned. - :return: a new :class:`SFTPClient` object, referring to an sftp session + :return: a new :class:`.SFTPClient` object, referring to an sftp session (channel) across this transport - :rtype: :class:`SFTPClient` + :rtype: :class:`.SFTPClient` """ return SFTPClient.from_transport(self) @@ -793,10 +793,10 @@ class Transport (threading.Thread): :param wait: ``True`` if this method should not return until a response is received; ``False`` otherwise. :type wait: bool - :return: a :class:`Message` containing possible additional data if the - request was successful (or an empty :class:`Message` if ``wait`` was + :return: a :class:`.Message` containing possible additional data if the + request was successful (or an empty :class:`.Message` if ``wait`` was ``False``); ``None`` if the request was denied. - :rtype: :class:`Message` + :rtype: :class:`.Message` """ if wait: self.completion_event = threading.Event() @@ -828,7 +828,7 @@ class Transport (threading.Thread): forever :type timeout: int :return: a new Channel opened by the client - :rtype: :class:`Channel` + :rtype: :class:`.Channel` """ self.lock.acquire() try: @@ -857,7 +857,7 @@ class Transport (threading.Thread): negotiate encryption with a server. If it fails, an exception will be thrown. On success, the method will return cleanly, and an encrypted session exists. You may immediately call :class:`open_channel` or - :class:`open_session` to get a :class:`Channel` object, which is used for data + :class:`open_session` to get a :class:`.Channel` object, which is used for data transfer. .. note:: If you fail to supply a password or private key, this method may @@ -928,15 +928,15 @@ class Transport (threading.Thread): """ Set the handler class for a subsystem in server mode. If a request for this subsystem is made on an open ssh channel later, this handler - will be constructed and called -- see :class:`SubsystemHandler` for more + will be constructed and called -- see :class:`.SubsystemHandler` for more detailed documentation. Any extra parameters (including keyword arguments) are saved and - passed to the :class:`SubsystemHandler` constructor later. + passed to the :class:`.SubsystemHandler` constructor later. :param name: name of the subsystem. :type name: str - :param handler: subclass of :class:`SubsystemHandler` that handles this + :param handler: subclass of :class:`.SubsystemHandler` that handles this subsystem. :type handler: class """ @@ -975,7 +975,7 @@ class Transport (threading.Thread): Try to authenticate to the server using no authentication at all. This will almost always fail. It may be useful for determining the list of authentication types supported by the server, by catching the - :class:`BadAuthenticationType` exception raised. + :class:`.BadAuthenticationType` exception raised. :param username: the username to authenticate as :type username: string @@ -2041,7 +2041,7 @@ class SecurityOptions (object): exchange algorithms, listed in order of preference. Changing the contents and/or order of these fields affects the underlying - :class:`Transport` (but only if you change them before starting the session). + :class:`.Transport` (but only if you change them before starting the session). If you try to add an algorithm that paramiko doesn't recognize, ``ValueError`` will be raised. If you try to assign something besides a tuple to one of the fields, ``TypeError`` will be raised. diff --git a/paramiko/util.py b/paramiko/util.py index a0f4b429..f2950134 100644 --- a/paramiko/util.py +++ b/paramiko/util.py @@ -192,7 +192,7 @@ def load_host_keys(filename): This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in ``os.path.expanduser("~/.ssh/known_hosts")``. - Since 1.5.3, this is just a wrapper around :class:`HostKeys`. + Since 1.5.3, this is just a wrapper around :class:`.HostKeys`. :param filename: name of the file to read host keys from :type filename: str @@ -204,7 +204,7 @@ def load_host_keys(filename): def parse_ssh_config(file_obj): """ - Provided only as a backward-compatible wrapper around :class:`SSHConfig`. + Provided only as a backward-compatible wrapper around :class:`.SSHConfig`. """ config = SSHConfig() config.parse(file_obj) @@ -212,7 +212,7 @@ def parse_ssh_config(file_obj): def lookup_ssh_host_config(hostname, config): """ - Provided only as a backward-compatible wrapper around :class:`SSHConfig`. + Provided only as a backward-compatible wrapper around :class:`.SSHConfig`. """ return config.lookup(hostname) -- cgit v1.2.3 From f09b562fa874d3358daa7dfd4ca7f2c8b5d47b68 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 12:15:29 -0800 Subject: Replace accidental class-refs on local method-refs --- paramiko/__init__.py | 4 +-- paramiko/agent.py | 2 +- paramiko/buffered_pipe.py | 4 +-- paramiko/channel.py | 72 +++++++++++++++++++++++------------------------ paramiko/client.py | 16 +++++------ paramiko/config.py | 2 +- paramiko/file.py | 12 ++++---- paramiko/hostkeys.py | 4 +-- paramiko/message.py | 4 +-- paramiko/pkey.py | 2 +- paramiko/resource.py | 2 +- paramiko/server.py | 28 +++++++++--------- paramiko/sftp_client.py | 14 ++++----- paramiko/sftp_file.py | 14 ++++----- paramiko/sftp_handle.py | 4 +-- paramiko/sftp_si.py | 4 +-- paramiko/transport.py | 40 +++++++++++++------------- 17 files changed, 114 insertions(+), 114 deletions(-) diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 1f7f6bc3..b7a2efb6 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -28,8 +28,8 @@ services across an encrypted tunnel. (This is how ``sftp`` works, for example.) The high-level client API starts with creation of an :class:`.SSHClient` object. For more direct control, pass a socket (or socket-like object) to a -:class:`.Transport`, and use :class:`start_server ` or -:class:`start_client ` to negoatite +:class:`.Transport`, and use `start_server <.Transport.start_server>` or +`start_client <.Transport.start_client>` to negoatite with the remote host as either a server or client. As a client, you are responsible for authenticating using a password or private key, and checking the server's host key. (Key signature and verification is done by paramiko, diff --git a/paramiko/agent.py b/paramiko/agent.py index a5413f74..45bb2657 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -318,7 +318,7 @@ class Agent(AgentSSH): def __init__(self): """ Open a session with the local machine's SSH agent, if one is running. - If no agent is running, initialization will succeed, but :class:`get_keys` + If no agent is running, initialization will succeed, but `get_keys` will return an empty tuple. :raises SSHException: if an SSH agent is found, but speaks an diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index c400bb4b..3a4b2bec 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -86,7 +86,7 @@ class BufferedPipe (object): feeder. A ``False`` result does not mean that the feeder has closed; it means you may need to wait before more data arrives. - :return: ``True`` if a :class:`read` call would immediately return at least + :return: ``True`` if a `read` call would immediately return at least one byte; ``False`` otherwise. :rtype: bool """ @@ -173,7 +173,7 @@ class BufferedPipe (object): def close(self): """ - Close this pipe object. Future calls to :class:`read` after the buffer + Close this pipe object. Future calls to `read` after the buffer has been emptied will return immediately with an empty string. """ self._lock.acquire() diff --git a/paramiko/channel.py b/paramiko/channel.py index 5cfa9059..b255c8a0 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -51,7 +51,7 @@ class Channel (object): you any more data until you read some of it. (This won't affect other channels on the same transport -- all channels on a single transport are flow-controlled independently.) Similarly, if the server isn't reading - data you send, calls to :class:`send` may block, unless you set a timeout. This + 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. """ @@ -127,9 +127,9 @@ class Channel (object): """ Request a pseudo-terminal from the server. This is usually used right after creating a client channel, to ask the server to provide some - basic terminal semantics for a shell invoked with :class:`invoke_shell`. + basic terminal semantics for a shell invoked with `invoke_shell`. It isn't necessary (or desirable) to call this method if you're going - to exectue a single command with :class:`exec_command`. + to exectue a single command with `exec_command`. :param term: the terminal type to emulate (for example, ``'vt100'``) :type term: str @@ -168,7 +168,7 @@ class Channel (object): allows it, the channel will then be directly connected to the stdin, stdout, and stderr of the shell. - Normally you would call :class:`get_pty` before this, in which case the + Normally you would call `get_pty` before this, in which case the shell will operate through the pty, and the channel will be connected to the stdin and stdout of the pty. @@ -247,7 +247,7 @@ class Channel (object): def resize_pty(self, width=80, height=24, width_pixels=0, height_pixels=0): """ Resize the pseudo-terminal. This can be used to change the width and - height of the terminal emulation created in a previous :class:`get_pty` call. + height of the terminal emulation created in a previous `get_pty` call. :param width: new width (in characters) of the terminal screen :type width: int @@ -278,10 +278,10 @@ class Channel (object): """ Return true if the remote process has exited and returned an exit status. You may use this to poll the process status if you don't - want to block in :class:`recv_exit_status`. Note that the server may not + want to block in `recv_exit_status`. Note that the server may not return an exit status in some cases (like bad servers). - :return: True if :class:`recv_exit_status` will return immediately + :return: True if `recv_exit_status` will return immediately :rtype: bool .. versionadded:: 1.7.3 """ @@ -290,7 +290,7 @@ class Channel (object): def recv_exit_status(self): """ Return the exit status from the process on the server. This is - mostly useful for retrieving the reults of an :class:`exec_command`. + mostly useful for retrieving the reults of an `exec_command`. If the command hasn't finished yet, this method will wait until it does, or until the channel is closed. If no exit status is provided by the server, -1 is returned. @@ -427,7 +427,7 @@ class Channel (object): """ Set a name for this channel. Currently it's only used to set the name of the channel in logfile entries. The name can be fetched with the - :class:`get_name` method. + `get_name` method. :param name: new channel name :type name: str @@ -436,7 +436,7 @@ class Channel (object): def get_name(self): """ - Get the name of this channel that was previously set by :class:`set_name`. + Get the name of this channel that was previously set by `set_name`. :return: the name of this channel. :rtype: str @@ -461,13 +461,13 @@ class Channel (object): The default is ``False``, but in some cases it may be convenient to have both streams combined. - If this is ``False``, and :class:`exec_command` is called (or ``invoke_shell`` - with no pty), output to stderr will not show up through the :class:`recv` - and :class:`recv_ready` calls. You will have to use :class:`recv_stderr` and - :class:`recv_stderr_ready` to get stderr output. + If this is ``False``, and `exec_command` is called (or ``invoke_shell`` + with no pty), output to stderr will not show up through the `recv` + and `recv_ready` calls. You will have to use `recv_stderr` and + `recv_stderr_ready` to get stderr output. - If this is ``True``, data will never show up via :class:`recv_stderr` or - :class:`recv_stderr_ready`. + If this is ``True``, data will never show up via `recv_stderr` or + `recv_stderr_ready`. :param combine: ``True`` if stderr output should be combined into stdout on this channel. @@ -517,7 +517,7 @@ class Channel (object): """ Returns the timeout in seconds (as a float) associated with socket operations, or ``None`` if no timeout is set. This reflects the last - call to :class:`setblocking` or :class:`settimeout`. + call to `setblocking` or `settimeout`. :return: timeout in seconds, or ``None``. :rtype: float @@ -530,10 +530,10 @@ class Channel (object): the channel is set to non-blocking mode; otherwise it's set to blocking mode. Initially all channels are in blocking mode. - In non-blocking mode, if a :class:`recv` call doesn't find any data, or if a - :class:`send` call can't immediately dispose of the data, an error exception + In non-blocking mode, if a `recv` call doesn't find any data, or if a + `send` call can't immediately dispose of the data, an error exception is raised. In blocking mode, the calls block until they can proceed. An - EOF condition is considered "immediate data" for :class:`recv`, so if the + EOF condition is considered "immediate data" for `recv`, so if the channel is closed in the read direction, it will never block. ``chan.setblocking(0)`` is equivalent to ``chan.settimeout(0)``; @@ -592,7 +592,7 @@ class Channel (object): channel. A ``False`` result does not mean that the channel has closed; it means you may need to wait before more data arrives. - :return: ``True`` if a :class:`recv` call on this channel would immediately + :return: ``True`` if a `recv` call on this channel would immediately return at least one byte; ``False`` otherwise. :rtype: boolean """ @@ -611,7 +611,7 @@ class Channel (object): :rtype: str :raises socket.timeout: if no data is ready before the timeout set by - :class:`settimeout`. + `settimeout`. """ try: out = self.in_buffer.read(nbytes, self.timeout) @@ -632,11 +632,11 @@ class Channel (object): def recv_stderr_ready(self): """ Returns true if data is buffered and ready to be read from this - channel's stderr stream. Only channels using :class:`exec_command` or - :class:`invoke_shell` without a pty will ever have data on the stderr + channel's stderr stream. Only channels using `exec_command` or + `invoke_shell` without a pty will ever have data on the stderr stream. - :return: ``True`` if a :class:`recv_stderr` call on this channel would + :return: ``True`` if a `recv_stderr` call on this channel would immediately return at least one byte; ``False`` otherwise. :rtype: boolean @@ -647,7 +647,7 @@ class Channel (object): def recv_stderr(self, nbytes): """ Receive data from the channel's stderr stream. Only channels using - :class:`exec_command` or :class:`invoke_shell` without a pty will ever have data + `exec_command` or `invoke_shell` without a pty will ever have data on the stderr stream. The return value is a string representing the data received. The maximum amount of data to be received at once is specified by ``nbytes``. If a string of length zero is returned, the @@ -659,7 +659,7 @@ class Channel (object): :rtype: str :raises socket.timeout: if no data is ready before the timeout set by - :class:`settimeout`. + `settimeout`. .. versionadded:: 1.1 """ @@ -685,10 +685,10 @@ class Channel (object): This means the channel is either closed (so any write attempt would return immediately) or there is at least one byte of space in the outbound buffer. If there is at least one byte of space in the - outbound buffer, a :class:`send` call will succeed immediately and return + outbound buffer, a `send` call will succeed immediately and return the number of bytes actually written. - :return: ``True`` if a :class:`send` call on this channel would immediately + :return: ``True`` if a `send` call on this channel would immediately succeed or fail :rtype: boolean """ @@ -714,7 +714,7 @@ class Channel (object): :rtype: int :raises socket.timeout: if no data could be sent before the timeout set - by :class:`settimeout`. + by `settimeout`. """ size = len(s) self.lock.acquire() @@ -749,7 +749,7 @@ class Channel (object): :rtype: int :raises socket.timeout: if no data could be sent before the timeout set - by :class:`settimeout`. + by `settimeout`. .. versionadded:: 1.1 """ @@ -775,14 +775,14 @@ class Channel (object): def sendall(self, s): """ Send data to the channel, without allowing partial results. Unlike - :class:`send`, this method continues to send data from the given string until + `send`, this method continues to send data from the given string until either all data has been sent or an error occurs. Nothing is returned. :param s: data to send. :type s: str :raises socket.timeout: if sending stalled for longer than the timeout - set by :class:`settimeout`. + set by `settimeout`. :raises socket.error: if an error occured before the entire string was sent. @@ -801,7 +801,7 @@ class Channel (object): def sendall_stderr(self, s): """ Send data to the channel's "stderr" stream, without allowing partial - results. Unlike :class:`send_stderr`, this method continues to send data + results. Unlike `send_stderr`, this method continues to send data from the given string until all data has been sent or an error occurs. Nothing is returned. @@ -809,7 +809,7 @@ class Channel (object): :type s: str :raises socket.timeout: if sending stalled for longer than the timeout - set by :class:`settimeout`. + set by `settimeout`. :raises socket.error: if an error occured before the entire string was sent. @@ -836,7 +836,7 @@ class Channel (object): def makefile_stderr(self, *params): """ Return a file-like object associated with this channel's stderr - stream. Only channels using :class:`exec_command` or :class:`invoke_shell` + stream. Only channels using `exec_command` or `invoke_shell` without a pty will ever have data on the stderr stream. The optional ``mode`` and ``bufsize`` arguments are interpreted the diff --git a/paramiko/client.py b/paramiko/client.py index 0ebc4df8..6041e858 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -71,7 +71,7 @@ class SSHClient (object): def load_system_host_keys(self, filename=None): """ Load host keys from a system (read-only) file. Host keys read with - this method will not be saved back by :class:`save_host_keys`. + this method will not be saved back by `save_host_keys`. This method can be called multiple times. Each new set of host keys will be merged with the existing set (new replacing old if there are @@ -101,8 +101,8 @@ class SSHClient (object): def load_host_keys(self, filename): """ Load host keys from a local host-key file. Host keys read with this - method will be checked after keys loaded via :class:`load_system_host_keys`, - but will be saved back by :class:`save_host_keys` (so they can be modified). + method will be checked after keys loaded via `load_system_host_keys`, + but will be saved back by `save_host_keys` (so they can be modified). The missing host key policy :class:`.AutoAddPolicy` adds keys to this set and saves them, when connecting to a previously-unknown server. @@ -121,8 +121,8 @@ class SSHClient (object): def save_host_keys(self, filename): """ Save the host keys back to a file. Only the host keys loaded with - :class:`load_host_keys` (plus any added directly) will be saved -- not any - host keys loaded with :class:`load_system_host_keys`. + `load_host_keys` (plus any added directly) will be saved -- not any + host keys loaded with `load_system_host_keys`. :param filename: the filename to save to :type filename: str @@ -179,10 +179,10 @@ class SSHClient (object): compress=False, sock=None): """ Connect to an SSH server and authenticate to it. The server's host key - is checked against the system host keys (see :class:`load_system_host_keys`) - and any local host keys (:class:`load_host_keys`). If the server's hostname + is checked against the system host keys (see `load_system_host_keys`) + and any local host keys (`load_host_keys`). If the server's hostname is not found in either set of host keys, the missing host key policy - is used (see :class:`set_missing_host_key_policy`). The default policy is + is used (see `set_missing_host_key_policy`). The default policy is to reject the key and raise an :class:`.SSHException`. Authentication is attempted in the following order of priority: diff --git a/paramiko/config.py b/paramiko/config.py index 583c7e85..980a6cf4 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -87,7 +87,7 @@ class LazyFqdn(object): class SSHConfig (object): """ Representation of config information as stored in the format used by - OpenSSH. Queries can be made via :class:`lookup`. The format is described in + OpenSSH. Queries can be made via `lookup`. The format is described in OpenSSH's ``ssh_config`` man page. This class is provided primarily as a convenience to posix users (since the OpenSSH format is a de-facto standard on posix) but should work fine on Windows too. diff --git a/paramiko/file.py b/paramiko/file.py index 334cff41..4f9b56b6 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -96,7 +96,7 @@ class BufferedFile (object): """ Returns the next line from the input, or raises :class:`.StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to - ``next`` and :class:`readline`. + `next` and `readline`. :raises StopIteration: when the end of the file is reached. @@ -243,7 +243,7 @@ class BufferedFile (object): def readlines(self, sizehint=None): """ - Read all remaining lines using :class:`readline` and return them as a list. + Read all remaining lines using `readline` and return them as a list. If the optional ``sizehint`` argument is present, instead of reading up to EOF, whole lines totalling approximately sizehint bytes (possibly after rounding up to an internal buffer size) are read. @@ -300,7 +300,7 @@ class BufferedFile (object): """ Write data to the file. If write buffering is on (``bufsize`` was specified and non-zero), some or all of the data may not actually be - written yet. (Use :class:`flush` or :class:`close` to force buffered data to be + written yet. (Use `flush` or `close` to force buffered data to be written out.) :param data: data to write. @@ -334,7 +334,7 @@ class BufferedFile (object): """ Write a sequence of strings to the file. The sequence can be any iterable object producing strings, typically a list of strings. (The - name is intended to match :class:`readlines`; ``writelines`` does not add line + name is intended to match `readlines`; ``writelines`` does not add line separators.) :param sequence: an iterable sequence of strings. @@ -380,9 +380,9 @@ class BufferedFile (object): def _get_size(self): """ (subclass override) - Return the size of the file. This is called from within :class:`_set_mode` + Return the size of the file. This is called from within `_set_mode` if the file is opened in append mode, so the file position can be - tracked and :class:`seek` and :class:`tell` will work correctly. If the file is + tracked and `seek` and `tell` will work correctly. If the file is a stream that can't be randomly accessed, you don't need to override this method, """ diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index 704fe7e3..cdf6d5c1 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -112,7 +112,7 @@ class HostKeys (UserDict.DictMixin): verify server keys during SSH negotiation. A HostKeys object can be treated like a dict; any dict lookup is equivalent - to calling :class:`lookup`. + to calling `lookup`. .. versionadded:: 1.5.3 """ @@ -156,7 +156,7 @@ class HostKeys (UserDict.DictMixin): ``os.path.expanduser("~/.ssh/known_hosts")``. If this method is called multiple times, the host keys are merged, - not cleared. So multiple calls to ``load`` will just call :class:`add`, + not cleared. So multiple calls to `load` will just call `add`, replacing any existing entries and adding new ones. :param filename: name of the file to read host keys from diff --git a/paramiko/message.py b/paramiko/message.py index 85fb3c09..3937938b 100644 --- a/paramiko/message.py +++ b/paramiko/message.py @@ -91,7 +91,7 @@ class Message (object): """ Returns the bytes of this Message that have been parsed and returned. The string passed into a Message's constructor can be regenerated by - concatenating ``get_so_far`` and :class:`get_remainder`. + concatenating ``get_so_far`` and `get_remainder`. :return: a string of the bytes parsed so far. :rtype: string @@ -118,7 +118,7 @@ class Message (object): def get_byte(self): """ Return the next byte of the Message, without decomposing it. This - is equivalent to :class:`get_bytes(1)`. + is equivalent to `get_bytes(1) `. :return: the next byte of the Message, or ``'\000'`` if there aren't any bytes remaining. diff --git a/paramiko/pkey.py b/paramiko/pkey.py index a12fc519..928b8498 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -66,7 +66,7 @@ class PKey (object): def __str__(self): """ Return a string of an SSH :class:`.Message` made up of the public part(s) of - this key. This string is suitable for passing to :class:`__init__` to + this key. This string is suitable for passing to `__init__` to re-create the key object later. :return: string representation of an SSH key message. diff --git a/paramiko/resource.py b/paramiko/resource.py index 1d1f8da4..32947c50 100644 --- a/paramiko/resource.py +++ b/paramiko/resource.py @@ -33,7 +33,7 @@ class ResourceManager (object): with the ResourceManager can be collected but still free resources when they die. - Resources are registered using :class:`register`, and when an object is garbage + Resources are registered using `register`, and when an object is garbage collected, each registered resource is closed by having its ``close()`` method called. Multiple resources may be registered per object, but a resource will only be closed once, even if multiple objects register it. diff --git a/paramiko/server.py b/paramiko/server.py index 14f89760..41d0d429 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -35,7 +35,7 @@ class InteractiveQuery (object): Create a new interactive query to send to the client. The name and instructions are optional, but are generally displayed to the end user. A list of prompts may be included, or they may be added via - the :class:`add_prompt` method. + the `add_prompt` method. :param name: name of this query :type name: str @@ -88,12 +88,12 @@ class ServerInterface (object): useless), you should also override some of the channel request methods below, which are used to determine which services will be allowed on a given channel: - - :class:`check_channel_pty_request` - - :class:`check_channel_shell_request` - - :class:`check_channel_subsystem_request` - - :class:`check_channel_window_change_request` - - :class:`check_channel_x11_request` - - :class:`check_channel_forward_agent_request` + - `check_channel_pty_request` + - `check_channel_shell_request` + - `check_channel_subsystem_request` + - `check_channel_window_change_request` + - `check_channel_x11_request` + - `check_channel_forward_agent_request` The ``chanid`` parameter is a small number that uniquely identifies the channel within a :class:`.Transport`. A :class:`.Channel` object is not created @@ -170,7 +170,7 @@ class ServerInterface (object): the authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this key is accepted for authentication, but more authentication is required. (In this latter - case, :class:`get_allowed_auths` will be called to report to the client what + case, `get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) The default implementation always returns :class:`.AUTH_FAILED`. @@ -199,7 +199,7 @@ class ServerInterface (object): authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this password is accepted for authentication, but more authentication is required. (In this latter - case, :class:`get_allowed_auths` will be called to report to the client what + case, `get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) Note that you don't have to actually verify any key signtature here. @@ -230,7 +230,7 @@ class ServerInterface (object): Return :class:`.AUTH_FAILED` if this auth method isn't supported. Otherwise, you should return an :class:`.InteractiveQuery` object containing the prompts and instructions for the user. The response will be sent via a call - to :class:`check_auth_interactive_response`. + to `check_auth_interactive_response`. The default implementation always returns :class:`.AUTH_FAILED`. @@ -256,7 +256,7 @@ class ServerInterface (object): the authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this set of responses is accepted for authentication, but more authentication is required. (In this latter - case, :class:`get_allowed_auths` will be called to report to the client what + case, `get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) If you wish to continue interactive authentication with more questions, @@ -333,7 +333,7 @@ class ServerInterface (object): does not support any global requests. .. note:: Port forwarding requests are handled separately, in - :class:`check_port_forward_request`. + `check_port_forward_request`. :param kind: the kind of global request being made. :type kind: str @@ -558,13 +558,13 @@ class SubsystemHandler (threading.Thread): :class:`Transport.set_subsystem_handler`, an object of this class will be created for each request for this subsystem. Each new object - will be executed within its own new thread by calling :class:`start_subsystem`. + will be executed within its own new thread by calling `start_subsystem`. When that method completes, the channel is closed. For example, if you made a subclass ``MP3Handler`` and registered it as the handler for subsystem ``"mp3"``, then whenever a client has successfully authenticated and requests subsytem ``"mp3"``, an object of class - ``MP3Handler`` will be created, and :class:`start_subsystem` will be called on + ``MP3Handler`` will be created, and `start_subsystem` will be called on it from a new thread. """ def __init__(self, channel, name, server): diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index c30805a6..dcd953f3 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -61,7 +61,7 @@ class SFTPClient (BaseSFTP): should already have requested the ``"sftp"`` subsystem. An alternate way to create an SFTP client context is by using - :class:`from_transport`. + `from_transport`. :param sock: an open :class:`.Channel` using the ``"sftp"`` subsystem :type sock: :class:`.Channel` @@ -140,7 +140,7 @@ class SFTPClient (BaseSFTP): The list is in arbitrary order. It does not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. This method is meant to mirror ``os.listdir`` as closely as possible. - For a list of full :class:`.SFTPAttributes` objects, see :class:`listdir_attr`. + For a list of full :class:`.SFTPAttributes` objects, see `listdir_attr`. :param path: path to list (defaults to ``'.'``) :type path: str @@ -255,7 +255,7 @@ class SFTPClient (BaseSFTP): def remove(self, path): """ Remove the file at the given path. This only works on files; for - removing folders (directories), use :class:`rmdir`. + removing folders (directories), use `rmdir`. :param path: path (absolute or relative) of the file to remove :type path: str @@ -343,7 +343,7 @@ class SFTPClient (BaseSFTP): """ Retrieve information about a file on the remote system, without following symbolic links (shortcuts). This otherwise behaves exactly - the same as :class:`stat`. + the same as `stat`. :param path: the filename to stat :type path: str @@ -394,7 +394,7 @@ class SFTPClient (BaseSFTP): """ Change the owner (``uid``) and group (``gid``) of a file. As with python's ``os.chown`` function, you must pass both arguments, so if you - only want to change one, use :class:`stat` first to retrieve the current + only want to change one, use `stat` first to retrieve the current owner and group. :param path: path of the file to change the owner and group of @@ -453,7 +453,7 @@ class SFTPClient (BaseSFTP): def readlink(self, path): """ Return the target of a symbolic link (shortcut). You can use - :class:`symlink` to create these. The result may be either an absolute or + `symlink` to create these. The result may be either an absolute or relative pathname. :param path: path of the symbolic link file @@ -523,7 +523,7 @@ class SFTPClient (BaseSFTP): def getcwd(self): """ Return the "current working directory" for this SFTP session, as - emulated by paramiko. If no directory has been set with :class:`chdir`, + emulated by paramiko. If no directory has been set with `chdir`, this method will return ``None``. :return: the current working directory on the server, or ``None`` diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index 3ff0d685..2ebad87e 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -255,7 +255,7 @@ class SFTPFile (BufferedFile): """ Change the owner (``uid``) and group (``gid``) of this file. As with python's ``os.chown`` function, you must pass both arguments, so if you - only want to change one, use :class:`stat` first to retrieve the current + only want to change one, use `stat` first to retrieve the current owner and group. :param uid: new owner's uid @@ -361,10 +361,10 @@ class SFTPFile (BufferedFile): Turn on/off the pipelining of write operations to this file. When pipelining is on, paramiko won't wait for the server response after each write operation. Instead, they're collected as they come in. - At the first non-write operation (including :class:`close`), all remaining + At the first non-write operation (including `close`), all remaining server responses are collected. This means that if there was an error with one of your later writes, an exception might be thrown from - within :class:`close` instead of :class:`write`. + within `close` instead of `write`. By default, files are not pipelined. @@ -379,13 +379,13 @@ class SFTPFile (BufferedFile): def prefetch(self): """ Pre-fetch the remaining contents of this file in anticipation of - future :class:`read` calls. If reading the entire file, pre-fetching can + future `read` calls. If reading the entire file, pre-fetching can dramatically improve the download speed by avoiding roundtrip latency. The file's contents are incrementally buffered in a background thread. - The prefetched data is stored in a buffer until read via the :class:`read` + The prefetched data is stored in a buffer until read via the `read` method. Once data has been read, it's removed from the buffer. The - data may be read in a random order (using :class:`seek`); chunks of the + data may be read in a random order (using `seek`); chunks of the buffer that haven't been read will continue to be buffered. .. versionadded:: 1.5.1 @@ -404,7 +404,7 @@ class SFTPFile (BufferedFile): def readv(self, chunks): """ Read a set of blocks from the file by (offset, length). This is more - efficient than doing a series of :class:`seek` and :class:`read` calls, since the + efficient than doing a series of `seek` and `read` calls, since the prefetch machinery is used to retrieve all the requested blocks at once. diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 3b3c6b45..a1a76c81 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -33,7 +33,7 @@ class SFTPHandle (object): by the client to refer to the underlying file. Server implementations can (and should) subclass SFTPHandle to implement - features of a file handle, like :class:`stat` or :class:`chattr`. + features of a file handle, like `stat` or `chattr`. """ def __init__(self, flags=0): """ @@ -59,7 +59,7 @@ class SFTPHandle (object): The default implementation checks for attributes on ``self`` named ``readfile`` and/or ``writefile``, and if either or both are present, their ``close()`` methods are called. This means that if you are - using the default implementations of :class:`read` and :class:`write`, this + using the default implementations of `read` and `write`, this method's default implementation should be fine also. """ readfile = getattr(self, 'readfile', None) diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index d1b24978..f3400c3f 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -143,7 +143,7 @@ class SFTPServerInterface (object): """ Return an :class:`.SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as - "aliases"), you should follow them. (:class:`lstat` is the corresponding + "aliases"), you should follow them. (`lstat` is the corresponding call that doesn't follow symlinks/aliases.) :param path: the requested path (relative or absolute) to fetch @@ -160,7 +160,7 @@ class SFTPServerInterface (object): Return an :class:`.SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as "aliases"), you should not follow them -- instead, you should - return data on the symlink or alias itself. (:class:`stat` is the + return data on the symlink or alias itself. (`stat` is the corresponding call that follows symlinks/aliases.) :param path: the requested path (relative or absolute) to fetch diff --git a/paramiko/transport.py b/paramiko/transport.py index 201ae007..44cdc77a 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -128,8 +128,8 @@ class Transport (threading.Thread): """ Create a new SSH session over an existing socket, or socket-like object. This only creates the Transport object; it doesn't begin the - SSH session yet. Use :class:`connect` or :class:`start_client` to begin a client - session, or :class:`start_server` to begin a server session. + SSH session yet. Use `connect` or `start_client` to begin a client + session, or `start_server` to begin a server session. If the object is not actually a socket, it must have the following methods: @@ -301,7 +301,7 @@ class Transport (threading.Thread): If an event is passed in, this method returns immediately. When negotiation is done (successful or not), the given ``Event`` will - be triggered. On failure, :class:`is_active` will return ``False``. + be triggered. On failure, `is_active` will return ``False``. (Since 1.4) If ``event`` is ``None``, this method will not return until negotation is done. On success, the method returns normally. @@ -311,9 +311,9 @@ class Transport (threading.Thread): calling :class:`auth_password ` or :class:`auth_publickey `. - .. note:: :class:`connect` is a simpler method for connecting as a client. + .. note:: `connect` is a simpler method for connecting as a client. - .. note:: After calling this method (or :class:`start_server` or :class:`connect`), + .. note:: After calling this method (or `start_server` or `connect`), you should no longer directly read from or write to the original socket object. @@ -353,7 +353,7 @@ class Transport (threading.Thread): If an event is passed in, this method returns immediately. When negotiation is done (successful or not), the given ``Event`` will - be triggered. On failure, :class:`is_active` will return ``False``. + be triggered. On failure, `is_active` will return ``False``. (Since 1.4) If ``event`` is ``None``, this method will not return until negotation is done. On success, the method returns normally. @@ -372,7 +372,7 @@ class Transport (threading.Thread): :class:`check_channel_request ` in the given ``server`` object to allow channels to be opened. - .. note:: After calling this method (or :class:`start_client` or :class:`connect`), + .. note:: After calling this method (or `start_client` or `connect`), you should no longer directly read from or write to the original socket object. @@ -428,7 +428,7 @@ class Transport (threading.Thread): """ Return the active host key, in server mode. After negotiating with the client, this method will return the negotiated host key. If only one - type of host key was set with :class:`add_server_key`, that's the only key + type of host key was set with `add_server_key`, that's the only key that will ever be returned. But in cases where you have set more than one type of host key (for example, an RSA key and a DSS key), the key type will be negotiated by the client, and this method will return the @@ -587,7 +587,7 @@ class Transport (threading.Thread): Request a new channel to the server. :class:`.Channels ` are socket-like objects used for the actual transfer of data across the session. You may only request a channel after negotiating encryption (using - :class:`connect` or :class:`start_client`) and authenticating. + `connect` or `start_client`) and authenticating. :param kind: the kind of channel requested (usually ``"session"``, ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"``) @@ -665,7 +665,7 @@ class Transport (threading.Thread): If no handler is set, the default behavior is to send new incoming forwarded connections into the accept queue, to be picked up via - :class:`accept`. + `accept`. :param address: the address to bind when forwarding :type address: str @@ -849,19 +849,19 @@ class Transport (threading.Thread): """ Negotiate an SSH2 session, and optionally verify the server's host key and authenticate using a password or private key. This is a shortcut - for :class:`start_client`, :class:`get_remote_server_key`, and + for `start_client`, `get_remote_server_key`, and :class:`Transport.auth_password` or :class:`Transport.auth_publickey`. Use those methods if you want more control. You can use this method immediately after creating a Transport to negotiate encryption with a server. If it fails, an exception will be thrown. On success, the method will return cleanly, and an encrypted - session exists. You may immediately call :class:`open_channel` or - :class:`open_session` to get a :class:`.Channel` object, which is used for data + session exists. You may immediately call `open_channel` or + `open_session` to get a :class:`.Channel` object, which is used for data transfer. .. note:: If you fail to supply a password or private key, this method may - succeed, but a subsequent :class:`open_channel` or :class:`open_session` call may + succeed, but a subsequent `open_channel` or `open_session` call may fail because you haven't authenticated yet. :param hostkey: the host key expected from the server, or ``None`` if @@ -908,7 +908,7 @@ class Transport (threading.Thread): """ Return any exception that happened during the last server request. This can be used to fetch more specific error information after using - calls like :class:`start_client`. The exception (if any) is cleared after + calls like `start_client`. The exception (if any) is cleared after this call. :return: an exception, or ``None`` if there is no stored exception. @@ -1004,8 +1004,8 @@ class Transport (threading.Thread): If an ``event`` is passed in, this method will return immediately, and the event will be triggered once authentication succeeds or fails. On - success, :class:`is_authenticated` will return ``True``. On failure, you may - use :class:`get_exception` to get more detailed error information. + success, `is_authenticated` will return ``True``. On failure, you may + use `get_exception` to get more detailed error information. Since 1.1, if no event is passed, this method will block until the authentication succeeds or fails. On failure, an exception is raised. @@ -1087,8 +1087,8 @@ class Transport (threading.Thread): If an ``event`` is passed in, this method will return immediately, and the event will be triggered once authentication succeeds or fails. On - success, :class:`is_authenticated` will return ``True``. On failure, you may - use :class:`get_exception` to get more detailed error information. + success, `is_authenticated` will return ``True``. On failure, you may + use `get_exception` to get more detailed error information. Since 1.1, if no event is passed, this method will block until the authentication succeeds or fails. On failure, an exception is raised. @@ -1237,7 +1237,7 @@ class Transport (threading.Thread): def use_compression(self, compress=True): """ Turn on/off compression. This will only have an affect before starting - the transport (ie before calling :class:`connect`, etc). By default, + the transport (ie before calling `connect`, etc). By default, compression is off since it negatively affects interactive sessions. :param compress: ``True`` to ask the remote client/server to compress -- cgit v1.2.3 From f836c98e5c5c859cb9d0189aed51dd5a884ee072 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 12:16:11 -0800 Subject: Don't actually need :class: anywhere now --- paramiko/__init__.py | 6 +- paramiko/agent.py | 6 +- paramiko/auth_handler.py | 2 +- paramiko/buffered_pipe.py | 4 +- paramiko/channel.py | 32 +++++------ paramiko/client.py | 56 +++++++++---------- paramiko/config.py | 2 +- paramiko/dsskey.py | 4 +- paramiko/file.py | 2 +- paramiko/hostkeys.py | 8 +-- paramiko/kex_gex.py | 2 +- paramiko/pkey.py | 28 +++++----- paramiko/proxy.py | 6 +- paramiko/rsakey.py | 4 +- paramiko/server.py | 140 +++++++++++++++++++++++----------------------- paramiko/sftp_attr.py | 4 +- paramiko/sftp_client.py | 32 +++++------ paramiko/sftp_file.py | 16 +++--- paramiko/sftp_handle.py | 18 +++--- paramiko/sftp_server.py | 20 +++---- paramiko/sftp_si.py | 54 +++++++++--------- paramiko/ssh_exception.py | 6 +- paramiko/transport.py | 90 ++++++++++++++--------------- paramiko/util.py | 14 ++--- 24 files changed, 278 insertions(+), 278 deletions(-) diff --git a/paramiko/__init__.py b/paramiko/__init__.py index b7a2efb6..6e282c63 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -26,9 +26,9 @@ replaced ``telnet`` and ``rsh`` for secure access to remote shells, but the protocol also includes the ability to open arbitrary channels to remote services across an encrypted tunnel. (This is how ``sftp`` works, for example.) -The high-level client API starts with creation of an :class:`.SSHClient` object. +The high-level client API starts with creation of an `.SSHClient` object. For more direct control, pass a socket (or socket-like object) to a -:class:`.Transport`, and use `start_server <.Transport.start_server>` or +`.Transport`, and use `start_server <.Transport.start_server>` or `start_client <.Transport.start_client>` to negoatite with the remote host as either a server or client. As a client, you are responsible for authenticating using a password or private key, and checking @@ -38,7 +38,7 @@ public key matches what you expected to see.) As a server, you are responsible for deciding which users, passwords, and keys to allow, and what kind of channels to allow. -Once you have finished, either side may request flow-controlled :class:`channels ` +Once you have finished, either side may request flow-controlled `channels ` to the other side, which are python objects that act like sockets, but send and receive data over the encrypted session. diff --git a/paramiko/agent.py b/paramiko/agent.py index 45bb2657..54617655 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -44,7 +44,7 @@ class AgentSSH(object): """ Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to - connect to it and retreive :class:`.PKey` objects which can be used when + connect to it and retreive `.PKey` objects which can be used when attempting to authenticate to remote SSH servers. Because the SSH agent protocol uses environment variables and unix-domain @@ -62,7 +62,7 @@ class AgentSSH(object): will be returned. :return: a list of keys available on the SSH agent - :rtype: tuple of :class:`.AgentKey` + :rtype: tuple of `.AgentKey` """ return self._keys @@ -307,7 +307,7 @@ class Agent(AgentSSH): """ Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to - connect to it and retreive :class:`.PKey` objects which can be used when + connect to it and retreive `.PKey` objects which can be used when attempting to authenticate to remote SSH servers. Because the SSH agent protocol uses environment variables and unix-domain diff --git a/paramiko/auth_handler.py b/paramiko/auth_handler.py index 2f73e5a3..e12859a7 100644 --- a/paramiko/auth_handler.py +++ b/paramiko/auth_handler.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.AuthHandler` +`.AuthHandler` """ import threading diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index 3a4b2bec..052b6c69 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -29,7 +29,7 @@ import time class PipeTimeout (IOError): """ - Indicates that a timeout was reached on a read from a :class:`.BufferedPipe`. + Indicates that a timeout was reached on a read from a `.BufferedPipe`. """ pass @@ -38,7 +38,7 @@ class BufferedPipe (object): """ A buffer that obeys normal read (with timeout) & close semantics for a file or socket, but is fed data from another thread. This is used by - :class:`.Channel`. + `.Channel`. """ def __init__(self): diff --git a/paramiko/channel.py b/paramiko/channel.py index b255c8a0..a7816a37 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -42,7 +42,7 @@ MIN_PACKET_SIZE = 1024 class Channel (object): """ - A secure tunnel across an SSH :class:`.Transport`. A Channel is meant to behave + A secure tunnel across an SSH `.Transport`. A Channel is meant to behave like a socket, and has an API that should be indistinguishable from the python socket API. @@ -58,12 +58,12 @@ class Channel (object): def __init__(self, chanid): """ Create a new channel. The channel is not associated with any - particular session or :class:`.Transport` until the Transport attaches it. + particular session or `.Transport` until the Transport attaches it. Normally you would only call this method from the constructor of a - subclass of :class:`.Channel`. + subclass of `.Channel`. :param chanid: the ID of this channel, as passed by an existing - :class:`.Transport`. + `.Transport`. :type chanid: int """ self.chanid = chanid @@ -347,7 +347,7 @@ class Channel (object): If a handler is passed in, the handler is called from another thread whenever a new x11 connection arrives. The default handler queues up incoming x11 connections, which may be retrieved using - :class:`Transport.accept`. The handler's calling signature is:: + `Transport.accept`. The handler's calling signature is:: handler(channel: Channel, (address: str, port: int)) @@ -416,10 +416,10 @@ class Channel (object): def get_transport(self): """ - Return the :class:`.Transport` associated with this channel. + Return the `.Transport` associated with this channel. - :return: the :class:`.Transport` that was used to create this channel. - :rtype: :class:`.Transport` + :return: the `.Transport` that was used to create this channel. + :rtype: `.Transport` """ return self.transport @@ -446,8 +446,8 @@ class Channel (object): def get_id(self): """ Return the ID # for this channel. The channel ID is unique across - a :class:`.Transport` and usually a small number. It's also the number - passed to :class:`ServerInterface.check_channel_request` when determining + a `.Transport` and usually a small number. It's also the number + passed to `ServerInterface.check_channel_request` when determining whether to accept a channel request in server mode. :return: the ID of this channel. @@ -564,7 +564,7 @@ class Channel (object): """ Close the channel. All future read/write operations on the channel will fail. The remote end will receive no more data (after queued data - is flushed). Channels are automatically closed when their :class:`.Transport` + is flushed). Channels are automatically closed when their `.Transport` is closed or when they are garbage collected. """ self.lock.acquire() @@ -829,7 +829,7 @@ class Channel (object): the built-in ``file()`` function in python. :return: object which can be used for python file I/O. - :rtype: :class:`.ChannelFile` + :rtype: `.ChannelFile` """ return ChannelFile(*([self] + list(params))) @@ -845,7 +845,7 @@ class Channel (object): server, it only makes sense to open this file for writing. :return: object which can be used for python file I/O. - :rtype: :class:`.ChannelFile` + :rtype: `.ChannelFile` .. versionadded:: 1.1 """ @@ -1227,11 +1227,11 @@ class Channel (object): class ChannelFile (BufferedFile): """ - A file-like wrapper around :class:`.Channel`. A ChannelFile is created by calling - :class:`Channel.makefile`. + A file-like wrapper around `.Channel`. A ChannelFile is created by calling + `Channel.makefile`. @bug: To correctly emulate the file object created from a socket's - ``makefile`` method, a :class:`.Channel` and its ``ChannelFile`` should be able + ``makefile`` method, a `.Channel` and its ``ChannelFile`` should be able to be closed or garbage-collected independently. Currently, closing the ``ChannelFile`` does nothing but flush the buffer. """ diff --git a/paramiko/client.py b/paramiko/client.py index 6041e858..17e942d3 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -41,7 +41,7 @@ from paramiko.util import retry_on_signal class SSHClient (object): """ A high-level representation of a session with an SSH server. This class - wraps :class:`.Transport`, :class:`.Channel`, and :class:`.SFTPClient` to take care of most + wraps `.Transport`, `.Channel`, and `.SFTPClient` to take care of most aspects of authenticating and opening channels. A typical use case is:: client = SSHClient() @@ -103,7 +103,7 @@ class SSHClient (object): Load host keys from a local host-key file. Host keys read with this method will be checked after keys loaded via `load_system_host_keys`, but will be saved back by `save_host_keys` (so they can be modified). - The missing host key policy :class:`.AutoAddPolicy` adds keys to this set and + The missing host key policy `.AutoAddPolicy` adds keys to this set and saves them, when connecting to a previously-unknown server. This method can be called multiple times. Each new set of host keys @@ -143,11 +143,11 @@ class SSHClient (object): def get_host_keys(self): """ - Get the local :class:`.HostKeys` object. This can be used to examine the + Get the local `.HostKeys` object. This can be used to examine the local host keys or change them. :return: the local host keys - :rtype: :class:`.HostKeys` + :rtype: `.HostKeys` """ return self._host_keys @@ -164,13 +164,13 @@ class SSHClient (object): def set_missing_host_key_policy(self, policy): """ Set the policy to use when connecting to a server that doesn't have a - host key in either the system or local :class:`.HostKeys` objects. The - default policy is to reject all unknown servers (using :class:`.RejectPolicy`). - You may substitute :class:`.AutoAddPolicy` or write your own policy class. + host key in either the system or local `.HostKeys` objects. The + default policy is to reject all unknown servers (using `.RejectPolicy`). + You may substitute `.AutoAddPolicy` or write your own policy class. :param policy: the policy to use when receiving a host key from a previously-unknown server - :type policy: :class:`.MissingHostKeyPolicy` + :type policy: `.MissingHostKeyPolicy` """ self._policy = policy @@ -183,7 +183,7 @@ class SSHClient (object): and any local host keys (`load_host_keys`). If the server's hostname is not found in either set of host keys, the missing host key policy is used (see `set_missing_host_key_policy`). The default policy is - to reject the key and raise an :class:`.SSHException`. + to reject the key and raise an `.SSHException`. Authentication is attempted in the following order of priority: @@ -206,7 +206,7 @@ class SSHClient (object): a private key :type password: str :param pkey: an optional private key to use for authentication - :type pkey: :class:`.PKey` + :type pkey: `.PKey` :param key_filename: the filename, or list of filenames, of optional private key(s) to try for authentication :type key_filename: str or list(str) @@ -220,7 +220,7 @@ class SSHClient (object): :param compress: set to True to turn on compression :type compress: bool :param sock: an open socket or socket-like object (such as a - :class:`.Channel`) to use for communication to the target host + `.Channel`) to use for communication to the target host :type sock: socket :raises BadHostKeyException: if the server's host key could not be @@ -286,7 +286,7 @@ class SSHClient (object): def close(self): """ - Close this SSHClient and its underlying :class:`.Transport`. + Close this SSHClient and its underlying `.Transport`. """ if self._transport is None: return @@ -299,7 +299,7 @@ class SSHClient (object): def exec_command(self, command, bufsize=-1, timeout=None, get_pty=False): """ - Execute a command on the SSH server. A new :class:`.Channel` is opened and + Execute a command on the SSH server. A new `.Channel` is opened and the requested command is executed. The command's input and output streams are returned as python ``file``-like objects representing stdin, stdout, and stderr. @@ -308,10 +308,10 @@ class SSHClient (object): :type command: str :param bufsize: interpreted the same way as by the built-in ``file()`` function in python :type bufsize: int - :param timeout: set command's channel timeout. See :class:`Channel.settimeout`.settimeout + :param timeout: set command's channel timeout. See `Channel.settimeout`.settimeout :type timeout: int :return: the stdin, stdout, and stderr of the executing command - :rtype: tuple(:class:`.ChannelFile`, :class:`.ChannelFile`, :class:`.ChannelFile`) + :rtype: tuple(`.ChannelFile`, `.ChannelFile`, `.ChannelFile`) :raises SSHException: if the server fails to execute the command """ @@ -328,7 +328,7 @@ class SSHClient (object): def invoke_shell(self, term='vt100', width=80, height=24, width_pixels=0, height_pixels=0): """ - Start an interactive shell session on the SSH server. A new :class:`.Channel` + Start an interactive shell session on the SSH server. A new `.Channel` is opened and connected to a pseudo-terminal using the requested terminal type and size. @@ -343,7 +343,7 @@ class SSHClient (object): :param height_pixels: the height (in pixels) of the terminal window :type height_pixels: int :return: a new channel connected to the remote shell - :rtype: :class:`.Channel` + :rtype: `.Channel` :raises SSHException: if the server fails to invoke a shell """ @@ -357,18 +357,18 @@ class SSHClient (object): Open an SFTP session on the SSH server. :return: a new SFTP session object - :rtype: :class:`.SFTPClient` + :rtype: `.SFTPClient` """ return self._transport.open_sftp_client() def get_transport(self): """ - Return the underlying :class:`.Transport` object for this SSH connection. + Return the underlying `.Transport` object for this SSH connection. This can be used to perform lower-level tasks, like opening specific kinds of channels. :return: the Transport for this connection - :rtype: :class:`.Transport` + :rtype: `.Transport` """ return self._transport @@ -482,19 +482,19 @@ class SSHClient (object): class MissingHostKeyPolicy (object): """ - Interface for defining the policy that :class:`.SSHClient` should use when the + Interface for defining the policy that `.SSHClient` should use when the SSH server's hostname is not in either the system host keys or the application's keys. Pre-made classes implement policies for automatically - adding the key to the application's :class:`.HostKeys` object (:class:`.AutoAddPolicy`), - and for automatically rejecting the key (:class:`.RejectPolicy`). + adding the key to the application's `.HostKeys` object (`.AutoAddPolicy`), + and for automatically rejecting the key (`.RejectPolicy`). This function may be used to ask the user to verify the key, for example. """ def missing_host_key(self, client, hostname, key): """ - Called when an :class:`.SSHClient` receives a server key for a server that - isn't in either the system or local :class:`.HostKeys` object. To accept + Called when an `.SSHClient` receives a server key for a server that + isn't in either the system or local `.HostKeys` object. To accept the key, simply return. To reject, raised an exception (which will be passed to the calling application). """ @@ -504,7 +504,7 @@ class MissingHostKeyPolicy (object): class AutoAddPolicy (MissingHostKeyPolicy): """ Policy for automatically adding the hostname and new host key to the - local :class:`.HostKeys` object, and saving it. This is used by :class:`.SSHClient`. + local `.HostKeys` object, and saving it. This is used by `.SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -518,7 +518,7 @@ class AutoAddPolicy (MissingHostKeyPolicy): class RejectPolicy (MissingHostKeyPolicy): """ Policy for automatically rejecting the unknown hostname & key. This is - used by :class:`.SSHClient`. + used by `.SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -530,7 +530,7 @@ class RejectPolicy (MissingHostKeyPolicy): class WarningPolicy (MissingHostKeyPolicy): """ Policy for logging a python-style warning for an unknown host key, but - accepting it. This is used by :class:`.SSHClient`. + accepting it. This is used by `.SSHClient`. """ def missing_host_key(self, client, hostname, key): warnings.warn('Unknown %s host key for %s: %s' % diff --git a/paramiko/config.py b/paramiko/config.py index 980a6cf4..6f3bbdfc 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -18,7 +18,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.SSHConfig`. +`.SSHConfig`. """ import fnmatch diff --git a/paramiko/dsskey.py b/paramiko/dsskey.py index 9581ec82..0f6f07fd 100644 --- a/paramiko/dsskey.py +++ b/paramiko/dsskey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.DSSKey` +`.DSSKey` """ from Crypto.PublicKey import DSA @@ -159,7 +159,7 @@ class DSSKey (PKey): key generation (used by ``pyCrypto.PublicKey``). :type progress_func: function :return: new private key - :rtype: :class:`.DSSKey` + :rtype: `.DSSKey` """ dsa = DSA.generate(bits, rng.read, progress_func) key = DSSKey(vals=(dsa.p, dsa.q, dsa.g, dsa.y)) diff --git a/paramiko/file.py b/paramiko/file.py index 4f9b56b6..65e58040 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -94,7 +94,7 @@ class BufferedFile (object): def next(self): """ - Returns the next line from the input, or raises :class:`.StopIteration` when + Returns the next line from the input, or raises `.StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to `next` and `readline`. diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index cdf6d5c1..7b6b1f1e 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.HostKeys` +`.HostKeys` """ import base64 @@ -140,7 +140,7 @@ class HostKeys (UserDict.DictMixin): :param keytype: key type (``"ssh-rsa"`` or ``"ssh-dss"``) :type keytype: str :param key: the key to add - :type key: :class:`.PKey` + :type key: `.PKey` """ for e in self._entries: if (hostname in e.hostnames) and (e.key.get_name() == keytype): @@ -209,7 +209,7 @@ class HostKeys (UserDict.DictMixin): :param hostname: the hostname (or IP) to lookup :type hostname: str :return: keys associated with this host (or ``None``) - :rtype: dict(str, :class:`.PKey`) + :rtype: dict(str, `.PKey`) """ class SubDict (UserDict.DictMixin): def __init__(self, hostname, entries, hostkeys): @@ -257,7 +257,7 @@ class HostKeys (UserDict.DictMixin): :param hostname: hostname (or IP) of the SSH server :type hostname: str :param key: the key to check - :type key: :class:`.PKey` + :type key: `.PKey` :return: ``True`` if the key is associated with the hostname; ``False`` if not :rtype: bool diff --git a/paramiko/kex_gex.py b/paramiko/kex_gex.py index c0b24453..27287300 100644 --- a/paramiko/kex_gex.py +++ b/paramiko/kex_gex.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Variant on :class:`KexGroup1 ` where the prime "p" and +Variant on `KexGroup1 ` where the prime "p" and generator "g" are provided by the server. A bit more work is required on the client side, and a B{lot} more on the server side. """ diff --git a/paramiko/pkey.py b/paramiko/pkey.py index 928b8498..655eb3e1 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -52,9 +52,9 @@ class PKey (object): ``data`` is given, the key's public part(s) will be filled in from the string. - :param msg: an optional SSH :class:`.Message` containing a public key of this + :param msg: an optional SSH `.Message` containing a public key of this type. - :type msg: :class:`.Message` + :type msg: `.Message` :param data: an optional string containing a public key of this type :type data: str @@ -65,7 +65,7 @@ class PKey (object): def __str__(self): """ - Return a string of an SSH :class:`.Message` made up of the public part(s) of + Return a string of an SSH `.Message` made up of the public part(s) of this key. This string is suitable for passing to `__init__` to re-create the key object later. @@ -82,7 +82,7 @@ class PKey (object): corresponding private key. :param other: key to compare to. - :type other: :class:`.PKey` + :type other: `.PKey` :return: 0 if the two keys are equivalent, non-0 otherwise. :rtype: int """ @@ -146,15 +146,15 @@ class PKey (object): def sign_ssh_data(self, rng, data): """ - Sign a blob of data with this private key, and return a :class:`.Message` + Sign a blob of data with this private key, and return a `.Message` representing an SSH signature message. :param rng: a secure random number generator. - :type rng: :class:`Crypto.Util.rng.RandomPool` + :type rng: `Crypto.Util.rng.RandomPool` :param data: the data to sign. :type data: str :return: an SSH signature message. - :rtype: :class:`.Message` + :rtype: `.Message` """ return '' @@ -166,7 +166,7 @@ class PKey (object): :param data: the data that was signed. :type data: str :param msg: an SSH signature message - :type msg: :class:`.Message` + :type msg: `.Message` :return: ``True`` if the signature verifies correctly; ``False`` otherwise. :rtype: boolean @@ -177,9 +177,9 @@ class PKey (object): """ Create a key object by reading a private key file. If the private key is encrypted and ``password`` is not ``None``, the given password - will be used to decrypt the key (otherwise :class:`.PasswordRequiredException` + will be used to decrypt the key (otherwise `.PasswordRequiredException` is thrown). Through the magic of python, this factory method will - exist in all subclasses of PKey (such as :class:`.RSAKey` or :class:`.DSSKey`), but + exist in all subclasses of PKey (such as `.RSAKey` or `.DSSKey`), but is useless on the abstract PKey class. :param filename: name of the file to read @@ -188,7 +188,7 @@ class PKey (object): if it's encrypted :type password: str :return: a new key object based on the given private key - :rtype: :class:`.PKey` + :rtype: `.PKey` :raises IOError: if there was an error reading the file :raises PasswordRequiredException: if the private key file is @@ -204,7 +204,7 @@ class PKey (object): Create a key object by reading a private key from a file (or file-like) object. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt the key (otherwise - :class:`.PasswordRequiredException` is thrown). + `.PasswordRequiredException` is thrown). :param file_obj: the file to read from :type file_obj: file @@ -212,7 +212,7 @@ class PKey (object): encrypted :type password: str :return: a new key object based on the given private key - :rtype: :class:`.PKey` + :rtype: `.PKey` :raises IOError: if there was an error reading the key :raises PasswordRequiredException: if the private key file is encrypted, @@ -259,7 +259,7 @@ class PKey (object): ``"BEGIN xxx PRIVATE KEY"`` for some ``xxx``, base64-decode the text we find, and return it as a string. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt - the key (otherwise :class:`.PasswordRequiredException` is thrown). + the key (otherwise `.PasswordRequiredException` is thrown). :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. :type tag: str diff --git a/paramiko/proxy.py b/paramiko/proxy.py index 85c73a6b..375c6556 100644 --- a/paramiko/proxy.py +++ b/paramiko/proxy.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.ProxyCommand`. +`.ProxyCommand`. """ import os @@ -33,14 +33,14 @@ class ProxyCommand(object): Wraps a subprocess running ProxyCommand-driven programs. This class implements a the socket-like interface needed by the - :class:`.Transport` and :class:`.Packetizer` classes. Using this class instead of a + `.Transport` and `.Packetizer` classes. Using this class instead of a regular socket makes it possible to talk with a Popen'd command that will proxy traffic between the client and a server hosted in another machine. """ def __init__(self, command_line): """ Create a new CommandProxy instance. The instance created by this - class can be passed as an argument to the :class:`.Transport` class. + class can be passed as an argument to the `.Transport` class. :param command_line: the command that should be executed and used as the proxy. diff --git a/paramiko/rsakey.py b/paramiko/rsakey.py index 8e9774f8..0f879da2 100644 --- a/paramiko/rsakey.py +++ b/paramiko/rsakey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.RSAKey` +`.RSAKey` """ from Crypto.PublicKey import RSA @@ -135,7 +135,7 @@ class RSAKey (PKey): key generation (used by ``pyCrypto.PublicKey``). :type progress_func: function :return: new private key - :rtype: :class:`.RSAKey` + :rtype: `.RSAKey` """ rsa = RSA.generate(bits, rng.read, progress_func) key = RSAKey(vals=(rsa.e, rsa.n)) diff --git a/paramiko/server.py b/paramiko/server.py index 41d0d429..e38fcbbf 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.ServerInterface` is an interface to override for server support. +`.ServerInterface` is an interface to override for server support. """ import threading @@ -96,9 +96,9 @@ class ServerInterface (object): - `check_channel_forward_agent_request` The ``chanid`` parameter is a small number that uniquely identifies the - channel within a :class:`.Transport`. A :class:`.Channel` object is not created + channel within a `.Transport`. A `.Channel` object is not created unless this method returns ``OPEN_SUCCEEDED`` -- once a - :class:`.Channel` object is created, you can call :class:`Channel.get_id` to + `.Channel` object is created, you can call `Channel.get_id` to retrieve the channel ID. The return value should either be ``OPEN_SUCCEEDED`` (or @@ -146,16 +146,16 @@ class ServerInterface (object): Determine if a client may open channels with no (further) authentication. - Return :class:`.AUTH_FAILED` if the client must authenticate, or - :class:`.AUTH_SUCCESSFUL` if it's okay for the client to not + Return `.AUTH_FAILED` if the client must authenticate, or + `.AUTH_SUCCESSFUL` if it's okay for the client to not authenticate. - The default implementation always returns :class:`.AUTH_FAILED`. + The default implementation always returns `.AUTH_FAILED`. :param username: the username of the client. :type username: str - :return: :class:`.AUTH_FAILED` if the authentication fails; - :class:`.AUTH_SUCCESSFUL` if it succeeds. + :return: `.AUTH_FAILED` if the authentication fails; + `.AUTH_SUCCESSFUL` if it succeeds. :rtype: int """ return AUTH_FAILED @@ -165,23 +165,23 @@ class ServerInterface (object): Determine if a given username and password supplied by the client is acceptable for use in authentication. - Return :class:`.AUTH_FAILED` if the password is not accepted, - :class:`.AUTH_SUCCESSFUL` if the password is accepted and completes - the authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your + Return `.AUTH_FAILED` if the password is not accepted, + `.AUTH_SUCCESSFUL` if the password is accepted and completes + the authentication, or `.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this key is accepted for authentication, but more authentication is required. (In this latter case, `get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) - The default implementation always returns :class:`.AUTH_FAILED`. + The default implementation always returns `.AUTH_FAILED`. :param username: the username of the authenticating client. :type username: str :param password: the password given by the client. :type password: str - :return: :class:`.AUTH_FAILED` if the authentication fails; - :class:`.AUTH_SUCCESSFUL` if it succeeds; - :class:`.AUTH_PARTIALLY_SUCCESSFUL` if the password auth is + :return: `.AUTH_FAILED` if the authentication fails; + `.AUTH_SUCCESSFUL` if it succeeds; + `.AUTH_PARTIALLY_SUCCESSFUL` if the password auth is successful, but authentication must continue. :rtype: int """ @@ -194,9 +194,9 @@ class ServerInterface (object): check the username and key and decide if you would accept a signature made using this key. - Return :class:`.AUTH_FAILED` if the key is not accepted, - :class:`.AUTH_SUCCESSFUL` if the key is accepted and completes the - authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your + Return `.AUTH_FAILED` if the key is not accepted, + `.AUTH_SUCCESSFUL` if the key is accepted and completes the + authentication, or `.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this password is accepted for authentication, but more authentication is required. (In this latter case, `get_allowed_auths` will be called to report to the client what @@ -206,15 +206,15 @@ class ServerInterface (object): If you're willing to accept the key, paramiko will do the work of verifying the client's signature. - The default implementation always returns :class:`.AUTH_FAILED`. + The default implementation always returns `.AUTH_FAILED`. :param username: the username of the authenticating client :type username: str :param key: the key object provided by the client - :type key: :class:`PKey ` - :return: :class:`.AUTH_FAILED` if the client can't authenticate - with this key; :class:`.AUTH_SUCCESSFUL` if it can; - :class:`.AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with + :type key: `PKey ` + :return: `.AUTH_FAILED` if the client can't authenticate + with this key; `.AUTH_SUCCESSFUL` if it can; + `.AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with this key but must continue with authentication :rtype: int """ @@ -227,21 +227,21 @@ class ServerInterface (object): ``"keyboard-interactive"`` auth type, which requires you to send a series of questions for the client to answer. - Return :class:`.AUTH_FAILED` if this auth method isn't supported. Otherwise, - you should return an :class:`.InteractiveQuery` object containing the prompts + Return `.AUTH_FAILED` if this auth method isn't supported. Otherwise, + you should return an `.InteractiveQuery` object containing the prompts and instructions for the user. The response will be sent via a call to `check_auth_interactive_response`. - The default implementation always returns :class:`.AUTH_FAILED`. + The default implementation always returns `.AUTH_FAILED`. :param username: the username of the authenticating client :type username: str :param submethods: a comma-separated list of methods preferred by the client (usually empty) :type submethods: str - :return: :class:`.AUTH_FAILED` if this auth method isn't supported; otherwise + :return: `.AUTH_FAILED` if this auth method isn't supported; otherwise an object containing queries for the user - :rtype: int or :class:`.InteractiveQuery` + :rtype: int or `.InteractiveQuery` """ return AUTH_FAILED @@ -251,29 +251,29 @@ class ServerInterface (object): supported. You should override this method in server mode if you want to support the ``"keyboard-interactive"`` auth type. - Return :class:`.AUTH_FAILED` if the responses are not accepted, - :class:`.AUTH_SUCCESSFUL` if the responses are accepted and complete - the authentication, or :class:`.AUTH_PARTIALLY_SUCCESSFUL` if your + Return `.AUTH_FAILED` if the responses are not accepted, + `.AUTH_SUCCESSFUL` if the responses are accepted and complete + the authentication, or `.AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this set of responses is accepted for authentication, but more authentication is required. (In this latter case, `get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) If you wish to continue interactive authentication with more questions, - you may return an :class:`.InteractiveQuery` object, which should cause the + you may return an `.InteractiveQuery` object, which should cause the client to respond with more answers, calling this method again. This cycle can continue indefinitely. - The default implementation always returns :class:`.AUTH_FAILED`. + The default implementation always returns `.AUTH_FAILED`. :param responses: list of responses from the client :type responses: list(str) - :return: :class:`.AUTH_FAILED` if the authentication fails; - :class:`.AUTH_SUCCESSFUL` if it succeeds; - :class:`.AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is + :return: `.AUTH_FAILED` if the authentication fails; + `.AUTH_SUCCESSFUL` if it succeeds; + `.AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is successful, but authentication must continue; otherwise an object containing queries for the user - :rtype: int or :class:`.InteractiveQuery` + :rtype: int or `.InteractiveQuery` """ return AUTH_FAILED @@ -338,7 +338,7 @@ class ServerInterface (object): :param kind: the kind of global request being made. :type kind: str :param msg: any extra arguments to the request. - :type msg: :class:`.Message` + :type msg: `.Message` :return: ``True`` or a tuple of data if the request was granted; ``False`` otherwise. :rtype: bool @@ -357,8 +357,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`.Channel` the pty request arrived on. - :type channel: :class:`.Channel` + :param channel: the `.Channel` the pty request arrived on. + :type channel: `.Channel` :param term: type of terminal requested (for example, ``"vt100"``). :type term: str :param width: width of screen in characters. @@ -386,8 +386,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`.Channel` the request arrived on. - :type channel: :class:`.Channel` + :param channel: the `.Channel` the request arrived on. + :type channel: `.Channel` :return: ``True`` if this channel is now hooked up to a shell; ``False`` if a shell can't or won't be provided. :rtype: bool @@ -402,8 +402,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`.Channel` the request arrived on. - :type channel: :class:`.Channel` + :param channel: the `.Channel` the request arrived on. + :type channel: `.Channel` :param command: the command to execute. :type command: str :return: ``True`` if this channel is now hooked up to the stdin, @@ -423,16 +423,16 @@ class ServerInterface (object): subsystem. An example of a subsystem is ``sftp``. The default implementation checks for a subsystem handler assigned via - :class:`Transport.set_subsystem_handler`. + `Transport.set_subsystem_handler`. If one has been set, the handler is invoked and this method returns ``True``. Otherwise it returns ``False``. - .. note:: Because the default implementation uses the :class:`.Transport` to + .. note:: Because the default implementation uses the `.Transport` to identify valid subsystems, you probably won't need to override this method. - :param channel: the :class:`.Channel` the pty request arrived on. - :type channel: :class:`.Channel` + :param channel: the `.Channel` the pty request arrived on. + :type channel: `.Channel` :param name: name of the requested subsystem. :type name: str :return: ``True`` if this channel is now hooked up to the requested @@ -453,8 +453,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`.Channel` the pty request arrived on. - :type channel: :class:`.Channel` + :param channel: the `.Channel` the pty request arrived on. + :type channel: `.Channel` :param width: width of screen in characters. :type width: int :param height: height of screen in characters. @@ -474,12 +474,12 @@ class ServerInterface (object): """ Determine if the client will be provided with an X11 session. If this method returns ``True``, X11 applications should be routed through new - SSH channels, using :class:`Transport.open_x11_channel`. + SSH channels, using `Transport.open_x11_channel`. The default implementation always returns ``False``. - :param channel: the :class:`.Channel` the X11 request arrived on - :type channel: :class:`.Channel` + :param channel: the `.Channel` the X11 request arrived on + :type channel: `.Channel` :param single_connection: ``True`` if only a single X11 channel should be opened :type single_connection: bool @@ -502,8 +502,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the :class:`.Channel` the request arrived on - :type channel: :class:`.Channel` + :param channel: the `.Channel` the request arrived on + :type channel: `.Channel` :return: ``True`` if the AgentForward was loaded; ``False`` if not :rtype: bool """ @@ -517,9 +517,9 @@ class ServerInterface (object): authentication is complete. The ``chanid`` parameter is a small number that uniquely identifies the - channel within a :class:`.Transport`. A :class:`.Channel` object is not created + channel within a `.Transport`. A `.Channel` object is not created unless this method returns ``OPEN_SUCCEEDED`` -- once a - :class:`.Channel` object is created, you can call :class:`Channel.get_id` to + `.Channel` object is created, you can call `Channel.get_id` to retrieve the channel ID. The origin and destination parameters are (ip_address, port) tuples @@ -555,7 +555,7 @@ class SubsystemHandler (threading.Thread): """ Handler for a subsytem in server mode. If you create a subclass of this class and pass it to - :class:`Transport.set_subsystem_handler`, + `Transport.set_subsystem_handler`, an object of this class will be created for each request for this subsystem. Each new object will be executed within its own new thread by calling `start_subsystem`. @@ -569,19 +569,19 @@ class SubsystemHandler (threading.Thread): """ def __init__(self, channel, name, server): """ - Create a new handler for a channel. This is used by :class:`.ServerInterface` + Create a new handler for a channel. This is used by `.ServerInterface` to start up a new handler when a channel requests this subsystem. You don't need to override this method, but if you do, be sure to pass the ``channel`` and ``name`` parameters through to the original ``__init__`` method here. :param channel: the channel associated with this subsystem request. - :type channel: :class:`.Channel` + :type channel: `.Channel` :param name: name of the requested subsystem. :type name: str :param server: the server object for the session that started this subsystem - :type server: :class:`.ServerInterface` + :type server: `.ServerInterface` """ threading.Thread.__init__(self, target=self._run) self.__channel = channel @@ -591,10 +591,10 @@ class SubsystemHandler (threading.Thread): def get_server(self): """ - Return the :class:`.ServerInterface` object associated with this channel and + Return the `.ServerInterface` object associated with this channel and subsystem. - :rtype: :class:`.ServerInterface` + :rtype: `.ServerInterface` """ return self.__server @@ -620,21 +620,21 @@ class SubsystemHandler (threading.Thread): returns, the channel is closed. The combination of ``transport`` and ``channel`` are unique; this handler - corresponds to exactly one :class:`.Channel` on one :class:`.Transport`. + corresponds to exactly one `.Channel` on one `.Transport`. .. note:: It is the responsibility of this method to exit if the - underlying :class:`.Transport` is closed. This can be done by checking - :class:`Transport.is_active` or noticing an EOF - on the :class:`.Channel`. If this method loops forever without checking + underlying `.Transport` is closed. This can be done by checking + `Transport.is_active` or noticing an EOF + on the `.Channel`. If this method loops forever without checking for this case, your python interpreter may refuse to exit because this thread will still be running. :param name: name of the requested subsystem. :type name: str - :param transport: the server-mode :class:`.Transport`. - :type transport: :class:`.Transport` + :param transport: the server-mode `.Transport`. + :type transport: `.Transport` :param channel: the channel associated with this subsystem request. - :type channel: :class:`.Channel` + :type channel: `.Channel` """ pass diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index 9eb66b5a..37cdeba7 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -68,8 +68,8 @@ class SFTPAttributes (object): :type obj: object :param filename: the filename associated with this file. :type filename: str - :return: new :class:`.SFTPAttributes` object with the same attribute fields. - :rtype: :class:`.SFTPAttributes` + :return: new `.SFTPAttributes` object with the same attribute fields. + :rtype: `.SFTPAttributes` """ attr = cls() attr.st_size = obj.st_size diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index dcd953f3..e5248378 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -52,19 +52,19 @@ def _to_unicode(s): class SFTPClient (BaseSFTP): """ SFTP client object. ``SFTPClient`` is used to open an sftp session across - an open ssh :class:`.Transport` and do remote file operations. + an open ssh `.Transport` and do remote file operations. """ def __init__(self, sock): """ - Create an SFTP client from an existing :class:`.Channel`. The channel + Create an SFTP client from an existing `.Channel`. The channel should already have requested the ``"sftp"`` subsystem. An alternate way to create an SFTP client context is by using `from_transport`. - :param sock: an open :class:`.Channel` using the ``"sftp"`` subsystem - :type sock: :class:`.Channel` + :param sock: an open `.Channel` using the ``"sftp"`` subsystem + :type sock: `.Channel` :raises SSHException: if there's an exception while negotiating sftp @@ -91,13 +91,13 @@ class SFTPClient (BaseSFTP): def from_transport(cls, t): """ - Create an SFTP client channel from an open :class:`.Transport`. + Create an SFTP client channel from an open `.Transport`. - :param t: an open :class:`.Transport` which is already authenticated - :type t: :class:`.Transport` - :return: a new :class:`.SFTPClient` object, referring to an sftp session + :param t: an open `.Transport` which is already authenticated + :type t: `.Transport` + :return: a new `.SFTPClient` object, referring to an sftp session (channel) across the transport - :rtype: :class:`.SFTPClient` + :rtype: `.SFTPClient` """ chan = t.open_session() if chan is None: @@ -124,11 +124,11 @@ class SFTPClient (BaseSFTP): def get_channel(self): """ - Return the underlying :class:`.Channel` object for this SFTP session. This + Return the underlying `.Channel` object for this SFTP session. This might be useful for doing things like setting a timeout on the channel. :return: the SSH channel - :rtype: :class:`.Channel` + :rtype: `.Channel` .. versionadded:: 1.7.1 """ @@ -140,7 +140,7 @@ class SFTPClient (BaseSFTP): The list is in arbitrary order. It does not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. This method is meant to mirror ``os.listdir`` as closely as possible. - For a list of full :class:`.SFTPAttributes` objects, see `listdir_attr`. + For a list of full `.SFTPAttributes` objects, see `listdir_attr`. :param path: path to list (defaults to ``'.'``) :type path: str @@ -151,12 +151,12 @@ class SFTPClient (BaseSFTP): def listdir_attr(self, path='.'): """ - Return a list containing :class:`.SFTPAttributes` objects corresponding to + Return a list containing `.SFTPAttributes` objects corresponding to files in the given ``path``. The list is in arbitrary order. It does not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. - The returned :class:`.SFTPAttributes` objects will each have an additional + The returned `.SFTPAttributes` objects will each have an additional field: ``longname``, which may contain a formatted string of the file's attributes, in unix format. The content of this string will probably depend on the SFTP server implementation. @@ -164,7 +164,7 @@ class SFTPClient (BaseSFTP): :param path: path to list (defaults to ``'.'``) :type path: str :return: list of attributes - :rtype: list of :class:`.SFTPAttributes` + :rtype: list of `.SFTPAttributes` .. versionadded:: 1.2 """ @@ -783,5 +783,5 @@ class SFTPClient (BaseSFTP): class SFTP (SFTPClient): - "an alias for :class:`.SFTPClient` for backwards compatability" + "an alias for `.SFTPClient` for backwards compatability" pass diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index 2ebad87e..770fa126 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.SFTPFile` +`.SFTPFile` """ from __future__ import with_statement @@ -181,9 +181,9 @@ class SFTPFile (BufferedFile): def settimeout(self, timeout): """ Set a timeout on read/write operations on the underlying socket or - ssh :class:`.Channel`. + ssh `.Channel`. - .. seealso:: :class:`Channel.settimeout` + .. seealso:: `Channel.settimeout` :param timeout: seconds to wait for a pending read/write operation before raising ``socket.timeout``, or ``None`` for no timeout :type timeout: float @@ -193,9 +193,9 @@ class SFTPFile (BufferedFile): def gettimeout(self): """ Returns the timeout in seconds (as a float) associated with the socket - or ssh :class:`.Channel` used for this file. + or ssh `.Channel` used for this file. - .. seealso:: :class:`Channel.gettimeout` + .. seealso:: `Channel.gettimeout` :rtype: float """ return self.sftp.sock.gettimeout() @@ -203,9 +203,9 @@ class SFTPFile (BufferedFile): def setblocking(self, blocking): """ Set blocking or non-blocking mode on the underiying socket or ssh - :class:`.Channel`. + `.Channel`. - .. seealso:: :class:`Channel.setblocking` + .. seealso:: `Channel.setblocking` :param blocking: 0 to set non-blocking mode; non-0 to set blocking mode. :type blocking: int @@ -226,7 +226,7 @@ class SFTPFile (BufferedFile): def stat(self): """ Retrieve information about this file from the remote system. This is - exactly like :class:`SFTP.stat`, except that it operates on an already-open + exactly like `SFTP.stat`, except that it operates on an already-open file. :return: an object containing attributes about this file. diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index a1a76c81..9b609da5 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -41,7 +41,7 @@ class SFTPHandle (object): SFTP. If ``flags`` is passed in, it's used to determine if the file is open in append mode. - :param flags: optional flags as passed to :class:`SFTPServerInterface.open` + :param flags: optional flags as passed to `SFTPServerInterface.open` :type flags: int """ self.__flags = flags @@ -76,7 +76,7 @@ class SFTPHandle (object): to be 64 bits. If the end of the file has been reached, this method may return an - empty string to signify EOF, or it may also return :class:`.SFTP_EOF`. + empty string to signify EOF, or it may also return `.SFTP_EOF`. The default implementation checks for an attribute on ``self`` named ``readfile``, and if present, performs the read operation on the python @@ -124,7 +124,7 @@ class SFTPHandle (object): :type offset: int or long :param data: data to write into the file. :type data: str - :return: an SFTP error code like :class:`.SFTP_OK`. + :return: an SFTP error code like `.SFTP_OK`. """ writefile = getattr(self, 'writefile', None) if writefile is None: @@ -148,13 +148,13 @@ class SFTPHandle (object): def stat(self): """ - Return an :class:`.SFTPAttributes` object referring to this open file, or an - error code. This is equivalent to :class:`SFTPServerInterface.stat`, except + Return an `.SFTPAttributes` object referring to this open file, or an + error code. This is equivalent to `SFTPServerInterface.stat`, except it's called on an open file instead of a path. :return: an attributes object for the given file, or an SFTP error - code (like :class:`.SFTP_PERMISSION_DENIED`). - :rtype: :class:`.SFTPAttributes` or error code + code (like `.SFTP_PERMISSION_DENIED`). + :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -165,8 +165,8 @@ class SFTPHandle (object): check for the presence of fields before using them. :param attr: the attributes to change on this file. - :type attr: :class:`.SFTPAttributes` - :return: an error code like :class:`.SFTP_OK`. + :type attr: `.SFTPAttributes` + :return: an error code like `.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index 89684c15..d45bc0f3 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -40,26 +40,26 @@ _hash_class = { class SFTPServer (BaseSFTP, SubsystemHandler): """ - Server-side SFTP subsystem support. Since this is a :class:`.SubsystemHandler`, + Server-side SFTP subsystem support. Since this is a `.SubsystemHandler`, it can be (and is meant to be) set as the handler for ``"sftp"`` requests. - Use :class:`Transport.set_subsystem_handler` to activate this class. + Use `Transport.set_subsystem_handler` to activate this class. """ def __init__(self, channel, name, server, sftp_si=SFTPServerInterface, *largs, **kwargs): """ The constructor for SFTPServer is meant to be called from within the - :class:`.Transport` as a subsystem handler. ``server`` and any additional + `.Transport` as a subsystem handler. ``server`` and any additional parameters or keyword parameters are passed from the original call to - :class:`Transport.set_subsystem_handler`. + `Transport.set_subsystem_handler`. - :param channel: channel passed from the :class:`.Transport`. - :type channel: :class:`.Channel` + :param channel: channel passed from the `.Transport`. + :type channel: `.Channel` :param name: name of the requested subsystem. :type name: str :param server: the server object associated with this channel and subsystem - :type server: :class:`.ServerInterface` - :param sftp_si: a subclass of :class:`.SFTPServerInterface` to use for handling + :type server: `.ServerInterface` + :param sftp_si: a subclass of `.SFTPServerInterface` to use for handling individual requests. :type sftp_si: class """ @@ -128,7 +128,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): :param e: an errno code, as from ``OSError.errno``. :type e: int - :return: an SFTP error code like :class:`.SFTP_NO_SUCH_FILE`. + :return: an SFTP error code like `.SFTP_NO_SUCH_FILE`. :rtype: int """ if e == errno.EACCES: @@ -155,7 +155,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): absolute path). :type filename: str :param attr: attributes to change. - :type attr: :class:`.SFTPAttributes` + :type attr: `.SFTPAttributes` """ if sys.platform != 'win32': # mode operations are meaningless on win32 diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index f3400c3f..4078b30d 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -:class:`.SFTPServerInterface` is an interface to override for SFTP server support. +`.SFTPServerInterface` is an interface to override for SFTP server support. """ import os @@ -29,7 +29,7 @@ from paramiko.sftp import * class SFTPServerInterface (object): """ This class defines an interface for controlling the behavior of paramiko - when using the :class:`.SFTPServer` subsystem to provide an SFTP server. + when using the `.SFTPServer` subsystem to provide an SFTP server. Methods on this class are called from the SFTP session's thread, so you can block as long as necessary without affecting other sessions (even other @@ -48,7 +48,7 @@ class SFTPServerInterface (object): :param server: the server object associated with this channel and SFTP subsystem - :type server: :class:`.ServerInterface` + :type server: `.ServerInterface` """ super(SFTPServerInterface, self).__init__(*largs, **kwargs) @@ -72,10 +72,10 @@ class SFTPServerInterface (object): def open(self, path, flags, attr): """ Open a file on the server and create a handle for future operations - on that file. On success, a new object subclassed from :class:`.SFTPHandle` + on that file. On success, a new object subclassed from `.SFTPHandle` should be returned. This handle will be used for future operations on the file (read, write, etc). On failure, an error code such as - :class:`.SFTP_PERMISSION_DENIED` should be returned. + `.SFTP_PERMISSION_DENIED` should be returned. ``flags`` contains the requested mode for opening (read-only, write-append, etc) as a bitset of flags from the ``os`` module: @@ -103,9 +103,9 @@ class SFTPServerInterface (object): requested mode for opening the file. :type flags: int :param attr: requested attributes of the file if it is newly created. - :type attr: :class:`.SFTPAttributes` - :return: a new :class:`.SFTPHandle` or error code. - :rtype :class:`.SFTPHandle` + :type attr: `.SFTPAttributes` + :return: a new `.SFTPHandle` or error code. + :rtype `.SFTPHandle` """ return SFTP_OP_UNSUPPORTED @@ -115,21 +115,21 @@ class SFTPServerInterface (object): posix notation (``"/"`` separates folder names) and may be an absolute or relative path. - The list of files is expected to be a list of :class:`.SFTPAttributes` + The list of files is expected to be a list of `.SFTPAttributes` objects, which are similar in structure to the objects returned by ``os.stat``. In addition, each object should have its ``filename`` field filled in, since this is important to a directory listing and not normally present in ``os.stat`` results. The method - :class:`SFTPAttributes.from_stat` will usually do what you want. + `SFTPAttributes.from_stat` will usually do what you want. In case of an error, you should return one of the ``SFTP_*`` error - codes, such as :class:`.SFTP_PERMISSION_DENIED`. + codes, such as `.SFTP_PERMISSION_DENIED`. :param path: the requested path (relative or absolute) to be listed. :type path: str :return: a list of the files in the given folder, using - :class:`.SFTPAttributes` objects. - :rtype: list of :class:`.SFTPAttributes` or error code + `.SFTPAttributes` objects. + :rtype: list of `.SFTPAttributes` or error code .. note:: You should normalize the given ``path`` first (see the ``os.path`` module) and check appropriate permissions before returning @@ -141,7 +141,7 @@ class SFTPServerInterface (object): def stat(self, path): """ - Return an :class:`.SFTPAttributes` object for a path on the server, or an + Return an `.SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as "aliases"), you should follow them. (`lstat` is the corresponding call that doesn't follow symlinks/aliases.) @@ -150,14 +150,14 @@ class SFTPServerInterface (object): file statistics for. :type path: str :return: an attributes object for the given file, or an SFTP error - code (like :class:`.SFTP_PERMISSION_DENIED`). - :rtype: :class:`.SFTPAttributes` or error code + code (like `.SFTP_PERMISSION_DENIED`). + :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED def lstat(self, path): """ - Return an :class:`.SFTPAttributes` object for a path on the server, or an + Return an `.SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as "aliases"), you should not follow them -- instead, you should return data on the symlink or alias itself. (`stat` is the @@ -167,8 +167,8 @@ class SFTPServerInterface (object): file statistics for. :type path: str :return: an attributes object for the given file, or an SFTP error - code (like :class:`.SFTP_PERMISSION_DENIED`). - :rtype: :class:`.SFTPAttributes` or error code + code (like `.SFTP_PERMISSION_DENIED`). + :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -179,7 +179,7 @@ class SFTPServerInterface (object): :param path: the requested path (relative or absolute) of the file to delete. :type path: str - :return: an SFTP error code like :class:`.SFTP_OK`. + :return: an SFTP error code like `.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -201,7 +201,7 @@ class SFTPServerInterface (object): :type oldpath: str :param newpath: the requested new path of the file. :type newpath: str - :return: an SFTP error code like :class:`.SFTP_OK`. + :return: an SFTP error code like `.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -220,8 +220,8 @@ class SFTPServerInterface (object): folder. :type path: str :param attr: requested attributes of the new folder. - :type attr: :class:`.SFTPAttributes` - :return: an SFTP error code like :class:`.SFTP_OK`. + :type attr: `.SFTPAttributes` + :return: an SFTP error code like `.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -235,7 +235,7 @@ class SFTPServerInterface (object): :param path: requested path (relative or absolute) of the folder to remove. :type path: str - :return: an SFTP error code like :class:`.SFTP_OK`. + :return: an SFTP error code like `.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -250,8 +250,8 @@ class SFTPServerInterface (object): change. :type path: str :param attr: requested attributes to change on the file. - :type attr: :class:`.SFTPAttributes` - :return: an error code like :class:`.SFTP_OK`. + :type attr: `.SFTPAttributes` + :return: an error code like `.SFTP_OK`. :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -288,7 +288,7 @@ class SFTPServerInterface (object): :param path: path (relative or absolute) of the symbolic link. :type path: str :return: the target path of the symbolic link, or an error code like - :class:`.SFTP_NO_SUCH_FILE`. + `.SFTP_NO_SUCH_FILE`. :rtype: str or error code """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py index 5d9f43c5..0e78287c 100644 --- a/paramiko/ssh_exception.py +++ b/paramiko/ssh_exception.py @@ -82,7 +82,7 @@ class PartialAuthentication (AuthenticationException): class ChannelException (SSHException): """ - Exception raised when an attempt to open a new :class:`.Channel` fails. + Exception raised when an attempt to open a new `.Channel` fails. :ivar code: the error code returned by the server :type code: int @@ -101,9 +101,9 @@ class BadHostKeyException (SSHException): :ivar hostname: the hostname of the SSH server :type hostname: str :ivar key: the host key presented by the server - :type key: :class:`.PKey` + :type key: `.PKey` :ivar expected_key: the host key expected - :type expected_key: :class:`.PKey` + :type expected_key: `.PKey` .. versionadded:: 1.6 """ diff --git a/paramiko/transport.py b/paramiko/transport.py index 44cdc77a..0df6d1f5 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -70,7 +70,7 @@ class Transport (threading.Thread): """ An SSH Transport attaches to a stream (usually a socket), negotiates an encrypted session, authenticates, and then creates stream tunnels, called - :class:`channels `, across the session. Multiple channels can be multiplexed + `channels `, across the session. Multiple channels can be multiplexed across a single session (and often are, in the case of port forwardings). """ @@ -283,20 +283,20 @@ class Transport (threading.Thread): def get_security_options(self): """ - Return a :class:`.SecurityOptions` object which can be used to tweak the + Return a `.SecurityOptions` object which can be used to tweak the encryption algorithms this transport will permit, and the order of preference for them. :return: an object that can be used to change the preferred algorithms for encryption, digest (hash), public key, and key exchange. - :rtype: :class:`.SecurityOptions` + :rtype: `.SecurityOptions` """ return SecurityOptions(self) def start_client(self, event=None): """ Negotiate a new SSH2 session as a client. This is the first step after - creating a new :class:`.Transport`. A separate thread is created for protocol + creating a new `.Transport`. A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When @@ -308,8 +308,8 @@ class Transport (threading.Thread): Otherwise an SSHException is raised. After a successful negotiation, you will usually want to authenticate, - calling :class:`auth_password ` or - :class:`auth_publickey `. + calling `auth_password ` or + `auth_publickey `. .. note:: `connect` is a simpler method for connecting as a client. @@ -348,7 +348,7 @@ class Transport (threading.Thread): def start_server(self, event=None, server=None): """ Negotiate a new SSH2 session as a server. This is the first step after - creating a new :class:`.Transport` and setting up your server host key(s). A + creating a new `.Transport` and setting up your server host key(s). A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When @@ -361,15 +361,15 @@ class Transport (threading.Thread): After a successful negotiation, the client will need to authenticate. Override the methods - :class:`get_allowed_auths `, - :class:`check_auth_none `, - :class:`check_auth_password `, and - :class:`check_auth_publickey ` in the + `get_allowed_auths `, + `check_auth_none `, + `check_auth_password `, and + `check_auth_publickey ` in the given ``server`` object to control the authentication process. After a successful authentication, the client should request to open a channel. Override - :class:`check_channel_request ` in the + `check_channel_request ` in the given ``server`` object to allow channels to be opened. .. note:: After calling this method (or `start_client` or `connect`), @@ -379,8 +379,8 @@ class Transport (threading.Thread): :param event: an event to trigger when negotiation is complete. :type event: threading.Event :param server: an object used to perform authentication and create - :class:`channels ` - :type server: :class:`server.ServerInterface` + `channels ` + :type server: `server.ServerInterface` :raises SSHException: if negotiation fails (and no ``event`` was passed in) @@ -418,9 +418,9 @@ class Transport (threading.Thread): key info, not just the public half. Only one key of each type (RSA or DSS) is kept. - :param key: the host key to add, usually an :class:`RSAKey ` or - :class:`DSSKey `. - :type key: :class:`PKey ` + :param key: the host key to add, usually an `RSAKey ` or + `DSSKey `. + :type key: `PKey ` """ self.server_key_dict[key.get_name()] = key @@ -436,7 +436,7 @@ class Transport (threading.Thread): yet, ``None`` is returned. In client mode, the behavior is undefined. :return: host key of the type negotiated by the client, or ``None``. - :rtype: :class:`PKey ` + :rtype: `PKey ` """ try: return self.server_key_dict[self.host_key_type] @@ -504,13 +504,13 @@ class Transport (threading.Thread): .. note:: Previously this call returned a tuple of (key type, key string). You can get the same effect by calling - :class:`PKey.get_name ` for the key type, and + `PKey.get_name ` for the key type, and ``str(key)`` for the key string. :raises SSHException: if no session is currently active. :return: public key of the remote server - :rtype: :class:`PKey ` + :rtype: `PKey ` """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -531,8 +531,8 @@ class Transport (threading.Thread): Request a new channel to the server, of type ``"session"``. This is just an alias for ``open_channel('session')``. - :return: a new :class:`.Channel` - :rtype: :class:`.Channel` + :return: a new `.Channel` + :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -547,8 +547,8 @@ class Transport (threading.Thread): :param src_addr: the source address of the x11 server (port is the x11 port, ie. 6010) :type src_addr: (str, int) - :return: a new :class:`.Channel` - :rtype: :class:`.Channel` + :return: a new `.Channel` + :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -561,8 +561,8 @@ class Transport (threading.Thread): ``"auth-agent@openssh.com"``. This is just an alias for ``open_channel('auth-agent@openssh.com')``. - :return: a new :class:`.Channel` - :rtype: :class:`.Channel` + :return: a new `.Channel` + :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -584,7 +584,7 @@ class Transport (threading.Thread): def open_channel(self, kind, dest_addr=None, src_addr=None): """ - Request a new channel to the server. :class:`.Channels ` are socket-like + Request a new channel to the server. `.Channels ` are socket-like objects used for the actual transfer of data across the session. You may only request a channel after negotiating encryption (using `connect` or `start_client`) and authenticating. @@ -599,8 +599,8 @@ class Transport (threading.Thread): :param src_addr: the source address of this port forwarding, if ``kind`` is ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"`` :type src_addr: (str, int) - :return: a new :class:`.Channel` on success - :rtype: :class:`.Channel` + :return: a new `.Channel` on success + :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -717,9 +717,9 @@ class Transport (threading.Thread): an SFTP session will be opened with the remote host, and a new SFTPClient object will be returned. - :return: a new :class:`.SFTPClient` object, referring to an sftp session + :return: a new `.SFTPClient` object, referring to an sftp session (channel) across this transport - :rtype: :class:`.SFTPClient` + :rtype: `.SFTPClient` """ return SFTPClient.from_transport(self) @@ -793,10 +793,10 @@ class Transport (threading.Thread): :param wait: ``True`` if this method should not return until a response is received; ``False`` otherwise. :type wait: bool - :return: a :class:`.Message` containing possible additional data if the - request was successful (or an empty :class:`.Message` if ``wait`` was + :return: a `.Message` containing possible additional data if the + request was successful (or an empty `.Message` if ``wait`` was ``False``); ``None`` if the request was denied. - :rtype: :class:`.Message` + :rtype: `.Message` """ if wait: self.completion_event = threading.Event() @@ -828,7 +828,7 @@ class Transport (threading.Thread): forever :type timeout: int :return: a new Channel opened by the client - :rtype: :class:`.Channel` + :rtype: `.Channel` """ self.lock.acquire() try: @@ -850,14 +850,14 @@ class Transport (threading.Thread): Negotiate an SSH2 session, and optionally verify the server's host key and authenticate using a password or private key. This is a shortcut for `start_client`, `get_remote_server_key`, and - :class:`Transport.auth_password` or :class:`Transport.auth_publickey`. Use those + `Transport.auth_password` or `Transport.auth_publickey`. Use those methods if you want more control. You can use this method immediately after creating a Transport to negotiate encryption with a server. If it fails, an exception will be thrown. On success, the method will return cleanly, and an encrypted session exists. You may immediately call `open_channel` or - `open_session` to get a :class:`.Channel` object, which is used for data + `open_session` to get a `.Channel` object, which is used for data transfer. .. note:: If you fail to supply a password or private key, this method may @@ -866,7 +866,7 @@ class Transport (threading.Thread): :param hostkey: the host key expected from the server, or ``None`` if you don't want to do host key verification. - :type hostkey: :class:`PKey` + :type hostkey: `PKey` :param username: the username to authenticate as. :type username: str :param password: a password to use for authentication, if you want to @@ -874,7 +874,7 @@ class Transport (threading.Thread): :type password: str :param pkey: a private key to use for authentication, if you want to use private key authentication; otherwise ``None``. - :type pkey: :class:`PKey` + :type pkey: `PKey` :raises SSHException: if the SSH2 negotiation fails, the host key supplied by the server is incorrect, or authentication fails. @@ -928,15 +928,15 @@ class Transport (threading.Thread): """ Set the handler class for a subsystem in server mode. If a request for this subsystem is made on an open ssh channel later, this handler - will be constructed and called -- see :class:`.SubsystemHandler` for more + will be constructed and called -- see `.SubsystemHandler` for more detailed documentation. Any extra parameters (including keyword arguments) are saved and - passed to the :class:`.SubsystemHandler` constructor later. + passed to the `.SubsystemHandler` constructor later. :param name: name of the subsystem. :type name: str - :param handler: subclass of :class:`.SubsystemHandler` that handles this + :param handler: subclass of `.SubsystemHandler` that handles this subsystem. :type handler: class """ @@ -975,7 +975,7 @@ class Transport (threading.Thread): Try to authenticate to the server using no authentication at all. This will almost always fail. It may be useful for determining the list of authentication types supported by the server, by catching the - :class:`.BadAuthenticationType` exception raised. + `.BadAuthenticationType` exception raised. :param username: the username to authenticate as :type username: string @@ -1101,7 +1101,7 @@ class Transport (threading.Thread): :param username: the username to authenticate as :type username: string :param key: the private key to authenticate with - :type key: :class:`PKey ` + :type key: `PKey ` :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) :type event: threading.Event @@ -2041,7 +2041,7 @@ class SecurityOptions (object): exchange algorithms, listed in order of preference. Changing the contents and/or order of these fields affects the underlying - :class:`.Transport` (but only if you change them before starting the session). + `.Transport` (but only if you change them before starting the session). If you try to add an algorithm that paramiko doesn't recognize, ``ValueError`` will be raised. If you try to assign something besides a tuple to one of the fields, ``TypeError`` will be raised. diff --git a/paramiko/util.py b/paramiko/util.py index f2950134..63f86f78 100644 --- a/paramiko/util.py +++ b/paramiko/util.py @@ -154,9 +154,9 @@ def generate_key_bytes(hashclass, salt, key, nbytes): through a secure hash into some keyworthy bytes. This specific algorithm is used for encrypting/decrypting private key files. - :param hashclass: class from :class:`Crypto.Hash` that can be used as a secure + :param hashclass: class from `Crypto.Hash` that can be used as a secure hashing function (like ``MD5`` or ``SHA``). - :type hashclass: :class:`Crypto.Hash` + :type hashclass: `Crypto.Hash` :param salt: data to salt the hash with. :type salt: string :param key: human-entered password or passphrase. @@ -185,26 +185,26 @@ def generate_key_bytes(hashclass, salt, key, nbytes): def load_host_keys(filename): """ Read a file of known SSH host keys, in the format used by openssh, and - return a compound dict of ``hostname -> keytype ->`` :class:`PKey `. + return a compound dict of ``hostname -> keytype ->`` `PKey `. The hostname may be an IP address or DNS name. The keytype will be either ``"ssh-rsa"`` or ``"ssh-dss"``. This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in ``os.path.expanduser("~/.ssh/known_hosts")``. - Since 1.5.3, this is just a wrapper around :class:`.HostKeys`. + Since 1.5.3, this is just a wrapper around `.HostKeys`. :param filename: name of the file to read host keys from :type filename: str :return: dict of host keys, indexed by hostname and then keytype - :rtype: dict(hostname, dict(keytype, :class:`PKey `)) + :rtype: dict(hostname, dict(keytype, `PKey `)) """ from paramiko.hostkeys import HostKeys return HostKeys(filename) def parse_ssh_config(file_obj): """ - Provided only as a backward-compatible wrapper around :class:`.SSHConfig`. + Provided only as a backward-compatible wrapper around `.SSHConfig`. """ config = SSHConfig() config.parse(file_obj) @@ -212,7 +212,7 @@ def parse_ssh_config(file_obj): def lookup_ssh_host_config(hostname, config): """ - Provided only as a backward-compatible wrapper around :class:`.SSHConfig`. + Provided only as a backward-compatible wrapper around `.SSHConfig`. """ return config.lookup(hostname) -- cgit v1.2.3 From 0e9a5a4b463fbbc8518e4679850207e31fbd8a0f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 14:31:08 -0800 Subject: Move module level docstring into Sphinx docs --- paramiko/__init__.py | 32 -------------------------------- sites/docs/index.rst | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 32 deletions(-) diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 6e282c63..bfd28f26 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -16,38 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -Paramiko (a combination of the esperanto words for "paranoid" and "friend") -is a module for python 2.5 or greater that implements the SSH2 protocol for -secure (encrypted and authenticated) connections to remote machines. Unlike -SSL (aka TLS), the SSH2 protocol does not require hierarchical certificates -signed by a powerful central authority. You may know SSH2 as the protocol that -replaced ``telnet`` and ``rsh`` for secure access to remote shells, but the -protocol also includes the ability to open arbitrary channels to remote -services across an encrypted tunnel. (This is how ``sftp`` works, for example.) - -The high-level client API starts with creation of an `.SSHClient` object. -For more direct control, pass a socket (or socket-like object) to a -`.Transport`, and use `start_server <.Transport.start_server>` or -`start_client <.Transport.start_client>` to negoatite -with the remote host as either a server or client. As a client, you are -responsible for authenticating using a password or private key, and checking -the server's host key. (Key signature and verification is done by paramiko, -but you will need to provide private keys and check that the content of a -public key matches what you expected to see.) As a server, you are -responsible for deciding which users, passwords, and keys to allow, and what -kind of channels to allow. - -Once you have finished, either side may request flow-controlled `channels ` -to the other side, which are python objects that act like sockets, but send and -receive data over the encrypted session. - -Paramiko is written entirely in python (no C or platform-dependent code) and is -released under the GNU Lesser General Public License (LGPL). - -Website: https://github.com/paramiko/paramiko/ -""" - import sys if sys.version_info < (2, 5): diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 98f4069a..87a0f994 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -10,6 +10,28 @@ please see `the main website `_. API documentation ================= +The high-level client API starts with creation of an `.SSHClient` object. For +more direct control, pass a socket (or socket-like object) to a `.Transport`, +and use `start_server <.Transport.start_server>` or `start_client +<.Transport.start_client>` to negotiate with the remote host as either a server +or client. + +As a client, you are responsible for authenticating using a password or private +key, and checking the server's host key. (Key signature and verification is +done by paramiko, but you will need to provide private keys and check that the +content of a public key matches what you expected to see.) + +As a server, you are responsible for deciding which users, passwords, and keys +to allow, and what kind of channels to allow. + +Once you have finished, either side may request flow-controlled `channels +<.Channel>` to the other side, which are Python objects that act like sockets, +but send and receive data over the encrypted session. + +For details, please see the following tables of contents (which are organized +by area of interest.) + + Core SSH protocol classes ------------------------- -- cgit v1.2.3 From 8c7eafdfcd00e7da483cfd1634683c67ea77b248 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 15:30:26 -0800 Subject: Exceptions --- paramiko/ssh_exception.py | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py index 0e78287c..56dec86a 100644 --- a/paramiko/ssh_exception.py +++ b/paramiko/ssh_exception.py @@ -16,10 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -Exceptions defined by paramiko. -""" - class SSHException (Exception): """ @@ -52,9 +48,9 @@ class BadAuthenticationType (AuthenticationException): the server isn't allowing that type. (It may only allow public-key, for example.) - :ivar allowed_types: list of allowed authentication types provided by the - server (possible values are: ``"none"``, ``"password"``, and - ``"publickey"``). + :ivar allowed_types: + list of allowed authentication types provided by the server (possible + values are: ``"none"``, ``"password"``, and ``"publickey"``). :type allowed_types: list .. versionadded:: 1.1 -- cgit v1.2.3 From 0b2d523665f3989d9375cd83970400ace0e40336 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 15:35:22 -0800 Subject: Connect to Python stdlib intersphinx --- sites/docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/sites/docs/conf.py b/sites/docs/conf.py index c0f51f76..619ff816 100644 --- a/sites/docs/conf.py +++ b/sites/docs/conf.py @@ -9,3 +9,8 @@ extensions.extend(['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']) # Autodoc settings autodoc_default_flags = ['members', 'special-members'] + +# Intersphinx connection to stdlib +intersphinx_mapping = { + 'python': ('http://docs.python.org/2.6', None), +} -- cgit v1.2.3 From 5681b8c25a7b7d441b05b2f04ec057d5d2fb3510 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 15:35:29 -0800 Subject: Pipe --- paramiko/pipe.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/paramiko/pipe.py b/paramiko/pipe.py index db43d549..705f8d49 100644 --- a/paramiko/pipe.py +++ b/paramiko/pipe.py @@ -17,11 +17,12 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Abstraction of a one-way pipe where the read end can be used in select(). -Normally this is trivial, but Windows makes it nearly impossible. +Abstraction of a one-way pipe where the read end can be used in +`select.select`. Normally this is trivial, but Windows makes it nearly +impossible. The pipe acts like an Event, which can be set or cleared. When set, the pipe -will trigger as readable in select(). +will trigger as readable in `select `. """ import sys -- cgit v1.2.3 From 0d0836661266befb03ecfd62c03461c2ccac8814 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 15:43:35 -0800 Subject: BufferedFile --- paramiko/file.py | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/paramiko/file.py b/paramiko/file.py index 65e58040..f843f936 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -16,10 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -BufferedFile. -""" - from cStringIO import StringIO @@ -69,7 +65,6 @@ class BufferedFile (object): :raises ValueError: if the file is closed. - :return: an interator. :rtype: iterator """ if self._closed: @@ -94,9 +89,9 @@ class BufferedFile (object): def next(self): """ - Returns the next line from the input, or raises `.StopIteration` when - EOF is hit. Unlike python file objects, it's okay to mix calls to - `next` and `readline`. + Returns the next line from the input, or raises + `~exceptions.StopIteration` when EOF is hit. Unlike Python file + objects, it's okay to mix calls to `next` and `readline`. :raises StopIteration: when the end of the file is reached. @@ -171,13 +166,15 @@ class BufferedFile (object): incomplete line may be returned. An empty string is returned only when EOF is encountered immediately. - .. note:: Unlike stdio's ``fgets()``, the returned string contains null - characters (``'\\0'``) if they occurred in the input. + .. note:: + Unlike stdio's ``fgets``, the returned string contains null + characters (``'\\0'``) if they occurred in the input. :param size: maximum length of returned string. :type size: int - :return: next line of the file, or an empty string if the end of the - file has been reached. + :return: + next line of the file, or an empty string if the end of the file + has been reached. :rtype: str """ # it's almost silly how complex this function is. @@ -334,7 +331,7 @@ class BufferedFile (object): """ Write a sequence of strings to the file. The sequence can be any iterable object producing strings, typically a list of strings. (The - name is intended to match `readlines`; ``writelines`` does not add line + name is intended to match `readlines`; `writelines` does not add line separators.) :param sequence: an iterable sequence of strings. -- cgit v1.2.3 From 91c47b17482ccabc64e6448cc0e1d48c38251105 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 15:46:58 -0800 Subject: s/python/Python/, c'mon son! --- paramiko/__init__.py | 2 +- paramiko/auth_handler.py | 2 +- paramiko/channel.py | 14 +++++++------- paramiko/client.py | 6 +++--- paramiko/file.py | 4 ++-- paramiko/hostkeys.py | 2 +- paramiko/logging22.py | 2 +- paramiko/message.py | 2 +- paramiko/packet.py | 2 +- paramiko/pkey.py | 2 +- paramiko/resource.py | 4 ++-- paramiko/server.py | 2 +- paramiko/sftp_client.py | 26 +++++++++++++------------- paramiko/sftp_file.py | 8 ++++---- paramiko/sftp_handle.py | 10 +++++----- paramiko/sftp_server.py | 2 +- paramiko/sftp_si.py | 4 ++-- paramiko/util.py | 4 ++-- 18 files changed, 49 insertions(+), 49 deletions(-) diff --git a/paramiko/__init__.py b/paramiko/__init__.py index bfd28f26..f081de21 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -19,7 +19,7 @@ import sys if sys.version_info < (2, 5): - raise RuntimeError('You need python 2.5+ for this module.') + raise RuntimeError('You need Python 2.5+ for this module.') __author__ = "Jeff Forcier " diff --git a/paramiko/auth_handler.py b/paramiko/auth_handler.py index e12859a7..0c9efa14 100644 --- a/paramiko/auth_handler.py +++ b/paramiko/auth_handler.py @@ -167,7 +167,7 @@ class AuthHandler (object): e = self.transport.get_exception() if e is None: e = AuthenticationException('Authentication failed.') - # this is horrible. python Exception isn't yet descended from + # this is horrible. Python Exception isn't yet descended from # object, so type(e) won't work. :( if issubclass(e.__class__, PartialAuthentication): return e.allowed_types diff --git a/paramiko/channel.py b/paramiko/channel.py index a7816a37..630a60c8 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -44,7 +44,7 @@ class Channel (object): """ A secure tunnel across an SSH `.Transport`. A Channel is meant to behave like a socket, and has an API that should be indistinguishable from the - python socket API. + Python socket API. Because SSH2 has a windowing kind of flow control, if you stop reading data from a Channel and its buffer fills up, the server will be unable to send @@ -788,7 +788,7 @@ class Channel (object): .. note:: If the channel is closed while only part of the data hase been sent, there is no way to determine how much data (if any) was sent. - This is irritating, but identically follows python's API. + This is irritating, but identically follows Python's API. """ while s: if self.closed: @@ -826,9 +826,9 @@ class Channel (object): """ Return a file-like object associated with this channel. The optional ``mode`` and ``bufsize`` arguments are interpreted the same way as by - the built-in ``file()`` function in python. + the built-in ``file()`` function in Python. - :return: object which can be used for python file I/O. + :return: object which can be used for Python file I/O. :rtype: `.ChannelFile` """ return ChannelFile(*([self] + list(params))) @@ -840,11 +840,11 @@ class Channel (object): without a pty will ever have data on the stderr stream. The optional ``mode`` and ``bufsize`` arguments are interpreted the - same way as by the built-in ``file()`` function in python. For a + same way as by the built-in ``file()`` function in Python. For a client, it only makes sense to open this file for reading. For a server, it only makes sense to open this file for writing. - :return: object which can be used for python file I/O. + :return: object which can be used for Python file I/O. :rtype: `.ChannelFile` .. versionadded:: 1.1 @@ -854,7 +854,7 @@ class Channel (object): def fileno(self): """ Returns an OS-level file descriptor which can be used for polling, but - but not for reading or writing. This is primaily to allow python's + but not for reading or writing. This is primaily to allow Python's ``select`` module to work. The first time ``fileno`` is called on a channel, a pipe is created to diff --git a/paramiko/client.py b/paramiko/client.py index 17e942d3..8646131b 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -301,12 +301,12 @@ class SSHClient (object): """ Execute a command on the SSH server. A new `.Channel` is opened and the requested command is executed. The command's input and output - streams are returned as python ``file``-like objects representing + streams are returned as Python ``file``-like objects representing stdin, stdout, and stderr. :param command: the command to execute :type command: str - :param bufsize: interpreted the same way as by the built-in ``file()`` function in python + :param bufsize: interpreted the same way as by the built-in ``file()`` function in Python :type bufsize: int :param timeout: set command's channel timeout. See `Channel.settimeout`.settimeout :type timeout: int @@ -529,7 +529,7 @@ class RejectPolicy (MissingHostKeyPolicy): class WarningPolicy (MissingHostKeyPolicy): """ - Policy for logging a python-style warning for an unknown host key, but + Policy for logging a Python-style warning for an unknown host key, but accepting it. This is used by `.SSHClient`. """ def missing_host_key(self, client, hostname, key): diff --git a/paramiko/file.py b/paramiko/file.py index f843f936..2f8499e0 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -21,7 +21,7 @@ from cStringIO import StringIO class BufferedFile (object): """ - Reusable base class to implement python-style file buffering around a + Reusable base class to implement Python-style file buffering around a simpler stream. """ @@ -344,7 +344,7 @@ class BufferedFile (object): def xreadlines(self): """ Identical to ``iter(f)``. This is a deprecated file interface that - predates python iterator support. + predates Python iterator support. :return: an iterator. :rtype: iterator diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index 7b6b1f1e..1eed350a 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -298,7 +298,7 @@ class HostKeys (UserDict.DictMixin): self._entries.append(HostKeyEntry([hostname], entry[key_type])) def keys(self): - # python 2.4 sets would be nice here. + # Python 2.4 sets would be nice here. ret = [] for e in self._entries: for h in e.hostnames: diff --git a/paramiko/logging22.py b/paramiko/logging22.py index e68c52cb..34a9a931 100644 --- a/paramiko/logging22.py +++ b/paramiko/logging22.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Stub out logging on python < 2.3. +Stub out logging on Python < 2.3. """ diff --git a/paramiko/message.py b/paramiko/message.py index 3937938b..55a8eb42 100644 --- a/paramiko/message.py +++ b/paramiko/message.py @@ -29,7 +29,7 @@ from paramiko import util class Message (object): """ An SSH2 Message is a stream of bytes that encodes some combination of - strings, integers, bools, and infinite-precision integers (known in python + strings, integers, bools, and infinite-precision integers (known in Python as longs). This class builds or breaks down such a byte stream. Normally you don't need to deal with anything this low-level, but it's diff --git a/paramiko/packet.py b/paramiko/packet.py index efdb2d04..0f8152fa 100644 --- a/paramiko/packet.py +++ b/paramiko/packet.py @@ -103,7 +103,7 @@ class Packetizer (object): def set_log(self, log): """ - Set the python log object to use for logging. + Set the Python log object to use for logging. """ self.__logger = log diff --git a/paramiko/pkey.py b/paramiko/pkey.py index 655eb3e1..21995bf9 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -178,7 +178,7 @@ class PKey (object): Create a key object by reading a private key file. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt the key (otherwise `.PasswordRequiredException` - is thrown). Through the magic of python, this factory method will + is thrown). Through the magic of Python, this factory method will exist in all subclasses of PKey (such as `.RSAKey` or `.DSSKey`), but is useless on the abstract PKey class. diff --git a/paramiko/resource.py b/paramiko/resource.py index 32947c50..8e8d9eee 100644 --- a/paramiko/resource.py +++ b/paramiko/resource.py @@ -28,7 +28,7 @@ class ResourceManager (object): A registry of objects and resources that should be closed when those objects are deleted. - This is meant to be a safer alternative to python's ``__del__`` method, + This is meant to be a safer alternative to Python's ``__del__`` method, which can cause reference cycles to never be collected. Objects registered with the ResourceManager can be collected but still free resources when they die. @@ -47,7 +47,7 @@ class ResourceManager (object): """ Register a resource to be closed with an object is collected. - When the given ``obj`` is garbage-collected by the python interpreter, + When the given ``obj`` is garbage-collected by the Python interpreter, the ``resource`` will be closed by having its ``close()`` method called. Any exceptions are ignored. diff --git a/paramiko/server.py b/paramiko/server.py index e38fcbbf..9ff7243b 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -626,7 +626,7 @@ class SubsystemHandler (threading.Thread): underlying `.Transport` is closed. This can be done by checking `Transport.is_active` or noticing an EOF on the `.Channel`. If this method loops forever without checking - for this case, your python interpreter may refuse to exit because + for this case, your Python interpreter may refuse to exit because this thread will still be running. :param name: name of the requested subsystem. diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index e5248378..d1d62233 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -196,30 +196,30 @@ class SFTPClient (BaseSFTP): def open(self, filename, mode='r', bufsize=-1): """ Open a file on the remote server. The arguments are the same as for - python's built-in ``file`` (aka ``open``). A file-like object is - returned, which closely mimics the behavior of a normal python file + Python's built-in ``file`` (aka ``open``). A file-like object is + returned, which closely mimics the behavior of a normal Python file object, including the ability to be used as a context manager. The mode indicates how the file is to be opened: ``'r'`` for reading, ``'w'`` for writing (truncating an existing file), ``'a'`` for appending, ``'r+'`` for reading/writing, ``'w+'`` for reading/writing (truncating an - existing file), ``'a+'`` for reading/appending. The python ``'b'`` flag + existing file), ``'a+'`` for reading/appending. The Python ``'b'`` flag is ignored, since SSH treats all files as binary. The ``'U'`` flag is supported in a compatible way. Since 1.5.2, an ``'x'`` flag indicates that the operation should only succeed if the file was created and did not previously exist. This has - no direct mapping to python's file flags, but is commonly known as the + no direct mapping to Python's file flags, but is commonly known as the ``O_EXCL`` flag in posix. - The file will be buffered in standard python style by default, but + The file will be buffered in standard Python style by default, but can be altered with the ``bufsize`` parameter. ``0`` turns off buffering, ``1`` uses line buffering, and any number greater than 1 (``>1``) uses that specific buffer size. :param filename: name of the file to open :type filename: str - :param mode: mode (python-style) to open in + :param mode: mode (Python-style) to open in :type mode: str :param bufsize: desired buffering (-1 = default buffer size) :type bufsize: int @@ -249,7 +249,7 @@ class SFTPClient (BaseSFTP): self._log(DEBUG, 'open(%r, %r) -> %s' % (filename, mode, hexlify(handle))) return SFTPFile(self, handle, mode, bufsize) - # python continues to vacillate about "open" vs "file"... + # Python continues to vacillate about "open" vs "file"... file = open def remove(self, path): @@ -317,11 +317,11 @@ class SFTPClient (BaseSFTP): """ Retrieve information about a file on the remote system. The return value is an object whose attributes correspond to the attributes of - python's ``stat`` structure as returned by ``os.stat``, except that it + Python's ``stat`` structure as returned by ``os.stat``, except that it contains fewer fields. An SFTP server may return as much or as little info as it wants, so the results may vary from server to server. - Unlike a python ``stat`` object, the result may not be accessed as a + Unlike a Python ``stat`` object, the result may not be accessed as a tuple. This is mostly due to the author's slack factor. The fields supported are: ``st_mode``, ``st_size``, ``st_uid``, ``st_gid``, @@ -376,7 +376,7 @@ class SFTPClient (BaseSFTP): def chmod(self, path, mode): """ Change the mode (permissions) of a file. The permissions are - unix-style and identical to those used by python's ``os.chmod`` + unix-style and identical to those used by Python's ``os.chmod`` function. :param path: path of the file to change the permissions of @@ -393,7 +393,7 @@ class SFTPClient (BaseSFTP): def chown(self, path, uid, gid): """ Change the owner (``uid``) and group (``gid``) of a file. As with - python's ``os.chown`` function, you must pass both arguments, so if you + Python's ``os.chown`` function, you must pass both arguments, so if you only want to change one, use `stat` first to retrieve the current owner and group. @@ -416,7 +416,7 @@ class SFTPClient (BaseSFTP): ``times`` is ``None``, then the file's access and modified times are set to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, of the form ``(atime, mtime)``, which is used to set the access and - modified times, respectively. This bizarre API is mimicked from python + modified times, respectively. This bizarre API is mimicked from Python for the sake of consistency -- I apologize. :param path: path of the file to modify @@ -437,7 +437,7 @@ class SFTPClient (BaseSFTP): """ Change the size of the file specified by ``path``. This usually extends or shrinks the size of the file, just like the ``truncate()`` method on - python file objects. + Python file objects. :param path: path of the file to modify :type path: str diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index 770fa126..fa026ec5 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -240,7 +240,7 @@ class SFTPFile (BufferedFile): def chmod(self, mode): """ Change the mode (permissions) of this file. The permissions are - unix-style and identical to those used by python's ``os.chmod`` + unix-style and identical to those used by Python's ``os.chmod`` function. :param mode: new permissions @@ -254,7 +254,7 @@ class SFTPFile (BufferedFile): def chown(self, uid, gid): """ Change the owner (``uid``) and group (``gid``) of this file. As with - python's ``os.chown`` function, you must pass both arguments, so if you + Python's ``os.chown`` function, you must pass both arguments, so if you only want to change one, use `stat` first to retrieve the current owner and group. @@ -274,7 +274,7 @@ class SFTPFile (BufferedFile): ``times`` is ``None``, then the file's access and modified times are set to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, of the form ``(atime, mtime)``, which is used to set the access and - modified times, respectively. This bizarre API is mimicked from python + modified times, respectively. This bizarre API is mimicked from Python for the sake of consistency -- I apologize. :param times: ``None`` or a tuple of (access time, modified time) in @@ -292,7 +292,7 @@ class SFTPFile (BufferedFile): """ Change the size of this file. This usually extends or shrinks the size of the file, just like the ``truncate()`` method on - python file objects. + Python file objects. :param size: the new size of the file :type size: int or long diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 9b609da5..7e1389a2 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -72,16 +72,16 @@ class SFTPHandle (object): def read(self, offset, length): """ Read up to ``length`` bytes from this file, starting at position - ``offset``. The offset may be a python long, since SFTP allows it + ``offset``. The offset may be a Python long, since SFTP allows it to be 64 bits. If the end of the file has been reached, this method may return an empty string to signify EOF, or it may also return `.SFTP_EOF`. The default implementation checks for an attribute on ``self`` named - ``readfile``, and if present, performs the read operation on the python + ``readfile``, and if present, performs the read operation on the Python file-like object found there. (This is meant as a time saver for the - common case where you are wrapping a python file object.) + common case where you are wrapping a Python file object.) :param offset: position in the file to start reading from. :type offset: int or long @@ -109,13 +109,13 @@ class SFTPHandle (object): def write(self, offset, data): """ Write ``data`` into this file at position ``offset``. Extending the - file past its original end is expected. Unlike python's normal + file past its original end is expected. Unlike Python's normal ``write()`` methods, this method cannot do a partial write: it must write all of ``data`` or else return an error. The default implementation checks for an attribute on ``self`` named ``writefile``, and if present, performs the write operation on the - python file-like object found there. The attribute is named + Python file-like object found there. The attribute is named differently from ``readfile`` to make it easy to implement read-only (or write-only) files, but if both attributes are present, they should refer to the same file. diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index d45bc0f3..c7e80c1c 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -296,7 +296,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): self._send_packet(CMD_EXTENDED_REPLY, str(msg)) def _convert_pflags(self, pflags): - "convert SFTP-style open() flags to python's os.open() flags" + "convert SFTP-style open() flags to Python's os.open() flags" if (pflags & SFTP_FLAG_READ) and (pflags & SFTP_FLAG_WRITE): flags = os.O_RDWR elif pflags & SFTP_FLAG_WRITE: diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index 4078b30d..b2debd3d 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -94,7 +94,7 @@ class SFTPServerInterface (object): the client didn't specify them. .. note:: The SFTP protocol defines all files to be in "binary" mode. - There is no equivalent to python's "text" mode. + There is no equivalent to Python's "text" mode. :param path: the requested path (relative or absolute) of the file to be opened. @@ -265,7 +265,7 @@ class SFTPServerInterface (object): specific folder, you probably don't want this method to reveal path names outside that folder. - You may find the python methods in ``os.path`` useful, especially + You may find the Python methods in ``os.path`` useful, especially ``os.path.normpath`` and ``os.path.realpath``. The default implementation returns ``os.path.normpath('/' + path)``. diff --git a/paramiko/util.py b/paramiko/util.py index 63f86f78..0a75da70 100644 --- a/paramiko/util.py +++ b/paramiko/util.py @@ -34,7 +34,7 @@ from paramiko.common import * from paramiko.config import SSHConfig -# Change by RogerB - python < 2.3 doesn't have enumerate so we implement it +# Change by RogerB - Python < 2.3 doesn't have enumerate so we implement it if sys.version_info < (2,3): class enumerate: def __init__ (self, sequence): @@ -217,7 +217,7 @@ def lookup_ssh_host_config(hostname, config): return config.lookup(hostname) def mod_inverse(x, m): - # it's crazy how small python can make this function. + # it's crazy how small Python can make this function. u1, u2, u3 = 1, 0, m v1, v2, v3 = 0, 1, x -- cgit v1.2.3 From a529e93256e300d8d07354d020e68ae7d45bdd45 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 16:01:32 -0800 Subject: BufferedPipe --- paramiko/buffered_pipe.py | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index 052b6c69..43bfa47d 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Attempt to generalize the "feeder" part of a Channel: an object which can be +Attempt to generalize the "feeder" part of a `.Channel`: an object which can be read from and closed, but is reading from a buffer fed by another thread. The read operations are blocking and can have a timeout set. """ @@ -107,19 +107,18 @@ class BufferedPipe (object): The optional ``timeout`` argument can be a nonnegative float expressing seconds, or ``None`` for no timeout. If a float is given, a - ``PipeTimeout`` will be raised if the timeout period value has - elapsed before any data arrives. + `.PipeTimeout` will be raised if the timeout period value has elapsed + before any data arrives. - :param nbytes: maximum number of bytes to read - :type nbytes: int - :param timeout: maximum seconds to wait (or ``None``, the default, to - wait forever) - :type timeout: float + :param int nbytes: maximum number of bytes to read + :param float timeout: + maximum seconds to wait (or ``None``, the default, to wait forever) :return: data :rtype: str - :raises PipeTimeout: if a timeout was specified and no data was ready - before that timeout + :raises PipeTimeout: + if a timeout was specified and no data was ready before that + timeout """ out = '' self._lock.acquire() @@ -189,7 +188,7 @@ class BufferedPipe (object): """ Return the number of bytes buffered. - :return: number of bytes bufferes + :return: number of bytes buffered :rtype: int """ self._lock.acquire() -- cgit v1.2.3 From 333dd249b01b059f8ecd887a515dd964bfbf7adb Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 16:37:16 -0800 Subject: Start in on the SFTP section --- paramiko/sftp_attr.py | 4 ++-- paramiko/sftp_client.py | 18 +++++++++--------- sites/docs/api/sftp.rst | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index 37cdeba7..b8040399 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -26,8 +26,8 @@ class SFTPAttributes (object): """ Representation of the attributes of a file (or proxied file) for SFTP in client or server mode. It attemps to mirror the object returned by - ``os.stat`` as closely as possible, so it may have the following fields, - with the same meanings as those returned by an ``os.stat`` object: + `os.stat` as closely as possible, so it may have the following fields, + with the same meanings as those returned by an `os.stat` object: - st_size - st_uid - st_gid diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index d1d62233..b9d8744d 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -16,9 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -Client-mode SFTP support. -""" from binascii import hexlify import errno @@ -49,12 +46,13 @@ def _to_unicode(s): return s -class SFTPClient (BaseSFTP): +class SFTPClient(BaseSFTP): """ - SFTP client object. ``SFTPClient`` is used to open an sftp session across - an open ssh `.Transport` and do remote file operations. + SFTP client object. + + Used to open an SFTP session across an open SSH `.Transport` and perform + remote file operations. """ - def __init__(self, sock): """ Create an SFTP client from an existing `.Channel`. The channel @@ -782,6 +780,8 @@ class SFTPClient (BaseSFTP): return self._cwd + '/' + path -class SFTP (SFTPClient): - "an alias for `.SFTPClient` for backwards compatability" +class SFTP(SFTPClient): + """ + An alias for `.SFTPClient` for backwards compatability. + """ pass diff --git a/sites/docs/api/sftp.rst b/sites/docs/api/sftp.rst index 2eedecf8..c016d73e 100644 --- a/sites/docs/api/sftp.rst +++ b/sites/docs/api/sftp.rst @@ -2,9 +2,9 @@ SFTP ==== .. automodule:: paramiko.sftp -.. automodule:: paramiko.sftp_attr .. automodule:: paramiko.sftp_client +.. automodule:: paramiko.sftp_server +.. automodule:: paramiko.sftp_attr .. automodule:: paramiko.sftp_file .. automodule:: paramiko.sftp_handle -.. automodule:: paramiko.sftp_server .. automodule:: paramiko.sftp_si -- cgit v1.2.3 From 6d9b28c56c81c2d4eb7452f0d986e4e4ec6c3039 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 16:56:13 -0800 Subject: Remove win_pageant from docs for now :( too many freakin errors --- sites/docs/api/win_pageant.rst | 4 ---- sites/docs/index.rst | 1 - 2 files changed, 5 deletions(-) delete mode 100644 sites/docs/api/win_pageant.rst diff --git a/sites/docs/api/win_pageant.rst b/sites/docs/api/win_pageant.rst deleted file mode 100644 index c48da5c6..00000000 --- a/sites/docs/api/win_pageant.rst +++ /dev/null @@ -1,4 +0,0 @@ -WinPageant support -================== - -.. automodule:: paramiko.win_pageant diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 87a0f994..9e682bb0 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -50,7 +50,6 @@ Authentication & keys api/agent api/hostkeys api/keys - api/win_pageant Other primary functions -- cgit v1.2.3 From 9ae62eb47a4f7a20eae90a7296ce0a8ecb4923b9 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 19:15:36 -0800 Subject: Wow there's a lot of SFTP crap. --- paramiko/sftp_attr.py | 19 ++++++++-------- paramiko/sftp_client.py | 58 +++++++++++++++++++++++++------------------------ paramiko/sftp_file.py | 50 +++++++++++++++++++++++------------------- paramiko/sftp_handle.py | 4 ++-- paramiko/sftp_server.py | 6 ++--- paramiko/sftp_si.py | 20 +++++++++-------- sites/docs/api/sftp.rst | 3 +++ 7 files changed, 87 insertions(+), 73 deletions(-) diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index b8040399..9b30829c 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -28,12 +28,13 @@ class SFTPAttributes (object): client or server mode. It attemps to mirror the object returned by `os.stat` as closely as possible, so it may have the following fields, with the same meanings as those returned by an `os.stat` object: - - st_size - - st_uid - - st_gid - - st_mode - - st_atime - - st_mtime + + - ``st_size`` + - ``st_uid`` + - ``st_gid`` + - ``st_mode`` + - ``st_atime`` + - ``st_mtime`` Because SFTP allows flags to have other arbitrary named attributes, these are stored in a dict named ``attr``. Occasionally, the filename is also @@ -61,10 +62,10 @@ class SFTPAttributes (object): def from_stat(cls, obj, filename=None): """ - Create an SFTPAttributes object from an existing ``stat`` object (an - object returned by ``os.stat``). + Create an `.SFTPAttributes` object from an existing ``stat`` object (an + object returned by `os.stat`). - :param obj: an object returned by ``os.stat`` (or equivalent). + :param obj: an object returned by `os.stat` (or equivalent). :type obj: object :param filename: the filename associated with this file. :type filename: str diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index b9d8744d..db8d196f 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -1,6 +1,6 @@ # Copyright (C) 2003-2007 Robey Pointer # -# This file is part of paramiko. +# This file is part of Paramiko. # # Paramiko is free software; you can redistribute it and/or modify it under the # terms of the GNU Lesser General Public License as published by the Free @@ -194,16 +194,17 @@ class SFTPClient(BaseSFTP): def open(self, filename, mode='r', bufsize=-1): """ Open a file on the remote server. The arguments are the same as for - Python's built-in ``file`` (aka ``open``). A file-like object is - returned, which closely mimics the behavior of a normal Python file - object, including the ability to be used as a context manager. + Python's built-in `python:file` (aka `python:open`). A file-like + object is returned, which closely mimics the behavior of a normal + Python file object, including the ability to be used as a context + manager. The mode indicates how the file is to be opened: ``'r'`` for reading, - ``'w'`` for writing (truncating an existing file), ``'a'`` for appending, - ``'r+'`` for reading/writing, ``'w+'`` for reading/writing (truncating an - existing file), ``'a+'`` for reading/appending. The Python ``'b'`` flag - is ignored, since SSH treats all files as binary. The ``'U'`` flag is - supported in a compatible way. + ``'w'`` for writing (truncating an existing file), ``'a'`` for + appending, ``'r+'`` for reading/writing, ``'w+'`` for reading/writing + (truncating an existing file), ``'a+'`` for reading/appending. The + Python ``'b'`` flag is ignored, since SSH treats all files as binary. + The ``'U'`` flag is supported in a compatible way. Since 1.5.2, an ``'x'`` flag indicates that the operation should only succeed if the file was created and did not previously exist. This has @@ -222,7 +223,7 @@ class SFTPClient(BaseSFTP): :param bufsize: desired buffering (-1 = default buffer size) :type bufsize: int :return: a file object representing the open file - :rtype: SFTPFile + :rtype: `.SFTPFile` :raises IOError: if the file could not be opened. """ @@ -319,16 +320,16 @@ class SFTPClient(BaseSFTP): contains fewer fields. An SFTP server may return as much or as little info as it wants, so the results may vary from server to server. - Unlike a Python ``stat`` object, the result may not be accessed as a - tuple. This is mostly due to the author's slack factor. + Unlike a Python `python:stat` object, the result may not be accessed as + a tuple. This is mostly due to the author's slack factor. - The fields supported are: ``st_mode``, ``st_size``, ``st_uid``, ``st_gid``, - ``st_atime``, and ``st_mtime``. + The fields supported are: ``st_mode``, ``st_size``, ``st_uid``, + ``st_gid``, ``st_atime``, and ``st_mtime``. :param path: the filename to stat :type path: str :return: an object containing attributes about the given file - :rtype: SFTPAttributes + :rtype: `.SFTPAttributes` """ path = self._adjust_cwd(path) self._log(DEBUG, 'stat(%r)' % path) @@ -346,7 +347,7 @@ class SFTPClient(BaseSFTP): :param path: the filename to stat :type path: str :return: an object containing attributes about the given file - :rtype: SFTPAttributes + :rtype: `.SFTPAttributes` """ path = self._adjust_cwd(path) self._log(DEBUG, 'lstat(%r)' % path) @@ -374,7 +375,7 @@ class SFTPClient(BaseSFTP): def chmod(self, path, mode): """ Change the mode (permissions) of a file. The permissions are - unix-style and identical to those used by Python's ``os.chmod`` + unix-style and identical to those used by Python's `os.chmod` function. :param path: path of the file to change the permissions of @@ -391,7 +392,7 @@ class SFTPClient(BaseSFTP): def chown(self, path, uid, gid): """ Change the owner (``uid``) and group (``gid``) of a file. As with - Python's ``os.chown`` function, you must pass both arguments, so if you + Python's `os.chown` function, you must pass both arguments, so if you only want to change one, use `stat` first to retrieve the current owner and group. @@ -433,9 +434,9 @@ class SFTPClient(BaseSFTP): def truncate(self, path, size): """ - Change the size of the file specified by ``path``. This usually extends - or shrinks the size of the file, just like the ``truncate()`` method on - Python file objects. + Change the size of the file specified by ``path``. This usually + extends or shrinks the size of the file, just like the `~file.truncate` + method on Python file objects. :param path: path of the file to modify :type path: str @@ -498,9 +499,9 @@ class SFTPClient(BaseSFTP): def chdir(self, path): """ Change the "current directory" of this SFTP session. Since SFTP - doesn't really have the concept of a current working directory, this - is emulated by paramiko. Once you use this method to set a working - directory, all operations on this SFTPClient object will be relative + doesn't really have the concept of a current working directory, this is + emulated by Paramiko. Once you use this method to set a working + directory, all operations on this `.SFTPClient` object will be relative to that path. You can pass in ``None`` to stop using a current working directory. @@ -521,7 +522,7 @@ class SFTPClient(BaseSFTP): def getcwd(self): """ Return the "current working directory" for this SFTP session, as - emulated by paramiko. If no directory has been set with `chdir`, + emulated by Paramiko. If no directory has been set with `chdir`, this method will return ``None``. :return: the current working directory on the server, or ``None`` @@ -534,7 +535,8 @@ class SFTPClient(BaseSFTP): def putfo(self, fl, remotepath, file_size=0, callback=None, confirm=True): """ Copy the contents of an open file object (``fl``) to the SFTP server as - ``remotepath``. Any exception raised by operations will be passed through. + ``remotepath``. Any exception raised by operations will be passed + through. The SFTP operations use pipelining for speed. @@ -555,7 +557,7 @@ class SFTPClient(BaseSFTP): :return: an object containing attributes about the given file (since 1.7.4) - :rtype: SFTPAttributes + :rtype: `.SFTPAttributes` .. versionadded:: 1.4 """ @@ -603,7 +605,7 @@ class SFTPClient(BaseSFTP): :return: an object containing attributes about the given file (since 1.7.4) - :rtype: SFTPAttributes + :rtype: `.SFTPAttributes` .. versionadded:: 1.4 """ diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index fa026ec5..068ca1a1 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -`.SFTPFile` +SFTP file object """ from __future__ import with_statement @@ -64,6 +64,9 @@ class SFTPFile (BufferedFile): self._close(async=True) def close(self): + """ + Close the file. + """ self._close(async=False) def _close(self, async=False): @@ -183,10 +186,11 @@ class SFTPFile (BufferedFile): Set a timeout on read/write operations on the underlying socket or ssh `.Channel`. - .. seealso:: `Channel.settimeout` :param timeout: seconds to wait for a pending read/write operation before raising ``socket.timeout``, or ``None`` for no timeout :type timeout: float + + .. seealso:: `.Channel.settimeout` """ self.sftp.sock.settimeout(timeout) @@ -195,8 +199,9 @@ class SFTPFile (BufferedFile): Returns the timeout in seconds (as a float) associated with the socket or ssh `.Channel` used for this file. - .. seealso:: `Channel.gettimeout` :rtype: float + + .. seealso:: `.Channel.gettimeout` """ return self.sftp.sock.gettimeout() @@ -205,10 +210,11 @@ class SFTPFile (BufferedFile): Set blocking or non-blocking mode on the underiying socket or ssh `.Channel`. - .. seealso:: `Channel.setblocking` - :param blocking: 0 to set non-blocking mode; non-0 to set blocking - mode. + :param blocking: + 0 to set non-blocking mode; non-0 to set blocking mode. :type blocking: int + + .. seealso:: `.Channel.setblocking` """ self.sftp.sock.setblocking(blocking) @@ -226,11 +232,11 @@ class SFTPFile (BufferedFile): def stat(self): """ Retrieve information about this file from the remote system. This is - exactly like `SFTP.stat`, except that it operates on an already-open - file. + exactly like `.SFTPClient.stat`, except that it operates on an + already-open file. :return: an object containing attributes about this file. - :rtype: SFTPAttributes + :rtype: `.SFTPAttributes` """ t, msg = self.sftp._request(CMD_FSTAT, self.handle) if t != CMD_ATTRS: @@ -240,7 +246,7 @@ class SFTPFile (BufferedFile): def chmod(self, mode): """ Change the mode (permissions) of this file. The permissions are - unix-style and identical to those used by Python's ``os.chmod`` + unix-style and identical to those used by Python's `os.chmod` function. :param mode: new permissions @@ -254,7 +260,7 @@ class SFTPFile (BufferedFile): def chown(self, uid, gid): """ Change the owner (``uid``) and group (``gid``) of this file. As with - Python's ``os.chown`` function, you must pass both arguments, so if you + Python's `os.chown` function, you must pass both arguments, so if you only want to change one, use `stat` first to retrieve the current owner and group. @@ -341,12 +347,12 @@ class SFTPFile (BufferedFile): concatenated together :rtype: str - .. note:: Many (most?) servers don't support this extension yet. - :raises IOError: if the server doesn't support the "check-file" extension, or possibly doesn't support the hash algorithm requested + .. note:: Many (most?) servers don't support this extension yet. + .. versionadded:: 1.4 """ t, msg = self.sftp._request(CMD_EXTENDED, 'check-file', self.handle, @@ -360,11 +366,11 @@ class SFTPFile (BufferedFile): """ Turn on/off the pipelining of write operations to this file. When pipelining is on, paramiko won't wait for the server response after - each write operation. Instead, they're collected as they come in. - At the first non-write operation (including `close`), all remaining + each write operation. Instead, they're collected as they come in. At + the first non-write operation (including `.close`), all remaining server responses are collected. This means that if there was an error - with one of your later writes, an exception might be thrown from - within `close` instead of `write`. + with one of your later writes, an exception might be thrown from within + `.close` instead of `.write`. By default, files are not pipelined. @@ -378,14 +384,14 @@ class SFTPFile (BufferedFile): def prefetch(self): """ - Pre-fetch the remaining contents of this file in anticipation of - future `read` calls. If reading the entire file, pre-fetching can + Pre-fetch the remaining contents of this file in anticipation of future + `.read` calls. If reading the entire file, pre-fetching can dramatically improve the download speed by avoiding roundtrip latency. The file's contents are incrementally buffered in a background thread. - The prefetched data is stored in a buffer until read via the `read` + The prefetched data is stored in a buffer until read via the `.read` method. Once data has been read, it's removed from the buffer. The - data may be read in a random order (using `seek`); chunks of the + data may be read in a random order (using `.seek`); chunks of the buffer that haven't been read will continue to be buffered. .. versionadded:: 1.5.1 @@ -404,7 +410,7 @@ class SFTPFile (BufferedFile): def readv(self, chunks): """ Read a set of blocks from the file by (offset, length). This is more - efficient than doing a series of `seek` and `read` calls, since the + efficient than doing a series of `.seek` and `.read` calls, since the prefetch machinery is used to retrieve all the requested blocks at once. diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 7e1389a2..6965fd65 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -41,7 +41,7 @@ class SFTPHandle (object): SFTP. If ``flags`` is passed in, it's used to determine if the file is open in append mode. - :param flags: optional flags as passed to `SFTPServerInterface.open` + :param flags: optional flags as passed to `.SFTPServerInterface.open` :type flags: int """ self.__flags = flags @@ -149,7 +149,7 @@ class SFTPHandle (object): def stat(self): """ Return an `.SFTPAttributes` object referring to this open file, or an - error code. This is equivalent to `SFTPServerInterface.stat`, except + error code. This is equivalent to `.SFTPServerInterface.stat`, except it's called on an open file instead of a path. :return: an attributes object for the given file, or an SFTP error diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index c7e80c1c..9b7ed5ca 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -42,7 +42,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): """ Server-side SFTP subsystem support. Since this is a `.SubsystemHandler`, it can be (and is meant to be) set as the handler for ``"sftp"`` requests. - Use `Transport.set_subsystem_handler` to activate this class. + Use `.Transport.set_subsystem_handler` to activate this class. """ def __init__(self, channel, name, server, sftp_si=SFTPServerInterface, *largs, **kwargs): @@ -50,7 +50,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): The constructor for SFTPServer is meant to be called from within the `.Transport` as a subsystem handler. ``server`` and any additional parameters or keyword parameters are passed from the original call to - `Transport.set_subsystem_handler`. + `.Transport.set_subsystem_handler`. :param channel: channel passed from the `.Transport`. :type channel: `.Channel` @@ -128,7 +128,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler): :param e: an errno code, as from ``OSError.errno``. :type e: int - :return: an SFTP error code like `.SFTP_NO_SUCH_FILE`. + :return: an SFTP error code like ``SFTP_NO_SUCH_FILE``. :rtype: int """ if e == errno.EACCES: diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index b2debd3d..ead483a0 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -`.SFTPServerInterface` is an interface to override for SFTP server support. +An interface to override for SFTP server support. """ import os @@ -64,7 +64,7 @@ class SFTPServerInterface (object): """ The SFTP server session has just ended, either cleanly or via an exception. This method is meant to be overridden to perform any - necessary cleanup before this ``SFTPServerInterface`` object is + necessary cleanup before this `.SFTPServerInterface` object is destroyed. """ pass @@ -105,7 +105,7 @@ class SFTPServerInterface (object): :param attr: requested attributes of the file if it is newly created. :type attr: `.SFTPAttributes` :return: a new `.SFTPHandle` or error code. - :rtype `.SFTPHandle` + :rtype: `.SFTPHandle` """ return SFTP_OP_UNSUPPORTED @@ -120,7 +120,7 @@ class SFTPServerInterface (object): ``os.stat``. In addition, each object should have its ``filename`` field filled in, since this is important to a directory listing and not normally present in ``os.stat`` results. The method - `SFTPAttributes.from_stat` will usually do what you want. + `.SFTPAttributes.from_stat` will usually do what you want. In case of an error, you should return one of the ``SFTP_*`` error codes, such as `.SFTP_PERMISSION_DENIED`. @@ -131,11 +131,13 @@ class SFTPServerInterface (object): `.SFTPAttributes` objects. :rtype: list of `.SFTPAttributes` or error code - .. note:: You should normalize the given ``path`` first (see the - ``os.path`` module) and check appropriate permissions before returning - the list of files. Be careful of malicious clients attempting to use - relative paths to escape restricted folders, if you're doing a direct - translation from the SFTP server path to your local filesystem. + .. note:: + You should normalize the given ``path`` first (see the `os.path` + module) and check appropriate permissions before returning the list + of files. Be careful of malicious clients attempting to use + relative paths to escape restricted folders, if you're doing a + direct translation from the SFTP server path to your local + filesystem. """ return SFTP_OP_UNSUPPORTED diff --git a/sites/docs/api/sftp.rst b/sites/docs/api/sftp.rst index c016d73e..956eada2 100644 --- a/sites/docs/api/sftp.rst +++ b/sites/docs/api/sftp.rst @@ -6,5 +6,8 @@ SFTP .. automodule:: paramiko.sftp_server .. automodule:: paramiko.sftp_attr .. automodule:: paramiko.sftp_file + :inherited-members: + :no-special-members: + :show-inheritance: .. automodule:: paramiko.sftp_handle .. automodule:: paramiko.sftp_si -- cgit v1.2.3 From c23579526b4a3c05e6d20bf92074ea0c8c37751d Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 09:49:30 -0800 Subject: Tweak order of System doc page --- paramiko/server.py | 84 +++++++++++++++++++++++------------------------ sites/docs/api/server.rst | 1 + 2 files changed, 43 insertions(+), 42 deletions(-) diff --git a/paramiko/server.py b/paramiko/server.py index 9ff7243b..e7d37849 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -25,48 +25,6 @@ from paramiko.common import * from paramiko import util -class InteractiveQuery (object): - """ - A query (set of prompts) for a user during interactive authentication. - """ - - def __init__(self, name='', instructions='', *prompts): - """ - Create a new interactive query to send to the client. The name and - instructions are optional, but are generally displayed to the end - user. A list of prompts may be included, or they may be added via - the `add_prompt` method. - - :param name: name of this query - :type name: str - :param instructions: user instructions (usually short) about this query - :type instructions: str - :param prompts: one or more authentication prompts - :type prompts: str - """ - self.name = name - self.instructions = instructions - self.prompts = [] - for x in prompts: - if (type(x) is str) or (type(x) is unicode): - self.add_prompt(x) - else: - self.add_prompt(x[0], x[1]) - - def add_prompt(self, prompt, echo=True): - """ - Add a prompt to this query. The prompt should be a (reasonably short) - string. Multiple prompts can be added to the same query. - - :param prompt: the user prompt - :type prompt: str - :param echo: ``True`` (default) if the user's response should be echoed; - ``False`` if not (for a password or similar) - :type echo: bool - """ - self.prompts.append((prompt, echo)) - - class ServerInterface (object): """ This class defines an interface for controlling the behavior of paramiko @@ -551,6 +509,48 @@ class ServerInterface (object): return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED +class InteractiveQuery (object): + """ + A query (set of prompts) for a user during interactive authentication. + """ + + def __init__(self, name='', instructions='', *prompts): + """ + Create a new interactive query to send to the client. The name and + instructions are optional, but are generally displayed to the end + user. A list of prompts may be included, or they may be added via + the `add_prompt` method. + + :param name: name of this query + :type name: str + :param instructions: user instructions (usually short) about this query + :type instructions: str + :param prompts: one or more authentication prompts + :type prompts: str + """ + self.name = name + self.instructions = instructions + self.prompts = [] + for x in prompts: + if (type(x) is str) or (type(x) is unicode): + self.add_prompt(x) + else: + self.add_prompt(x[0], x[1]) + + def add_prompt(self, prompt, echo=True): + """ + Add a prompt to this query. The prompt should be a (reasonably short) + string. Multiple prompts can be added to the same query. + + :param prompt: the user prompt + :type prompt: str + :param echo: ``True`` (default) if the user's response should be echoed; + ``False`` if not (for a password or similar) + :type echo: bool + """ + self.prompts.append((prompt, echo)) + + class SubsystemHandler (threading.Thread): """ Handler for a subsytem in server mode. If you create a subclass of this diff --git a/sites/docs/api/server.rst b/sites/docs/api/server.rst index 7519ae99..ea854544 100644 --- a/sites/docs/api/server.rst +++ b/sites/docs/api/server.rst @@ -2,3 +2,4 @@ Server implementation ===================== .. automodule:: paramiko.server + :member-order: bysource -- cgit v1.2.3 From 74af60803ff7762fd5bfbc654d5b23e7c3b71492 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 09:50:03 -0800 Subject: s/paramiko/Paramiko/ --- paramiko/server.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/paramiko/server.py b/paramiko/server.py index e7d37849..98db5dfb 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -27,10 +27,10 @@ from paramiko import util class ServerInterface (object): """ - This class defines an interface for controlling the behavior of paramiko + This class defines an interface for controlling the behavior of Paramiko in server mode. - Methods on this class are called from paramiko's primary thread, so you + Methods on this class are called from Paramiko's primary thread, so you shouldn't do too much work in them. (Certainly nothing that blocks or sleeps.) """ @@ -161,7 +161,7 @@ class ServerInterface (object): options it has for continuing the authentication.) Note that you don't have to actually verify any key signtature here. - If you're willing to accept the key, paramiko will do the work of + If you're willing to accept the key, Paramiko will do the work of verifying the client's signature. The default implementation always returns `.AUTH_FAILED`. -- cgit v1.2.3 From 2dc2643b681f08fdbb7a48dfd19ddf8a8d52fc29 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 09:58:09 -0800 Subject: Server docstrings updated --- paramiko/server.py | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/paramiko/server.py b/paramiko/server.py index 98db5dfb..d956a379 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -56,7 +56,7 @@ class ServerInterface (object): The ``chanid`` parameter is a small number that uniquely identifies the channel within a `.Transport`. A `.Channel` object is not created unless this method returns ``OPEN_SUCCEEDED`` -- once a - `.Channel` object is created, you can call `Channel.get_id` to + `.Channel` object is created, you can call `.Channel.get_id` to retrieve the channel ID. The return value should either be ``OPEN_SUCCEEDED`` (or @@ -169,7 +169,7 @@ class ServerInterface (object): :param username: the username of the authenticating client :type username: str :param key: the key object provided by the client - :type key: `PKey ` + :type key: `.PKey` :return: `.AUTH_FAILED` if the client can't authenticate with this key; `.AUTH_SUCCESSFUL` if it can; `.AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with @@ -381,7 +381,7 @@ class ServerInterface (object): subsystem. An example of a subsystem is ``sftp``. The default implementation checks for a subsystem handler assigned via - `Transport.set_subsystem_handler`. + `.Transport.set_subsystem_handler`. If one has been set, the handler is invoked and this method returns ``True``. Otherwise it returns ``False``. @@ -432,7 +432,7 @@ class ServerInterface (object): """ Determine if the client will be provided with an X11 session. If this method returns ``True``, X11 applications should be routed through new - SSH channels, using `Transport.open_x11_channel`. + SSH channels, using `.Transport.open_x11_channel`. The default implementation always returns ``False``. @@ -477,7 +477,7 @@ class ServerInterface (object): The ``chanid`` parameter is a small number that uniquely identifies the channel within a `.Transport`. A `.Channel` object is not created unless this method returns ``OPEN_SUCCEEDED`` -- once a - `.Channel` object is created, you can call `Channel.get_id` to + `.Channel` object is created, you can call `.Channel.get_id` to retrieve the channel ID. The origin and destination parameters are (ip_address, port) tuples @@ -554,9 +554,7 @@ class InteractiveQuery (object): class SubsystemHandler (threading.Thread): """ Handler for a subsytem in server mode. If you create a subclass of this - class and pass it to - `Transport.set_subsystem_handler`, - an object of this + class and pass it to `.Transport.set_subsystem_handler`, an object of this class will be created for each request for this subsystem. Each new object will be executed within its own new thread by calling `start_subsystem`. When that method completes, the channel is closed. @@ -622,12 +620,13 @@ class SubsystemHandler (threading.Thread): The combination of ``transport`` and ``channel`` are unique; this handler corresponds to exactly one `.Channel` on one `.Transport`. - .. note:: It is the responsibility of this method to exit if the - underlying `.Transport` is closed. This can be done by checking - `Transport.is_active` or noticing an EOF - on the `.Channel`. If this method loops forever without checking - for this case, your Python interpreter may refuse to exit because - this thread will still be running. + .. note:: + It is the responsibility of this method to exit if the underlying + `.Transport` is closed. This can be done by checking + `.Transport.is_active` or noticing an EOF on the `.Channel`. If + this method loops forever without checking for this case, your + Python interpreter may refuse to exit because this thread will + still be running. :param name: name of the requested subsystem. :type name: str -- cgit v1.2.3 From 23bb7e593647d0021aa68513fb881c79d807ca0b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 09:59:40 -0800 Subject: Nuke useless module docstring --- paramiko/proxy.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/paramiko/proxy.py b/paramiko/proxy.py index 375c6556..a977b019 100644 --- a/paramiko/proxy.py +++ b/paramiko/proxy.py @@ -16,9 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -`.ProxyCommand`. -""" import os from shlex import split as shlsplit -- cgit v1.2.3 From 24cc59b64d4325a42f8992c7c916ace18bbcf960 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 10:01:03 -0800 Subject: Reorder config doc --- paramiko/config.py | 110 +++++++++++++++++++++++----------------------- sites/docs/api/config.rst | 1 + 2 files changed, 56 insertions(+), 55 deletions(-) diff --git a/paramiko/config.py b/paramiko/config.py index 6f3bbdfc..ea978017 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -18,7 +18,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -`.SSHConfig`. +Configuration file (aka ``ssh_config``) support. """ import fnmatch @@ -30,60 +30,6 @@ SSH_PORT = 22 proxy_re = re.compile(r"^(proxycommand)\s*=*\s*(.*)", re.I) -class LazyFqdn(object): - """ - Returns the host's fqdn on request as string. - """ - - def __init__(self, config, host=None): - self.fqdn = None - self.config = config - self.host = host - - def __str__(self): - if self.fqdn is None: - # - # If the SSH config contains AddressFamily, use that when - # determining the local host's FQDN. Using socket.getfqdn() from - # the standard library is the most general solution, but can - # result in noticeable delays on some platforms when IPv6 is - # misconfigured or not available, as it calls getaddrinfo with no - # address family specified, so both IPv4 and IPv6 are checked. - # - - # Handle specific option - fqdn = None - address_family = self.config.get('addressfamily', 'any').lower() - if address_family != 'any': - try: - family = socket.AF_INET if address_family == 'inet' \ - else socket.AF_INET6 - results = socket.getaddrinfo( - self.host, - None, - family, - socket.SOCK_DGRAM, - socket.IPPROTO_IP, - socket.AI_CANONNAME - ) - for res in results: - af, socktype, proto, canonname, sa = res - if canonname and '.' in canonname: - fqdn = canonname - break - # giaerror -> socket.getaddrinfo() can't resolve self.host - # (which is from socket.gethostname()). Fall back to the - # getfqdn() call below. - except socket.gaierror: - pass - # Handle 'any' / unspecified - if fqdn is None: - fqdn = socket.getfqdn() - # Cache - self.fqdn = fqdn - return self.fqdn - - class SSHConfig (object): """ Representation of config information as stored in the format used by @@ -264,3 +210,57 @@ class SSHConfig (object): else: config[k] = config[k].replace(find, str(replace)) return config + + +class LazyFqdn(object): + """ + Returns the host's fqdn on request as string. + """ + + def __init__(self, config, host=None): + self.fqdn = None + self.config = config + self.host = host + + def __str__(self): + if self.fqdn is None: + # + # If the SSH config contains AddressFamily, use that when + # determining the local host's FQDN. Using socket.getfqdn() from + # the standard library is the most general solution, but can + # result in noticeable delays on some platforms when IPv6 is + # misconfigured or not available, as it calls getaddrinfo with no + # address family specified, so both IPv4 and IPv6 are checked. + # + + # Handle specific option + fqdn = None + address_family = self.config.get('addressfamily', 'any').lower() + if address_family != 'any': + try: + family = socket.AF_INET if address_family == 'inet' \ + else socket.AF_INET6 + results = socket.getaddrinfo( + self.host, + None, + family, + socket.SOCK_DGRAM, + socket.IPPROTO_IP, + socket.AI_CANONNAME + ) + for res in results: + af, socktype, proto, canonname, sa = res + if canonname and '.' in canonname: + fqdn = canonname + break + # giaerror -> socket.getaddrinfo() can't resolve self.host + # (which is from socket.gethostname()). Fall back to the + # getfqdn() call below. + except socket.gaierror: + pass + # Handle 'any' / unspecified + if fqdn is None: + fqdn = socket.getfqdn() + # Cache + self.fqdn = fqdn + return self.fqdn diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst index 6f9d3ce3..afb004c9 100644 --- a/sites/docs/api/config.rst +++ b/sites/docs/api/config.rst @@ -2,3 +2,4 @@ Configuration ============= .. automodule:: paramiko.config + :member-order: bysource -- cgit v1.2.3 From f76485f766339f02e81b45b12d0779555fdd0486 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 10:05:25 -0800 Subject: PKey docstring cleanup --- paramiko/pkey.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/paramiko/pkey.py b/paramiko/pkey.py index 21995bf9..b412f768 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -52,14 +52,14 @@ class PKey (object): ``data`` is given, the key's public part(s) will be filled in from the string. - :param msg: an optional SSH `.Message` containing a public key of this - type. + :param msg: + an optional SSH `.Message` containing a public key of this type. :type msg: `.Message` - :param data: an optional string containing a public key of this type - :type data: str + :param str data: an optional string containing a public key of this type - :raises SSHException: if a key cannot be created from the ``data`` or - ``msg`` given, or no key was passed in. + :raises SSHException: + if a key cannot be created from the ``data`` or ``msg`` given, or + no key was passed in. """ pass @@ -96,8 +96,9 @@ class PKey (object): """ Return the name of this private key implementation. - :return: name of this private key type, in SSH terminology (for - example, ``"ssh-rsa"``). + :return: + name of this private key type, in SSH terminology (for example, + ``"ssh-rsa"``). :rtype: str """ return '' -- cgit v1.2.3 From 15568537131aceccf12b845c830d8f42e4c264f8 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 10:06:24 -0800 Subject: Module docstring tweaks for keys --- paramiko/dsskey.py | 2 +- paramiko/rsakey.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/paramiko/dsskey.py b/paramiko/dsskey.py index 0f6f07fd..c6488c57 100644 --- a/paramiko/dsskey.py +++ b/paramiko/dsskey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -`.DSSKey` +DSS keys. """ from Crypto.PublicKey import DSA diff --git a/paramiko/rsakey.py b/paramiko/rsakey.py index 0f879da2..c8b4daa9 100644 --- a/paramiko/rsakey.py +++ b/paramiko/rsakey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -`.RSAKey` +RSA keys. """ from Crypto.PublicKey import RSA -- cgit v1.2.3 From 4bcac18d17b62d3553f4fd91c9e904c1d5808cfe Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 10:08:46 -0800 Subject: Host key docs (order + tweaks) --- paramiko/hostkeys.py | 163 +++++++++++++++++++++----------------------- sites/docs/api/hostkeys.rst | 1 + 2 files changed, 80 insertions(+), 84 deletions(-) diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index 1eed350a..ceb9051f 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -16,9 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -`.HostKeys` -""" import base64 import binascii @@ -31,95 +28,21 @@ from paramiko.rsakey import RSAKey from paramiko.util import get_logger, constant_time_bytes_eq -class InvalidHostKey(Exception): - - def __init__(self, line, exc): - self.line = line - self.exc = exc - self.args = (line, exc) - - -class HostKeyEntry: - """ - Representation of a line in an OpenSSH-style "known hosts" file. - """ - - def __init__(self, hostnames=None, key=None): - self.valid = (hostnames is not None) and (key is not None) - self.hostnames = hostnames - self.key = key - - def from_line(cls, line, lineno=None): - """ - Parses the given line of text to find the names for the host, - the type of key, and the key data. The line is expected to be in the - format used by the openssh known_hosts file. - - Lines are expected to not have leading or trailing whitespace. - We don't bother to check for comments or empty lines. All of - that should be taken care of before sending the line to us. - - :param line: a line from an OpenSSH known_hosts file - :type line: str - """ - log = get_logger('paramiko.hostkeys') - fields = line.split(' ') - if len(fields) < 3: - # Bad number of fields - log.info("Not enough fields found in known_hosts in line %s (%r)" % - (lineno, line)) - return None - fields = fields[:3] - - names, keytype, key = fields - names = names.split(',') - - # Decide what kind of key we're looking at and create an object - # to hold it accordingly. - try: - if keytype == 'ssh-rsa': - key = RSAKey(data=base64.decodestring(key)) - elif keytype == 'ssh-dss': - key = DSSKey(data=base64.decodestring(key)) - else: - log.info("Unable to handle key of type %s" % (keytype,)) - return None - except binascii.Error, e: - raise InvalidHostKey(line, e) - - return cls(names, key) - from_line = classmethod(from_line) - - def to_line(self): - """ - Returns a string in OpenSSH known_hosts file format, or None if - the object is not in a valid state. A trailing newline is - included. - """ - if self.valid: - return '%s %s %s\n' % (','.join(self.hostnames), self.key.get_name(), - self.key.get_base64()) - return None - - def __repr__(self): - return '' % (self.hostnames, self.key) - - class HostKeys (UserDict.DictMixin): """ - Representation of an openssh-style "known hosts" file. Host keys can be + Representation of an OpenSSH-style "known hosts" file. Host keys can be read from one or more files, and then individual hosts can be looked up to verify server keys during SSH negotiation. - A HostKeys object can be treated like a dict; any dict lookup is equivalent - to calling `lookup`. + A `.HostKeys` object can be treated like a dict; any dict lookup is + equivalent to calling `lookup`. .. versionadded:: 1.5.3 """ def __init__(self, filename=None): """ - Create a new HostKeys object, optionally loading keys from an openssh + Create a new HostKeys object, optionally loading keys from an OpenSSH style host-key file. :param filename: filename to load host keys from, or ``None`` @@ -150,7 +73,7 @@ class HostKeys (UserDict.DictMixin): def load(self, filename): """ - Read a file of known SSH host keys, in the format used by openssh. + Read a file of known SSH host keys, in the format used by OpenSSH. This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in ``os.path.expanduser("~/.ssh/known_hosts")``. @@ -181,7 +104,7 @@ class HostKeys (UserDict.DictMixin): def save(self, filename): """ - Save host keys into a file, in the format used by openssh. The order of + Save host keys into a file, in the format used by OpenSSH. The order of keys in the file will be preserved when possible (if these keys were loaded from a file originally). The single exception is that combined lines will be split into individual key lines, which is arguably a bug. @@ -314,7 +237,7 @@ class HostKeys (UserDict.DictMixin): def hash_host(hostname, salt=None): """ - Return a "hashed" form of the hostname, as used by openssh when storing + Return a "hashed" form of the hostname, as used by OpenSSH when storing hashed hostnames in the known_hosts file. :param hostname: the hostname to hash @@ -336,3 +259,75 @@ class HostKeys (UserDict.DictMixin): return hostkey.replace('\n', '') hash_host = staticmethod(hash_host) + +class InvalidHostKey(Exception): + def __init__(self, line, exc): + self.line = line + self.exc = exc + self.args = (line, exc) + + +class HostKeyEntry: + """ + Representation of a line in an OpenSSH-style "known hosts" file. + """ + + def __init__(self, hostnames=None, key=None): + self.valid = (hostnames is not None) and (key is not None) + self.hostnames = hostnames + self.key = key + + def from_line(cls, line, lineno=None): + """ + Parses the given line of text to find the names for the host, + the type of key, and the key data. The line is expected to be in the + format used by the OpenSSH known_hosts file. + + Lines are expected to not have leading or trailing whitespace. + We don't bother to check for comments or empty lines. All of + that should be taken care of before sending the line to us. + + :param line: a line from an OpenSSH known_hosts file + :type line: str + """ + log = get_logger('paramiko.hostkeys') + fields = line.split(' ') + if len(fields) < 3: + # Bad number of fields + log.info("Not enough fields found in known_hosts in line %s (%r)" % + (lineno, line)) + return None + fields = fields[:3] + + names, keytype, key = fields + names = names.split(',') + + # Decide what kind of key we're looking at and create an object + # to hold it accordingly. + try: + if keytype == 'ssh-rsa': + key = RSAKey(data=base64.decodestring(key)) + elif keytype == 'ssh-dss': + key = DSSKey(data=base64.decodestring(key)) + else: + log.info("Unable to handle key of type %s" % (keytype,)) + return None + except binascii.Error, e: + raise InvalidHostKey(line, e) + + return cls(names, key) + from_line = classmethod(from_line) + + def to_line(self): + """ + Returns a string in OpenSSH known_hosts file format, or None if + the object is not in a valid state. A trailing newline is + included. + """ + if self.valid: + return '%s %s %s\n' % (','.join(self.hostnames), self.key.get_name(), + self.key.get_base64()) + return None + + def __repr__(self): + return '' % (self.hostnames, self.key) diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst index 0859fbed..770652fd 100644 --- a/sites/docs/api/hostkeys.rst +++ b/sites/docs/api/hostkeys.rst @@ -2,3 +2,4 @@ Host keys / ``known_hosts`` files ================================= .. automodule:: paramiko.hostkeys + :member-order: bysource -- cgit v1.2.3 From b47b578e592e204a31f566826005f432d4b9d3fa Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 16:51:55 -0800 Subject: Whitespace --- paramiko/agent.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index 54617655..f5b116ca 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -40,6 +40,7 @@ from paramiko.util import retry_on_signal SSH2_AGENTC_REQUEST_IDENTITIES, SSH2_AGENT_IDENTITIES_ANSWER, \ SSH2_AGENTC_SIGN_REQUEST, SSH2_AGENT_SIGN_RESPONSE = range(11, 15) + class AgentSSH(object): """ Client interface for using private keys from an SSH agent running on the @@ -100,6 +101,7 @@ class AgentSSH(object): result += extra return result + class AgentProxyThread(threading.Thread): """ Class in charge of communication between two chan """ def __init__(self, agent): @@ -146,6 +148,7 @@ class AgentProxyThread(threading.Thread): self.__inr.close() self._agent._conn.close() + class AgentLocalProxy(AgentProxyThread): """ Class to be used when wanting to ask a local SSH Agent being @@ -168,6 +171,7 @@ class AgentLocalProxy(AgentProxyThread): raise return None + class AgentRemoteProxy(AgentProxyThread): """ Class to be used when wanting to ask a remote SSH Agent @@ -183,6 +187,7 @@ class AgentRemoteProxy(AgentProxyThread): """ return (self.__chan, None) + class AgentClientProxy(object): """ Class proxying request as a client: @@ -236,6 +241,7 @@ class AgentClientProxy(object): if self._conn is not None: self._conn.close() + class AgentServerProxy(AgentSSH): """ :param t : transport used for the Forward for SSH Agent communication @@ -286,6 +292,7 @@ class AgentServerProxy(AgentSSH): def _get_filename(self): return self._file + class AgentRequestHandler(object): def __init__(self, chanClient): self._conn = None @@ -303,6 +310,7 @@ class AgentRequestHandler(object): for p in self.__clientProxys: p.close() + class Agent(AgentSSH): """ Client interface for using private keys from an SSH agent running on the @@ -314,7 +322,6 @@ class Agent(AgentSSH): sockets, this probably doesn't work on Windows. It does work on most posix platforms though (Linux and MacOS X, for example). """ - def __init__(self): """ Open a session with the local machine's SSH agent, if one is running. @@ -350,13 +357,13 @@ class Agent(AgentSSH): """ self._close() + class AgentKey(PKey): """ Private key held in a local SSH agent. This type of key can be used for authenticating to a remote server (signing). Most other key operations work as expected. """ - def __init__(self, agent, blob): self.agent = agent self.blob = blob -- cgit v1.2.3 From 9ae46dcbfaab42b450db410eecd8e7e94183f1b8 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:00:53 -0800 Subject: Fix up AgentSSH vs Agent classes/docstrings, sigh --- paramiko/agent.py | 29 +++++++---------------------- sites/docs/api/agent.rst | 2 ++ 2 files changed, 9 insertions(+), 22 deletions(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index f5b116ca..302d31ec 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -SSH Agent interface for Unix clients. +SSH Agent interface """ import os @@ -42,16 +42,6 @@ SSH2_AGENTC_REQUEST_IDENTITIES, SSH2_AGENT_IDENTITIES_ANSWER, \ class AgentSSH(object): - """ - Client interface for using private keys from an SSH agent running on the - local machine. If an SSH agent is running, this class can be used to - connect to it and retreive `.PKey` objects which can be used when - attempting to authenticate to remote SSH servers. - - Because the SSH agent protocol uses environment variables and unix-domain - sockets, this probably doesn't work on Windows. It does work on most - posix platforms though (Linux and MacOS X, for example). - """ def __init__(self): self._conn = None self._keys = () @@ -318,19 +308,14 @@ class Agent(AgentSSH): connect to it and retreive `.PKey` objects which can be used when attempting to authenticate to remote SSH servers. - Because the SSH agent protocol uses environment variables and unix-domain - sockets, this probably doesn't work on Windows. It does work on most - posix platforms though (Linux and MacOS X, for example). + Upon initialization, a session with the local machine's SSH agent is + opened, if one is running. If no agent is running, initialization will + succeed, but `get_keys` will return an empty tuple. + + :raises SSHException: + if an SSH agent is found, but speaks an incompatible protocol """ def __init__(self): - """ - Open a session with the local machine's SSH agent, if one is running. - If no agent is running, initialization will succeed, but `get_keys` - will return an empty tuple. - - :raises SSHException: if an SSH agent is found, but speaks an - incompatible protocol - """ AgentSSH.__init__(self) if ('SSH_AUTH_SOCK' in os.environ) and (sys.platform != 'win32'): diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst index 789f7b1d..3b614a82 100644 --- a/sites/docs/api/agent.rst +++ b/sites/docs/api/agent.rst @@ -2,3 +2,5 @@ SSH Agents ========== .. automodule:: paramiko.agent + :inherited-members: + :no-special-members: -- cgit v1.2.3 From 4fb748ccf8743099198daa00265bb38ea096044f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:01:18 -0800 Subject: Remove apparently bogus docstring --- paramiko/agent.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index 302d31ec..13d90dbe 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -171,10 +171,6 @@ class AgentRemoteProxy(AgentProxyThread): self.__chan = chan def get_connection(self): - """ - Class to be used when wanting to ask a local SSH Agent being - asked from a remote fake agent (so use a unix socket for ex.) - """ return (self.__chan, None) -- cgit v1.2.3 From c8382442f51eda4ac47de5d3842d4923d0642e5d Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:06:08 -0800 Subject: Docstring cleanups --- paramiko/agent.py | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index 13d90dbe..8571f31a 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -93,7 +93,9 @@ class AgentSSH(object): class AgentProxyThread(threading.Thread): - """ Class in charge of communication between two chan """ + """ + Class in charge of communication between two channels. + """ def __init__(self, agent): threading.Thread.__init__(self, target=self.run) self._agent = agent @@ -148,8 +150,10 @@ class AgentLocalProxy(AgentProxyThread): AgentProxyThread.__init__(self, agent) def get_connection(self): - """ Return a pair of socket object and string address - May Block ! + """ + Return a pair of socket object and string address. + + May block! """ conn = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) try: @@ -177,13 +181,14 @@ class AgentRemoteProxy(AgentProxyThread): class AgentClientProxy(object): """ Class proxying request as a client: - -> client ask for a request_forward_agent() - -> server creates a proxy and a fake SSH Agent - -> server ask for establishing a connection when needed, + + #. client ask for a request_forward_agent() + #. server creates a proxy and a fake SSH Agent + #. server ask for establishing a connection when needed, calling the forward_agent_handler at client side. - -> the forward_agent_handler launch a thread for connecting + #. the forward_agent_handler launch a thread for connecting the remote fake agent and the local agent - -> Communication occurs ... + #. Communication occurs ... """ def __init__(self, chanRemote): self._conn = None -- cgit v1.2.3 From 6dcf67a9ad2868233f163509274e91d772ac7164 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:06:25 -0800 Subject: This is really not a link as the target can't have a useful docstring, meh --- paramiko/agent.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index 8571f31a..d224cd74 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -201,7 +201,7 @@ class AgentClientProxy(object): def connect(self): """ - Method automatically called by the run() method of the AgentProxyThread + Method automatically called by ``AgentProxyThread.run``. """ if ('SSH_AUTH_SOCK' in os.environ) and (sys.platform != 'win32'): conn = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) -- cgit v1.2.3 From 999bb4eaafc754764b55f02bf20f782df2eaa80d Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:08:09 -0800 Subject: Done with SSH Agent docstring junk --- paramiko/agent.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index d224cd74..cdb4313d 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -235,7 +235,7 @@ class AgentClientProxy(object): class AgentServerProxy(AgentSSH): """ - :param t : transport used for the Forward for SSH Agent communication + :param t: transport used for SSH Agent communication forwarding :raises SSHException: mostly if we lost the agent """ -- cgit v1.2.3 From ad1fbcce0b115a67cdf461f34bcc34fda1823508 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:17:50 -0800 Subject: Fix Channel link --- paramiko/transport.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index 0df6d1f5..74f8f516 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -70,7 +70,7 @@ class Transport (threading.Thread): """ An SSH Transport attaches to a stream (usually a socket), negotiates an encrypted session, authenticates, and then creates stream tunnels, called - `channels `, across the session. Multiple channels can be multiplexed + `channels <.Channel>`, across the session. Multiple channels can be multiplexed across a single session (and often are, in the case of port forwardings). """ -- cgit v1.2.3 From e207a4f704472bb0ab5230bdeeac585e99d37dbe Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:17:52 -0800 Subject: Whitespace --- paramiko/transport.py | 1 - 1 file changed, 1 deletion(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index 74f8f516..d1159eb9 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -73,7 +73,6 @@ class Transport (threading.Thread): `channels <.Channel>`, across the session. Multiple channels can be multiplexed across a single session (and often are, in the case of port forwardings). """ - _PROTO_ID = '2.0' _CLIENT_ID = 'paramiko_%s' % (paramiko.__version__) -- cgit v1.2.3 From e2ac82c47c0e70426f3be4329f20bd3b500078bb Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:18:00 -0800 Subject: Formatting --- paramiko/transport.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index d1159eb9..612dfc28 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -70,8 +70,9 @@ class Transport (threading.Thread): """ An SSH Transport attaches to a stream (usually a socket), negotiates an encrypted session, authenticates, and then creates stream tunnels, called - `channels <.Channel>`, across the session. Multiple channels can be multiplexed - across a single session (and often are, in the case of port forwardings). + `channels <.Channel>`, across the session. Multiple channels can be + multiplexed across a single session (and often are, in the case of port + forwardings). """ _PROTO_ID = '2.0' _CLIENT_ID = 'paramiko_%s' % (paramiko.__version__) -- cgit v1.2.3 From a00316af157a8b798b47b8ab1336d5b1a878d3ed Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:19:38 -0800 Subject: Format init --- paramiko/transport.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index 612dfc28..dc493746 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -127,30 +127,30 @@ class Transport (threading.Thread): def __init__(self, sock): """ Create a new SSH session over an existing socket, or socket-like - object. This only creates the Transport object; it doesn't begin the + object. This only creates the `.Transport` object; it doesn't begin the SSH session yet. Use `connect` or `start_client` to begin a client session, or `start_server` to begin a server session. If the object is not actually a socket, it must have the following methods: - - ``send(str)``: Writes from 1 to ``len(str)`` bytes, and - returns an int representing the number of bytes written. Returns - 0 or raises ``EOFError`` if the stream has been closed. - - ``recv(int)``: Reads from 1 to ``int`` bytes and returns them as a - string. Returns 0 or raises ``EOFError`` if the stream has been - closed. - - ``close()``: Closes the socket. - - ``settimeout(n)``: Sets a (float) timeout on I/O operations. + + - ``send(str)``: Writes from 1 to ``len(str)`` bytes, and returns an + int representing the number of bytes written. Returns + 0 or raises ``EOFError`` if the stream has been closed. + - ``recv(int)``: Reads from 1 to ``int`` bytes and returns them as a + string. Returns 0 or raises ``EOFError`` if the stream has been + closed. + - ``close()``: Closes the socket. + - ``settimeout(n)``: Sets a (float) timeout on I/O operations. For ease of use, you may also pass in an address (as a tuple) or a host string as the ``sock`` argument. (A host string is a hostname with an optional port (separated by ``":"``) which will be converted into a tuple of ``(hostname, port)``.) A socket will be connected to this - address and used for communication. Exceptions from the ``socket`` call - may be thrown in this case. + address and used for communication. Exceptions from the ``socket`` + call may be thrown in this case. - :param sock: a socket or socket-like object to create the session over. - :type sock: socket + :param socket sock: a socket or socket-like object to create the session over. """ if isinstance(sock, (str, unicode)): # convert "host:port" into (host, port) -- cgit v1.2.3 From 0bf0f08ee46aa210bd820e40a67648a34ba85cd6 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:21:12 -0800 Subject: Reformat + fix links --- paramiko/transport.py | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index dc493746..060012f3 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -360,27 +360,29 @@ class Transport (threading.Thread): Otherwise an SSHException is raised. After a successful negotiation, the client will need to authenticate. - Override the methods - `get_allowed_auths `, - `check_auth_none `, - `check_auth_password `, and - `check_auth_publickey ` in the - given ``server`` object to control the authentication process. - - After a successful authentication, the client should request to open - a channel. Override - `check_channel_request ` in the - given ``server`` object to allow channels to be opened. - - .. note:: After calling this method (or `start_client` or `connect`), - you should no longer directly read from or write to the original - socket object. + Override the methods `get_allowed_auths + <.ServerInterface.get_allowed_auths>`, `check_auth_none + <.ServerInterface.check_auth_none>`, `check_auth_password + <.ServerInterface.check_auth_password>`, and `check_auth_publickey + <.ServerInterface.check_auth_publickey>` in the given ``server`` object + to control the authentication process. + + After a successful authentication, the client should request to open a + channel. Override `check_channel_request + <.ServerInterface.check_channel_request>` in the given ``server`` + object to allow channels to be opened. + + .. note:: + After calling this method (or `start_client` or `connect`), you + should no longer directly read from or write to the original socket + object. :param event: an event to trigger when negotiation is complete. :type event: threading.Event - :param server: an object used to perform authentication and create - `channels ` - :type server: `server.ServerInterface` + :param server: + an object used to perform authentication and create `channels + <.Channel>` + :type server: `.ServerInterface` :raises SSHException: if negotiation fails (and no ``event`` was passed in) -- cgit v1.2.3 From 6d71fbd9ef155df29be96aec69379a27d91927ed Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 24 Feb 2014 17:43:22 -0800 Subject: More formatting + link fixes --- paramiko/transport.py | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index 060012f3..dfcf51a7 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -420,9 +420,8 @@ class Transport (threading.Thread): key info, not just the public half. Only one key of each type (RSA or DSS) is kept. - :param key: the host key to add, usually an `RSAKey ` or - `DSSKey `. - :type key: `PKey ` + :param key: the host key to add, usually an `.RSAKey` or `.DSSKey`. + :type key: `.PKey` """ self.server_key_dict[key.get_name()] = key @@ -438,7 +437,7 @@ class Transport (threading.Thread): yet, ``None`` is returned. In client mode, the behavior is undefined. :return: host key of the type negotiated by the client, or ``None``. - :rtype: `PKey ` + :rtype: `.PKey` """ try: return self.server_key_dict[self.host_key_type] @@ -458,16 +457,16 @@ class Transport (threading.Thread): fits certain criteria. These primes are pretty difficult to compute, so they can't be generated on demand. But many systems contain a file of suitable primes (usually named something like ``/etc/ssh/moduli``). - If you call ``load_server_moduli`` and it returns ``True``, then this + If you call `load_server_moduli` and it returns ``True``, then this file of primes has been loaded and we will support "group-exchange" in server mode. Otherwise server mode will just claim that it doesn't support that method of key negotiation. - :param filename: optional path to the moduli file, if you happen to - know that it's not in a standard location. - :type filename: str - :return: True if a moduli file was successfully loaded; False - otherwise. + :param str filename: + optional path to the moduli file, if you happen to know that it's + not in a standard location. + :return: + True if a moduli file was successfully loaded; False otherwise. :rtype: bool .. note:: This has no effect when used in client mode. -- cgit v1.2.3 From b8fbbb3d32408031d3040f9c29d75c401a88b0d6 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Tue, 25 Feb 2014 16:35:28 -0800 Subject: Rest of basic formatting and link fixing for Transport --- paramiko/transport.py | 58 ++++++++++++++++++++++++++------------------------- 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index dfcf51a7..5f326809 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -503,15 +503,15 @@ class Transport (threading.Thread): """ Return the host key of the server (in client mode). - .. note:: Previously this call returned a tuple of (key type, key string). - You can get the same effect by calling - `PKey.get_name ` for the key type, and - ``str(key)`` for the key string. + .. note:: + Previously this call returned a tuple of ``(key type, key + string)``. You can get the same effect by calling `.PKey.get_name` + for the key type, and ``str(key)`` for the key string. :raises SSHException: if no session is currently active. :return: public key of the remote server - :rtype: `PKey ` + :rtype: `.PKey` """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -529,11 +529,11 @@ class Transport (threading.Thread): def open_session(self): """ - Request a new channel to the server, of type ``"session"``. This - is just an alias for ``open_channel('session')``. + Request a new channel to the server, of type ``"session"``. This is + just an alias for calling `open_channel` with an argument of + ``"session"``. :return: a new `.Channel` - :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -562,11 +562,12 @@ class Transport (threading.Thread): ``"auth-agent@openssh.com"``. This is just an alias for ``open_channel('auth-agent@openssh.com')``. + :return: a new `.Channel` :rtype: `.Channel` - :raises SSHException: if the request is rejected or the session ends - prematurely + :raises SSHException: + if the request is rejected or the session ends prematurely """ return self.open_channel('auth-agent@openssh.com') @@ -585,10 +586,10 @@ class Transport (threading.Thread): def open_channel(self, kind, dest_addr=None, src_addr=None): """ - Request a new channel to the server. `.Channels ` are socket-like - objects used for the actual transfer of data across the session. - You may only request a channel after negotiating encryption (using - `connect` or `start_client`) and authenticating. + Request a new channel to the server. `Channels <.Channel>` are + socket-like objects used for the actual transfer of data across the + session. You may only request a channel after negotiating encryption + (using `connect` or `start_client`) and authenticating. :param kind: the kind of channel requested (usually ``"session"``, ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"``) @@ -714,9 +715,9 @@ class Transport (threading.Thread): def open_sftp_client(self): """ - Create an SFTP client channel from an open transport. On success, - an SFTP session will be opened with the remote host, and a new - SFTPClient object will be returned. + Create an SFTP client channel from an open transport. On success, an + SFTP session will be opened with the remote host, and a new + `.SFTPClient` object will be returned. :return: a new `.SFTPClient` object, referring to an sftp session (channel) across this transport @@ -828,7 +829,7 @@ class Transport (threading.Thread): :param timeout: seconds to wait for a channel, or ``None`` to wait forever :type timeout: int - :return: a new Channel opened by the client + :return: a new `.Channel` opened by the client :rtype: `.Channel` """ self.lock.acquire() @@ -861,13 +862,14 @@ class Transport (threading.Thread): `open_session` to get a `.Channel` object, which is used for data transfer. - .. note:: If you fail to supply a password or private key, this method may - succeed, but a subsequent `open_channel` or `open_session` call may - fail because you haven't authenticated yet. + .. note:: + If you fail to supply a password or private key, this method may + succeed, but a subsequent `open_channel` or `open_session` call may + fail because you haven't authenticated yet. :param hostkey: the host key expected from the server, or ``None`` if you don't want to do host key verification. - :type hostkey: `PKey` + :type hostkey: `.PKey` :param username: the username to authenticate as. :type username: str :param password: a password to use for authentication, if you want to @@ -875,7 +877,7 @@ class Transport (threading.Thread): :type password: str :param pkey: a private key to use for authentication, if you want to use private key authentication; otherwise ``None``. - :type pkey: `PKey` + :type pkey: `.PKey` :raises SSHException: if the SSH2 negotiation fails, the host key supplied by the server is incorrect, or authentication fails. @@ -1028,7 +1030,7 @@ class Transport (threading.Thread): :param username: the username to authenticate as :type username: str :param password: the password to authenticate with - :type password: str or unicode + :type password: basestring :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) :type event: threading.Event @@ -1102,7 +1104,7 @@ class Transport (threading.Thread): :param username: the username to authenticate as :type username: string :param key: the private key to authenticate with - :type key: `PKey ` + :type key: `.PKey` :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) :type event: threading.Event @@ -1187,9 +1189,9 @@ class Transport (threading.Thread): def set_log_channel(self, name): """ Set the channel for this transport's logging. The default is - ``"paramiko.transport"`` but it can be set to anything you want. - (See the ``logging`` module for more info.) SSH Channels will log - to a sub-channel of the one specified. + ``"paramiko.transport"`` but it can be set to anything you want. (See + the `.logging` module for more info.) SSH Channels will log to a + sub-channel of the one specified. :param name: new channel name for logging :type name: str -- cgit v1.2.3 From e293dff6533c5b39ef5b98e849d3fdb4a2c70e15 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Tue, 25 Feb 2014 16:39:15 -0800 Subject: 'Message' did not really need capitalizing within its own docstrings --- paramiko/message.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/paramiko/message.py b/paramiko/message.py index 55a8eb42..9081155d 100644 --- a/paramiko/message.py +++ b/paramiko/message.py @@ -28,7 +28,7 @@ from paramiko import util class Message (object): """ - An SSH2 Message is a stream of bytes that encodes some combination of + An SSH2 message is a stream of bytes that encodes some combination of strings, integers, bools, and infinite-precision integers (known in Python as longs). This class builds or breaks down such a byte stream. @@ -39,10 +39,10 @@ class Message (object): def __init__(self, content=None): """ - Create a new SSH2 Message. + Create a new SSH2 message. - :param content: the byte stream to use as the Message content (passed - in only when decomposing a Message). + :param content: the byte stream to use as the message content (passed + in only when decomposing a message). :type content: string """ if content != None: @@ -52,9 +52,9 @@ class Message (object): def __str__(self): """ - Return the byte stream content of this Message, as a string. + Return the byte stream content of this message, as a string. - :return: the contents of this Message. + :return: the contents of this message. :rtype: string """ return self.packet.getvalue() @@ -76,7 +76,7 @@ class Message (object): def get_remainder(self): """ - Return the bytes of this Message that haven't already been parsed and + Return the bytes of this message that haven't already been parsed and returned. :return: a string of the bytes not parsed yet. @@ -89,8 +89,8 @@ class Message (object): def get_so_far(self): """ - Returns the bytes of this Message that have been parsed and returned. - The string passed into a Message's constructor can be regenerated by + Returns the bytes of this message that have been parsed and returned. + The string passed into a message's constructor can be regenerated by concatenating ``get_so_far`` and `get_remainder`. :return: a string of the bytes parsed so far. @@ -102,10 +102,10 @@ class Message (object): def get_bytes(self, n): """ - Return the next ``n`` bytes of the Message, without decomposing into + Return the next ``n`` bytes of the message, without decomposing into an int, string, etc. Just the raw bytes are returned. - :return: a string of the next ``n`` bytes of the Message, or a string + :return: a string of the next ``n`` bytes of the message, or a string of ``n`` zero bytes, if there aren't ``n`` bytes remaining. :rtype: string """ @@ -117,10 +117,10 @@ class Message (object): def get_byte(self): """ - Return the next byte of the Message, without decomposing it. This + Return the next byte of the message, without decomposing it. This is equivalent to `get_bytes(1) `. - :return: the next byte of the Message, or ``'\000'`` if there aren't + :return: the next byte of the message, or ``'\000'`` if there aren't any bytes remaining. :rtype: string """ @@ -130,7 +130,7 @@ class Message (object): """ Fetch a boolean from the stream. - :return: ``True`` or ``False`` (from the Message). + :return: ``True`` or ``False`` (from the message). :rtype: bool """ b = self.get_bytes(1) @@ -167,7 +167,7 @@ class Message (object): """ Fetch a string from the stream. This could be a byte string and may contain unprintable characters. (It's not unheard of for a string to - contain another byte-stream Message.) + contain another byte-stream message.) :return: a string. :rtype: string -- cgit v1.2.3 From 33452b2e6c7f7c48d7bfa6fcf770b1d27d6af2d6 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Tue, 25 Feb 2014 16:57:54 -0800 Subject: Random reformat/fixing-up of Channel --- paramiko/channel.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/paramiko/channel.py b/paramiko/channel.py index 630a60c8..85d988b6 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -347,7 +347,7 @@ class Channel (object): If a handler is passed in, the handler is called from another thread whenever a new x11 connection arrives. The default handler queues up incoming x11 connections, which may be retrieved using - `Transport.accept`. The handler's calling signature is:: + `.Transport.accept`. The handler's calling signature is:: handler(channel: Channel, (address: str, port: int)) @@ -392,7 +392,7 @@ class Channel (object): def request_forward_agent(self, handler): """ Request for a forward SSH Agent on this channel. - This is only valid for an ssh-agent from openssh !!! + This is only valid for an ssh-agent from OpenSSH !!! :param handler: a required handler to use for incoming SSH Agent connections :type handler: function @@ -447,7 +447,7 @@ class Channel (object): """ Return the ID # for this channel. The channel ID is unique across a `.Transport` and usually a small number. It's also the number - passed to `ServerInterface.check_channel_request` when determining + passed to `.ServerInterface.check_channel_request` when determining whether to accept a channel request in server mode. :return: the ID of this channel. @@ -1230,10 +1230,12 @@ class ChannelFile (BufferedFile): A file-like wrapper around `.Channel`. A ChannelFile is created by calling `Channel.makefile`. - @bug: To correctly emulate the file object created from a socket's - ``makefile`` method, a `.Channel` and its ``ChannelFile`` should be able - to be closed or garbage-collected independently. Currently, closing - the ``ChannelFile`` does nothing but flush the buffer. + .. warning:: + To correctly emulate the file object created from a socket's `makefile + ` method, a `.Channel` and its + `.ChannelFile` should be able to be closed or garbage-collected + independently. Currently, closing the `ChannelFile` does nothing but + flush the buffer. """ def __init__(self, channel, mode = 'r', bufsize = -1): -- cgit v1.2.3 From 7df1ae9602e0b5425ccfd9a1351e059fbbdfce89 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 11:06:20 -0800 Subject: Start cleaning up info field lists --- paramiko/agent.py | 11 ++++++----- paramiko/buffered_pipe.py | 23 ++++++++++------------- paramiko/channel.py | 4 ++-- 3 files changed, 18 insertions(+), 20 deletions(-) diff --git a/paramiko/agent.py b/paramiko/agent.py index cdb4313d..d9f4b1bc 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -52,8 +52,9 @@ class AgentSSH(object): no SSH agent was running (or it couldn't be contacted), an empty list will be returned. - :return: a list of keys available on the SSH agent - :rtype: tuple of `.AgentKey` + :return: + a tuple of `.AgentKey` objects representing keys available on the + SSH agent """ return self._keys @@ -235,7 +236,7 @@ class AgentClientProxy(object): class AgentServerProxy(AgentSSH): """ - :param t: transport used for SSH Agent communication forwarding + :param .Transport t: Transport used for SSH Agent communication forwarding :raises SSHException: mostly if we lost the agent """ @@ -273,8 +274,8 @@ class AgentServerProxy(AgentSSH): """ Helper for the environnement under unix - :return: the SSH_AUTH_SOCK Environnement variables - :rtype: dict + :return: + a dict containing the ``SSH_AUTH_SOCK`` environnement variables """ env = {} env['SSH_AUTH_SOCK'] = self._get_filename() diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index 43bfa47d..a4be5d8d 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -54,8 +54,7 @@ class BufferedPipe (object): buffer has been closed), the event will be set. When no data is ready, the event will be cleared. - :param event: the event to set/clear - :type event: Event + :param threading.Event event: the event to set/clear """ self._event = event if len(self._buffer) > 0: @@ -68,8 +67,7 @@ class BufferedPipe (object): Feed new data into this pipe. This method is assumed to be called from a separate thread, so synchronization is done. - :param data: the data to add - :type data: str + :param data: the data to add, as a `str` """ self._lock.acquire() try: @@ -86,9 +84,9 @@ class BufferedPipe (object): feeder. A ``False`` result does not mean that the feeder has closed; it means you may need to wait before more data arrives. - :return: ``True`` if a `read` call would immediately return at least - one byte; ``False`` otherwise. - :rtype: bool + :return: + ``True`` if a `read` call would immediately return at least one + byte; ``False`` otherwise. """ self._lock.acquire() try: @@ -113,8 +111,7 @@ class BufferedPipe (object): :param int nbytes: maximum number of bytes to read :param float timeout: maximum seconds to wait (or ``None``, the default, to wait forever) - :return: data - :rtype: str + :return: the read data, as a `str` :raises PipeTimeout: if a timeout was specified and no data was ready before that @@ -157,8 +154,9 @@ class BufferedPipe (object): """ Clear out the buffer and return all data that was in it. - :return: any data that was in the buffer prior to clearing it out - :rtype: str + :return: + any data that was in the buffer prior to clearing it out, as a + `str` """ self._lock.acquire() try: @@ -188,8 +186,7 @@ class BufferedPipe (object): """ Return the number of bytes buffered. - :return: number of bytes buffered - :rtype: int + :return: number (`int`) of bytes buffered """ self._lock.acquire() try: diff --git a/paramiko/channel.py b/paramiko/channel.py index 85d988b6..3d48e2ad 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -142,8 +142,8 @@ class Channel (object): :param height_pixels: height (in pixels) of the terminal screen :type height_pixels: int - :raises SSHException: if the request was rejected or the channel was - closed + :raises SSHException: + if the request was rejected or the channel was closed """ if self.closed or self.eof_received or self.eof_sent or not self.active: raise SSHException('Channel is not open') -- cgit v1.2.3 From f556c8f0ae11bdfb7277421114cb24228619a01a Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 11:35:06 -0800 Subject: Channel info fields --- paramiko/channel.py | 242 +++++++++++++++++++++------------------------------- 1 file changed, 98 insertions(+), 144 deletions(-) diff --git a/paramiko/channel.py b/paramiko/channel.py index 3d48e2ad..b04c4d98 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -62,9 +62,8 @@ class Channel (object): Normally you would only call this method from the constructor of a subclass of `.Channel`. - :param chanid: the ID of this channel, as passed by an existing - `.Transport`. - :type chanid: int + :param int chanid: + the ID of this channel, as passed by an existing `.Transport`. """ self.chanid = chanid self.remote_chanid = 0 @@ -104,8 +103,6 @@ class Channel (object): def __repr__(self): """ Return a string representation of this object, for debugging. - - :rtype: str """ out = '' -- cgit v1.2.3 From 01f365a3e1cf5fdaf4c9b3d7bfef1cad6bc56b47 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 11:39:33 -0800 Subject: Client info fields --- paramiko/client.py | 112 ++++++++++++++++++++++------------------------------- 1 file changed, 47 insertions(+), 65 deletions(-) diff --git a/paramiko/client.py b/paramiko/client.py index 8646131b..b5929e6e 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -82,11 +82,10 @@ class SSHClient (object): and no exception will be raised if the file can't be read. This is probably only useful on posix. - :param filename: the filename to read, or ``None`` - :type filename: str + :param str filename: the filename to read, or ``None`` - :raises IOError: if a filename was provided and the file could not be - read + :raises IOError: + if a filename was provided and the file could not be read """ if filename is None: # try the user's .ssh key file, and mask exceptions @@ -110,8 +109,7 @@ class SSHClient (object): will be merged with the existing set (new replacing old if there are conflicts). When automatically saving, the last hostname is used. - :param filename: the filename to read - :type filename: str + :param str filename: the filename to read :raises IOError: if the filename could not be read """ @@ -124,8 +122,7 @@ class SSHClient (object): `load_host_keys` (plus any added directly) will be saved -- not any host keys loaded with `load_system_host_keys`. - :param filename: the filename to save to - :type filename: str + :param str filename: the filename to save to :raises IOError: if the file could not be written """ @@ -146,8 +143,7 @@ class SSHClient (object): Get the local `.HostKeys` object. This can be used to examine the local host keys or change them. - :return: the local host keys - :rtype: `.HostKeys` + :return: the local host keys as a `.HostKeys` object. """ return self._host_keys @@ -156,8 +152,7 @@ class SSHClient (object): Set the channel for logging. The default is ``"paramiko.transport"`` but it can be set to anything you want. - :param name: new channel name for logging - :type name: str + :param str name: new channel name for logging """ self._log_channel = name @@ -168,9 +163,9 @@ class SSHClient (object): default policy is to reject all unknown servers (using `.RejectPolicy`). You may substitute `.AutoAddPolicy` or write your own policy class. - :param policy: the policy to use when receiving a host key from a + :param .MissingHostKeyPolicy policy: + the policy to use when receiving a host key from a previously-unknown server - :type policy: `.MissingHostKeyPolicy` """ self._policy = policy @@ -195,33 +190,26 @@ class SSHClient (object): If a private key requires a password to unlock it, and a password is passed in, that password will be used to attempt to unlock the key. - :param hostname: the server to connect to - :type hostname: str - :param port: the server port to connect to - :type port: int - :param username: the username to authenticate as (defaults to the - current local username) - :type username: str - :param password: a password to use for authentication or for unlocking - a private key - :type password: str - :param pkey: an optional private key to use for authentication - :type pkey: `.PKey` - :param key_filename: the filename, or list of filenames, of optional - private key(s) to try for authentication - :type key_filename: str or list(str) - :param timeout: an optional timeout (in seconds) for the TCP connect - :type timeout: float - :param allow_agent: set to False to disable connecting to the SSH agent - :type allow_agent: bool - :param look_for_keys: set to False to disable searching for discoverable - private key files in ``~/.ssh/`` - :type look_for_keys: bool - :param compress: set to True to turn on compression - :type compress: bool - :param sock: an open socket or socket-like object (such as a - `.Channel`) to use for communication to the target host - :type sock: socket + :param str hostname: the server to connect to + :param int port: the server port to connect to + :param str username: + the username to authenticate as (defaults to the current local + username) + :param str password: + a password to use for authentication or for unlocking a private key + :param .PKey pkey: an optional private key to use for authentication + :param str key_filename: + the filename, or list of filenames, of optional private key(s) to + try for authentication + :param float timeout: an optional timeout (in seconds) for the TCP connect + :param bool allow_agent: set to False to disable connecting to the SSH agent + :param bool look_for_keys: + set to False to disable searching for discoverable private key + files in ``~/.ssh/`` + :param bool compress: set to True to turn on compression + :param socket sock: + an open socket or socket-like object (such as a `.Channel`) to use + for communication to the target host :raises BadHostKeyException: if the server's host key could not be verified @@ -304,14 +292,15 @@ class SSHClient (object): streams are returned as Python ``file``-like objects representing stdin, stdout, and stderr. - :param command: the command to execute - :type command: str - :param bufsize: interpreted the same way as by the built-in ``file()`` function in Python - :type bufsize: int - :param timeout: set command's channel timeout. See `Channel.settimeout`.settimeout - :type timeout: int - :return: the stdin, stdout, and stderr of the executing command - :rtype: tuple(`.ChannelFile`, `.ChannelFile`, `.ChannelFile`) + :param str command: the command to execute + :param int bufsize: + interpreted the same way as by the built-in ``file()`` function in + Python + :param int timeout: + set command's channel timeout. See `Channel.settimeout`.settimeout + :return: + the stdin, stdout, and stderr of the executing command, as a + 3-tuple :raises SSHException: if the server fails to execute the command """ @@ -332,18 +321,13 @@ class SSHClient (object): is opened and connected to a pseudo-terminal using the requested terminal type and size. - :param term: the terminal type to emulate (for example, ``"vt100"``) - :type term: str - :param width: the width (in characters) of the terminal window - :type width: int - :param height: the height (in characters) of the terminal window - :type height: int - :param width_pixels: the width (in pixels) of the terminal window - :type width_pixels: int - :param height_pixels: the height (in pixels) of the terminal window - :type height_pixels: int - :return: a new channel connected to the remote shell - :rtype: `.Channel` + :param str term: + the terminal type to emulate (for example, ``"vt100"``) + :param int width: the width (in characters) of the terminal window + :param int height: the height (in characters) of the terminal window + :param int width_pixels: the width (in pixels) of the terminal window + :param int height_pixels: the height (in pixels) of the terminal window + :return: a new `.Channel` connected to the remote shell :raises SSHException: if the server fails to invoke a shell """ @@ -356,8 +340,7 @@ class SSHClient (object): """ Open an SFTP session on the SSH server. - :return: a new SFTP session object - :rtype: `.SFTPClient` + :return: a new `.SFTPClient` session object """ return self._transport.open_sftp_client() @@ -367,8 +350,7 @@ class SSHClient (object): This can be used to perform lower-level tasks, like opening specific kinds of channels. - :return: the Transport for this connection - :rtype: `.Transport` + :return: the `.Transport` for this connection """ return self._transport -- cgit v1.2.3 From 79a69e88c39f8fa3d51790cf501a19644cce869b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 12:44:58 -0800 Subject: More info field updates --- paramiko/config.py | 13 ++++--------- paramiko/dsskey.py | 12 +++++------- paramiko/file.py | 49 +++++++++++++++++-------------------------------- 3 files changed, 26 insertions(+), 48 deletions(-) diff --git a/paramiko/config.py b/paramiko/config.py index ea978017..bc2816da 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -51,8 +51,7 @@ class SSHConfig (object): """ Read an OpenSSH config from the given file object. - :param file_obj: a file-like object to read the config file from - :type file_obj: file + :param file file_obj: a file-like object to read the config file from """ host = {"host": ['*'], "config": {}} for line in file_obj: @@ -110,10 +109,8 @@ class SSHConfig (object): ``"port"``, not ``"Port"``. The values are processed according to the rules for substitution variable expansion in ``ssh_config``. - :param hostname: the hostname to lookup - :type hostname: str + :param str hostname: the hostname to lookup """ - matches = [config for config in self._config if self._allowed(hostname, config['host'])] @@ -148,10 +145,8 @@ class SSHConfig (object): Please refer to man ``ssh_config`` for the parameters that are replaced. - :param config: the config for the hostname - :type hostname: dict - :param hostname: the hostname that the config belongs to - :type hostname: str + :param dict config: the config for the hostname + :param str hostname: the hostname that the config belongs to """ if 'hostname' in config: diff --git a/paramiko/dsskey.py b/paramiko/dsskey.py index c6488c57..bac3dfed 100644 --- a/paramiko/dsskey.py +++ b/paramiko/dsskey.py @@ -153,13 +153,11 @@ class DSSKey (PKey): Generate a new private DSS key. This factory function can be used to generate a new host key or authentication key. - :param bits: number of bits the generated key should be. - :type bits: int - :param progress_func: an optional function to call at key points in - key generation (used by ``pyCrypto.PublicKey``). - :type progress_func: function - :return: new private key - :rtype: `.DSSKey` + :param int bits: number of bits the generated key should be. + :param function progress_func: + an optional function to call at key points in key generation (used + by ``pyCrypto.PublicKey``). + :return: new `.DSSKey` private key """ dsa = DSA.generate(bits, rng.read, progress_func) key = DSSKey(vals=(dsa.p, dsa.q, dsa.g, dsa.y)) diff --git a/paramiko/file.py b/paramiko/file.py index 2f8499e0..253ffcd0 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -64,8 +64,6 @@ class BufferedFile (object): its own iterator. :raises ValueError: if the file is closed. - - :rtype: iterator """ if self._closed: raise ValueError('I/O operation on closed file') @@ -95,8 +93,7 @@ class BufferedFile (object): :raises StopIteration: when the end of the file is reached. - :return: a line read from the file. - :rtype: str + :return: a line (`str`) read from the file. """ line = self.readline() if not line: @@ -109,11 +106,10 @@ class BufferedFile (object): file first). If the ``size`` argument is negative or omitted, read all the remaining data in the file. - :param size: maximum number of bytes to read - :type size: int - :return: data read from the file, or an empty string if EOF was + :param int size: maximum number of bytes to read + :return: + data read from the file (as a `str`), or an empty string if EOF was encountered immediately - :rtype: str """ if self._closed: raise IOError('File is closed') @@ -170,12 +166,10 @@ class BufferedFile (object): Unlike stdio's ``fgets``, the returned string contains null characters (``'\\0'``) if they occurred in the input. - :param size: maximum length of returned string. - :type size: int + :param int size: maximum length of returned string. :return: - next line of the file, or an empty string if the end of the file - has been reached. - :rtype: str + next line of the file (`str`), or an empty string if the end of the + file has been reached. """ # it's almost silly how complex this function is. if self._closed: @@ -245,10 +239,8 @@ class BufferedFile (object): to EOF, whole lines totalling approximately sizehint bytes (possibly after rounding up to an internal buffer size) are read. - :param sizehint: desired maximum number of bytes to read. - :type sizehint: int - :return: list of lines read from the file. - :rtype: list + :param int sizehint: desired maximum number of bytes to read. + :return: `list` of lines read from the file. """ lines = [] bytes = 0 @@ -271,12 +263,11 @@ class BufferedFile (object): operations will be undone at the next write (as the file position will move back to the end of the file). - :param offset: position to move to within the file, relative to - ``whence``. - :type offset: int - :param whence: type of movement: 0 = absolute; 1 = relative to the - current position; 2 = relative to the end of the file. - :type whence: int + :param int offset: + position to move to within the file, relative to ``whence``. + :param int whence: + type of movement: 0 = absolute; 1 = relative to the current + position; 2 = relative to the end of the file. :raises IOError: if the file doesn't support random access. """ @@ -288,8 +279,7 @@ class BufferedFile (object): useful if the underlying file doesn't support random access, or was opened in append mode. - :return: file position (in bytes). - :rtype: int + :return: file position (`number ` of bytes). """ return self._pos @@ -300,8 +290,7 @@ class BufferedFile (object): written yet. (Use `flush` or `close` to force buffered data to be written out.) - :param data: data to write. - :type data: str + :param str data: data to write """ if self._closed: raise IOError('File is closed') @@ -334,8 +323,7 @@ class BufferedFile (object): name is intended to match `readlines`; `writelines` does not add line separators.) - :param sequence: an iterable sequence of strings. - :type sequence: sequence + :param iterable sequence: an iterable sequence of strings. """ for line in sequence: self.write(line) @@ -345,9 +333,6 @@ class BufferedFile (object): """ Identical to ``iter(f)``. This is a deprecated file interface that predates Python iterator support. - - :return: an iterator. - :rtype: iterator """ return self -- cgit v1.2.3 From 8ddaac24ae746846a31153b8b93c275b30de8f0d Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 12:55:58 -0800 Subject: Even moar info fields --- paramiko/hostkeys.py | 47 +++++++++---------------- paramiko/message.py | 96 ++++++++++++++++++---------------------------------- 2 files changed, 48 insertions(+), 95 deletions(-) diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index ceb9051f..b35c415f 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -45,8 +45,7 @@ class HostKeys (UserDict.DictMixin): Create a new HostKeys object, optionally loading keys from an OpenSSH style host-key file. - :param filename: filename to load host keys from, or ``None`` - :type filename: str + :param str filename: filename to load host keys from, or ``None`` """ # emulate a dict of { hostname: { keytype: PKey } } self._entries = [] @@ -58,12 +57,9 @@ class HostKeys (UserDict.DictMixin): Add a host key entry to the table. Any existing entry for a ``(hostname, keytype)`` pair will be replaced. - :param hostname: the hostname (or IP) to add - :type hostname: str - :param keytype: key type (``"ssh-rsa"`` or ``"ssh-dss"``) - :type keytype: str - :param key: the key to add - :type key: `.PKey` + :param str hostname: the hostname (or IP) to add + :param str keytype: key type (``"ssh-rsa"`` or ``"ssh-dss"``) + :param .PKey key: the key to add """ for e in self._entries: if (hostname in e.hostnames) and (e.key.get_name() == keytype): @@ -82,8 +78,7 @@ class HostKeys (UserDict.DictMixin): not cleared. So multiple calls to `load` will just call `add`, replacing any existing entries and adding new ones. - :param filename: name of the file to read host keys from - :type filename: str + :param str filename: name of the file to read host keys from :raises IOError: if there was an error reading the file """ @@ -109,8 +104,7 @@ class HostKeys (UserDict.DictMixin): loaded from a file originally). The single exception is that combined lines will be split into individual key lines, which is arguably a bug. - :param filename: name of the file to write - :type filename: str + :param str filename: name of the file to write :raises IOError: if there was an error writing the file @@ -129,10 +123,8 @@ class HostKeys (UserDict.DictMixin): ``None`` is returned. Otherwise a dictionary of keytype to key is returned. The keytype will be either ``"ssh-rsa"`` or ``"ssh-dss"``. - :param hostname: the hostname (or IP) to lookup - :type hostname: str - :return: keys associated with this host (or ``None``) - :rtype: dict(str, `.PKey`) + :param str hostname: the hostname (or IP) to lookup + :return: dict of `str` -> `.PKey` keys associated with this host (or ``None``) """ class SubDict (UserDict.DictMixin): def __init__(self, hostname, entries, hostkeys): @@ -177,13 +169,10 @@ class HostKeys (UserDict.DictMixin): Return True if the given key is associated with the given hostname in this dictionary. - :param hostname: hostname (or IP) of the SSH server - :type hostname: str - :param key: the key to check - :type key: `.PKey` - :return: ``True`` if the key is associated with the hostname; ``False`` - if not - :rtype: bool + :param str hostname: hostname (or IP) of the SSH server + :param .PKey key: the key to check + :return: + ``True`` if the key is associated with the hostname; else ``False`` """ k = self.lookup(hostname) if k is None: @@ -240,12 +229,9 @@ class HostKeys (UserDict.DictMixin): Return a "hashed" form of the hostname, as used by OpenSSH when storing hashed hostnames in the known_hosts file. - :param hostname: the hostname to hash - :type hostname: str - :param salt: optional salt to use when hashing (must be 20 bytes long) - :type salt: str - :return: the hashed hostname - :rtype: str + :param str hostname: the hostname to hash + :param str salt: optional salt to use when hashing (must be 20 bytes long) + :return: the hashed hostname as a `str` """ if salt is None: salt = rng.read(SHA.digest_size) @@ -287,8 +273,7 @@ class HostKeyEntry: We don't bother to check for comments or empty lines. All of that should be taken care of before sending the line to us. - :param line: a line from an OpenSSH known_hosts file - :type line: str + :param str line: a line from an OpenSSH known_hosts file """ log = get_logger('paramiko.hostkeys') fields = line.split(' ') diff --git a/paramiko/message.py b/paramiko/message.py index 9081155d..213b2e79 100644 --- a/paramiko/message.py +++ b/paramiko/message.py @@ -41,9 +41,9 @@ class Message (object): """ Create a new SSH2 message. - :param content: the byte stream to use as the message content (passed - in only when decomposing a message). - :type content: string + :param str content: + the byte stream to use as the message content (passed in only when + decomposing a message). """ if content != None: self.packet = cStringIO.StringIO(content) @@ -53,17 +53,12 @@ class Message (object): def __str__(self): """ Return the byte stream content of this message, as a string. - - :return: the contents of this message. - :rtype: string """ return self.packet.getvalue() def __repr__(self): """ Returns a string representation of this object, for debugging. - - :rtype: string """ return 'paramiko.Message(' + repr(self.packet.getvalue()) + ')' @@ -76,11 +71,8 @@ class Message (object): def get_remainder(self): """ - Return the bytes of this message that haven't already been parsed and - returned. - - :return: a string of the bytes not parsed yet. - :rtype: string + Return the bytes (as a `str`) of this message that haven't already been + parsed and returned. """ position = self.packet.tell() remainder = self.packet.read() @@ -89,12 +81,9 @@ class Message (object): def get_so_far(self): """ - Returns the bytes of this message that have been parsed and returned. - The string passed into a message's constructor can be regenerated by - concatenating ``get_so_far`` and `get_remainder`. - - :return: a string of the bytes parsed so far. - :rtype: string + Returns the `str` bytes of this message that have been parsed and + returned. The string passed into a message's constructor can be + regenerated by concatenating ``get_so_far`` and `get_remainder`. """ position = self.packet.tell() self.rewind() @@ -102,12 +91,10 @@ class Message (object): def get_bytes(self, n): """ - Return the next ``n`` bytes of the message, without decomposing into - an int, string, etc. Just the raw bytes are returned. - - :return: a string of the next ``n`` bytes of the message, or a string - of ``n`` zero bytes, if there aren't ``n`` bytes remaining. - :rtype: string + Return the next ``n`` bytes of the message (as a `str`), without + decomposing into an int, decoded string, etc. Just the raw bytes are + returned. Returns a string of ``n`` zero bytes if there weren't ``n`` + bytes remaining in the message. """ b = self.packet.read(n) max_pad_size = 1<<20 # Limit padding to 1 MB @@ -120,18 +107,15 @@ class Message (object): Return the next byte of the message, without decomposing it. This is equivalent to `get_bytes(1) `. - :return: the next byte of the message, or ``'\000'`` if there aren't + :return: + the next (`str`) byte of the message, or ``'\000'`` if there aren't any bytes remaining. - :rtype: string """ return self.get_bytes(1) def get_boolean(self): """ Fetch a boolean from the stream. - - :return: ``True`` or ``False`` (from the message). - :rtype: bool """ b = self.get_bytes(1) return b != '\x00' @@ -140,8 +124,7 @@ class Message (object): """ Fetch an int from the stream. - :return: a 32-bit unsigned integer. - :rtype: int + :return: a 32-bit unsigned `int`. """ return struct.unpack('>I', self.get_bytes(4))[0] @@ -149,8 +132,7 @@ class Message (object): """ Fetch a 64-bit int from the stream. - :return: a 64-bit unsigned integer. - :rtype: long + :return: a 64-bit unsigned integer (`long`). """ return struct.unpack('>Q', self.get_bytes(8))[0] @@ -158,29 +140,23 @@ class Message (object): """ Fetch a long int (mpint) from the stream. - :return: an arbitrary-length integer. - :rtype: long + :return: an arbitrary-length integer (`long`). """ return util.inflate_long(self.get_string()) def get_string(self): """ - Fetch a string from the stream. This could be a byte string and may + Fetch a `str` from the stream. This could be a byte string and may contain unprintable characters. (It's not unheard of for a string to contain another byte-stream message.) - - :return: a string. - :rtype: string """ return self.get_bytes(self.get_int()) def get_list(self): """ - Fetch a list of strings from the stream. These are trivially encoded - as comma-separated values in a string. - - :return: a list of strings. - :rtype: list of strings + Fetch a `list` of `strings ` from the stream. + + These are trivially encoded as comma-separated values in a string. """ return self.get_string().split(',') @@ -188,8 +164,7 @@ class Message (object): """ Write bytes to the stream, without any formatting. - :param b: bytes to add - :type b: str + :param str b: bytes to add """ self.packet.write(b) return self @@ -198,8 +173,7 @@ class Message (object): """ Write a single byte to the stream, without any formatting. - :param b: byte to add - :type b: str + :param str b: byte to add """ self.packet.write(b) return self @@ -208,8 +182,7 @@ class Message (object): """ Add a boolean value to the stream. - :param b: boolean value to add - :type b: bool + :param bool b: boolean value to add """ if b: self.add_byte('\x01') @@ -221,8 +194,7 @@ class Message (object): """ Add an integer to the stream. - :param n: integer to add - :type n: int + :param int n: integer to add """ self.packet.write(struct.pack('>I', n)) return self @@ -231,8 +203,7 @@ class Message (object): """ Add a 64-bit int to the stream. - :param n: long int to add - :type n: long + :param long n: long int to add """ self.packet.write(struct.pack('>Q', n)) return self @@ -242,8 +213,7 @@ class Message (object): Add a long int to the stream, encoded as an infinite-precision integer. This method only works on positive numbers. - :param z: long int to add - :type z: long + :param long z: long int to add """ self.add_string(util.deflate_long(z)) return self @@ -252,8 +222,7 @@ class Message (object): """ Add a string to the stream. - :param s: string to add - :type s: str + :param str s: string to add """ self.add_int(len(s)) self.packet.write(s) @@ -265,8 +234,7 @@ class Message (object): a single string of values separated by commas. (Yes, really, that's how SSH2 does it.) - :param l: list of strings to add - :type l: list(str) + :param list l: list of strings to add """ self.add_string(','.join(l)) return self @@ -292,11 +260,11 @@ class Message (object): """ Add a sequence of items to the stream. The values are encoded based on their type: str, int, bool, list, or long. + + .. warning:: + Longs are encoded non-deterministically. Don't use this method. :param seq: the sequence of items - :type seq: sequence - - @bug: longs are encoded non-deterministically. Don't use this method. """ for item in seq: self._add(item) -- cgit v1.2.3 From 3f34ea48dbb5d0666f61a3e7db2504615e677757 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 14:29:07 -0800 Subject: Bunch more info fields --- paramiko/packet.py | 13 +++--- paramiko/pkey.py | 109 +++++++++++++++++---------------------------------- paramiko/proxy.py | 14 +++---- paramiko/resource.py | 7 ++-- paramiko/rsakey.py | 12 +++--- 5 files changed, 55 insertions(+), 100 deletions(-) diff --git a/paramiko/packet.py b/paramiko/packet.py index 0f8152fa..397193cd 100644 --- a/paramiko/packet.py +++ b/paramiko/packet.py @@ -171,8 +171,6 @@ class Packetizer (object): Returns ``True`` if a new set of keys needs to be negotiated. This will be triggered during a packet read or write, so it should be checked after every read or write, or at least after every few. - - :return: ``True`` if a new set of keys needs to be negotiated """ return self.__need_rekey @@ -190,12 +188,11 @@ class Packetizer (object): """ Read as close to N bytes as possible, blocking as long as necessary. - :param n: number of bytes to read - :type n: int - :return: the data read - :rtype: str - :raises EOFError: if the socket was closed before all the bytes could - be read + :param int n: number of bytes to read + :return: the data read, as a `str` + + :raises EOFError: + if the socket was closed before all the bytes could be read """ out = '' # handle over-reading from reading the banner line diff --git a/paramiko/pkey.py b/paramiko/pkey.py index b412f768..ea4d2140 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -52,9 +52,8 @@ class PKey (object): ``data`` is given, the key's public part(s) will be filled in from the string. - :param msg: + :param .Message msg: an optional SSH `.Message` containing a public key of this type. - :type msg: `.Message` :param str data: an optional string containing a public key of this type :raises SSHException: @@ -68,9 +67,6 @@ class PKey (object): Return a string of an SSH `.Message` made up of the public part(s) of this key. This string is suitable for passing to `__init__` to re-create the key object later. - - :return: string representation of an SSH key message. - :rtype: str """ return '' @@ -81,10 +77,7 @@ class PKey (object): of the key are compared, so a public key will compare equal to its corresponding private key. - :param other: key to compare to. - :type other: `.PKey` - :return: 0 if the two keys are equivalent, non-0 otherwise. - :rtype: int + :param .Pkey other: key to compare to. """ hs = hash(self) ho = hash(other) @@ -97,9 +90,8 @@ class PKey (object): Return the name of this private key implementation. :return: - name of this private key type, in SSH terminology (for example, - ``"ssh-rsa"``). - :rtype: str + name of this private key type, in SSH terminology, as a `str` (for + example, ``"ssh-rsa"``). """ return '' @@ -108,8 +100,7 @@ class PKey (object): Return the number of significant bits in this key. This is useful for judging the relative security of a key. - :return: bits in the key. - :rtype: int + :return: bits in the key (as an `int`) """ return 0 @@ -117,9 +108,6 @@ class PKey (object): """ Return ``True`` if this key has the private part necessary for signing data. - - :return: ``True`` if this is a private key. - :rtype: bool """ return False @@ -128,9 +116,9 @@ class PKey (object): Return an MD5 fingerprint of the public part of this key. Nothing secret is revealed. - :return: a 16-byte string (binary) of the MD5 fingerprint, in SSH + :return: + a 16-byte `string ` (binary) of the MD5 fingerprint, in SSH format. - :rtype: str """ return MD5.new(str(self)).digest() @@ -140,8 +128,7 @@ class PKey (object): secret is revealed. This format is compatible with that used to store public key files or recognized host keys. - :return: a base64 string containing the public part of the key. - :rtype: str + :return: a base64 `string ` containing the public part of the key. """ return base64.encodestring(str(self)).replace('\n', '') @@ -150,12 +137,9 @@ class PKey (object): Sign a blob of data with this private key, and return a `.Message` representing an SSH signature message. - :param rng: a secure random number generator. - :type rng: `Crypto.Util.rng.RandomPool` - :param data: the data to sign. - :type data: str - :return: an SSH signature message. - :rtype: `.Message` + :param .Crypto.Util.rng.RandomPool rng: a secure random number generator. + :param str data: the data to sign. + :return: an SSH signature `message <.Message>`. """ return '' @@ -164,13 +148,10 @@ class PKey (object): Given a blob of data, and an SSH message representing a signature of that data, verify that it was signed with this key. - :param data: the data that was signed. - :type data: str - :param msg: an SSH signature message - :type msg: `.Message` - :return: ``True`` if the signature verifies correctly; ``False`` - otherwise. - :rtype: boolean + :param str data: the data that was signed. + :param .Message msg: an SSH signature message + :return: + ``True`` if the signature verifies correctly; ``False`` otherwise. """ return False @@ -183,13 +164,10 @@ class PKey (object): exist in all subclasses of PKey (such as `.RSAKey` or `.DSSKey`), but is useless on the abstract PKey class. - :param filename: name of the file to read - :type filename: str - :param password: an optional password to use to decrypt the key file, + :param str filename: name of the file to read + :param str password: an optional password to use to decrypt the key file, if it's encrypted - :type password: str - :return: a new key object based on the given private key - :rtype: `.PKey` + :return: a new `.PKey` based on the given private key :raises IOError: if there was an error reading the file :raises PasswordRequiredException: if the private key file is @@ -207,13 +185,10 @@ class PKey (object): the given password will be used to decrypt the key (otherwise `.PasswordRequiredException` is thrown). - :param file_obj: the file to read from - :type file_obj: file - :param password: an optional password to use to decrypt the key, if it's - encrypted - :type password: str - :return: a new key object based on the given private key - :rtype: `.PKey` + :param file file_obj: the file to read from + :param str password: + an optional password to use to decrypt the key, if it's encrypted + :return: a new `.PKey` based on the given private key :raises IOError: if there was an error reading the key :raises PasswordRequiredException: if the private key file is encrypted, @@ -229,10 +204,9 @@ class PKey (object): Write private key contents into a file. If the password is not ``None``, the key is encrypted before writing. - :param filename: name of the file to write - :type filename: str - :param password: an optional password to use to encrypt the key file - :type password: str + :param str filename: name of the file to write + :param str password: + an optional password to use to encrypt the key file :raises IOError: if there was an error writing the file :raises SSHException: if the key is invalid @@ -244,10 +218,8 @@ class PKey (object): Write private key contents into a file (or file-like) object. If the password is not ``None``, the key is encrypted before writing. - :param file_obj: the file object to write into - :type file_obj: file - :param password: an optional password to use to encrypt the key - :type password: str + :param file file_obj: the file object to write into + :param str password: an optional password to use to encrypt the key :raises IOError: if there was an error writing to the file :raises SSHException: if the key is invalid @@ -262,15 +234,12 @@ class PKey (object): ``password`` is not ``None``, the given password will be used to decrypt the key (otherwise `.PasswordRequiredException` is thrown). - :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. - :type tag: str - :param filename: name of the file to read. - :type filename: str - :param password: an optional password to use to decrypt the key file, - if it's encrypted. - :type password: str - :return: data blob that makes up the private key. - :rtype: str + :param str tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. + :param str filename: name of the file to read. + :param str password: + an optional password to use to decrypt the key file, if it's + encrypted. + :return: data blob (`str`) that makes up the private key. :raises IOError: if there was an error reading the file. :raises PasswordRequiredException: if the private key file is @@ -336,14 +305,10 @@ class PKey (object): a trivially-encoded format (base64) which is completely insecure. If a password is given, DES-EDE3-CBC is used. - :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. - :type tag: str - :param filename: name of the file to write. - :type filename: str - :param data: data blob that makes up the private key. - :type data: str - :param password: an optional password to use to encrypt the file. - :type password: str + :param str tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. + :param file filename: name of the file to write. + :param str data: data blob that makes up the private key. + :param str password: an optional password to use to encrypt the file. :raises IOError: if there was an error writing the file. """ diff --git a/paramiko/proxy.py b/paramiko/proxy.py index a977b019..30d596ba 100644 --- a/paramiko/proxy.py +++ b/paramiko/proxy.py @@ -39,9 +39,8 @@ class ProxyCommand(object): Create a new CommandProxy instance. The instance created by this class can be passed as an argument to the `.Transport` class. - :param command_line: the command that should be executed and - used as the proxy. - :type command_line: str + :param str command_line: + the command that should be executed and used as the proxy. """ self.cmd = shlsplit(command_line) self.process = Popen(self.cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE) @@ -51,8 +50,7 @@ class ProxyCommand(object): Write the content received from the SSH client to the standard input of the forked command. - :param content: string to be sent to the forked command - :type content: str + :param str content: string to be sent to the forked command """ try: self.process.stdin.write(content) @@ -68,11 +66,9 @@ class ProxyCommand(object): """ Read from the standard output of the forked program. - :param size: how many chars should be read - :type size: int + :param int size: how many chars should be read - :return: the length of the read content - :rtype: int + :return: the length of the read content, as an `int` """ try: return os.read(self.process.stdout.fileno(), size) diff --git a/paramiko/resource.py b/paramiko/resource.py index 8e8d9eee..9809afbe 100644 --- a/paramiko/resource.py +++ b/paramiko/resource.py @@ -51,10 +51,9 @@ class ResourceManager (object): the ``resource`` will be closed by having its ``close()`` method called. Any exceptions are ignored. - :param obj: the object to track - :type obj: object - :param resource: the resource to close when the object is collected - :type resource: object + :param object obj: the object to track + :param object resource: + the resource to close when the object is collected """ def callback(ref): try: diff --git a/paramiko/rsakey.py b/paramiko/rsakey.py index c8b4daa9..8c2aae91 100644 --- a/paramiko/rsakey.py +++ b/paramiko/rsakey.py @@ -129,13 +129,11 @@ class RSAKey (PKey): Generate a new private RSA key. This factory function can be used to generate a new host key or authentication key. - :param bits: number of bits the generated key should be. - :type bits: int - :param progress_func: an optional function to call at key points in - key generation (used by ``pyCrypto.PublicKey``). - :type progress_func: function - :return: new private key - :rtype: `.RSAKey` + :param int bits: number of bits the generated key should be. + :param function progress_func: + an optional function to call at key points in key generation (used + by ``pyCrypto.PublicKey``). + :return: new `.RSAKey` private key """ rsa = RSA.generate(bits, rng.read, progress_func) key = RSAKey(vals=(rsa.e, rsa.n)) -- cgit v1.2.3 From dd9934f2b53db4a8311a53b2040254f72cf71ea3 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 14:29:36 -0800 Subject: Server info fields. Some :rtype:s were left around as they were truly useful, given difficulty of linking to constant integer values. --- paramiko/server.py | 269 ++++++++++++++++++++++------------------------------- 1 file changed, 109 insertions(+), 160 deletions(-) diff --git a/paramiko/server.py b/paramiko/server.py index d956a379..11562e12 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -70,13 +70,11 @@ class ServerInterface (object): The default implementation always returns ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED``. - :param kind: the kind of channel the client would like to open - (usually ``"session"``). - :type kind: str - :param chanid: ID of the channel - :type chanid: int - :return: a success or failure code (listed above) - :rtype: int + :param str kind: + the kind of channel the client would like to open (usually + ``"session"``). + :param int chanid: ID of the channel + :return: an `int` success or failure code (listed above) """ return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED @@ -92,10 +90,8 @@ class ServerInterface (object): The default implementation always returns ``"password"``. - :param username: the username requesting authentication. - :type username: str - :return: a comma-separated list of authentication types - :rtype: str + :param str username: the username requesting authentication. + :return: a comma-separated `str` of authentication types """ return 'password' @@ -110,10 +106,10 @@ class ServerInterface (object): The default implementation always returns `.AUTH_FAILED`. - :param username: the username of the client. - :type username: str - :return: `.AUTH_FAILED` if the authentication fails; - `.AUTH_SUCCESSFUL` if it succeeds. + :param str username: the username of the client. + :return: + `.AUTH_FAILED` if the authentication fails; `.AUTH_SUCCESSFUL` if + it succeeds. :rtype: int """ return AUTH_FAILED @@ -133,13 +129,11 @@ class ServerInterface (object): The default implementation always returns `.AUTH_FAILED`. - :param username: the username of the authenticating client. - :type username: str - :param password: the password given by the client. - :type password: str - :return: `.AUTH_FAILED` if the authentication fails; - `.AUTH_SUCCESSFUL` if it succeeds; - `.AUTH_PARTIALLY_SUCCESSFUL` if the password auth is + :param str username: the username of the authenticating client. + :param str password: the password given by the client. + :return: + `.AUTH_FAILED` if the authentication fails; `.AUTH_SUCCESSFUL` if + it succeeds; `.AUTH_PARTIALLY_SUCCESSFUL` if the password auth is successful, but authentication must continue. :rtype: int """ @@ -166,14 +160,13 @@ class ServerInterface (object): The default implementation always returns `.AUTH_FAILED`. - :param username: the username of the authenticating client - :type username: str - :param key: the key object provided by the client - :type key: `.PKey` - :return: `.AUTH_FAILED` if the client can't authenticate - with this key; `.AUTH_SUCCESSFUL` if it can; - `.AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with - this key but must continue with authentication + :param str username: the username of the authenticating client + :param .PKey key: the key object provided by the client + :return: + `.AUTH_FAILED` if the client can't authenticate with this key; + `.AUTH_SUCCESSFUL` if it can; `.AUTH_PARTIALLY_SUCCESSFUL` if it + can authenticate with this key but must continue with + authentication :rtype: int """ return AUTH_FAILED @@ -192,13 +185,13 @@ class ServerInterface (object): The default implementation always returns `.AUTH_FAILED`. - :param username: the username of the authenticating client - :type username: str - :param submethods: a comma-separated list of methods preferred by the - client (usually empty) - :type submethods: str - :return: `.AUTH_FAILED` if this auth method isn't supported; otherwise - an object containing queries for the user + :param str username: the username of the authenticating client + :param str submethods: + a comma-separated list of methods preferred by the client (usually + empty) + :return: + `.AUTH_FAILED` if this auth method isn't supported; otherwise an + object containing queries for the user :rtype: int or `.InteractiveQuery` """ return AUTH_FAILED @@ -224,13 +217,12 @@ class ServerInterface (object): The default implementation always returns `.AUTH_FAILED`. - :param responses: list of responses from the client - :type responses: list(str) - :return: `.AUTH_FAILED` if the authentication fails; - `.AUTH_SUCCESSFUL` if it succeeds; - `.AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is - successful, but authentication must continue; otherwise an object - containing queries for the user + :param list responses: list of `str` responses from the client + :return: + `.AUTH_FAILED` if the authentication fails; `.AUTH_SUCCESSFUL` if + it succeeds; `.AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth + is successful, but authentication must continue; otherwise an + object containing queries for the user :rtype: int or `.InteractiveQuery` """ return AUTH_FAILED @@ -248,13 +240,11 @@ class ServerInterface (object): port forwarding request. If the request is accepted, you should return the port opened for listening. - :param address: the requested address - :type address: str - :param port: the requested port - :type port: int - :return: the port number that was opened for listening, or ``False`` to - reject - :rtype: int + :param str address: the requested address + :param int port: the requested port + :return: + the port number (`int`) that was opened for listening, or ``False`` + to reject """ return False @@ -264,10 +254,8 @@ class ServerInterface (object): If the given address and port is being forwarded across this ssh connection, the port should be closed. - :param address: the forwarded address - :type address: str - :param port: the forwarded port - :type port: int + :param str address: the forwarded address + :param int port: the forwarded port """ pass @@ -293,13 +281,11 @@ class ServerInterface (object): .. note:: Port forwarding requests are handled separately, in `check_port_forward_request`. - :param kind: the kind of global request being made. - :type kind: str - :param msg: any extra arguments to the request. - :type msg: `.Message` - :return: ``True`` or a tuple of data if the request was granted; - ``False`` otherwise. - :rtype: bool + :param str kind: the kind of global request being made. + :param .Message msg: any extra arguments to the request. + :return: + ``True`` or a `tuple` of data if the request was granted; ``False`` + otherwise. """ return False @@ -315,23 +301,17 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the `.Channel` the pty request arrived on. - :type channel: `.Channel` - :param term: type of terminal requested (for example, ``"vt100"``). - :type term: str - :param width: width of screen in characters. - :type width: int - :param height: height of screen in characters. - :type height: int - :param pixelwidth: width of screen in pixels, if known (may be ``0`` if - unknown). - :type pixelwidth: int - :param pixelheight: height of screen in pixels, if known (may be ``0`` - if unknown). - :type pixelheight: int - :return: ``True`` if the psuedo-terminal has been allocated; ``False`` + :param .Channel channel: the `.Channel` the pty request arrived on. + :param str term: type of terminal requested (for example, ``"vt100"``). + :param int width: width of screen in characters. + :param int height: height of screen in characters. + :param int pixelwidth: + width of screen in pixels, if known (may be ``0`` if unknown). + :param int pixelheight: + height of screen in pixels, if known (may be ``0`` if unknown). + :return: + ``True`` if the psuedo-terminal has been allocated; ``False`` otherwise. - :rtype: bool """ return False @@ -344,11 +324,10 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the `.Channel` the request arrived on. - :type channel: `.Channel` - :return: ``True`` if this channel is now hooked up to a shell; ``False`` - if a shell can't or won't be provided. - :rtype: bool + :param .Channel channel: the `.Channel` the request arrived on. + :return: + ``True`` if this channel is now hooked up to a shell; ``False`` if + a shell can't or won't be provided. """ return False @@ -360,14 +339,12 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the `.Channel` the request arrived on. - :type channel: `.Channel` - :param command: the command to execute. - :type command: str - :return: ``True`` if this channel is now hooked up to the stdin, - stdout, and stderr of the executing command; ``False`` if the - command will not be executed. - :rtype: bool + :param .Channel channel: the `.Channel` the request arrived on. + :param str command: the command to execute. + :return: + ``True`` if this channel is now hooked up to the stdin, stdout, and + stderr of the executing command; ``False`` if the command will not + be executed. .. versionadded:: 1.1 """ @@ -389,13 +366,11 @@ class ServerInterface (object): identify valid subsystems, you probably won't need to override this method. - :param channel: the `.Channel` the pty request arrived on. - :type channel: `.Channel` - :param name: name of the requested subsystem. - :type name: str - :return: ``True`` if this channel is now hooked up to the requested + :param .Channel channel: the `.Channel` the pty request arrived on. + :param str name: name of the requested subsystem. + :return: + ``True`` if this channel is now hooked up to the requested subsystem; ``False`` if that subsystem can't or won't be provided. - :rtype: bool """ handler_class, larg, kwarg = channel.get_transport()._get_subsystem_handler(name) if handler_class is None: @@ -411,20 +386,14 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the `.Channel` the pty request arrived on. - :type channel: `.Channel` - :param width: width of screen in characters. - :type width: int - :param height: height of screen in characters. - :type height: int - :param pixelwidth: width of screen in pixels, if known (may be ``0`` if - unknown). - :type pixelwidth: int - :param pixelheight: height of screen in pixels, if known (may be ``0`` - if unknown). - :type pixelheight: int + :param .Channel channel: the `.Channel` the pty request arrived on. + :param int width: width of screen in characters. + :param int height: height of screen in characters. + :param int pixelwidth: + width of screen in pixels, if known (may be ``0`` if unknown). + :param int pixelheight: + height of screen in pixels, if known (may be ``0`` if unknown). :return: ``True`` if the terminal was resized; ``False`` if not. - :rtype: bool """ return False @@ -436,19 +405,14 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the `.Channel` the X11 request arrived on - :type channel: `.Channel` - :param single_connection: ``True`` if only a single X11 channel should - be opened - :type single_connection: bool - :param auth_protocol: the protocol used for X11 authentication - :type auth_protocol: str - :param auth_cookie: the cookie used to authenticate to X11 - :type auth_cookie: str - :param screen_number: the number of the X11 screen to connect to - :type screen_number: int + :param .Channel channel: the `.Channel` the X11 request arrived on + :param bool single_connection: + ``True`` if only a single X11 channel should be opened, else + ``False``. + :param str auth_protocol: the protocol used for X11 authentication + :param str auth_cookie: the cookie used to authenticate to X11 + :param int screen_number: the number of the X11 screen to connect to :return: ``True`` if the X11 session was opened; ``False`` if not - :rtype: bool """ return False @@ -460,10 +424,8 @@ class ServerInterface (object): The default implementation always returns ``False``. - :param channel: the `.Channel` the request arrived on - :type channel: `.Channel` + :param .Channel channel: the `.Channel` the request arrived on :return: ``True`` if the AgentForward was loaded; ``False`` if not - :rtype: bool """ return False @@ -495,16 +457,14 @@ class ServerInterface (object): The default implementation always returns ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED``. - :param chanid: ID of the channel - :type chanid: int - :param origin: 2-tuple containing the IP address and port of the - originator (client side) - :type origin: tuple - :param destination: 2-tuple containing the IP address and port of the - destination (server side) - :type destination: tuple - :return: a success or failure code (listed above) - :rtype: int + :param int chanid: ID of the channel + :param tuple origin: + 2-tuple containing the IP address and port of the originator + (client side) + :param tuple destination: + 2-tuple containing the IP address and port of the destination + (server side) + :return: an `int` success or failure code (listed above) """ return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED @@ -521,12 +481,10 @@ class InteractiveQuery (object): user. A list of prompts may be included, or they may be added via the `add_prompt` method. - :param name: name of this query - :type name: str - :param instructions: user instructions (usually short) about this query - :type instructions: str - :param prompts: one or more authentication prompts - :type prompts: str + :param str name: name of this query + :param str instructions: + user instructions (usually short) about this query + :param str prompts: one or more authentication prompts """ self.name = name self.instructions = instructions @@ -542,11 +500,10 @@ class InteractiveQuery (object): Add a prompt to this query. The prompt should be a (reasonably short) string. Multiple prompts can be added to the same query. - :param prompt: the user prompt - :type prompt: str - :param echo: ``True`` (default) if the user's response should be echoed; + :param str prompt: the user prompt + :param bool echo: + ``True`` (default) if the user's response should be echoed; ``False`` if not (for a password or similar) - :type echo: bool """ self.prompts.append((prompt, echo)) @@ -573,13 +530,10 @@ class SubsystemHandler (threading.Thread): ``channel`` and ``name`` parameters through to the original ``__init__`` method here. - :param channel: the channel associated with this subsystem request. - :type channel: `.Channel` - :param name: name of the requested subsystem. - :type name: str - :param server: the server object for the session that started this - subsystem - :type server: `.ServerInterface` + :param .Channel channel: the channel associated with this subsystem request. + :param str name: name of the requested subsystem. + :param .ServerInterface server: + the server object for the session that started this subsystem """ threading.Thread.__init__(self, target=self._run) self.__channel = channel @@ -591,8 +545,6 @@ class SubsystemHandler (threading.Thread): """ Return the `.ServerInterface` object associated with this channel and subsystem. - - :rtype: `.ServerInterface` """ return self.__server @@ -628,12 +580,9 @@ class SubsystemHandler (threading.Thread): Python interpreter may refuse to exit because this thread will still be running. - :param name: name of the requested subsystem. - :type name: str - :param transport: the server-mode `.Transport`. - :type transport: `.Transport` - :param channel: the channel associated with this subsystem request. - :type channel: `.Channel` + :param str name: name of the requested subsystem. + :param .Transport transport: the server-mode `.Transport`. + :param .Channel channel: the channel associated with this subsystem request. """ pass -- cgit v1.2.3 From de99785ef081bf6308498d621aae40d99c0d59aa Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 15:25:48 -0800 Subject: SFTP done, ugh --- paramiko/sftp_attr.py | 7 +- paramiko/sftp_client.py | 217 ++++++++++++++++++++---------------------------- paramiko/sftp_file.py | 71 ++++++++-------- paramiko/sftp_handle.py | 23 ++--- paramiko/sftp_server.py | 31 +++---- paramiko/sftp_si.py | 121 ++++++++++++--------------- 6 files changed, 197 insertions(+), 273 deletions(-) diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index 9b30829c..3ef9703b 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -65,12 +65,9 @@ class SFTPAttributes (object): Create an `.SFTPAttributes` object from an existing ``stat`` object (an object returned by `os.stat`). - :param obj: an object returned by `os.stat` (or equivalent). - :type obj: object - :param filename: the filename associated with this file. - :type filename: str + :param object obj: an object returned by `os.stat` (or equivalent). + :param str filename: the filename associated with this file. :return: new `.SFTPAttributes` object with the same attribute fields. - :rtype: `.SFTPAttributes` """ attr = cls() attr.st_size = obj.st_size diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index db8d196f..0580bc43 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -61,8 +61,7 @@ class SFTPClient(BaseSFTP): An alternate way to create an SFTP client context is by using `from_transport`. - :param sock: an open `.Channel` using the ``"sftp"`` subsystem - :type sock: `.Channel` + :param .Channel sock: an open `.Channel` using the ``"sftp"`` subsystem :raises SSHException: if there's an exception while negotiating sftp @@ -91,11 +90,10 @@ class SFTPClient(BaseSFTP): """ Create an SFTP client channel from an open `.Transport`. - :param t: an open `.Transport` which is already authenticated - :type t: `.Transport` - :return: a new `.SFTPClient` object, referring to an sftp session - (channel) across the transport - :rtype: `.SFTPClient` + :param .Transport t: an open `.Transport` which is already authenticated + :return: + a new `.SFTPClient` object, referring to an sftp session (channel) + across the transport """ chan = t.open_session() if chan is None: @@ -125,9 +123,6 @@ class SFTPClient(BaseSFTP): Return the underlying `.Channel` object for this SFTP session. This might be useful for doing things like setting a timeout on the channel. - :return: the SSH channel - :rtype: `.Channel` - .. versionadded:: 1.7.1 """ return self.sock @@ -135,15 +130,13 @@ class SFTPClient(BaseSFTP): def listdir(self, path='.'): """ Return a list containing the names of the entries in the given ``path``. + The list is in arbitrary order. It does not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. This method is meant to mirror ``os.listdir`` as closely as possible. For a list of full `.SFTPAttributes` objects, see `listdir_attr`. - :param path: path to list (defaults to ``'.'``) - :type path: str - :return: list of filenames - :rtype: list of str + :param str path: path to list (defaults to ``'.'``) """ return [f.filename for f in self.listdir_attr(path)] @@ -159,10 +152,8 @@ class SFTPClient(BaseSFTP): attributes, in unix format. The content of this string will probably depend on the SFTP server implementation. - :param path: path to list (defaults to ``'.'``) - :type path: str - :return: list of attributes - :rtype: list of `.SFTPAttributes` + :param str path: path to list (defaults to ``'.'``) + :return: list of `.SFTPAttributes` objects .. versionadded:: 1.2 """ @@ -216,14 +207,10 @@ class SFTPClient(BaseSFTP): buffering, ``1`` uses line buffering, and any number greater than 1 (``>1``) uses that specific buffer size. - :param filename: name of the file to open - :type filename: str - :param mode: mode (Python-style) to open in - :type mode: str - :param bufsize: desired buffering (-1 = default buffer size) - :type bufsize: int - :return: a file object representing the open file - :rtype: `.SFTPFile` + :param str filename: name of the file to open + :param str mode: mode (Python-style) to open in + :param int bufsize: desired buffering (-1 = default buffer size) + :return: an `.SFTPFile` object representing the open file :raises IOError: if the file could not be opened. """ @@ -256,8 +243,7 @@ class SFTPClient(BaseSFTP): Remove the file at the given path. This only works on files; for removing folders (directories), use `rmdir`. - :param path: path (absolute or relative) of the file to remove - :type path: str + :param str path: path (absolute or relative) of the file to remove :raises IOError: if the path refers to a folder (directory) """ @@ -271,10 +257,8 @@ class SFTPClient(BaseSFTP): """ Rename a file or folder from ``oldpath`` to ``newpath``. - :param oldpath: existing name of the file or folder - :type oldpath: str - :param newpath: new name for the file or folder - :type newpath: str + :param str oldpath: existing name of the file or folder + :param str newpath: new name for the file or folder :raises IOError: if ``newpath`` is a folder, or something else goes wrong @@ -290,10 +274,8 @@ class SFTPClient(BaseSFTP): The default mode is 0777 (octal). On some systems, mode is ignored. Where it is used, the current umask value is first masked out. - :param path: name of the folder to create - :type path: str - :param mode: permissions (posix-style) for the newly-created folder - :type mode: int + :param str path: name of the folder to create + :param int mode: permissions (posix-style) for the newly-created folder """ path = self._adjust_cwd(path) self._log(DEBUG, 'mkdir(%r, %r)' % (path, mode)) @@ -305,8 +287,7 @@ class SFTPClient(BaseSFTP): """ Remove the folder named ``path``. - :param path: name of the folder to remove - :type path: str + :param str path: name of the folder to remove """ path = self._adjust_cwd(path) self._log(DEBUG, 'rmdir(%r)' % path) @@ -326,10 +307,10 @@ class SFTPClient(BaseSFTP): The fields supported are: ``st_mode``, ``st_size``, ``st_uid``, ``st_gid``, ``st_atime``, and ``st_mtime``. - :param path: the filename to stat - :type path: str - :return: an object containing attributes about the given file - :rtype: `.SFTPAttributes` + :param str path: the filename to stat + :return: + an `.SFTPAttributes` object containing attributes about the given + file """ path = self._adjust_cwd(path) self._log(DEBUG, 'stat(%r)' % path) @@ -344,10 +325,10 @@ class SFTPClient(BaseSFTP): following symbolic links (shortcuts). This otherwise behaves exactly the same as `stat`. - :param path: the filename to stat - :type path: str - :return: an object containing attributes about the given file - :rtype: `.SFTPAttributes` + :param str path: the filename to stat + :return: + an `.SFTPAttributes` object containing attributes about the given + file """ path = self._adjust_cwd(path) self._log(DEBUG, 'lstat(%r)' % path) @@ -361,10 +342,8 @@ class SFTPClient(BaseSFTP): Create a symbolic link (shortcut) of the ``source`` path at ``destination``. - :param source: path of the original file - :type source: str - :param dest: path of the newly created symlink - :type dest: str + :param str source: path of the original file + :param str dest: path of the newly created symlink """ dest = self._adjust_cwd(dest) self._log(DEBUG, 'symlink(%r, %r)' % (source, dest)) @@ -378,10 +357,8 @@ class SFTPClient(BaseSFTP): unix-style and identical to those used by Python's `os.chmod` function. - :param path: path of the file to change the permissions of - :type path: str - :param mode: new permissions - :type mode: int + :param str path: path of the file to change the permissions of + :param int mode: new permissions """ path = self._adjust_cwd(path) self._log(DEBUG, 'chmod(%r, %r)' % (path, mode)) @@ -396,12 +373,9 @@ class SFTPClient(BaseSFTP): only want to change one, use `stat` first to retrieve the current owner and group. - :param path: path of the file to change the owner and group of - :type path: str - :param uid: new owner's uid - :type uid: int - :param gid: new group id - :type gid: int + :param str path: path of the file to change the owner and group of + :param int uid: new owner's uid + :param int gid: new group id """ path = self._adjust_cwd(path) self._log(DEBUG, 'chown(%r, %r, %r)' % (path, uid, gid)) @@ -418,11 +392,10 @@ class SFTPClient(BaseSFTP): modified times, respectively. This bizarre API is mimicked from Python for the sake of consistency -- I apologize. - :param path: path of the file to modify - :type path: str - :param times: ``None`` or a tuple of (access time, modified time) in - standard internet epoch time (seconds since 01 January 1970 GMT) - :type times: tuple(int) + :param str path: path of the file to modify + :param tuple times: + ``None`` or a tuple of (access time, modified time) in standard + internet epoch time (seconds since 01 January 1970 GMT) """ path = self._adjust_cwd(path) if times is None: @@ -438,8 +411,7 @@ class SFTPClient(BaseSFTP): extends or shrinks the size of the file, just like the `~file.truncate` method on Python file objects. - :param path: path of the file to modify - :type path: str + :param str path: path of the file to modify :param size: the new size of the file :type size: int or long """ @@ -455,10 +427,8 @@ class SFTPClient(BaseSFTP): `symlink` to create these. The result may be either an absolute or relative pathname. - :param path: path of the symbolic link file - :type path: str - :return: target path - :rtype: str + :param str path: path of the symbolic link file + :return: target path, as a `str` """ path = self._adjust_cwd(path) self._log(DEBUG, 'readlink(%r)' % path) @@ -479,10 +449,8 @@ class SFTPClient(BaseSFTP): server is considering to be the "current folder" (by passing ``'.'`` as ``path``). - :param path: path to be normalized - :type path: str - :return: normalized form of the given path - :rtype: str + :param str path: path to be normalized + :return: normalized form of the given path (as a `str`) :raises IOError: if the path can't be resolved on the server """ @@ -505,8 +473,7 @@ class SFTPClient(BaseSFTP): to that path. You can pass in ``None`` to stop using a current working directory. - :param path: new current working directory - :type path: str + :param str path: new current working directory :raises IOError: if the requested path doesn't exist on the server @@ -525,9 +492,6 @@ class SFTPClient(BaseSFTP): emulated by Paramiko. If no directory has been set with `chdir`, this method will return ``None``. - :return: the current working directory on the server, or ``None`` - :rtype: str - .. versionadded:: 1.4 """ return self._cwd @@ -540,26 +504,26 @@ class SFTPClient(BaseSFTP): The SFTP operations use pipelining for speed. - :param fl: opened file or file-like object to copy - :type localpath: object - :param remotepath: the destination path on the SFTP server - :type remotepath: str - :param file_size: optional size parameter passed to callback. If none is - specified, size defaults to 0 - :type file_size: int - :param callback: optional callback function that accepts the bytes - transferred so far and the total bytes to be transferred + :param file fl: opened file or file-like object to copy + :param str remotepath: the destination path on the SFTP server + :param int file_size: + optional size parameter passed to callback. If none is specified, + size defaults to 0 + :param callable callback: + optional callback function (form: ``func(int, int)``) that accepts + the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - :type callback: function(int, int) - :param confirm: whether to do a stat() on the file afterwards to - confirm the file size (since 1.7.7) - :type confirm: bool + :param bool confirm: + whether to do a stat() on the file afterwards to confirm the file + size (since 1.7.7) - :return: an object containing attributes about the given file - (since 1.7.4) - :rtype: `.SFTPAttributes` + :return: + an `.SFTPAttributes` object containing attributes about the given + file. .. versionadded:: 1.4 + .. versionchanged:: 1.7.4 + Began returning rich attribute objects. """ fr = self.file(remotepath, 'wb') fr.set_pipelined(True) @@ -591,23 +555,22 @@ class SFTPClient(BaseSFTP): The SFTP operations use pipelining for speed. - :param localpath: the local file to copy - :type localpath: str - :param remotepath: the destination path on the SFTP server - :type remotepath: str - :param callback: optional callback function that accepts the bytes - transferred so far and the total bytes to be transferred - (since 1.7.4) - :type callback: function(int, int) - :param confirm: whether to do a stat() on the file afterwards to - confirm the file size (since 1.7.7) - :type confirm: bool + :param str localpath: the local file to copy + :param str remotepath: the destination path on the SFTP server + :param callable callback: + optional callback function (form: ``func(int, int)``) that accepts + the bytes transferred so far and the total bytes to be transferred + :param bool confirm: + whether to do a stat() on the file afterwards to confirm the file + size - :return: an object containing attributes about the given file - (since 1.7.4) - :rtype: `.SFTPAttributes` + :return: an `.SFTPAttributes` object containing attributes about the given file .. versionadded:: 1.4 + .. versionchanged:: 1.7.4 + ``callback`` and rich attribute return value added. + .. versionchanged:: 1.7.7 + ``confirm`` param added. """ file_size = os.stat(localpath).st_size fl = file(localpath, 'rb') @@ -623,18 +586,17 @@ class SFTPClient(BaseSFTP): operations will be passed through. This method is primarily provided as a convenience. - :param remotepath: opened file or file-like object to copy to - :type remotepath: object - :param fl: the destination path on the local host or open file - object - :type localpath: str - :param callback: optional callback function that accepts the bytes - transferred so far and the total bytes to be transferred - (since 1.7.4) - :type callback: function(int, int) - :return: the number of bytes written to the opened file object + :param object remotepath: opened file or file-like object to copy to + :param str fl: + the destination path on the local host or open file object + :param callable callback: + optional callback function (form: ``func(int, int)``) that accepts + the bytes transferred so far and the total bytes to be transferred + :return: the `number ` of bytes written to the opened file object .. versionadded:: 1.4 + .. versionchanged:: 1.7.4 + Added the ``callable`` param. """ fr = self.file(remotepath, 'rb') file_size = self.stat(remotepath).st_size @@ -659,16 +621,15 @@ class SFTPClient(BaseSFTP): host as ``localpath``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. - :param remotepath: the remote file to copy - :type remotepath: str - :param localpath: the destination path on the local host - :type localpath: str - :param callback: optional callback function that accepts the bytes - transferred so far and the total bytes to be transferred - (since 1.7.4) - :type callback: function(int, int) + :param str remotepath: the remote file to copy + :param str localpath: the destination path on the local host + :param callable callback: + optional callback function (form: ``func(int, int)``) that accepts + the bytes transferred so far and the total bytes to be transferred .. versionadded:: 1.4 + .. versionchanged:: 1.7.4 + Added the ``callback`` param """ file_size = self.stat(remotepath).st_size fl = file(localpath, 'wb') diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index 068ca1a1..9add3c91 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -186,9 +186,9 @@ class SFTPFile (BufferedFile): Set a timeout on read/write operations on the underlying socket or ssh `.Channel`. - :param timeout: seconds to wait for a pending read/write operation - before raising ``socket.timeout``, or ``None`` for no timeout - :type timeout: float + :param float timeout: + seconds to wait for a pending read/write operation before raising + ``socket.timeout``, or ``None`` for no timeout .. seealso:: `.Channel.settimeout` """ @@ -196,10 +196,8 @@ class SFTPFile (BufferedFile): def gettimeout(self): """ - Returns the timeout in seconds (as a float) associated with the socket - or ssh `.Channel` used for this file. - - :rtype: float + Returns the timeout in seconds (as a `float`) associated with the + socket or ssh `.Channel` used for this file. .. seealso:: `.Channel.gettimeout` """ @@ -210,9 +208,8 @@ class SFTPFile (BufferedFile): Set blocking or non-blocking mode on the underiying socket or ssh `.Channel`. - :param blocking: + :param int blocking: 0 to set non-blocking mode; non-0 to set blocking mode. - :type blocking: int .. seealso:: `.Channel.setblocking` """ @@ -235,8 +232,7 @@ class SFTPFile (BufferedFile): exactly like `.SFTPClient.stat`, except that it operates on an already-open file. - :return: an object containing attributes about this file. - :rtype: `.SFTPAttributes` + :return: an `.SFTPAttributes` object containing attributes about this file. """ t, msg = self.sftp._request(CMD_FSTAT, self.handle) if t != CMD_ATTRS: @@ -249,8 +245,7 @@ class SFTPFile (BufferedFile): unix-style and identical to those used by Python's `os.chmod` function. - :param mode: new permissions - :type mode: int + :param int mode: new permissions """ self.sftp._log(DEBUG, 'chmod(%s, %r)' % (hexlify(self.handle), mode)) attr = SFTPAttributes() @@ -264,10 +259,8 @@ class SFTPFile (BufferedFile): only want to change one, use `stat` first to retrieve the current owner and group. - :param uid: new owner's uid - :type uid: int - :param gid: new group id - :type gid: int + :param int uid: new owner's uid + :param int gid: new group id """ self.sftp._log(DEBUG, 'chown(%s, %r, %r)' % (hexlify(self.handle), uid, gid)) attr = SFTPAttributes() @@ -283,9 +276,9 @@ class SFTPFile (BufferedFile): modified times, respectively. This bizarre API is mimicked from Python for the sake of consistency -- I apologize. - :param times: ``None`` or a tuple of (access time, modified time) in - standard internet epoch time (seconds since 01 January 1970 GMT) - :type times: tuple(int) + :param tuple times: + ``None`` or a tuple of (access time, modified time) in standard + internet epoch time (seconds since 01 January 1970 GMT) """ if times is None: times = (time.time(), time.time()) @@ -331,21 +324,23 @@ class SFTPFile (BufferedFile): of the file, and the last 20 bytes will be the SHA-1 of the next 512 bytes. - :param hash_algorithm: the name of the hash algorithm to use (normally - ``"sha1"`` or ``"md5"``) - :type hash_algorithm: str - :param offset: offset into the file to begin hashing (0 means to start - from the beginning) + :param str hash_algorithm: + the name of the hash algorithm to use (normally ``"sha1"`` or + ``"md5"``) + :param offset: + offset into the file to begin hashing (0 means to start from the + beginning) :type offset: int or long - :param length: number of bytes to hash (0 means continue to the end of - the file) + :param length: + number of bytes to hash (0 means continue to the end of the file) :type length: int or long - :param block_size: number of bytes to hash per result (must not be less - than 256; 0 means to compute only one hash of the entire segment) + :param int block_size: + number of bytes to hash per result (must not be less than 256; 0 + means to compute only one hash of the entire segment) :type block_size: int - :return: string of bytes representing the hash of each block, - concatenated together - :rtype: str + :return: + `str` of bytes representing the hash of each block, concatenated + together :raises IOError: if the server doesn't support the "check-file" extension, or possibly doesn't support the hash algorithm @@ -374,9 +369,9 @@ class SFTPFile (BufferedFile): By default, files are not pipelined. - :param pipelined: ``True`` if pipelining should be turned on for this - file; ``False`` otherwise - :type pipelined: bool + :param bool pipelined: + ``True`` if pipelining should be turned on for this file; ``False`` + otherwise .. versionadded:: 1.5 """ @@ -414,11 +409,11 @@ class SFTPFile (BufferedFile): prefetch machinery is used to retrieve all the requested blocks at once. - :param chunks: a list of (offset, length) tuples indicating which - sections of the file to read + :param chunks: + a list of (offset, length) tuples indicating which sections of the + file to read :type chunks: list(tuple(long, int)) :return: a list of blocks read, in the same order as in ``chunks`` - :rtype: list(str) .. versionadded:: 1.5.4 """ diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 6965fd65..a799d57c 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -41,8 +41,7 @@ class SFTPHandle (object): SFTP. If ``flags`` is passed in, it's used to determine if the file is open in append mode. - :param flags: optional flags as passed to `.SFTPServerInterface.open` - :type flags: int + :param int flags: optional flags as passed to `.SFTPServerInterface.open` """ self.__flags = flags self.__name = None @@ -85,10 +84,8 @@ class SFTPHandle (object): :param offset: position in the file to start reading from. :type offset: int or long - :param length: number of bytes to attempt to read. - :type length: int - :return: data read from the file, or an SFTP error code. - :rtype: str + :param int length: number of bytes to attempt to read. + :return: data read from the file, or an SFTP error code, as a `str`. """ readfile = getattr(self, 'readfile', None) if readfile is None: @@ -122,8 +119,7 @@ class SFTPHandle (object): :param offset: position in the file to start reading from. :type offset: int or long - :param data: data to write into the file. - :type data: str + :param str data: data to write into the file. :return: an SFTP error code like `.SFTP_OK`. """ writefile = getattr(self, 'writefile', None) @@ -152,8 +148,9 @@ class SFTPHandle (object): error code. This is equivalent to `.SFTPServerInterface.stat`, except it's called on an open file instead of a path. - :return: an attributes object for the given file, or an SFTP error - code (like `.SFTP_PERMISSION_DENIED`). + :return: + an attributes object for the given file, or an SFTP error code + (like `.SFTP_PERMISSION_DENIED`). :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -164,10 +161,8 @@ class SFTPHandle (object): only those fields provided by the client in its request, so you should check for the presence of fields before using them. - :param attr: the attributes to change on this file. - :type attr: `.SFTPAttributes` - :return: an error code like `.SFTP_OK`. - :rtype: int + :param .SFTPAttributes attr: the attributes to change on this file. + :return: an `int` error code like `.SFTP_OK`. """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index 9b7ed5ca..0456e0a6 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -52,16 +52,13 @@ class SFTPServer (BaseSFTP, SubsystemHandler): parameters or keyword parameters are passed from the original call to `.Transport.set_subsystem_handler`. - :param channel: channel passed from the `.Transport`. - :type channel: `.Channel` - :param name: name of the requested subsystem. - :type name: str - :param server: the server object associated with this channel and - subsystem - :type server: `.ServerInterface` - :param sftp_si: a subclass of `.SFTPServerInterface` to use for handling - individual requests. - :type sftp_si: class + :param .Channel channel: channel passed from the `.Transport`. + :param str name: name of the requested subsystem. + :param .ServerInterface server: + the server object associated with this channel and subsystem + :param class sftp_si: + a subclass of `.SFTPServerInterface` to use for handling individual + requests. """ BaseSFTP.__init__(self) SubsystemHandler.__init__(self, channel, name, server) @@ -126,10 +123,8 @@ class SFTPServer (BaseSFTP, SubsystemHandler): standard SFTP result code. This is a convenience function for trapping exceptions in server code and returning an appropriate result. - :param e: an errno code, as from ``OSError.errno``. - :type e: int - :return: an SFTP error code like ``SFTP_NO_SUCH_FILE``. - :rtype: int + :param int e: an errno code, as from ``OSError.errno``. + :return: an `int` SFTP error code like ``SFTP_NO_SUCH_FILE``. """ if e == errno.EACCES: # permission denied @@ -151,11 +146,9 @@ class SFTPServer (BaseSFTP, SubsystemHandler): This is meant to be a handy helper function for translating SFTP file requests into local file operations. - :param filename: name of the file to alter (should usually be an - absolute path). - :type filename: str - :param attr: attributes to change. - :type attr: `.SFTPAttributes` + :param str filename: + name of the file to alter (should usually be an absolute path). + :param .SFTPAttributes attr: attributes to change. """ if sys.platform != 'win32': # mode operations are meaningless on win32 diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index ead483a0..d4b34268 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -46,9 +46,8 @@ class SFTPServerInterface (object): Create a new SFTPServerInterface object. This method does nothing by default and is meant to be overridden by subclasses. - :param server: the server object associated with this channel and - SFTP subsystem - :type server: `.ServerInterface` + :param .ServerInterface server: + the server object associated with this channel and SFTP subsystem """ super(SFTPServerInterface, self).__init__(*largs, **kwargs) @@ -96,16 +95,14 @@ class SFTPServerInterface (object): .. note:: The SFTP protocol defines all files to be in "binary" mode. There is no equivalent to Python's "text" mode. - :param path: the requested path (relative or absolute) of the file - to be opened. - :type path: str - :param flags: flags or'd together from the ``os`` module indicating the - requested mode for opening the file. - :type flags: int - :param attr: requested attributes of the file if it is newly created. - :type attr: `.SFTPAttributes` + :param str path: + the requested path (relative or absolute) of the file to be opened. + :param int flags: + flags or'd together from the ``os`` module indicating the requested + mode for opening the file. + :param .SFTPAttributes attr: + requested attributes of the file if it is newly created. :return: a new `.SFTPHandle` or error code. - :rtype: `.SFTPHandle` """ return SFTP_OP_UNSUPPORTED @@ -125,11 +122,10 @@ class SFTPServerInterface (object): In case of an error, you should return one of the ``SFTP_*`` error codes, such as `.SFTP_PERMISSION_DENIED`. - :param path: the requested path (relative or absolute) to be listed. - :type path: str - :return: a list of the files in the given folder, using - `.SFTPAttributes` objects. - :rtype: list of `.SFTPAttributes` or error code + :param str path: the requested path (relative or absolute) to be listed. + :return: + a list of the files in the given folder, using `.SFTPAttributes` + objects. .. note:: You should normalize the given ``path`` first (see the `os.path` @@ -148,12 +144,12 @@ class SFTPServerInterface (object): "aliases"), you should follow them. (`lstat` is the corresponding call that doesn't follow symlinks/aliases.) - :param path: the requested path (relative or absolute) to fetch - file statistics for. - :type path: str - :return: an attributes object for the given file, or an SFTP error + :param str path: + the requested path (relative or absolute) to fetch file statistics + for. + :return: + an `.SFTPAttributes` object for the given file, or an SFTP error code (like `.SFTP_PERMISSION_DENIED`). - :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -165,12 +161,13 @@ class SFTPServerInterface (object): return data on the symlink or alias itself. (`stat` is the corresponding call that follows symlinks/aliases.) - :param path: the requested path (relative or absolute) to fetch - file statistics for. + :param str path: + the requested path (relative or absolute) to fetch file statistics + for. :type path: str - :return: an attributes object for the given file, or an SFTP error + :return: + an `.SFTPAttributes` object for the given file, or an SFTP error code (like `.SFTP_PERMISSION_DENIED`). - :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -178,11 +175,9 @@ class SFTPServerInterface (object): """ Delete a file, if possible. - :param path: the requested path (relative or absolute) of the file - to delete. - :type path: str - :return: an SFTP error code like `.SFTP_OK`. - :rtype: int + :param str path: + the requested path (relative or absolute) of the file to delete. + :return: an SFTP error code `int` like `.SFTP_OK`. """ return SFTP_OP_UNSUPPORTED @@ -198,13 +193,10 @@ class SFTPServerInterface (object): ``newpath`` already exists. (The rename operation should be non-desctructive.) - :param oldpath: the requested path (relative or absolute) of the - existing file. - :type oldpath: str - :param newpath: the requested new path of the file. - :type newpath: str - :return: an SFTP error code like `.SFTP_OK`. - :rtype: int + :param str oldpath: + the requested path (relative or absolute) of the existing file. + :param str newpath: the requested new path of the file. + :return: an SFTP error code `int` like `.SFTP_OK`. """ return SFTP_OP_UNSUPPORTED @@ -218,13 +210,10 @@ class SFTPServerInterface (object): the presense of fields before using them. In some cases, the ``attr`` object may be completely empty. - :param path: requested path (relative or absolute) of the new - folder. - :type path: str - :param attr: requested attributes of the new folder. - :type attr: `.SFTPAttributes` - :return: an SFTP error code like `.SFTP_OK`. - :rtype: int + :param str path: + requested path (relative or absolute) of the new folder. + :param .SFTPAttributes attr: requested attributes of the new folder. + :return: an SFTP error code `int` like `.SFTP_OK`. """ return SFTP_OP_UNSUPPORTED @@ -234,11 +223,9 @@ class SFTPServerInterface (object): existing, empty folder -- otherwise this method should return an error. - :param path: requested path (relative or absolute) of the folder - to remove. - :type path: str - :return: an SFTP error code like `.SFTP_OK`. - :rtype: int + :param str path: + requested path (relative or absolute) of the folder to remove. + :return: an SFTP error code `int` like `.SFTP_OK`. """ return SFTP_OP_UNSUPPORTED @@ -248,13 +235,12 @@ class SFTPServerInterface (object): only those fields provided by the client in its request, so you should check for the presence of fields before using them. - :param path: requested path (relative or absolute) of the file to - change. - :type path: str - :param attr: requested attributes to change on the file. - :type attr: `.SFTPAttributes` - :return: an error code like `.SFTP_OK`. - :rtype: int + :param str path: + requested path (relative or absolute) of the file to change. + :param attr: + requested attributes to change on the file (an `.SFTPAttributes` + object) + :return: an error code `int` like `.SFTP_OK`. """ return SFTP_OP_UNSUPPORTED @@ -287,11 +273,10 @@ class SFTPServerInterface (object): If the specified path doesn't refer to a symbolic link, an error should be returned. - :param path: path (relative or absolute) of the symbolic link. - :type path: str - :return: the target path of the symbolic link, or an error code like + :param str path: path (relative or absolute) of the symbolic link. + :return: + the target `str` path of the symbolic link, or an error code like `.SFTP_NO_SUCH_FILE`. - :rtype: str or error code """ return SFTP_OP_UNSUPPORTED @@ -300,13 +285,11 @@ class SFTPServerInterface (object): Create a symbolic link on the server, as new pathname ``path``, with ``target_path`` as the target of the link. - :param target_path: path (relative or absolute) of the target for - this new symbolic link. - :type target_path: str - :param path: path (relative or absolute) of the symbolic link to - create. - :type path: str - :return: an error code like ``SFTP_OK``. - :rtype: int + :param str target_path: + path (relative or absolute) of the target for this new symbolic + link. + :param str path: + path (relative or absolute) of the symbolic link to create. + :return: an error code `int` like ``SFTP_OK``. """ return SFTP_OP_UNSUPPORTED -- cgit v1.2.3 From 9c3f2c2122cdf6bec97cf8bd1db664b20f861813 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 17:50:26 -0800 Subject: ivars kinda suck --- paramiko/ssh_exception.py | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py index 56dec86a..63ca6409 100644 --- a/paramiko/ssh_exception.py +++ b/paramiko/ssh_exception.py @@ -48,10 +48,9 @@ class BadAuthenticationType (AuthenticationException): the server isn't allowing that type. (It may only allow public-key, for example.) - :ivar allowed_types: + :ivar list allowed_types: list of allowed authentication types provided by the server (possible values are: ``"none"``, ``"password"``, and ``"publickey"``). - :type allowed_types: list .. versionadded:: 1.1 """ @@ -80,8 +79,7 @@ class ChannelException (SSHException): """ Exception raised when an attempt to open a new `.Channel` fails. - :ivar code: the error code returned by the server - :type code: int + :ivar int code: the error code returned by the server .. versionadded:: 1.6 """ @@ -94,12 +92,9 @@ class BadHostKeyException (SSHException): """ The host key given by the SSH server did not match what we were expecting. - :ivar hostname: the hostname of the SSH server - :type hostname: str - :ivar key: the host key presented by the server - :type key: `.PKey` - :ivar expected_key: the host key expected - :type expected_key: `.PKey` + :ivar str hostname: the hostname of the SSH server + :ivar PKey got_key: the host key presented by the server + :ivar PKey expected_key: the host key expected .. versionadded:: 1.6 """ @@ -114,10 +109,8 @@ class ProxyCommandFailure (SSHException): """ The "ProxyCommand" found in the .ssh/config file returned an error. - :ivar command: The command line that is generating this exception. - :type command: str - :ivar error: The error captured from the proxy command output. - :type error: str + :ivar str command: The command line that is generating this exception. + :ivar str error: The error captured from the proxy command output. """ def __init__(self, command, error): SSHException.__init__(self, -- cgit v1.2.3 From 5ee1fb478176c5db08e919f8cc3899a457a81eb0 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 18:48:28 -0800 Subject: Transport info fields cleanup. --- paramiko/transport.py | 259 ++++++++++++++++++++++---------------------------- 1 file changed, 112 insertions(+), 147 deletions(-) diff --git a/paramiko/transport.py b/paramiko/transport.py index 5f326809..dfb3df81 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -150,7 +150,8 @@ class Transport (threading.Thread): address and used for communication. Exceptions from the ``socket`` call may be thrown in this case. - :param socket sock: a socket or socket-like object to create the session over. + :param socket sock: + a socket or socket-like object to create the session over. """ if isinstance(sock, (str, unicode)): # convert "host:port" into (host, port) @@ -249,8 +250,6 @@ class Transport (threading.Thread): def __repr__(self): """ Returns a string representation of this object, for debugging. - - :rtype: str """ out = '` - :type server: `.ServerInterface` :raises SSHException: if negotiation fails (and no ``event`` was passed in) @@ -420,8 +414,8 @@ class Transport (threading.Thread): key info, not just the public half. Only one key of each type (RSA or DSS) is kept. - :param key: the host key to add, usually an `.RSAKey` or `.DSSKey`. - :type key: `.PKey` + :param .PKey key: + the host key to add, usually an `.RSAKey` or `.DSSKey`. """ self.server_key_dict[key.get_name()] = key @@ -436,8 +430,9 @@ class Transport (threading.Thread): key of the type agreed on. If the host key has not been negotiated yet, ``None`` is returned. In client mode, the behavior is undefined. - :return: host key of the type negotiated by the client, or ``None``. - :rtype: `.PKey` + :return: + host key (`.PKey`) of the type negotiated by the client, or + ``None``. """ try: return self.server_key_dict[self.host_key_type] @@ -467,7 +462,6 @@ class Transport (threading.Thread): not in a standard location. :return: True if a moduli file was successfully loaded; False otherwise. - :rtype: bool .. note:: This has no effect when used in client mode. """ @@ -510,8 +504,7 @@ class Transport (threading.Thread): :raises SSHException: if no session is currently active. - :return: public key of the remote server - :rtype: `.PKey` + :return: public key (`.PKey`) of the remote server """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -521,9 +514,9 @@ class Transport (threading.Thread): """ Return true if this session is active (open). - :return: True if the session is still active (open); False if the - session is closed - :rtype: bool + :return: + True if the session is still active (open); False if the session is + closed """ return self.active @@ -545,11 +538,10 @@ class Transport (threading.Thread): Request a new channel to the client, of type ``"x11"``. This is just an alias for ``open_channel('x11', src_addr=src_addr)``. - :param src_addr: the source address of the x11 server (port is the + :param tuple src_addr: + the source address (``(str, int)``) of the x11 server (port is the x11 port, ie. 6010) - :type src_addr: (str, int) :return: a new `.Channel` - :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -564,7 +556,6 @@ class Transport (threading.Thread): This is just an alias for ``open_channel('auth-agent@openssh.com')``. :return: a new `.Channel` - :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -591,18 +582,16 @@ class Transport (threading.Thread): session. You may only request a channel after negotiating encryption (using `connect` or `start_client`) and authenticating. - :param kind: the kind of channel requested (usually ``"session"``, + :param str kind: + the kind of channel requested (usually ``"session"``, ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"``) - :type kind: str - :param dest_addr: the destination address of this port forwarding, - if ``kind`` is ``"forwarded-tcpip"`` or ``"direct-tcpip"`` (ignored - for other channel types) - :type dest_addr: (str, int) + :param tuple dest_addr: + the destination address (address + port tuple) of this port + forwarding, if ``kind`` is ``"forwarded-tcpip"`` or + ``"direct-tcpip"`` (ignored for other channel types) :param src_addr: the source address of this port forwarding, if ``kind`` is ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"`` - :type src_addr: (str, int) :return: a new `.Channel` on success - :rtype: `.Channel` :raises SSHException: if the request is rejected or the session ends prematurely @@ -669,15 +658,13 @@ class Transport (threading.Thread): forwarded connections into the accept queue, to be picked up via `accept`. - :param address: the address to bind when forwarding - :type address: str - :param port: the port to forward, or 0 to ask the server to allocate - any port - :type port: int - :param handler: optional handler for incoming forwarded connections - :type handler: function(Channel, (str, int), (str, int)) - :return: the port # allocated by the server - :rtype: int + :param str address: the address to bind when forwarding + :param int port: + the port to forward, or 0 to ask the server to allocate any port + :param callable handler: + optional handler for incoming forwarded connections, of the form + ``func(Channel, (str, int), (str, int))``. + :return: the port number (`int`) allocated by the server :raises SSHException: if the server refused the TCP forward request """ @@ -703,10 +690,8 @@ class Transport (threading.Thread): connections to the given address & port will be forwarded across this ssh connection. - :param address: the address to stop forwarding - :type address: str - :param port: the port to stop forwarding - :type port: int + :param str address: the address to stop forwarding + :param int port: the port to stop forwarding """ if not self.active: return @@ -719,9 +704,9 @@ class Transport (threading.Thread): SFTP session will be opened with the remote host, and a new `.SFTPClient` object will be returned. - :return: a new `.SFTPClient` object, referring to an sftp session - (channel) across this transport - :rtype: `.SFTPClient` + :return: + a new `.SFTPClient` referring to an sftp session (channel) across + this transport """ return SFTPClient.from_transport(self) @@ -732,9 +717,9 @@ class Transport (threading.Thread): also be used as a keep-alive for long lived connections traversing firewalls. - :param bytes: the number of random bytes to send in the payload of the - ignored packet -- defaults to a random number from 10 to 41. - :type bytes: int + :param int bytes: + the number of random bytes to send in the payload of the ignored + packet -- defaults to a random number from 10 to 41. """ m = Message() m.add_byte(chr(MSG_IGNORE)) @@ -775,9 +760,9 @@ class Transport (threading.Thread): "keepalive" packet will be sent (and ignored by the remote host). This can be useful to keep connections alive over a NAT, for example. - :param interval: seconds to wait before sending a keepalive packet (or + :param int interval: + seconds to wait before sending a keepalive packet (or 0 to disable keepalives). - :type interval: int """ self.packetizer.set_keepalive(interval, lambda x=weakref.proxy(self): x.global_request('keepalive@lag.net', wait=False)) @@ -787,18 +772,17 @@ class Transport (threading.Thread): Make a global request to the remote host. These are normally extensions to the SSH2 protocol. - :param kind: name of the request. - :type kind: str - :param data: an optional tuple containing additional data to attach - to the request. - :type data: tuple - :param wait: ``True`` if this method should not return until a response - is received; ``False`` otherwise. - :type wait: bool - :return: a `.Message` containing possible additional data if the - request was successful (or an empty `.Message` if ``wait`` was - ``False``); ``None`` if the request was denied. - :rtype: `.Message` + :param str kind: name of the request. + :param tuple data: + an optional tuple containing additional data to attach to the + request. + :param bool wait: + ``True`` if this method should not return until a response is + received; ``False`` otherwise. + :return: + a `.Message` containing possible additional data if the request was + successful (or an empty `.Message` if ``wait`` was ``False``); + ``None`` if the request was denied. """ if wait: self.completion_event = threading.Event() @@ -826,11 +810,9 @@ class Transport (threading.Thread): server mode. If no channel is opened before the given timeout, ``None`` is returned. - :param timeout: seconds to wait for a channel, or ``None`` to wait - forever - :type timeout: int + :param int timeout: + seconds to wait for a channel, or ``None`` to wait forever :return: a new `.Channel` opened by the client - :rtype: `.Channel` """ self.lock.acquire() try: @@ -867,17 +849,16 @@ class Transport (threading.Thread): succeed, but a subsequent `open_channel` or `open_session` call may fail because you haven't authenticated yet. - :param hostkey: the host key expected from the server, or ``None`` if - you don't want to do host key verification. - :type hostkey: `.PKey` - :param username: the username to authenticate as. - :type username: str - :param password: a password to use for authentication, if you want to - use password authentication; otherwise ``None``. - :type password: str - :param pkey: a private key to use for authentication, if you want to - use private key authentication; otherwise ``None``. - :type pkey: `.PKey` + :param .PKey hostkey: + the host key expected from the server, or ``None`` if you don't + want to do host key verification. + :param str username: the username to authenticate as. + :param str password: + a password to use for authentication, if you want to use password + authentication; otherwise ``None``. + :param .PKey pkey: + a private key to use for authentication, if you want to use private + key authentication; otherwise ``None``. :raises SSHException: if the SSH2 negotiation fails, the host key supplied by the server is incorrect, or authentication fails. @@ -914,8 +895,8 @@ class Transport (threading.Thread): calls like `start_client`. The exception (if any) is cleared after this call. - :return: an exception, or ``None`` if there is no stored exception. - :rtype: Exception + :return: + an exception, or ``None`` if there is no stored exception. .. versionadded:: 1.1 """ @@ -937,11 +918,9 @@ class Transport (threading.Thread): Any extra parameters (including keyword arguments) are saved and passed to the `.SubsystemHandler` constructor later. - :param name: name of the subsystem. - :type name: str - :param handler: subclass of `.SubsystemHandler` that handles this - subsystem. - :type handler: class + :param str name: name of the subsystem. + :param class handler: + subclass of `.SubsystemHandler` that handles this subsystem. """ try: self.lock.acquire() @@ -953,10 +932,10 @@ class Transport (threading.Thread): """ Return true if this session is active and authenticated. - :return: True if the session is still open and has been authenticated + :return: + True if the session is still open and has been authenticated successfully; False if authentication failed and/or the session is closed. - :rtype: bool """ return self.active and (self.auth_handler is not None) and self.auth_handler.is_authenticated() @@ -966,8 +945,7 @@ class Transport (threading.Thread): session is not authenticated (or authentication failed), this method returns ``None``. - :return: username that was authenticated, or ``None``. - :rtype: string + :return: username that was authenticated (a `str`), or ``None``. """ if not self.active or (self.auth_handler is None): return None @@ -980,11 +958,10 @@ class Transport (threading.Thread): list of authentication types supported by the server, by catching the `.BadAuthenticationType` exception raised. - :param username: the username to authenticate as - :type username: string - :return: list of auth types permissible for the next stage of + :param str username: the username to authenticate as + :return: + `list` of auth types permissible for the next stage of authentication (normally empty) - :rtype: list :raises BadAuthenticationType: if "none" authentication isn't allowed by the server for this user @@ -1027,20 +1004,17 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - :param username: the username to authenticate as - :type username: str - :param password: the password to authenticate with - :type password: basestring - :param event: an event to trigger when the authentication attempt is - complete (whether it was successful or not) - :type event: threading.Event - :param fallback: ``True`` if an attempt at an automated "interactive" - password auth should be made if the server doesn't support normal - password auth - :type fallback: bool - :return: list of auth types permissible for the next stage of + :param str username: the username to authenticate as + :param basestring password: the password to authenticate with + :param .threading.Event event: + an event to trigger when the authentication attempt is complete + (whether it was successful or not) + :param bool fallback: + ``True`` if an attempt at an automated "interactive" password auth + should be made if the server doesn't support normal password auth + :return: + `list` of auth types permissible for the next stage of authentication (normally empty) - :rtype: list :raises BadAuthenticationType: if password authentication isn't allowed by the server for this user (and no event was passed in) @@ -1101,16 +1075,14 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - :param username: the username to authenticate as - :type username: string - :param key: the private key to authenticate with - :type key: `.PKey` - :param event: an event to trigger when the authentication attempt is - complete (whether it was successful or not) - :type event: threading.Event - :return: list of auth types permissible for the next stage of + :param str username: the username to authenticate as + :param .PKey key: the private key to authenticate with + :param .threading.Event event: + an event to trigger when the authentication attempt is complete + (whether it was successful or not) + :return: + `list` of auth types permissible for the next stage of authentication (normally empty) - :rtype: list :raises BadAuthenticationType: if public-key authentication isn't allowed by the server for this user (and no event was passed in) @@ -1161,15 +1133,12 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - :param username: the username to authenticate as - :type username: string - :param handler: a handler for responding to server questions - :type handler: callable - :param submethods: a string list of desired submethods (optional) - :type submethods: str - :return: list of auth types permissible for the next stage of + :param str username: the username to authenticate as + :param callable handler: a handler for responding to server questions + :param str submethods: a string list of desired submethods (optional) + :return: + `list` of auth types permissible for the next stage of authentication (normally empty). - :rtype: list :raises BadAuthenticationType: if public-key authentication isn't allowed by the server for this user @@ -1193,8 +1162,7 @@ class Transport (threading.Thread): the `.logging` module for more info.) SSH Channels will log to a sub-channel of the one specified. - :param name: new channel name for logging - :type name: str + :param str name: new channel name for logging .. versionadded:: 1.1 """ @@ -1206,8 +1174,7 @@ class Transport (threading.Thread): """ Return the channel name used for this transport's logging. - :return: channel name. - :rtype: str + :return: channel name as a `str` .. versionadded:: 1.2 """ @@ -1219,9 +1186,9 @@ class Transport (threading.Thread): the logs. Normally you would want this off (which is the default), but if you are debugging something, it may be useful. - :param hexdump: ``True`` to log protocol traffix (in hex) to the log; - ``False`` otherwise. - :type hexdump: bool + :param bool hexdump: + ``True`` to log protocol traffix (in hex) to the log; ``False`` + otherwise. """ self.packetizer.set_hexdump(hexdump) @@ -1230,8 +1197,7 @@ class Transport (threading.Thread): Return ``True`` if the transport is currently logging hex dumps of protocol traffic. - :return: ``True`` if hex dumps are being logged - :rtype: bool + :return: ``True`` if hex dumps are being logged, else ``False``. .. versionadded:: 1.4 """ @@ -1243,9 +1209,9 @@ class Transport (threading.Thread): the transport (ie before calling `connect`, etc). By default, compression is off since it negatively affects interactive sessions. - :param compress: ``True`` to ask the remote client/server to compress - traffic; ``False`` to refuse compression - :type compress: bool + :param bool compress: + ``True`` to ask the remote client/server to compress traffic; + ``False`` to refuse compression .. versionadded:: 1.5.2 """ @@ -1261,8 +1227,9 @@ class Transport (threading.Thread): socket. If the socket-like object has no ``'getpeername'`` method, then ``("unknown", 0)`` is returned. - :return: the address if the remote host, if known - :rtype: tuple(str, int) + :return: + the address of the remote host, if known, as a ``(str, int)`` + tuple. """ gp = getattr(self.sock, 'getpeername', None) if gp is None: @@ -2057,8 +2024,6 @@ class SecurityOptions (object): def __repr__(self): """ Returns a string representation of this object, for debugging. - - :rtype: str """ return '' % repr(self._transport) -- cgit v1.2.3 From dfcd904318ed40af0e79efe72a293d538a3fb716 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 18:55:14 -0800 Subject: Last of the info field stuff --- paramiko/util.py | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/paramiko/util.py b/paramiko/util.py index 0a75da70..e0ef3b7c 100644 --- a/paramiko/util.py +++ b/paramiko/util.py @@ -154,17 +154,13 @@ def generate_key_bytes(hashclass, salt, key, nbytes): through a secure hash into some keyworthy bytes. This specific algorithm is used for encrypting/decrypting private key files. - :param hashclass: class from `Crypto.Hash` that can be used as a secure - hashing function (like ``MD5`` or ``SHA``). - :type hashclass: `Crypto.Hash` - :param salt: data to salt the hash with. - :type salt: string - :param key: human-entered password or passphrase. - :type key: string - :param nbytes: number of bytes to generate. - :type nbytes: int - :return: key data - :rtype: string + :param class hashclass: + class from `Crypto.Hash` that can be used as a secure hashing function + (like ``MD5`` or ``SHA``). + :param str salt: data to salt the hash with. + :param str key: human-entered password or passphrase. + :param int nbytes: number of bytes to generate. + :return: Key data `str` """ keydata = '' digest = '' @@ -185,19 +181,18 @@ def generate_key_bytes(hashclass, salt, key, nbytes): def load_host_keys(filename): """ Read a file of known SSH host keys, in the format used by openssh, and - return a compound dict of ``hostname -> keytype ->`` `PKey `. - The hostname may be an IP address or DNS name. The keytype will be either - ``"ssh-rsa"`` or ``"ssh-dss"``. + return a compound dict of ``hostname -> keytype ->`` `PKey + `. The hostname may be an IP address or DNS name. The + keytype will be either ``"ssh-rsa"`` or ``"ssh-dss"``. This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in ``os.path.expanduser("~/.ssh/known_hosts")``. Since 1.5.3, this is just a wrapper around `.HostKeys`. - :param filename: name of the file to read host keys from - :type filename: str - :return: dict of host keys, indexed by hostname and then keytype - :rtype: dict(hostname, dict(keytype, `PKey `)) + :param str filename: name of the file to read host keys from + :return: + nested dict of `.PKey` objects, indexed by hostname and then keytype """ from paramiko.hostkeys import HostKeys return HostKeys(filename) -- cgit v1.2.3 From d97d28e4e2e0fd6f63c97fd58d3fdb96a5d9e4b4 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Wed, 26 Feb 2014 19:27:37 -0800 Subject: Fix up remaining Sphinx build warnings --- paramiko/server.py | 3 +++ paramiko/sftp_si.py | 2 ++ 2 files changed, 5 insertions(+) diff --git a/paramiko/server.py b/paramiko/server.py index 11562e12..c3f3a0c4 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -46,6 +46,7 @@ class ServerInterface (object): useless), you should also override some of the channel request methods below, which are used to determine which services will be allowed on a given channel: + - `check_channel_pty_request` - `check_channel_shell_request` - `check_channel_subsystem_request` @@ -62,6 +63,7 @@ class ServerInterface (object): The return value should either be ``OPEN_SUCCEEDED`` (or ``0``) to allow the channel request, or one of the following error codes to reject it: + - ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED`` - ``OPEN_FAILED_CONNECT_FAILED`` - ``OPEN_FAILED_UNKNOWN_CHANNEL_TYPE`` @@ -449,6 +451,7 @@ class ServerInterface (object): The return value should either be ``OPEN_SUCCEEDED`` (or ``0``) to allow the channel request, or one of the following error codes to reject it: + - ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED`` - ``OPEN_FAILED_CONNECT_FAILED`` - ``OPEN_FAILED_UNKNOWN_CHANNEL_TYPE`` diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index d4b34268..3786be4e 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -78,6 +78,7 @@ class SFTPServerInterface (object): ``flags`` contains the requested mode for opening (read-only, write-append, etc) as a bitset of flags from the ``os`` module: + - ``os.O_RDONLY`` - ``os.O_WRONLY`` - ``os.O_RDWR`` @@ -85,6 +86,7 @@ class SFTPServerInterface (object): - ``os.O_CREAT`` - ``os.O_TRUNC`` - ``os.O_EXCL`` + (One of ``os.O_RDONLY``, ``os.O_WRONLY``, or ``os.O_RDWR`` will always be set.) -- cgit v1.2.3 From c05b06577785bdf34f1fcd051ecf6d4398d2f77e Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 3 Mar 2014 17:27:10 -0800 Subject: Add new release task w/ API doc prebuilding --- tasks.py | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/tasks.py b/tasks.py index f8f4017d..d48a0de0 100644 --- a/tasks.py +++ b/tasks.py @@ -1,23 +1,26 @@ from os.path import join +from shutil import rmtree, move from invoke import Collection, ctask as task from invocations import docs as _docs +from invocations.packaging import publish d = 'sites' # Usage doc/API site (published as docs.paramiko.org) -path = join(d, 'docs') +docs_path = join(d, 'docs') +docs_build = join(docs_path, '_build') docs = Collection.from_module(_docs, name='docs', config={ - 'sphinx.source': path, - 'sphinx.target': join(path, '_build'), + 'sphinx.source': docs_path, + 'sphinx.target': docs_build, }) # Main/about/changelog site ((www.)?paramiko.org) -path = join(d, 'www') +www_path = join(d, 'www') www = Collection.from_module(_docs, name='www', config={ - 'sphinx.source': path, - 'sphinx.target': join(path, '_build'), + 'sphinx.source': www_path, + 'sphinx.target': join(www_path, '_build'), }) @@ -31,4 +34,14 @@ def coverage(ctx): ctx.run("coverage run --source=paramiko test.py --verbose") -ns = Collection(test, coverage, docs=docs, www=www) +# Until we stop bundling docs w/ releases. Need to discover use cases first. +@task('docs') # Will invoke the API doc site build +def release(ctx): + # Move the built docs into where Epydocs used to live + rmtree('docs') + move(docs_build, 'docs') + # Publish + publish(ctx) + + +ns = Collection(test, coverage, release, docs=docs, www=www) -- cgit v1.2.3 From 83f09e634f4e57707c8423423f5cb8ad74d731bd Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 3 Mar 2014 17:30:15 -0800 Subject: Changelog re #256 --- sites/www/changelog.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst index fa58c5f6..fa43a379 100644 --- a/sites/www/changelog.rst +++ b/sites/www/changelog.rst @@ -2,6 +2,9 @@ Changelog ========= +* :support:`256` Convert API documentation to Sphinx, yielding a new API + docs website to replace the old Epydoc one. Thanks to Olle Lundberg for the + initial conversion work. * :bug:`-` Use constant-time hash comparison operations where possible, to protect against `timing-based attacks `_. Thanks to Alex Gaynor -- cgit v1.2.3 From 1038cfe7dd4cfb3fc8f4c09442f4b8ff9443b67b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 3 Mar 2014 18:09:10 -0800 Subject: No more need for the fabfile, everything uses invoke now --- fabfile.py | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 fabfile.py diff --git a/fabfile.py b/fabfile.py deleted file mode 100644 index 29394f94..00000000 --- a/fabfile.py +++ /dev/null @@ -1,13 +0,0 @@ -from fabric.api import task, sudo, env -from fabric.contrib.project import rsync_project - - -@task -def upload_docs(): - target = "/var/www/paramiko.org" - staging = "/tmp/paramiko_docs" - sudo("mkdir -p %s" % staging) - sudo("chown -R %s %s" % (env.user, staging)) - sudo("rm -rf %s/*" % target) - rsync_project(local_dir='docs/', remote_dir=staging, delete=True) - sudo("cp -R %s/* %s/" % (staging, target)) -- cgit v1.2.3 From 056323979d7a2a5623bc2c3845fde9888093b4f2 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 3 Mar 2014 18:22:33 -0800 Subject: Re-enable Intersphinx from www -> docs --- sites/www/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sites/www/conf.py b/sites/www/conf.py index 481acdff..1c6c9254 100644 --- a/sites/www/conf.py +++ b/sites/www/conf.py @@ -24,10 +24,10 @@ extensions.append('sphinx.ext.intersphinx') target = join(dirname(__file__), '..', 'docs', '_build') if os.environ.get('READTHEDOCS') == 'True': # TODO: switch to docs.paramiko.org post go-live of sphinx API docs - target = 'http://paramiko-docs.readthedocs.org/en/latest/' -#intersphinx_mapping = { -# 'docs': (target, None), -#} + target = 'http://docs.paramiko.org/en/latest/' +intersphinx_mapping = { + 'docs': (target, None), +} # Sister-site links to API docs html_theme_options['extra_nav_links'] = { -- cgit v1.2.3 From c0fcd11ea0074d8cd019ed7087282754ea3ff792 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 3 Mar 2014 18:22:44 -0800 Subject: Herpaderp, copy not move --- tasks.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/tasks.py b/tasks.py index d48a0de0..c9844780 100644 --- a/tasks.py +++ b/tasks.py @@ -1,5 +1,6 @@ +from os import mkdir from os.path import join -from shutil import rmtree, move +from shutil import rmtree, copytree from invoke import Collection, ctask as task from invocations import docs as _docs @@ -38,8 +39,9 @@ def coverage(ctx): @task('docs') # Will invoke the API doc site build def release(ctx): # Move the built docs into where Epydocs used to live - rmtree('docs') - move(docs_build, 'docs') + target = 'docs' + rmtree(target, ignore_errors=True) + copytree(docs_build, target) # Publish publish(ctx) -- cgit v1.2.3