277: Added public.generate_argument() function; added corresponding unit tests

2 files changed, 39 insertions, 0 deletions

diff --git a/ipalib/public.py b/ipalib/public.py
index fb7a80b9..772490d0 100644
--- a/ipalib/public.py
+++ b/ipalib/public.py
@@ -198,6 +198,21 @@ class Option(plugable.ReadOnly):
         )
 
 
+def generate_argument(name):
+    """
+    Returns an `Option` instance using argument ``name``.
+    """
+    if name.endswith('?'):
+        kw = dict(required=False, multivalue=False)
+    elif name.endswith('*'):
+        kw = dict(required=False, multivalue=True)
+    elif name.endswith('+'):
+        kw = dict(required=True, multivalue=True)
+    else:
+        kw = dict(required=True, multivalue=False)
+    return Option(name.rstrip('?*+'), ipa_types.Unicode(), **kw)
+
+
 class Command(plugable.Plugin):
     __public__ = frozenset((
         'get_default',
diff --git a/ipalib/tests/test_public.py b/ipalib/tests/test_public.py
index 73521e91..3841d384 100644
--- a/ipalib/tests/test_public.py
+++ b/ipalib/tests/test_public.py
@@ -309,6 +309,30 @@ class test_Option(ClassChecker):
         assert o.get_values() == values
 
 
+def test_generate_argument():
+    """
+    Tests the `public.generate_argument` function.
+    """
+    f = public.generate_argument
+    for name in ['arg', 'arg?', 'arg*', 'arg+']:
+        o = f(name)
+        assert type(o) is public.Option
+        assert type(o.type) is ipa_types.Unicode
+        assert o.name == 'arg'
+    o = f('arg')
+    assert o.required is True
+    assert o.multivalue is False
+    o = f('arg?')
+    assert o.required is False
+    assert o.multivalue is False
+    o = f('arg*')
+    assert o.required is False
+    assert o.multivalue is True
+    o = f('arg+')
+    assert o.required is True
+    assert o.multivalue is True
+
+
 class test_Command(ClassChecker):
     """
     Tests the `public.Command` class.