IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

371: Added examples to parse_param_spec() docstring and changed syntax guide into a reStructuredText table

Browse Source
This commit is contained in:
Jason Gerard DeRose 2008-09-26 23:41:51 +00:00
parent 7bbd81d831
commit 031daabcc4
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
ipalib/frontend.py
View File

@ -152,10 +152,25 @@ def parse_param_spec(spec):
required, and whether the param is multivalue according the following
syntax:
name => required=True, multivalue=False
name? => required=False, multivalue=False
name+ => required=True, multivalue=True
name* => required=False, multivalue=True
====== ===== ======== ==========
Spec Name Required Multivalue
====== ===== ======== ==========
'var' 'var' True False
'var?' 'var' False False
'var*' 'var' False True
'var+' 'var' True True
====== ===== ======== ==========
For example,
>>> parse_param_spec('login')
('login', {'required': True, 'multivalue': False})
>>> parse_param_spec('gecos?')
('gecos', {'required': False, 'multivalue': False})
>>> parse_param_spec('telephone_numbers*')
('telephone_numbers', {'required': False, 'multivalue': True})
>>> parse_param_spec('group+')
('group', {'required': True, 'multivalue': True})
:param spec: A spec string.
"""