2023年8月2日发(作者：)

【shell】代码编写规范通⽤排版规范1、程序块要采⽤缩进风格编写。函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采⽤缩进风格。例：# ⽂件⾃检file_check(){ if [[ ! -n $file_01 ]];then echo "TM_ ⽂件不存在。" exit elif [[ ! -n $file_02 ]];then echo "TM_ ⽂件不存在。"

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个字符。以下情况除外长的导⼊模块语句注释⾥的URLshell⼀、注释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 # [/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_](/us/developer/documeNo: # See details at # [/us/developer/documentation/api/content/](/us/developer/documentation/api/content/) # v2.0/csv_file_name_extension_full_注意上⾯例⼦中的元素缩进; 你可以在本⽂的: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 (): ...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, xNo: 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 == 1No: 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试⼀把, 看看它长什么样). 我们对⽂档字符串的惯例是使⽤三重双引号"""( PEP-257 ). ⼀个⽂档字符串应该这样组织: ⾸先是⼀⾏以句号, 问号或惊叹号结尾的概述(或者该⽂档字符串单纯只有⼀⾏). 接着是⼀个空⾏. 接着是⽂档字符串剩下的部分, 它应该与⽂档字符串的第⼀⾏的第⼀个引号对齐. 下⾯有更多⽂档字符串的格式化规范.模块每个⽂件应该包含⼀个许可样板. 根据项⽬使⽤的许可(例如, Apache 2.0, BSD, LGPL, GPL), 选择合适的样板.函数和⽅法下⽂所指的函数,包括函数, ⽅法, 以及⽣成器.⼀个函数必须要有⽂档字符串, 除⾮它满⾜以下条件:1. 外部不可见2. ⾮常短⼩3. 简单明了⽂档字符串应该包含函数做什么, 以及输⼊和输出的详细描述. 通常, 不应该描述"怎么做", 除⾮是⼀些复杂的算法. ⽂档字符串应该提供⾜够的信息, 当别⼈编写代码调⽤该函数时, 他不需要看⼀⾏代码, 只要看⽂档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会⽐使⽤⽂档字符串更有意义.关于函数的⼏个⽅⾯应该在特定的⼩节中进⾏描述记录，这⼏个⽅⾯如下⽂所述. 每节应该以⼀个标题⾏开始. 标题⾏以冒号结尾. 除标题⾏外, 节的其他内容应被缩进2个空格.Args:列出每个参数的名字, 并在名字后使⽤⼀个冒号和⼀个空格, 分隔对该参数的描述.如果描述太长超过了单⾏80字符,使⽤2或者4个空格的悬挂缩进(与⽂件其他部分保持⼀致). 描述应该包括所需的类型和含义. 如果⼀个函数接受foo(可变长度参数列表)或者bar (任意关键字参数), 应该详细列出foo和**s: (或者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 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 &(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 连接列表. (也可以将每个⼦串写⼊⼀个 IO 缓存中.)Yes: items = ['

'] for last_name, first_name in employee_list: ('' % (last_name, first_name)) ('

%s, %s

') employee_table = ''.join(items)No: employee_table = '' for last_name, first_name in employee_list: employee_table += '' % (last_name, first_name) employee_table += '

%s, %s

' 在同⼀个⽂件中, 保持使⽤字符串引号的⼀致性. 使⽤单引号'或者双引号"之⼀⽤以引⽤字符串, 并在同⼀⽂件中沿⽤. 在字符串内可以使⽤另外⼀种引号, 以避免在字符串中使⽤. 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)⼗⼀、命名应该避免的名称1. 单字符名称, 除了计数器和迭代器.2. 包/模块名中的连字符(-)3. 双下划线开头并结尾的名称(Python保留, 例如init)命名约定1. 所谓"内部(Internal)"表⽰仅模块内可⽤, 或者, 在类内是保护或私有的.2. ⽤单下划线(_)开头表⽰模块变量或函数是protected的(使⽤import * from时不会包含).3. ⽤双下划线(__)开头的实例变量或⽅法表⽰类内私有.4. 将相关的类和顶级函数放在同⼀个模块⾥. 不像Java, 没必要限制⼀个类⼀个模块.5. 对类名使⽤⼤写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该⽤⼩写加下划线的⽅式(如lower_with_). 尽管已经有很多现存的模块使⽤类似于这样的命名, 但现在已经不⿎励这样做, 因为如果模块名碰巧和类名⼀致, 这会让⼈困扰.Python之⽗Guido推荐的规范TypeModulesPackagesClassesExceptionsFunctionsGlobal/Class ConstantsGlobal/Class VariablesInstance VariablesPubliclower_with_underlower_with_underCapWordsCapWordslower_with_under()CAPS_WITH_UNDERlower_with_underlower_with_under_lower_with_under()_CAPS_WITH_UNDER_lower_with_under_CapWords_lower_with_underInternal_lower_with_under (protected) or __lower_with_under(private)_lower_with_under() (protected) or __lower_with_under()(private)Method NamesFunction/MethodParametersLocal Variableslower_with_under()lower_with_underlower_with_under⼗⼆、Main 即使是⼀个打算被⽤作脚本的⽂件, 也应该是可导⼊的. 并且简单的导⼊不应该导致这个脚本的主功能(main functionality)被执⾏, 这是⼀种副作⽤. 主功能应该放在⼀个main()函数中. 在Python中, pydoc以及单元测试要求模块必须是可导⼊的. 你的代码应该在执⾏主程序前总是检查 if name == 'main' , 这样当模块被导⼊时主程序就不会被执⾏.def main(): ...

if __name__ == '__main__': main() 所有的顶级代码在模块导⼊时都会被执⾏. 要⼩⼼不要去调⽤函数, 创建对象, 或者执⾏那些不应该在使⽤pydoc时执⾏的操作.