From bce3cd945c66e8e8dc49382356348745eefe8c59 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Tue, 22 Nov 2011 17:04:03 +0200 Subject: Rename included snippets to avoid problems with pylint --- doc/guide/guide.org | 4 +- doc/guide/role.py | 140 -------------------------------------------------- doc/guide/role.py.txt | 140 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/guide/wsgi.py | 26 ---------- doc/guide/wsgi.py.txt | 26 ++++++++++ 5 files changed, 168 insertions(+), 168 deletions(-) delete mode 100644 doc/guide/role.py create mode 100644 doc/guide/role.py.txt delete mode 100644 doc/guide/wsgi.py create mode 100644 doc/guide/wsgi.py.txt (limited to 'doc') diff --git a/doc/guide/guide.org b/doc/guide/guide.org index 0d6430be3..68858166e 100644 --- a/doc/guide/guide.org +++ b/doc/guide/guide.org @@ -437,7 +437,7 @@ backend. As an example, let's see how role is defined. This is fully functioning plugin that provides operations on roles: -#+INCLUDE "role.py" src python -n +#+INCLUDE "role.py.txt" src python -n * Extending existing object As said earlier, until API instance is finalized, objects, methods, and commands can be @@ -595,7 +595,7 @@ tool, ~ipa~. Web UI communicates with a FreeIPA server running WSGI application accepts JSON-formatted requests and translates them to calls to FreeIPA plugins. A following code in ~install/share/ui/wsgi.py~ defines FreeIPA web application: -#+INCLUDE "wsgi.py" src python -n -r +#+INCLUDE "wsgi.py.txt" src python -n -r At line [[(wsgi-app-bootstrap)]] we set up FreeIPA framework with server context. This means plugins are loaded and initialized from following locations: diff --git a/doc/guide/role.py b/doc/guide/role.py deleted file mode 100644 index 068fd84bb..000000000 --- a/doc/guide/role.py +++ /dev/null @@ -1,140 +0,0 @@ -from ipalib.plugins.baseldap import * -from ipalib import api, Str, _, ngettext -from ipalib import Command -from ipalib.plugins import privilege - -class role(LDAPObject): - """ - Role object. - """ - container_dn = api.env.container_rolegroup - object_name = _('role') - object_name_plural = _('roles') - object_class = ['groupofnames', 'nestedgroup'] - default_attributes = ['cn', 'description', 'member', 'memberof', - 'memberindirect', 'memberofindirect', - ] - attribute_members = { - 'member': ['user', 'group', 'host', 'hostgroup'], - 'memberof': ['privilege'], - } - reverse_members = { - 'member': ['privilege'], - } - rdnattr='cn' - - label = _('Roles') - label_singular = _('Role') - - takes_params = ( - Str('cn', - cli_name='name', - label=_('Role name'), - primary_key=True, - ), - Str('description', - cli_name='desc', - label=_('Description'), - doc=_('A description of this role-group'), - ), - ) - -api.register(role) - - -class role_add(LDAPCreate): - __doc__ = _('Add a new role.') - - msg_summary = _('Added role "%(value)s"') - -api.register(role_add) - - -class role_del(LDAPDelete): - __doc__ = _('Delete a role.') - - msg_summary = _('Deleted role "%(value)s"') - -api.register(role_del) - - -class role_mod(LDAPUpdate): - __doc__ = _('Modify a role.') - - msg_summary = _('Modified role "%(value)s"') - -api.register(role_mod) - - -class role_find(LDAPSearch): - __doc__ = _('Search for roles.') - - msg_summary = ngettext( - '%(count)d role matched', '%(count)d roles matched', 0 - ) - -api.register(role_find) - - -class role_show(LDAPRetrieve): - __doc__ = _('Display information about a role.') - -api.register(role_show) - - -class role_add_member(LDAPAddMember): - __doc__ = _('Add members to a role.') - -api.register(role_add_member) - - -class role_remove_member(LDAPRemoveMember): - __doc__ = _('Remove members from a role.') - -api.register(role_remove_member) - - -class role_add_privilege(LDAPAddReverseMember): - __doc__ = _('Add privileges to a role.') - - show_command = 'role_show' - member_command = 'privilege_add_member' - reverse_attr = 'privilege' - member_attr = 'role' - - has_output = ( - output.Entry('result'), - output.Output('failed', - type=dict, - doc=_('Members that could not be added'), - ), - output.Output('completed', - type=int, - doc=_('Number of privileges added'), - ), - ) - -api.register(role_add_privilege) - - -class role_remove_privilege(LDAPRemoveReverseMember): - __doc__ = _('Remove privileges from a role.') - - show_command = 'role_show' - member_command = 'privilege_remove_member' - reverse_attr = 'privilege' - member_attr = 'role' - - has_output = ( - output.Entry('result'), - output.Output('failed', - type=dict, - doc=_('Members that could not be added'), - ), - output.Output('completed', - type=int, - doc=_('Number of privileges removed'), - ), - ) - -api.register(role_remove_privilege) diff --git a/doc/guide/role.py.txt b/doc/guide/role.py.txt new file mode 100644 index 000000000..068fd84bb --- /dev/null +++ b/doc/guide/role.py.txt @@ -0,0 +1,140 @@ +from ipalib.plugins.baseldap import * +from ipalib import api, Str, _, ngettext +from ipalib import Command +from ipalib.plugins import privilege + +class role(LDAPObject): + """ + Role object. + """ + container_dn = api.env.container_rolegroup + object_name = _('role') + object_name_plural = _('roles') + object_class = ['groupofnames', 'nestedgroup'] + default_attributes = ['cn', 'description', 'member', 'memberof', + 'memberindirect', 'memberofindirect', + ] + attribute_members = { + 'member': ['user', 'group', 'host', 'hostgroup'], + 'memberof': ['privilege'], + } + reverse_members = { + 'member': ['privilege'], + } + rdnattr='cn' + + label = _('Roles') + label_singular = _('Role') + + takes_params = ( + Str('cn', + cli_name='name', + label=_('Role name'), + primary_key=True, + ), + Str('description', + cli_name='desc', + label=_('Description'), + doc=_('A description of this role-group'), + ), + ) + +api.register(role) + + +class role_add(LDAPCreate): + __doc__ = _('Add a new role.') + + msg_summary = _('Added role "%(value)s"') + +api.register(role_add) + + +class role_del(LDAPDelete): + __doc__ = _('Delete a role.') + + msg_summary = _('Deleted role "%(value)s"') + +api.register(role_del) + + +class role_mod(LDAPUpdate): + __doc__ = _('Modify a role.') + + msg_summary = _('Modified role "%(value)s"') + +api.register(role_mod) + + +class role_find(LDAPSearch): + __doc__ = _('Search for roles.') + + msg_summary = ngettext( + '%(count)d role matched', '%(count)d roles matched', 0 + ) + +api.register(role_find) + + +class role_show(LDAPRetrieve): + __doc__ = _('Display information about a role.') + +api.register(role_show) + + +class role_add_member(LDAPAddMember): + __doc__ = _('Add members to a role.') + +api.register(role_add_member) + + +class role_remove_member(LDAPRemoveMember): + __doc__ = _('Remove members from a role.') + +api.register(role_remove_member) + + +class role_add_privilege(LDAPAddReverseMember): + __doc__ = _('Add privileges to a role.') + + show_command = 'role_show' + member_command = 'privilege_add_member' + reverse_attr = 'privilege' + member_attr = 'role' + + has_output = ( + output.Entry('result'), + output.Output('failed', + type=dict, + doc=_('Members that could not be added'), + ), + output.Output('completed', + type=int, + doc=_('Number of privileges added'), + ), + ) + +api.register(role_add_privilege) + + +class role_remove_privilege(LDAPRemoveReverseMember): + __doc__ = _('Remove privileges from a role.') + + show_command = 'role_show' + member_command = 'privilege_remove_member' + reverse_attr = 'privilege' + member_attr = 'role' + + has_output = ( + output.Entry('result'), + output.Output('failed', + type=dict, + doc=_('Members that could not be added'), + ), + output.Output('completed', + type=int, + doc=_('Number of privileges removed'), + ), + ) + +api.register(role_remove_privilege) diff --git a/doc/guide/wsgi.py b/doc/guide/wsgi.py deleted file mode 100644 index 2c4a9aaaa..000000000 --- a/doc/guide/wsgi.py +++ /dev/null @@ -1,26 +0,0 @@ -from ipalib import api -from ipalib.config import Env -from ipalib.constants import DEFAULT_CONFIG - -# Determine what debug level is configured. We can only do this -# by reading in the configuration file(s). The server always reads -# default.conf and will also read in `context'.conf. -env = Env() -env._bootstrap(context='server', log=None) -env._finalize_core(**dict(DEFAULT_CONFIG)) - -# Initialize the API with the proper debug level -api.bootstrap(context='server', debug=env.debug, log=None) (ref:wsgi-app-bootstrap) -try: - api.finalize() (ref:wsgi-app-finalize) -except StandardError, e: - api.log.error('Failed to start IPA: %s' % e) -else: - api.log.info('*** PROCESS START ***') - - # This is the WSGI callable: - def application(environ, start_response): (ref:wsgi-app-start) - if not environ['wsgi.multithread']: - return api.Backend.session(environ, start_response) - else: - api.log.error("IPA does not work with the threaded MPM, use the pre-fork MPM") (ref:wsgi-app-end) diff --git a/doc/guide/wsgi.py.txt b/doc/guide/wsgi.py.txt new file mode 100644 index 000000000..2c4a9aaaa --- /dev/null +++ b/doc/guide/wsgi.py.txt @@ -0,0 +1,26 @@ +from ipalib import api +from ipalib.config import Env +from ipalib.constants import DEFAULT_CONFIG + +# Determine what debug level is configured. We can only do this +# by reading in the configuration file(s). The server always reads +# default.conf and will also read in `context'.conf. +env = Env() +env._bootstrap(context='server', log=None) +env._finalize_core(**dict(DEFAULT_CONFIG)) + +# Initialize the API with the proper debug level +api.bootstrap(context='server', debug=env.debug, log=None) (ref:wsgi-app-bootstrap) +try: + api.finalize() (ref:wsgi-app-finalize) +except StandardError, e: + api.log.error('Failed to start IPA: %s' % e) +else: + api.log.info('*** PROCESS START ***') + + # This is the WSGI callable: + def application(environ, start_response): (ref:wsgi-app-start) + if not environ['wsgi.multithread']: + return api.Backend.session(environ, start_response) + else: + api.log.error("IPA does not work with the threaded MPM, use the pre-fork MPM") (ref:wsgi-app-end) -- cgit