Improve documentation
This commit adds a lot of documentation including block diagramms for message flows.
This commit is contained in:
parent
09cfc6a373
commit
5dc3549896
11 changed files with 853 additions and 87 deletions
|
|
@ -9,7 +9,7 @@ from celery import shared_task
|
|||
|
||||
|
||||
@shared_task
|
||||
def create_ldap_group(groupname, gid, descr):
|
||||
def create_ldap_group(groupname, gid, description):
|
||||
"""
|
||||
This task creates an :py:class:`LDAP group <ldapentities.models.LdapGroup>`
|
||||
if it does not exist yet.
|
||||
|
|
@ -19,9 +19,12 @@ def create_ldap_group(groupname, gid, descr):
|
|||
|
||||
:param str groupname: the group name
|
||||
:param int gid: the group id
|
||||
:param str descr: description text for the group
|
||||
:return: the distinguished name of the group
|
||||
:rtype: str
|
||||
:param str description: description text for the group
|
||||
:return: dictionary containing groupname, gid, description and
|
||||
:py:const:`group_dn` set to the distinguished name of the newly created
|
||||
or existing LDAP group
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
||||
|
|
@ -45,8 +48,10 @@ def create_ldap_user(username, uid, gid, gecos, homedir, shell, password):
|
|||
is passed the password is not touched
|
||||
:raises celery.exceptions.Reject: if the specified primary group does not
|
||||
exist
|
||||
:return: the distinguished name of the user
|
||||
:rtype: str
|
||||
:return: dictionary containing username, uid, gid, gecos, homedir, shell,
|
||||
password and :py:const:`user_dn` set to the distinguished name of the
|
||||
newly created or existing LDAP user
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
|
@ -59,8 +64,10 @@ def set_ldap_user_password(username, password):
|
|||
|
||||
:param str username: the user name
|
||||
:param str password: teh clear text password
|
||||
:return: :py:const:`True` if the password has been set, :py:const:`False`
|
||||
if the user does not exist.
|
||||
:return: dictionary containing the username and a flag
|
||||
:py:const:`password_set` that is set to :py:const:`True` if the
|
||||
password has been set, :py:const:`False` if the user does not exist.
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
|
@ -76,8 +83,10 @@ def add_ldap_user_to_group(username, groupname):
|
|||
:param str groupname: the group name
|
||||
:raises celery.exceptions.Retry: if the user does not exist yet,
|
||||
:py:func:`create_ldap_user` should be called before
|
||||
:return: True if the user has been added to the group otherwise False
|
||||
:rtype: boolean
|
||||
:return: dictionary containing the username, groupname and a flag
|
||||
:py:const`added` that is as a :py:const:`True` if the user has been
|
||||
added to the group otherwise to :py:const:`False`
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
|
@ -89,20 +98,48 @@ def remove_ldap_user_from_group(username, groupname):
|
|||
|
||||
:param str username: the user name
|
||||
:param str groupname: the group name
|
||||
:return: True if the user has been removed, False otherwise
|
||||
:rtype: boolean
|
||||
:return: dictionary containing the input parameters and a flag
|
||||
:py:const:`removed` that is set to :py:const:`True` if the user has
|
||||
been removed, False otherwise
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
||||
@shared_task
|
||||
def delete_ldap_user(username):
|
||||
def delete_ldap_user(username, *args, **kwargs):
|
||||
"""
|
||||
This task deletes the given user.
|
||||
|
||||
:param str username: the user name
|
||||
:return: True if the user has been deleted, False otherwise
|
||||
:rtype: boolean
|
||||
:return: dictionary containing the username and a flag :py:const:`deleted`
|
||||
that is set to :py:const:`True` if the user has been deleted and is set
|
||||
to :py:const:`False` otherwise
|
||||
:rtype: dict
|
||||
|
||||
.. note::
|
||||
|
||||
This variant can only be used at the beginning of a Celery task chain
|
||||
or as a standalone task.
|
||||
|
||||
Use :py:func:`ldaptasks.tasks.delete_ldap_user_chained` at other
|
||||
positions in the task chain
|
||||
|
||||
"""
|
||||
|
||||
|
||||
@shared_task
|
||||
def delete_ldap_user_chained(previous_result, *args, **kwargs):
|
||||
"""
|
||||
This task deletes the given user.
|
||||
|
||||
:param dict previous_result: a dictionary describing the result of the
|
||||
previous step in the Celery task chain. This dictionary must contain a
|
||||
:py:const:`username` key
|
||||
:return: a copy of the :py:obj:`previous_result` dictionary with a new
|
||||
:py:const:`deleted` key set to :py:const:`True` if the user has been
|
||||
deleted and set to :py:const:`False` otherwise
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
|
@ -113,8 +150,10 @@ def delete_ldap_group_if_empty(groupname):
|
|||
This task deletes the given group if it is empty.
|
||||
|
||||
:param str groupname: the group name
|
||||
:return: True if the user has been deleted, False otherwise
|
||||
:rtype: boolean
|
||||
:return: dictionary that contains the groupname and a flag
|
||||
:py:const:`deleted` that is set to :py:const:`True` if the group has
|
||||
been deleted and is set to :py:const:`False` otherwise
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
||||
|
|
@ -122,10 +161,12 @@ def delete_ldap_group_if_empty(groupname):
|
|||
@shared_task
|
||||
def delete_ldap_group(groupname):
|
||||
"""
|
||||
This taks deletes the given group.
|
||||
This task deletes the given group.
|
||||
|
||||
:param str groupname: the group name
|
||||
:return: True if the user has been deleted, False otherwise
|
||||
:rtype: boolean
|
||||
:return: dictionary that contains the groupname and a flag
|
||||
:py:const:`deleted` that is set to :py:const:`True` if the group has
|
||||
been deleted and is set to :py:const:`False` otherwise
|
||||
:rtype: dict
|
||||
|
||||
"""
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue