Documentation et pep8 sur models de topologie

topologie/models.py

@@ -20,24 +20,31 @@
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+"""
+Definition des modèles de l'application topologie.
+
+On défini les models suivants :
+
+- stack (id, id_min, id_max et nom) regrouppant les switches
+- switch : nom, nombre de port, et interface
+machine correspondante (mac, ip, etc) (voir machines.models.interface)
+- Port: relié à un switch parent par foreign_key, numero du port,
+relié de façon exclusive à un autre port, une machine
+(serveur ou borne) ou une prise murale
+- room : liste des prises murales, nom et commentaire de l'état de
+la prise
+"""
 
 from __future__ import unicode_literals
 
 from django.db import models
 from django.db.models.signals import post_delete
 from django.dispatch import receiver
-from django.forms import ModelForm, Form
-from django.contrib.contenttypes.models import ContentType
-from django.contrib.contenttypes.fields import GenericForeignKey
 from django.core.exceptions import ValidationError
-import reversion
-
-from machines.models import Vlan
-
 
 class Stack(models.Model):
-    """ Un objet stack. Regrouppe des switchs en foreign key
-    , contient une id de stack, un switch id min et max dans 
+    """Un objet stack. Regrouppe des switchs en foreign key
+    ,contient une id de stack, un switch id min et max dans
     le stack"""
     PRETTY_NAME = "Stack de switchs"
 
@@ -59,7 +66,8 @@ class Stack(models.Model):
     def clean(self):
         """ Verification que l'id_max < id_min"""
         if self.member_id_max < self.member_id_min:
-            raise ValidationError({'member_id_max':"L'id maximale est inférieure à l'id minimale"})
+            raise ValidationError({'member_id_max':"L'id maximale est\
+                inférieure à l'id minimale"})
 
 class Switch(models.Model):
     """ Definition d'un switch. Contient un nombre de ports (number),
@@ -69,18 +77,29 @@ class Switch(models.Model):
     Pourquoi ne pas avoir fait hériter switch de interface ?
     Principalement par méconnaissance de la puissance de cette façon de faire.
     Ceci étant entendu, django crée en interne un onetoone, ce qui a un
-    effet identique avec ce que l'on fait ici"""
+    effet identique avec ce que l'on fait ici
+
+    Validation au save que l'id du stack est bien dans le range id_min
+    id_max de la stack parente"""
     PRETTY_NAME = "Switch / Commutateur"
 
-    switch_interface = models.OneToOneField('machines.Interface', on_delete=models.CASCADE)
+    switch_interface = models.OneToOneField(
+        'machines.Interface',
+        on_delete=models.CASCADE
+        )
     location = models.CharField(max_length=255)
     number = models.IntegerField()
     details = models.CharField(max_length=255, blank=True)
-    stack = models.ForeignKey(Stack, blank=True, null=True, on_delete=models.SET_NULL)
+    stack = models.ForeignKey(
+        Stack,
+        blank=True,
+        null=True,
+        on_delete=models.SET_NULL
+        )
     stack_member_id = models.IntegerField(blank=True, null=True)
 
     class Meta:
-        unique_together = ('stack','stack_member_id')
+        unique_together = ('stack', 'stack_member_id')
 
     def __str__(self):
         return str(self.location) + ' ' + str(self.switch_interface)
@@ -89,10 +108,13 @@ class Switch(models.Model):
         """ Verifie que l'id stack est dans le bon range"""
         if self.stack is not None:
             if self.stack_member_id is not None:
-                if (self.stack_member_id > self.stack.member_id_max) or (self.stack_member_id < self.stack.member_id_min):
-                    raise ValidationError({'stack_member_id': "L'id de ce switch est en dehors des bornes permises pas la stack"})
+                if (self.stack_member_id > self.stack.member_id_max) or\
+                    (self.stack_member_id < self.stack.member_id_min):
+                    raise ValidationError({'stack_member_id': "L'id de ce\
+                        switch est en dehors des bornes permises pas la stack"})
             else:
-                raise ValidationError({'stack_member_id': "L'id dans la stack ne peut être nul"})
+                raise ValidationError({'stack_member_id': "L'id dans la stack\
+                    ne peut être nul"})
 
 class Port(models.Model):
     """ Definition d'un port. Relié à un switch(foreign_key),
@@ -102,7 +124,8 @@ class Port(models.Model):
     - un autre port (uplink) (related)
     Champs supplémentaires :
     - RADIUS (mode STRICT : connexion sur port uniquement si machine
-    d'un adhérent à jour de cotisation et que la chambre est également à jour de cotisation
+    d'un adhérent à jour de cotisation et que la chambre est également à
+    jour de cotisation
     mode COMMON : vérification uniquement du statut de la machine
     mode NO : accepte toute demande venant du port et place sur le vlan normal
     mode BLOQ : rejet de toute authentification
@@ -111,19 +134,39 @@ class Port(models.Model):
     RADIUS"""
     PRETTY_NAME = "Port de switch"
     STATES = (
-            ('NO', 'NO'),
-            ('STRICT', 'STRICT'),
-            ('BLOQ', 'BLOQ'),
-            ('COMMON', 'COMMON'),
-            )
+        ('NO', 'NO'),
+        ('STRICT', 'STRICT'),
+        ('BLOQ', 'BLOQ'),
+        ('COMMON', 'COMMON'),
+        )
 
     switch = models.ForeignKey('Switch', related_name="ports")
     port = models.IntegerField()
-    room = models.ForeignKey('Room', on_delete=models.PROTECT, blank=True, null=True)
-    machine_interface = models.ForeignKey('machines.Interface', on_delete=models.SET_NULL, blank=True, null=True)
-    related = models.OneToOneField('self', null=True, blank=True, related_name='related_port')
+    room = models.ForeignKey(
+        'Room',
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True
+        )
+    machine_interface = models.ForeignKey(
+        'machines.Interface',
+        on_delete=models.SET_NULL,
+        blank=True,
+        null=True
+        )
+    related = models.OneToOneField(
+        'self',
+        null=True,
+        blank=True,
+        related_name='related_port'
+        )
     radius = models.CharField(max_length=32, choices=STATES, default='NO')
-    vlan_force = models.ForeignKey('machines.Vlan', on_delete=models.SET_NULL, blank=True, null=True)
+    vlan_force = models.ForeignKey(
+        'machines.Vlan',
+        on_delete=models.SET_NULL,
+        blank=True,
+        null=True
+        )
     details = models.CharField(max_length=255, blank=True)
 
     class Meta:
@@ -142,23 +185,27 @@ class Port(models.Model):
         related_port.save()
 
     def clean(self):
-        """ Verifie que un seul de chambre, interface_parent et related_port est rempli.
-        Verifie que le related n'est pas le port lui-même....
-        Verifie que le related n'est pas déjà occupé par une machine ou une chambre. Si
-        ce n'est pas le cas, applique la relation related
+        """ Verifie que un seul de chambre, interface_parent et related_port
+        est rempli. Verifie que le related n'est pas le port lui-même....
+        Verifie que le related n'est pas déjà occupé par une machine ou une
+        chambre. Si ce n'est pas le cas, applique la relation related
         Si un port related point vers self, on nettoie la relation
-        A priori pas d'autre solution que de faire ça à la main. A priori tout cela est dans
-        un bloc transaction, donc pas de problème de cohérence"""
+        A priori pas d'autre solution que de faire ça à la main. A priori
+        tout cela est dans un bloc transaction, donc pas de problème de
+        cohérence"""
         if hasattr(self, 'switch'):
             if self.port > self.switch.number:
                 raise ValidationError("Ce port ne peut exister, numero trop élevé")
-        if self.room and self.machine_interface or self.room and self.related or self.machine_interface and self.related:
-            raise ValidationError("Chambre, interface et related_port sont mutuellement exclusifs")
-        if self.related==self:
+        if self.room and self.machine_interface or self.room and\
+            self.related or self.machine_interface and self.related:
+            raise ValidationError("Chambre, interface et related_port sont\
+                mutuellement exclusifs")
+        if self.related == self:
             raise ValidationError("On ne peut relier un port à lui même")
         if self.related and not self.related.related:
             if self.related.machine_interface or self.related.room:
-                raise ValidationError("Le port relié est déjà occupé, veuillez le libérer avant de créer une relation")
+                raise ValidationError("Le port relié est déjà occupé, veuillez\
+                    le libérer avant de créer une relation")
             else:
                 self.make_port_related()
         elif hasattr(self, 'related_port'):
@@ -168,7 +215,7 @@ class Port(models.Model):
         return str(self.switch) + " - " + str(self.port)
 
 class Room(models.Model):
-    """ Une chambre/local contenant une prise murale"""
+    """Une chambre/local contenant une prise murale"""
     PRETTY_NAME = "Chambre/ Prise murale"
 
     name = models.CharField(max_length=255, unique=True)
@@ -182,4 +229,5 @@ class Room(models.Model):
 
 @receiver(post_delete, sender=Stack)
 def stack_post_delete(sender, **kwargs):
-    Switch.objects.filter(stack=None).update(stack_member_id = None)
+    """Vide les id des switches membres d'une stack supprimée"""
+    Switch.objects.filter(stack=None).update(stack_member_id=None)