Ñò
Ã#xPc @ s” d Z d d k l Z d d k l Z d d k l Z l Z d d k l Z d e f d „ ƒ YZ
d e
f d „ ƒ YZ d
Z d e
f d „ ƒ YZ
e
d
d e d ƒ ƒZ e
d e e f e d ƒ ƒ Z e
d e e d ƒ d d g ƒZ e e f Z e e d
ƒ e f Z e e
d
ƒ e
d e e d ƒ ƒ e
d e e d ƒ ƒ f Z e e
d
e e d ƒ ƒ e f Z e e
d
e e d ƒ ƒ e f Z e Z d S( s&
Simple description of return values.
iÿÿÿÿ( t getdoc( t NoneType( t ReadOnlyt lock( t _t Outputc B sA e Z d Z d Z d Z d Z g Z d d g d „ Z d „ Z RS( s
Simple description of a member in the return value ``dict``.
This class controls both the type of object being returned by
a command as well as how the output will be displayed.
For example, this class defines two return results: an entry
and a value.
>>> from ipalib import crud, output
>>> class user(crud.Update):
...
... has_output = (
... output.Entry('result'),
... output.value,
... )
The order of the values in has_output controls the order of output.
If you have values that you don't want to be printed then add
``'no_display'`` to flags.
The difference between ``'no_display'`` and ``'no_output'`` is
that ``'no_output'`` will prevent a Param value from being returned
at all. ``'no_display'`` will cause the API to return a value, it
simply won't be displayed to the user. This is so some things may
be returned that while not interesting to us, but may be to others.
>>> from ipalib import crud, output
>>> myvalue = output.Output('myvalue', unicode,
... 'Do not print this value', flags=['no_display'],
... )
>>> class user(crud.Update):
...
... has_output = (
... output.Entry('result'),
... myvalue,
... )
c C sT | | _ | d j o
| | _ n | d j o
| | _ n | | _ t | ƒ d S( N( t namet Nonet typet doct flagsR ( t selfR R R R
( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyt __init__K s
c C s# d | i i | i | i | i f S( Ns %s(%r, %r, %r)( t __class__t __name__R R R ( R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyt __repr__T s N(
R t
__module__t __doc__R R t validateR R
R R ( ( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyR s & t Entryc B s e Z e Z e d ƒ Z RS( s' A dictionary representing an LDAP entry( R R t dictR R R ( ( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyR Z s sP %s.validate_output() => %s.validate():
output[%r][%d]: need a %r; got a %r: %rt
ListOfEntriesc B s) e Z e e f Z e d ƒ Z d „ Z RS( s A list of LDAP entriesc
C sl xe t | ƒ D]W \ } } t | t ƒ p; t t | i | i i | i | t t | ƒ | f ƒ ‚ q
q
Wd S( N( t enumeratet
isinstanceR t TypeErrort emsgR R
R R ( R t cmdt entriest it entry( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyR f s
( R R t listt tupleR R R R ( ( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyR b s t resultR s* All commands should at least have a resultt summarys- User-friendly description of action performedt values: The primary_key value of the entry, e.g. 'jdoe' for a userR
t
no_displayt counts Number of entries returnedt truncateds% True if not all results were returneds List of deletions that faileds' True means the operation was successfulN( R t inspectR t typesR t plugableR R t textR R R R R R t unicodeR! R" t standardt standard_entryt intt boolt standard_list_of_entriesR t standard_deletet standard_booleant standard_value( ( ( s1 /usr/lib/python2.6/site-packages/ipalib/output.pyt s: <