diff options
author | Olle Lundberg <olle.lundberg@klarna.com> | 2014-01-23 11:32:59 +0100 |
---|---|---|
committer | Olle Lundberg <olle.lundberg@klarna.com> | 2014-01-23 11:32:59 +0100 |
commit | 24635609dc5ab8aff2e7fa3f34c4993cbc424579 (patch) | |
tree | 7be1e6ee8e6df7e90c188cd8949cbb8fba9e372e /paramiko/proxy.py | |
parent | dde21a7de09bd92a6a362a26009a56a942b3d246 (diff) | |
download | paramiko-24635609dc5ab8aff2e7fa3f34c4993cbc424579.tar.gz |
Epydoc -> Sphinx.
Diffstat (limited to 'paramiko/proxy.py')
-rw-r--r-- | paramiko/proxy.py | 22 |
1 files changed, 11 insertions, 11 deletions
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) |