Shulou(Shulou.com)06/03 Report--

This article shows you how to write clear and elegant Python code, the content is concise and easy to understand, can definitely brighten your eyes, through the detailed introduction of this article, I hope you can get something.

Personally, I think the following rules should be followed absolutely.

01 suggestions relating to blanks

In Python, white space (whitespace) is grammatically important. Python programmers are particularly concerned about the use of white space characters because they affect the clarity of the code. In this regard, we should follow the following suggestions.

Indentation is indicated by spaces (space) instead of tabs (tab).

Each level of indentation associated with grammar is represented by four spaces.

Each line does not exceed 79 characters.

For long expressions that occupy multiple lines, all lines except the first line should add four more spaces above the usual indentation level.

In the same file, functions and classes are separated by two blank lines.

In the same class, methods and methods are separated by a blank line.

When using a dictionary, there is no space between the key and the colon, and a space should be added between the colon and the value written on the same line.

When assigning a value to a variable, add a space to the left and right of the assignment symbol, and just add a space.

When annotation the type of a variable, do not separate the variable name from the colon, but there should be a space before the type information.

02 suggestions relating to naming

PEP 8 recommends naming parts of your Python code in different ways, so that when you read the code, you can see their role in the Python language by these names. Follow the following naming-related recommendations.

Functions, variables, and properties are spelled in lowercase letters, and the words are connected by an underscore, such as lowercase_underscore.

Protected instance properties, starting with an underscore, for example: _ leading_underscore.

Private instance properties, starting with two underscores, for example: _ _ double_leading_underscore.

When classes (including exceptions) are named, the first letter of each word is capitalized, for example: CapitalizedWord.

Module-level constants in which all letters are capitalized and words are connected by an underscore, for example: ALL_CAPS.

Class, the first parameter should be named self to represent the object itself.

The first parameter of the class method, which should be named cls, represents the class itself.

03 suggestions related to expressions and statements

"there should be a simple way to do everything, and it's best to have only one," The Zen of Python said. PEP 8 tries to apply this idea to standardize the way expressions and statements are written.

Use inline negation, that is, write the negative word directly in front of the content to be negated, rather than in front of the whole expression, for example, you should write if an is not b, not if not an is b.

Do not judge whether the container or sequence is empty by length, for example, do not judge whether somelist is a null value such as [] or''by if len (somelist) = = 0, but should use the writing method such as if not somelist, because Python will automatically evaluate the null value as False.

If you want to determine whether there is content in the container or sequence (for example, to determine whether somelist is a non-empty value such as [1] or 'hi'), you should not judge by length, but should use the if somelist statement, because Python will automatically determine the non-empty value as True.

Do not squeeze if statements, for loops, while loops, and except compound statements on one line. These statements should be written in multiple lines to make them clearer.

If the expression cannot be written on a line, you can enclose it in parentheses and add line breaks and indents appropriately to make it easier to read.

Multi-line expressions should be enclosed in parentheses instead of continuing lines with the\ symbol.

04 recommendations relating to introduction

PEP 8 gives the following suggestions on how to introduce and use modules in your code.

Import statements (including from x import y) should always be placed at the beginning of the file.

When introducing a module, you should always use an absolute name, not a relative name based on the current module path. For example, to introduce the foo module in the bar package, you should write the from bar import foo in its entirety, even if the current path is in the bar package, it should not be abbreviated to import foo.

If the import statement must be written with a relative name, it should be explicitly written as: from. Import foo .

The import statements in the file should be divided into three parts in order: first, the modules in the standard library are introduced, then the third-party modules are introduced, and finally their own modules are introduced. Import statements that belong to the same part are arranged alphabetically.

Tip: Pylint is a popular Python source code static analysis tool. It can automatically check whether the code under test conforms to the PEP 8 style guidelines, and it can also find many common errors in Python programs. Many IDE (integrated development environments) and editors include such linting tools or support similar plug-ins.

Keystone

When writing Python code, you should always follow the PEP 8 style guidelines.

Adopting the same code style with the majority of Python developers can make the project more conducive to multi-person collaboration.

Writing code in a consistent style makes it easier to modify the code later.

The above is how to write clear and elegant Python code, have you learned the knowledge or skills? If you want to learn more skills or enrich your knowledge reserve, you are welcome to follow the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.