管理制度_18Python编码规范.docx

PAGE1/NUMPAGES7

Python编码规范

遵循良好的编码风格，可以有效的提高代码的可读性，降低出错几率和维护难度。在团队开发中，使用（尽量）统一的编码风格，还可以降低沟通成本。

网上有很多版本的编码规范，基本上都是遵循PEP8的规范：

PEP0008–StyleGuideforPythonCode

Google的Python风格指南

PythonGuide-CodeStyle

PocooStyleguide

除了在编码时主动遵循规范，还有很多有用的工具：

IntelliJIDEA和PyCharm的格式化代码功能

Google开源的Python文件格式化工具：/google/yapf

pyflakes,pylint等工具及各种编辑器的插件

本文的内容主要摘自互联网上各种版本的规范，因为公司有些小伙伴代码风格不太好，所以整理了一份算是团队的编码规范。

缩进

不要使用tab缩进

使用任何编辑器写Python，请把一个tab展开为4个空格

绝对不要混用tab和空格，否则容易出现?IndentationError

空格

在list,dict,tuple,set,参数列表的?,?后面加一个空格

在dict的?:?后面加一个空格

在注释符号?#?后面加一个空格，但是?#!/usr/bin/python?的?#?后不能有空格

操作符两端加一个空格，如?+,?-,?*,?/,?|,?,?=

接上一条，在参数列表里的?=?两端不需要空格

括号（(),?{},?[]）内的两端不需要空格

空行

function和class顶上两个空行

class的method之间一个空行

函数内逻辑无关的段落之间空一行，不要过度使用空行

不要把多个语句写在一行，然后用?;?隔开

if/for/while语句中，即使执行语句只有一句，也要另起一行

换行

每一行代码控制在80字符以内

使用?\?或?()?控制换行，举例：

deffoo(first,second,third,fourth,fifth,

sixth,and_some_other_very_long_param):

user=User.objects.filter_by(first=first,second=second,third=third)\

.skip(100).limit(100)\

.all()

text=(Longstringscanbemadeup

ofseveralshorterstrings.)

命名

使用有意义的，英文单词或词组，绝对不要使用汉语拼音

package/module名中不要出现?-

各种类型的命名规范：

Type

Public

Internal

Modules

lower_with_under

_lower_with_under

Packages

lower_with_under

?

Classes

CapWords

_CapWords

Exceptions

CapWords

?

Functions

lower_with_under()

_lower_with_under()

Global/ClassConstants

CAPS_WITH_UNDER

_CAPS_WITH_UNDER

Global/ClassVariables

lower_with_under

_lower_with_under

InstanceVariables

lower_with_under

_lower_with_under?(protected)or?__lower_with_under?(private)

MethodNames

lower_with_under()

_lower_with_under()?(protected)or?__lower_with_under()?(private)

Function/MethodParameters

lower_with_under

?

LocalVariables

lower_with_under

?

import

所有import尽量放在文件开头，在docstring下面，其他变量定义的上面

不要使用?fromfooimort*

import需要分组，每组之间一个空行，每个分组内的顺序尽量采用字典序，分组顺序是：

标准库

第三方库

本项目的package和module

不要使用隐式的相对导入（implicitrelati