search
HomeBackend DevelopmentPython TutorialPython code specifications
Python code specificationsMar 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之Seaborn(数据可视化)详细讲解Python之Seaborn(数据可视化)Apr 21, 2022 pm 06:08 PM

本篇文章给大家带来了关于Python的相关知识,其中主要介绍了关于Seaborn的相关问题,包括了数据可视化处理的散点图、折线图、条形图等等内容,下面一起来看一下,希望对大家有帮助。

详细了解Python进程池与进程锁详细了解Python进程池与进程锁May 10, 2022 pm 06:11 PM

本篇文章给大家带来了关于Python的相关知识,其中主要介绍了关于进程池与进程锁的相关问题,包括进程池的创建模块,进程池函数等等内容,下面一起来看一下,希望对大家有帮助。

Python自动化实践之筛选简历Python自动化实践之筛选简历Jun 07, 2022 pm 06:59 PM

本篇文章给大家带来了关于Python的相关知识,其中主要介绍了关于简历筛选的相关问题,包括了定义 ReadDoc 类用以读取 word 文件以及定义 search_word 函数用以筛选的相关内容,下面一起来看一下,希望对大家有帮助。

归纳总结Python标准库归纳总结Python标准库May 03, 2022 am 09:00 AM

本篇文章给大家带来了关于Python的相关知识,其中主要介绍了关于标准库总结的相关问题,下面一起来看一下,希望对大家有帮助。

分享10款高效的VSCode插件,总有一款能够惊艳到你!!分享10款高效的VSCode插件,总有一款能够惊艳到你!!Mar 09, 2021 am 10:15 AM

VS Code的确是一款非常热门、有强大用户基础的一款开发工具。本文给大家介绍一下10款高效、好用的插件,能够让原本单薄的VS Code如虎添翼,开发效率顿时提升到一个新的阶段。

python中文是什么意思python中文是什么意思Jun 24, 2019 pm 02:22 PM

pythn的中文意思是巨蟒、蟒蛇。1989年圣诞节期间,Guido van Rossum在家闲的没事干,为了跟朋友庆祝圣诞节,决定发明一种全新的脚本语言。他很喜欢一个肥皂剧叫Monty Python,所以便把这门语言叫做python。

Python数据类型详解之字符串、数字Python数据类型详解之字符串、数字Apr 27, 2022 pm 07:27 PM

本篇文章给大家带来了关于Python的相关知识,其中主要介绍了关于数据类型之字符串、数字的相关问题,下面一起来看一下,希望对大家有帮助。

详细介绍python的numpy模块详细介绍python的numpy模块May 19, 2022 am 11:43 AM

本篇文章给大家带来了关于Python的相关知识,其中主要介绍了关于numpy模块的相关问题,Numpy是Numerical Python extensions的缩写,字面意思是Python数值计算扩展,下面一起来看一下,希望对大家有帮助。

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)
2 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
Repo: How To Revive Teammates
4 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: How To Get Giant Seeds
4 weeks agoBy尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SecLists

SecLists

SecLists is the ultimate security tester's companion. It is a collection of various types of lists that are frequently used during security assessments, all in one place. SecLists helps make security testing more efficient and productive by conveniently providing all the lists a security tester might need. List types include usernames, passwords, URLs, fuzzing payloads, sensitive data patterns, web shells, and more. The tester can simply pull this repository onto a new test machine and he will have access to every type of list he needs.

MantisBT

MantisBT

Mantis is an easy-to-deploy web-based defect tracking tool designed to aid in product defect tracking. It requires PHP, MySQL and a web server. Check out our demo and hosting services.

mPDF

mPDF

mPDF is a PHP library that can generate PDF files from UTF-8 encoded HTML. The original author, Ian Back, wrote mPDF to output PDF files "on the fly" from his website and handle different languages. It is slower than original scripts like HTML2FPDF and produces larger files when using Unicode fonts, but supports CSS styles etc. and has a lot of enhancements. Supports almost all languages, including RTL (Arabic and Hebrew) and CJK (Chinese, Japanese and Korean). Supports nested block-level elements (such as P, DIV),

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment