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

Generate same API.txt under Python 2 and 3

Browse Source 
Use Python 3's reprlib with customizations to create same API.txt under
Python 2 and 3. Some plugins have been slightly altered to use stable
sorting for dynamically created parameter lists.

Signed-off-by: Christian Heimes <cheimes@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
This commit is contained in:
Christian Heimes
2018-02-14 16:59:50 +01:00
parent 86a6fdcc43
commit 8ffa33c24e
8 changed files with 111 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
API.txt
View File

@@ -2973,7 +2973,7 @@ option: Int('ipabaserid?', cli_name='rid_base')
option: Int('ipaidrangesize', cli_name='range_size')
option: Str('ipanttrusteddomainname?', cli_name='dom_name')
option: Str('ipanttrusteddomainsid?', cli_name='dom_sid')
option: StrEnum('iparangetype?', cli_name='type', values=[u'ipa-ad-trust-posix', u'ipa-ad-trust', u'ipa-local'])
option: StrEnum('iparangetype?', cli_name='type', values=[u'ipa-ad-trust', u'ipa-ad-trust-posix', u'ipa-local'])
option: Int('ipasecondarybaserid?', cli_name='secondary_rid_base')
option: Flag('raw', autofill=True, cli_name='raw', default=False)
option: Str('setattr*', cli_name='setattr')
@@ -2998,7 +2998,7 @@ option: Int('ipabaseid?', autofill=False, cli_name='base_id')
option: Int('ipabaserid?', autofill=False, cli_name='rid_base')
option: Int('ipaidrangesize?', autofill=False, cli_name='range_size')
option: Str('ipanttrusteddomainsid?', autofill=False, cli_name='dom_sid')
option: StrEnum('iparangetype?', autofill=False, cli_name='type', values=[u'ipa-ad-trust-posix', u'ipa-ad-trust', u'ipa-local'])
option: StrEnum('iparangetype?', autofill=False, cli_name='type', values=[u'ipa-ad-trust', u'ipa-ad-trust-posix', u'ipa-local'])
option: Int('ipasecondarybaserid?', autofill=False, cli_name='secondary_rid_base')
option: Flag('pkey_only?', autofill=True, default=False)
option: Flag('raw', autofill=True, cli_name='raw', default=False)
@@ -3255,7 +3255,7 @@ option: Str('groupignoreobjectclass*', autofill=True, cli_name='group_ignore_obj
option: Str('groupobjectclass+', autofill=True, cli_name='group_objectclass', default=[u'groupOfUniqueNames', u'groupOfNames'])
option: Flag('groupoverwritegid', autofill=True, cli_name='group_overwrite_gid', default=False)
option: StrEnum('schema?', autofill=True, cli_name='schema', default=u'RFC2307bis', values=[u'RFC2307bis', u'RFC2307'])
option: StrEnum('scope', autofill=True, cli_name='scope', default=u'onelevel', values=[u'base', u'subtree', u'onelevel'])
option: StrEnum('scope', autofill=True, cli_name='scope', default=u'onelevel', values=[u'base', u'onelevel', u'subtree'])
option: Bool('use_def_group?', autofill=True, cli_name='use_default_group', default=True)
option: DNParam('usercontainer', autofill=True, cli_name='user_container', default=ipapython.dn.DN('ou=people'))
option: Str('userignoreattribute*', autofill=True, cli_name='user_ignore_attribute', default=[])
@@ -5721,7 +5721,7 @@ option: Int('base_id?', cli_name='base_id')
option: Bool('bidirectional?', cli_name='two_way', default=False)
option: Bool('external?', cli_name='external', default=False)
option: Int('range_size?', cli_name='range_size')
option: StrEnum('range_type?', cli_name='range_type', values=[u'ipa-ad-trust-posix', u'ipa-ad-trust'])
option: StrEnum('range_type?', cli_name='range_type', values=[u'ipa-ad-trust', u'ipa-ad-trust-posix'])
option: Flag('raw', autofill=True, cli_name='raw', default=False)
option: Str('realm_admin?', cli_name='admin')
option: Password('realm_passwd?', cli_name='password', confirm=False)

3
ipalib/output.py
View File

@@ -25,6 +25,7 @@ import six
from ipalib.plugable import ReadOnly, lock
from ipalib.capabilities import client_has_capability
from ipalib.text import _
from ipalib.util import apirepr
if six.PY3:
unicode = str
@@ -98,7 +99,7 @@ class Output(ReadOnly):
if not value:
continue
if isinstance(value, tuple):
value = repr(list(value))
value = apirepr(list(value))
else:
value = repr(value)
yield '%s=%s' % (key, value)

9
ipalib/parameters.py
View File

@@ -123,7 +123,7 @@ from ipalib.text import Gettext, FixMe
from ipalib.util import json_serialize, validate_idna_domain
from ipalib.x509 import (
load_der_x509_certificate, IPACertificate, default_backend)
from ipalib.util import strip_csr_header
from ipalib.util import strip_csr_header, apirepr
from ipapython import kerberos
from ipapython.dn import DN
from ipapython.dnsutil import DNSName
@@ -600,9 +600,12 @@ class Param(ReadOnly):
elif isinstance(value, six.integer_types):
value = str(value)
elif isinstance(value, (tuple, set, frozenset)):
value = repr(list(value))
else:
value = apirepr(list(value))
elif key == 'cli_name':
# always represented as native string
value = repr(value)
else:
value = apirepr(value)
yield '%s=%s' % (key, value)
def __call__(self, value, **kw):

38
ipalib/util.py
View File

@@ -66,6 +66,11 @@ from ipapython.dnsutil import DNSName
from ipapython.dnsutil import resolve_ip_addresses
from ipapython.admintool import ScriptError
if sys.version_info >= (3, 2):
import reprlib # pylint: disable=import-error
else:
reprlib = None
if six.PY3:
unicode = str
@@ -1213,3 +1218,36 @@ def open_in_pager(data):
pager_process.communicate()
except IOError:
pass
if reprlib is not None:
class APIRepr(reprlib.Repr):
builtin_types = {
bool, int, float,
str, bytes,
dict, tuple, list, set, frozenset,
type(None),
}
def __init__(self):
super(APIRepr, self).__init__()
# no limitation
for k, v in self.__dict__.items():
if isinstance(v, int):
setattr(self, k, sys.maxsize)
def repr_str(self, x, level):
"""Output with u'' prefix"""
return 'u' + repr(x)
def repr_type(self, x, level):
if x is str:
return "<type 'unicode'>"
if x in self.builtin_types:
return "<type '{}'>".format(x.__name__)
else:
return repr(x)
apirepr = APIRepr().repr
else:
apirepr = repr

7
ipaserver/plugins/idrange.py
View File

@@ -244,13 +244,14 @@ class idrange(LDAPObject):
label=_('Range type'),
cli_name='type',
doc=(_('ID range type, one of {vals}'
.format(vals=', '.join(range_types.keys())))),
values=tuple(range_types.keys()),
.format(vals=', '.join(sorted(range_types))))),
values=sorted(range_types),
flags=['no_update'],
)
)
def handle_iparangetype(self, entry_attrs, options, keep_objectclass=False):
def handle_iparangetype(self, entry_attrs, options,
keep_objectclass=False):
if not any((options.get('pkey_only', False),
options.get('raw', False))):
range_type = entry_attrs['iparangetype'][0]

6
ipaserver/plugins/migration.py
View File

@@ -644,9 +644,9 @@ class migrate_ds(Command):
StrEnum('scope',
cli_name='scope',
label=_('Search scope'),
doc=_('LDAP search scope for users and groups: base, onelevel, or '
'subtree. Defaults to onelevel'),
values=tuple(_supported_scopes.keys()),
doc=_('LDAP search scope for users and groups: base, '
'onelevel, or subtree. Defaults to onelevel'),
values=sorted(_supported_scopes),
default=_default_scope,
autofill=True,
),

18
ipaserver/plugins/trust.py
View File

@@ -665,7 +665,8 @@ ipa idrange-del before retrying the command with the desired range type.
),
Str('realm_server?',
cli_name='server',
label=_('Domain controller for the Active Directory domain (optional)'),
label=_('Domain controller for the Active Directory domain '
'(optional)'),
),
Password('trust_secret?',
cli_name='trust_secret',
@@ -674,29 +675,32 @@ ipa idrange-del before retrying the command with the desired range type.
),
Int('base_id?',
cli_name='base_id',
label=_('First Posix ID of the range reserved for the trusted domain'),
label=_('First Posix ID of the range reserved for the '
'trusted domain'),
),
Int('range_size?',
cli_name='range_size',
label=_('Size of the ID range reserved for the trusted domain'),
label=_('Size of the ID range reserved for the trusted domain')
),
StrEnum('range_type?',
label=_('Range type'),
cli_name='range_type',
doc=(_('Type of trusted domain ID range, one of {vals}'
.format(vals=', '.join(range_types.keys())))),
values=tuple(range_types.keys()),
.format(vals=', '.join(sorted(range_types))))),
values=sorted(range_types),
),
Bool('bidirectional?',
label=_('Two-way trust'),
cli_name='two_way',
doc=(_('Establish bi-directional trust. By default trust is inbound one-way only.')),
doc=(_('Establish bi-directional trust. By default trust is '
'inbound one-way only.')),
default=False,
),
Bool('external?',
label=_('External trust'),
cli_name='external',
doc=(_('Establish external trust to a domain in another forest. The trust is not transitive beyond the domain.')),
doc=_('Establish external trust to a domain in another forest. '
'The trust is not transitive beyond the domain.'),
default=False,
),
)

8
ipatests/test_ipalib/test_output.py
View File

@@ -53,14 +53,18 @@ class test_Output(ClassChecker):
o = self.cls('aye')
assert repr(o) == "Output('aye')"
o = self.cls('aye', type=int, doc='An A, aye?')
assert repr(o) == "Output('aye', type=[%r], doc='An A, aye?')" % int
assert repr(o) == (
"Output('aye', type=[<type 'int'>], doc='An A, aye?')"
)
class Entry(self.cls):
pass
o = Entry('aye')
assert repr(o) == "Entry('aye')"
o = Entry('aye', type=int, doc='An A, aye?')
assert repr(o) == "Entry('aye', type=[%r], doc='An A, aye?')" % int
assert repr(o) == (
"Entry('aye', type=[<type 'int'>], doc='An A, aye?')"
)
class test_ListOfEntries(ClassChecker):