diff options
| author | Thomas Kluyver <takowl@gmail.com> | 2013-09-25 15:05:45 -0700 |
|---|---|---|
| committer | Thomas Kluyver <takowl@gmail.com> | 2013-09-25 15:05:45 -0700 |
| commit | 137f605dd0f25511e83e1bfb455676e2498fe7a2 (patch) | |
| tree | 0a437c2841c55b874a3a3d966186d6663453c794 /doc/api | |
| parent | 5a38ba61cebf6d73627a522bf371679762dd7651 (diff) | |
| download | pexpect-git-137f605dd0f25511e83e1bfb455676e2498fe7a2.tar.gz | |
Document pxssh module
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/index.rst | 3 | ||||
| -rw-r--r-- | doc/api/pxssh.rst | 29 |
2 files changed, 31 insertions, 1 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst index 29303fd..3b245d1 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -5,4 +5,5 @@ API documentation :maxdepth: 2 pexpect - fdpexpect
\ No newline at end of file + fdpexpect + pxssh
\ No newline at end of file diff --git a/doc/api/pxssh.rst b/doc/api/pxssh.rst new file mode 100644 index 0000000..91b7fe0 --- /dev/null +++ b/doc/api/pxssh.rst @@ -0,0 +1,29 @@ +pxssh module +============ + +.. automodule:: pexpect.pxssh + +.. autoclass:: ExceptionPxssh + +pxssh class +----------- + +.. autoclass:: pxssh + + .. automethod:: __init__ + + .. attribute:: auto_prompt_reset + + Set this to False to prevent :meth:`login` from setting a unique prompt + which can easily be located. + + .. attribute:: PROMPT + + The regex pattern to search for to find the prompt. If + :attr:`auto_prompt_reset` is False, you must set this attribute manually. + + .. automethod:: login + .. automethod:: logout + .. automethod:: prompt + .. automethod:: sync_original_prompt + .. automethod:: set_unique_prompt
\ No newline at end of file |