What is Python’s naming convention? Introduction to python naming conventions

This article brings you what is the naming convention of Python? The introduction to python naming conventions has certain reference value. Friends in need can refer to it. I hope it will be helpful to you.

File name
All lowercase, underscores may be used

Package

should be a short, lowercase name. Underlining can be added if it improves readability. Such as mypackage.

Module

The same specification as the package. Such as mymodule.

Class

Always capitalize the first letter of a word string. Such as MyClass. Inner classes can use extra leading underscores.

Function & Method

Function names should be lowercase, and underlined style words can be used to increase readability. Such as: myfunction, my_example_function.

*Note*: Mixed case is only allowed where this style is already dominant, in order to maintain backward compatibility.

Parameters of functions and methods

Always use "self" as the first parameter of instance methods. Always use "cls" as the first parameter of a class method.
If a function parameter name conflicts with a reserved keyword, it is usually better to use a suffixing underscore than to use an abbreviation or strange spelling.

Global variables

For the from M import * import statement, if you want to prevent global variables from being imported into the module, you can use the old specification and add a leading underscore to the global variable.
*Note*: Avoid using global variables

Variables

Variable names are all lowercase, with underscores connecting each word. For example, color = WHITE, this_is_a_variable = 1

*Note*:
1. Whether it is a class member variable or a global variable, do not use the m or g prefix.
2. Private class members are identified with a single underscore prefix, define more public members and less private members.
3. Variable names should not carry type information because Python is a dynamically typed language. Such as iValue, names_list, dict_obj, etc. are all bad names.

Constant

Constant names are all capital letters, with underscores connecting each word such as MAX_OVERFLOW, TOTAL.

Exceptions

are suffixed with "Error".

Abbreviations

You should try to use fully spelled words when naming. There are two types of abbreviations:
1. Commonly used abbreviations, such as XML, ID, etc., should also be used when naming. Capitalize only the first letter, such as XmlParser.
2. If the name contains long words, abbreviate a certain word. In this case, the conventional abbreviation should be used.

For example:
function is abbreviated as fn
text, abbreviated as txt
object, abbreviated as obj
count, abbreviated as cnt
number, abbreviated as num, etc.

Leading and suffixed underscore

A leading underscore: indicates non-public.
A suffix underscore: avoid keyword conflicts.
Two leading underscores: Used when naming a class attribute causes a name conflict.
Two leading and suffixed underscores: "magic" (with special use) objects or attributes, such as __init__ or __file__. Never create such names, just use them.

*NOTE*: There is some controversy regarding the use of underscores.

Specific naming method

Mainly refers to the system reserved word naming method in the form of __xxx__. This kind of naming can also be used in projects. Its significance is that variables in this form are read-only. Try not to overload class member functions in this form. Such as

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

where __id__, __parent__ and __message__ all use system reserved word nomenclature.

Attachment: Google Python naming convention

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

The above is the detailed content of What is Python’s naming convention? Introduction to python naming conventions. For more information, please follow other related articles on the PHP Chinese website!