python代码编写规范有哪些_【shell】代码编写规范

通用

排版规范

1、程序块要采用缩进风格编写。函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

例：

# 文件自检

file_check()

{

if [[ ! -n $file_01 ]];then

echo "TM_ota.sh 文件不存在。"

exit

elif [[ ! -n $file_02 ]];then

echo "TM_app.sh 文件不存在。"

exit

fi

}

函数内部统一缩进一格，判断语句内部统一缩进一格。

2、不要把多个短语写在一行中，即一行只写一条语句。

比如错误示范

a=1;b=2;c=$((a+b));

3、If、for、do、while、case、switch、default等语句自占一行。

4、程序块的分界符（如C++/C#语言中的‘{’和‘}’）应各自独占一行并且位于同一列，同时与引用它们的语句左对齐。

3、4 都可以参考第一个例子。

5、行长度，每行不超过80个字符。以下情况除外

长的导入模块语句

注释里的URL

shell

一、注释

1、脚本头部注释

脚本头部注释，主要是改脚本的描述信息，这些信息主要包括脚本的作者、开发时间、脚本的功能描述，如：

#!/bin/bash

#####################################

#Script: XXXX

#Author: XXXX

#Date: XX-XX-XX

#Description: XXXXXX

#Usage: XXXX

#####################################

其中，（根据项目实际需要，也可以添加其他描述信息）

2、其他注释

函数注释：描述函数的具体功能；放在函数上一行。

代码注释：对关键或复杂代码进行注释；注释放在代码上一行或代码后。

二、命名规范

1、变量名

命名只能使用英文字母，数字和下划线。

只有一个英文单词时使用全拼；有多个单词时，使用下划线分隔；长度较长时，可以取单词前3～4字母。

避免使用Linux的保留字如true、关键字如pwd等。

配置文件中定义的环境变量名统一大写。

2、函数命名

同变量命名

3、文件命名

linux不以文件后缀来区分文件类型，但为了便于日常管理和维护，shell脚本习惯以.sh结尾。

文件名全部以小写命名，不要大小写混用（不推荐驼峰命名法，大小写混用在特殊情况下会存在问题）。

文件名尽可能做到“见名知意”；可以参考变量命名。

三、函数规范

1、函数结构

每一个小功能都封装到独立的函数类，一个函数只完成一个功能；在脚本尾部，通过函数的顺序调用将整个脚本逻辑串联起来。

控制函数的大小，函数体的行数尽量控制在100行左右；过大的函数要分割成两个或者多个函数。

2、函数复用

多次调用的功能要抽离出独立的函数，提高编码效率，降低维护成本。

对常用的功能（如计算日期，发邮件、写日志）的功能，封装成函数后形成独立的脚本，其他脚本引入即可。

四、编写规范

1、缩进

良好的缩进可以提高代码的可读性，建议代码中统一用制表符（一般4个字符）作为缩进。

2、分割长行

参考通用部分

3、分离符合体

主要是针对 if语句、while语句，参考通用部分

# 连续录像压力测试

test_case_02()

{

clear

echo "开始连续录像压力测试："

while((1))

do

echo "Loop "$i

takevideo

sleep 2

echo "take video success ..."

sleep 1

echo " "

((i++))

done

}

4、变量统一管理

shell脚本中使用的全局变量，要统一定义。一般在init()函数中进行统一初始化。

函数内部使用的变量，最好也在函数开始位置进行初始化。

函数内部局部变量用local修饰。

多个脚本都需要引用的变量，统一在配置文件中定义（后续会详细说明）。

变量引用，以 ${} 方式。

5、shell脚本结构

shell 脚本，自上而下一次为：

set_env() 该函数用于初始化脚本的环境，引入全局变量。

init() 该脚本用于初始化当前脚本的全局参数。

xxx() 其他脚本，与具体业务相关。

依次调用自上而下的脚本，形成处理逻辑。

五、脚本复用

将常用功能封装成函数，把一类功能的函数写入一个脚本中，其他脚本在需要某一类功能时，直接引入该脚本，调用函数即可。

形成固定的脚本引用方式，如脚本开头固定引入某些脚本，达到设置脚本运行环境的功能。

Python

一、编写规范

1、分号

不要在行尾加分号, 也不要用分号将两条命令放在同一行

2、行长度

每行不超过80个字符

以下情况除外：

长的导入模块语句

注释里的URL

推荐:

foo_bar(self,width,height,color='black',design=None,x='foo',

emphasis=None,highlight=0)

if(width ==0andheight ==0and

color =='red'andemphasis =='strong'):

如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:

x =('这是一个非常长非常长非常长非常长'

'非常长非常长非常长非常长非常长非常长的字符串')

在注释中，如果必要，将长的URL放在一行上。

Yes: # See details at

# [http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html](http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html)

No: # See details at

# [http://www.example.com/us/developer/documentation/api/content/\](http://www.example.com/us/developer/documentation/api/content/)

# v2.0/csv_file_name_extension_full_specification.html

注意上面例子中的元素缩进; 你可以在本文的:ref:缩进`部分找到解释.

3、括号

宁缺毋滥的使用括号

除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.

Yes: if foo:

bar()

while x:

x = bar()

if x and y:

bar()

if not x:

bar()

return foo

for (x, y) in dict.items(): ...

No: if (x):

bar()

if not(x):

bar()

return (foo)

4、缩进

用4个空格来缩进代码

绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:行长度 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):

Yes: # 与起始变量对齐

foo = long_function_name(var_one, var_two,

var_three, var_four)

# 字典中与起始值对齐

foo = {

long_dictionary_key: value1 +

value2,

...

}

# 4 个空格缩进，第一行不需要

foo = long_function_name(

var_one, var_two, var_three,

var_four)

# 字典中 4 个空格缩进

foo = {

long_dictionary_key:

long_dictionary_value,

...

}

No: # 第一行有空格是禁止的

foo = long_function_name(var_one, var_two,

var_three, var_four)

# 2 个空格是禁止的

foo = long_function_name(

var_one, var_two, var_three,

var_four)

# 字典中没有处理缩进

foo = {

long_dictionary_key:

long_dictionary_value,

...

}

5、空行

顶级定义之间空两行, 方法定义之间空一行

顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.

6、空格

按照标准的排版规范来使用标点两边的空格

括号内不要有空格.

按照标准的排版规范来使用标点两边的空格

Yes: spam(ham[1], {eggs: 2}, [])

No: spam( ham[ 1 ], { eggs: 2 }, [ ] )

不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).

Yes: if x == 4:

print x, y

x, y = y, x

No: if x == 4 :

print x , y

x , y = y , x

参数列表, 索引或切片的左括号前不应加空格.

Yes: spam(1)

no: spam (1)

Yes: dict['key'] = list[index]

No: dict ['key'] = list [index]

在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.

Yes: x == 1

No: x<1

当'='用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.

Yes: def complex(real, imag=0.0): return magic(r=real, i=imag)

No: def complex(real, imag = 0.0): return magic(r = real, i = imag)

不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):

Yes:

foo = 1000 # 注释

long_name = 2 # 注释不需要对齐

dictionary = {

"foo": 1,

"long_name": 2,

}

No:

foo = 1000 # 注释

long_name = 2 # 注释不需要对齐

dictionary = {

"foo" : 1,

"long_name": 2,

}

二、注释

确保对模块, 函数, 方法和行内注释使用正确的风格

文档字符串

Python有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的doc成员被自动提取, 并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号"""( 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐. 下面有更多文档字符串的格式化规范.

模块

每个文件应该包含一个许可样板. 根据项目使用的许可(例如, Apache 2.0, BSD, LGPL, GPL), 选择合适的样板.

函数和方法

下文所指的函数,包括函数, 方法, 以及生成器.

一个函数必须要有文档字符串, 除非它满足以下条件:

外部不可见

非常短小

简单明了

文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述"怎么做", 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.

关于函数的几个方面应该在特定的小节中进行描述记录，这几个方面如下文所述. 每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外, 节的其他内容应被缩进2个空格.

Args:

列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受foo(可变长度参数列表)或者bar (任意关键字参数), 应该详细列出foo和**bar.

Returns: (或者Yields: 用于生成器)

描述返回值的类型和语义. 如果函数返回None, 这一部分可以省略.

Raises:

列出与接口有关的所有异常.

deffetch_bigtable_rows(big_table,keys,other_silly_variable=None):

"""Fetches rows from a Bigtable.

Retrieves rows pertaining to the given keys from the Table instance

represented by big_table. Silly things may happen if

other_silly_variable is not None.

Args:

big_table: An open Bigtable Table instance.

keys: A sequence of strings representing the key of each table row

to fetch.

other_silly_variable: Another optional variable, that has a much

longer name than the other args, and which does nothing.

Returns:

A dict mapping keys to the corresponding table row data

fetched. Each row is represented as a tuple of strings. For

example:

{'Serak': ('Rigel VII', 'Preparer'),

'Zim': ('Irk', 'Invader'),

'Lrrr': ('Omicron Persei 8', 'Emperor')}

If a key from the keys argument is missing from the dictionary,

then that row was not found in the table.

Raises:

IOError: An error occurred accessing the bigtable.Table object.

"""

pass

块注释和行注释

最需要写注释的是代码中那些技巧性的部分. 如果你在下次代码审查的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.

# We use a weighted dictionary search to find out where i is in

# the array. We extrapolate position based on the largest num

# in the array and the array size and then do binary search to

# get the exact number.

ifi &(i-1)==0: # true iff i is a power of 2

为了提高可读性, 注释应该至少离开代码2个空格.

另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要做什么.

# BAD COMMENT: Now go through the b array and make sure whenever I occurs

# the next element is I+1

四、类

如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.

Yes: class SampleClass(object):

pass

class OuterClass(object):

class InnerClass(object):

pass

class ChildClass(ParentClass):

"""Explicitly inherits from another class already."""

No: class SampleClass:

pass

class OuterClass:

class InnerClass:

pass

继承自 object 是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不受Python 3000的一个特殊的潜在不兼容性影响. 这样做也定义了一些特殊的方法, 这些方法实现了对象的默认语义, 包括 new, init, delattr, getattribute, setattr, hash, repr, and str .

五、字符串

Yes: x = a + b

x = '%s, %s!' % (imperative, expletive)

x = '{}, {}!'.format(imperative, expletive)

x = 'name: %s; score: %d' % (name, n)

x = 'name: {}; score: {}'.format(name, n)

No: x = '%s%s' % (a, b) # use + in this case

x = '{}{}'.format(a, b) # use + in this case

x = imperative + ', ' + expletive + '!'

x = 'name: ' + name + '; score: ' + str(n)

避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的, 这样做会创建不必要的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加入列表, 然后在循环结束后用 .join 连接列表. (也可以将每个子串写入一个 cStringIO.StringIO 缓存中.)

Yes: items = ['

for last_name, first_name in employee_list:

items.append('

%s, %s' % (last_name, first_name))

items.append('

')

employee_table = ''.join(items)

No: employee_table = '

for last_name, first_name in employee_list:

employee_table += '

%s, %s' % (last_name, first_name)

employee_table += '

'

在同一个文件中, 保持使用字符串引号的一致性. 使用单引号'或者双引号"之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用. PyLint已经加入了这一检查.

Yes:

Python('Why are you hiding your eyes?')

Gollum("I'm scared of lint errors.")

Narrator('"Good!" thought a happy Python reviewer.')

No:

Python("Why are you hiding your eyes?")

Gollum('The lint. It burns. It burns us.')

Gollum("Always the great lint. Watching. Watching.")

为多行字符串使用三重双引号"""而非三重单引号'''. 当且仅当项目中使用单引号'来引用字符串时, 才可能会使用三重'''为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号""". 不过要注意, 通常用隐式行连接更清晰, 因为多行字符串与程序其他部分的缩进方式不一致.

Yes:

print ("This is much nicer.\n"

"Do it this way.\n")

No:

print """This is pretty ugly.

Don't do this.

"""

九、语句

通常每个语句应该独占一行

不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行. 如果是if语句, 只有在没有else时才能这样做. 特别地, 绝不要对 try/except 这样做, 因为try和except不能放在同一行.

Yes:

if foo: bar(foo)

No:

if foo: bar(foo)

else: baz(foo)

try: bar(foo)

except ValueError: baz(foo)

try:

bar(foo)

except ValueError: baz(foo)

十一、命名

应该避免的名称

单字符名称, 除了计数器和迭代器.

包/模块名中的连字符(-)

双下划线开头并结尾的名称(Python保留, 例如init)

命名约定

所谓"内部(Internal)"表示仅模块内可用, 或者, 在类内是保护或私有的.

用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).

用双下划线(__)开头的实例变量或方法表示类内私有.

将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.

Python之父Guido推荐的规范

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/Class Constants

CAPS_WITH_UNDER

_CAPS_WITH_UNDER

Global/Class Variables

lower_with_under

_lower_with_under

Instance Variables

lower_with_under

_lower_with_under (protected) or __lower_with_under (private)

Method Names

lower_with_under()

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

Function/Method Parameters

lower_with_under

Local Variables

lower_with_under

十二、Main

即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.

在Python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查 if name == 'main' , 这样当模块被导入时主程序就不会被执行.

def main():

...

if __name__ == '__main__':

main()

所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.