Home       Trees       Index       Help   
Package paramiko :: Module server :: Class InteractiveQuery
[show private | hide private]
[frames | no frames]

Type InteractiveQuery

object --+
         |
        InteractiveQuery

A query (set of prompts) for a user during interactive authentication.
Method Summary
  __init__(self, name, instructions, *prompts)
Create a new interactive query to send to the client.
  add_prompt(self, prompt, echo)
Add a prompt to this query.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

__init__(self, name='', instructions='', *prompts)
(Constructor)

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.
Parameters:
name - name of this query
           (type=str)
instructions - user instructions (usually short) about this query
           (type=str)
Overrides:
__builtin__.object.__init__

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.
Parameters:
prompt - the user prompt
           (type=str)
echo - True (default) if the user's response should be echoed; False if not (for a password or similar)
           (type=bool)

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005 http://epydoc.sf.net