Formatage Sphinx d'une partie des docstrings

Modifs non commitées qui traînaient dans ma copie, histoire d'éviter les conflits...
This commit is contained in:
Olivier Iffrig 2013-03-07 18:46:09 +01:00
parent b72d61108f
commit ec40333e10
3 changed files with 34 additions and 26 deletions

View file

@ -76,13 +76,13 @@ DROITS_SUPERVISEUR = { nounou : TOUS_DROITS,
def attrify(val, attr, ldif, conn, ctxt_check = True):
"""Transforme un n'importe quoi en Attr.
"""Transforme un n'importe quoi en :py:class:`Attr`.
Doit effectuer les normalisations et sanity check si un str ou un
unicode est passé en argument.
Devrait insulter en cas de potentiel problème d'encodage.
Doit effectuer les vérifications de contexte dans le *ldif* si
ctxt_check est vrai"""
Doit effectuer les vérifications de contexte dans le ``ldif`` si
``ctxt_check`` est vrai"""
if isinstance(val, Attr):
return val
@ -90,7 +90,14 @@ def attrify(val, attr, ldif, conn, ctxt_check = True):
return CRANS_ATTRIBUTES.get(attr, Attr)(val, ldif, conn, ctxt_check)
class Attr(object):
"""La liste des droits qui suffisent à avoir le droit de modifier la valeur"""
"""Objet représentant un attribut.
**Paramètres :**
* ``val`` : valeur de l'attribut
* ``ldif`` : objet contenant l'attribut (permet de faire les validations sur l'environnement)
* ``ctxt_check`` : effectue les validations
"""
legend = "Human-readable description of attribute"
singlevalue = None
optional = None
@ -98,6 +105,7 @@ class Attr(object):
unique = False
can_modify = [nounou]
"""La liste des droits qui suffisent à avoir le droit de modifier la valeur"""
can_view = [nounou, apprenti, soi, parent, respo]
"""Qui peut voir l'attribut. Par défaut, les Nounous et les Apprentis
@ -108,12 +116,7 @@ class Attr(object):
"""Catégorie de l'attribut (pour affichage futur)"""
def __init__(self, val, ldif, conn, ctxt_check):
"""Crée un nouvel objet représentant un attribut.
val: valeur de l'attribut
ldif: objet contenant l'attribut (permet de faire les validations sur l'environnement)
ctxt_check: effectue les validations
"""
"""Crée un nouvel objet représentant un attribut. """
self.ctxt_check=ctxt_check
#self.value = None
self.conn = conn
@ -159,7 +162,7 @@ class Attr(object):
raise ValueError('%s doit avoir au moins une valeur' % self.__class__)
def _check_uniqueness(self):
"""Vérifie l'unicité dans la base de la valeur (mailAlias, chbre,
"""Vérifie l'unicité dans la base de la valeur (``mailAlias``, ``chbre``,
etc...)"""
attr = self.__class__.__name__
if self.unique:
@ -169,7 +172,7 @@ class Attr(object):
def _check_users_restrictions(self, values):
"""Vérifie les restrictions supplémentaires imposées selon les
niveaux de droits (<= 3 mailAlias, pas de mac identiques,
niveaux de droits (<= 3 ``mailAlias``, pas de mac identiques,
etc...)"""
### On l'implémente dans les classes filles !
pass