search
HomeBackend DevelopmentPython TutorialPython code specifications

Python code specifications

Mar 12, 2017 am 10:25 AM
python

1: Background

is used to standardize ocp python development, and use a unified style for programs developed using python to facilitate code Maintenance

Two:pythonStyle specification

  • points Symbol: Do not add a semicolon at the end of the line, and do not use a semicolon to put two commands on the same line

  • Brackets: Use brackets sparingly rather than excessively. Unless used to implement row concatenation, do not use parentheses in return statements or conditional statements, but parentheses around tuples are allowed

  • Indentation: use 4 spaces. Instead of indenting code. Never use tabs, or mix tabs and spaces. For line concatenation, you should either vertically align wrapped elements, or use a 4-space hanging indent (in which case there should be no parameters on the first line)

  • Empty line :Two empty lines between top-level definitions, such as functionor class definitions. There should be a blank line between method definition, class definition and the first method. In functions or methods, if you think it is appropriate, leave a blank line in some places.

  • Spaces: Use spaces on both sides of punctuation according to standard formatting conventions. There should be no spaces within the brackets; do not add spaces before commas, semicolons, and colons, but they should be added after them (except at the end of the line); there should be no spaces in the left parenthesis of parameter lists, index, or slices ;Add a space on both sides of the binary operator, such as assignment (=), comparison (==, , !=, , =, in, not in, is, is not), Boolean (and, or, not). As for how to use the spaces on both sides of the arithmetic operators, you need to make your own judgment. However, both sides must be consistent; when '=' is used to indicate keyword parameters or default parameter values, do not use spaces on both sides of it; do not use spaces to vertically align tags between multiple lines, because this will become a maintenance problem Burden (applicable to:, #, =, etc.)

  • Class: If a class does not inherit from other classes, it will be displayed from object classInheritance

  • String : Even if the parameters are all strings, use the % operator or format method to format characters String , do not use the + method

  • Import method: Each import has its own line. Imports should always be placed at the top of the file, after module comments and docstrings, and before module global variables and constants . Imports should be in order from most common to least commonGroup: standard library import; third-party library import;applicationprogram specified import, each group should be based on the completeness of each module Package paths are sorted lexicographically, ignoring case

  • statements: Normally each statement should be on its own line. If the test results and test statements fit on one line, you can put them on the same line. In the case of a if statement, this can only be done if there is no else. In particular, never do this with try/except because try and except cannot be on the same line.

  • Name: ob_module_name ob_package_name ObClassName TestObClassName method_name test_method_name ExceptionName function_name GLOBAL_VAR_NAME instance_var_name function_parameter_name local_var_name

  • Other points will be added later

Three: Requirements:

  • After the code is modified, you must first run pylint and then initiate a review. The pylint running score must be controlled above 90. Some obvious irregularities must be corrected

  • pylint Usage: Execute tools/pylint.sh in the obztools directory file

## Four: Reference:

  • PEP 8 – Style Guide for Python Code: http://legacy.python.org/dev/peps/pep-0008/

  • Python Coding Style Guide Chinese translation (Google SOC): http://www.elias.cn/Python/PythonStyleGuide?from= Develop.PythonStyleGuide

The above is the detailed content of Python code specifications. For more information, please follow other related articles on the PHP Chinese website!

Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Python: Games, GUIs, and MorePython: Games, GUIs, and MoreApr 13, 2025 am 12:14 AM

Python excels in gaming and GUI development. 1) Game development uses Pygame, providing drawing, audio and other functions, which are suitable for creating 2D games. 2) GUI development can choose Tkinter or PyQt. Tkinter is simple and easy to use, PyQt has rich functions and is suitable for professional development.

Python vs. C  : Applications and Use Cases ComparedPython vs. C : Applications and Use Cases ComparedApr 12, 2025 am 12:01 AM

Python is suitable for data science, web development and automation tasks, while C is suitable for system programming, game development and embedded systems. Python is known for its simplicity and powerful ecosystem, while C is known for its high performance and underlying control capabilities.

The 2-Hour Python Plan: A Realistic ApproachThe 2-Hour Python Plan: A Realistic ApproachApr 11, 2025 am 12:04 AM

You can learn basic programming concepts and skills of Python within 2 hours. 1. Learn variables and data types, 2. Master control flow (conditional statements and loops), 3. Understand the definition and use of functions, 4. Quickly get started with Python programming through simple examples and code snippets.

Python: Exploring Its Primary ApplicationsPython: Exploring Its Primary ApplicationsApr 10, 2025 am 09:41 AM

Python is widely used in the fields of web development, data science, machine learning, automation and scripting. 1) In web development, Django and Flask frameworks simplify the development process. 2) In the fields of data science and machine learning, NumPy, Pandas, Scikit-learn and TensorFlow libraries provide strong support. 3) In terms of automation and scripting, Python is suitable for tasks such as automated testing and system management.

How Much Python Can You Learn in 2 Hours?How Much Python Can You Learn in 2 Hours?Apr 09, 2025 pm 04:33 PM

You can learn the basics of Python within two hours. 1. Learn variables and data types, 2. Master control structures such as if statements and loops, 3. Understand the definition and use of functions. These will help you start writing simple Python programs.

How to teach computer novice programming basics in project and problem-driven methods within 10 hours?How to teach computer novice programming basics in project and problem-driven methods within 10 hours?Apr 02, 2025 am 07:18 AM

How to teach computer novice programming basics within 10 hours? If you only have 10 hours to teach computer novice some programming knowledge, what would you choose to teach...

How to avoid being detected by the browser when using Fiddler Everywhere for man-in-the-middle reading?How to avoid being detected by the browser when using Fiddler Everywhere for man-in-the-middle reading?Apr 02, 2025 am 07:15 AM

How to avoid being detected when using FiddlerEverywhere for man-in-the-middle readings When you use FiddlerEverywhere...

What should I do if the '__builtin__' module is not found when loading the Pickle file in Python 3.6?What should I do if the '__builtin__' module is not found when loading the Pickle file in Python 3.6?Apr 02, 2025 am 07:12 AM

Error loading Pickle file in Python 3.6 environment: ModuleNotFoundError:Nomodulenamed...

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
3 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
3 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. How to Fix Audio if You Can't Hear Anyone
3 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
WWE 2K25: How To Unlock Everything In MyRise
4 weeks agoBy尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Atom editor mac version download

Atom editor mac version download

The most popular open source editor

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

WebStorm Mac version

WebStorm Mac version

Useful JavaScript development tools

VSCode Windows 64-bit Download

VSCode Windows 64-bit Download

A free and powerful IDE editor launched by Microsoft