2016-07-26 2 views
1

Les modèles de django peuvent venir avec une classe méta comme ceci:Quelle est la docstring standard pour une métaclasse de modèle django?

class Address(models.Model): 
    """Address model.""" 

    class Meta: 
     """Meta McMetaface.""" 

     verbose_name = "Address" 
     verbose_name_plural = "Addresses" 

    address_line = models.CharField(max_length=256) 
    postcode = models.CharField(max_length=10) 

    def __str__(self): 
     """Return address without post code.""" 
     return self.address_line 

Mon métaclasse est fantaisiste au mieux. Est-ce que Python ou Django ont un texte standard pour les méta-classes?

+1

C'est un docstring pour la documentation. Un texte standard servirait cet objectif purement. Ceci est également valable pour un nom stupide ou un contenu qui répète juste la ligne 'class' ou' def' ci-dessus. S'il n'y a rien d'utile à écrire, laissez-le vide. –

+0

@KlausD. rien sur comment il devrait décrire la métaness de la classe dans le pep? – Pureferret

Répondre

1

Il ne sert à rien d'écrire une docstring pour Meta. C'est un nom standard que chaque modèle définit, et signifie la même chose dans chaque modèle. N'écrivez simplement pas de docstring.

+0

La raison pour laquelle je voulais, c'est que Flake8 me le demande. Je suis juste surpris qu'il n'y ait aucune clause dans PEP qui l'exclue ou quelque chose? – Pureferret

+1

Reconfigurez Flake8! –

+1

Les outils sont là pour vous aider. Si vous ne pouvez pas dire à Flake8 ce que vous voulez, utilisez pylint. –