Quelle est la convention de dénomination de Python ? Introduction aux conventions de dénomination Python

Ce que cet article vous apporte, c'est quelle est la convention de dénomination de Python ? L'introduction aux conventions de dénomination Python a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer. J'espère qu'elle vous sera utile.

Nom du fichier
Tout en minuscules, les traits de soulignement peuvent être utilisés

Le package

doit être un nom court et en minuscules. Un soulignement peut être ajouté s’il améliore la lisibilité. Tel que mon colis.

Module

a les mêmes spécifications que le package. Tel que mon module.

classe

met toujours en majuscule la première lettre des chaînes de mots. Tel que MaClasse. Les classes internes peuvent utiliser des traits de soulignement supplémentaires.

Fonctions et méthodes

Les noms de fonctions doivent être en minuscules et les mots de style soulignés peuvent être utilisés pour augmenter la lisibilité. Tels que : mafonction, ma_fonction_exemple.

*REMARQUE* : La casse mixte n'est autorisée que là où ce style est déjà dominant, afin de maintenir une compatibilité ascendante.

Paramètres des fonctions et méthodes

Utilisez toujours "self" comme premier paramètre des méthodes d'instance. Utilisez toujours "cls" comme premier paramètre d'une méthode de classe.
Si le nom d'un paramètre de fonction entre en conflit avec un mot-clé réservé, il est généralement préférable d'utiliser un trait de soulignement suffixant plutôt que d'utiliser une abréviation ou une orthographe étrange.

Variables globales

Pour l'instruction from M import * import, si vous souhaitez empêcher les variables globales dans le module importé, vous pouvez utiliser l'ancienne spécification et ajouter un trait de soulignement de début à la variable globale .
*Remarque* : évitez d'utiliser des variables globales

Variables

Les noms de variables sont tous en minuscules, avec des traits de soulignement reliant chaque mot. Par exemple, color = WHITE, this_is_a_variable = 1

*Remarque* :
1. N'utilisez pas le préfixe m ou g, qu'il s'agisse d'une variable membre de classe ou d'une variable globale.
2. Les membres de la classe privée sont identifiés par un seul préfixe de trait de soulignement, définissant plus de membres publics et moins de membres privés.
3. Les noms de variables ne doivent pas contenir d'informations de type car Python est un langage typé dynamiquement. Tels que iValue, names_list, dict_obj, etc. sont tous de mauvais noms.

Constante

Toutes les lettres des noms de constantes sont en majuscules et chaque mot est relié par un trait de soulignement, tel que MAX_OVERFLOW, TOTAL.

Les exceptions

ont "Erreur" comme suffixe.

Abréviations

Vous devriez essayer d'utiliser des mots entièrement orthographiés lors de la dénomination. Il existe deux types d'abréviations :
1. Les abréviations couramment utilisées, telles que XML, ID, etc., devraient. également être utilisé lors de la dénomination. Mettez uniquement la première lettre en majuscule, comme XmlParser.
2. Si le nom contient des mots longs, abrégez un certain mot. Dans ce cas, l'abréviation conventionnelle doit être utilisée.

Par exemple :
function est abrégé en fn
text, abrégé en txt
object, abrégé en obj
count, abrégé en cnt
number, abrégé en num, etc.

Trait de soulignement de début et suffixe

Un trait de soulignement de début : indique que ce n'est pas public.
Un suffixe souligné : évitez les conflits de mots clés.
Deux traits de soulignement en tête : utilisés lorsque le nom d'un attribut de classe provoque un conflit de nom.
Deux traits de soulignement en début et en suffixe : objets ou attributs "magiques" (à usage spécial), tels que __init__ ou __file__. Ne créez jamais de tels noms, utilisez-les simplement.

*REMARQUE* : Il existe une certaine controverse concernant l'utilisation des traits de soulignement.

Méthode de dénomination spécifique

Se réfère principalement à la méthode de dénomination des mots réservés au système sous la forme de __xxx__. Ce type de dénomination peut également être utilisé dans les projets. Sa signification est que les variables sous cette forme sont en lecture seule et que les fonctions membres de la classe sous cette forme ne doivent pas être surchargées autant que possible. Par exemple,

class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略

où __id__, __parent__ et __message__ utilisent tous la nomenclature de mots réservée au système.

Pièce jointe : convention de dénomination Google Python

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!