python编程和命名规范

https://blog.csdn.net/warm77/article/details/78353632

前言

Python 学习之旅，先来看看 Python 的代码规范，让自己先有个意识，而且在往后的学习中慢慢养成习惯

一、简明概述

1、编码

• 文件使用 UTF-8 编码
• 文件头部加入#-*-conding:utf-8-*-标识

2、缩进

• 统一使用4个空格进行缩进

3、空行

• 模块级函数和类定义之间空两行；

类成员函数之间空一行；

class A:
    # 这儿要不要空行呢？？？？
    def __init__(self):
        pass
 
    def hello(self):
        pass


def main():
    pass 

• 可以使用多个空行分隔多组相关的函数
• 函数中可以使用空行分隔出逻辑相关的代码

4、空格

• 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:

# 正确的写法
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)
 
# 不推荐的写法
i=i+1
submitted +=1
x = x*2 - 1
hypot2 = x*x + y*y

• 函数的参数列表中，之后要有空格

# 正确的写法
def complex(real, imag):
    pass
 
# 不推荐的写法
def complex(real,imag):

• 函数的参数列表中，默认值等号两边不要添加空格

# 正确的写法
def complex(real, imag=0.0):
    pass
 
# 不推荐的写法
def complex(real, imag = 0.0):
    pass

• 左括号之后，右括号之前不要加多余的空格

# 正确的写法
spam(ham[1], {eggs: 2})
 
# 不推荐的写法
spam( ham[1], { eggs : 2 } )

字典的冒号之前不要加空格，冒号之后加一个空格

# 正确的写法
temp = {'name': 'zhangsan'}

# 不推荐的写法
temp = {'name':'zhangsan'}
temp = {'name' : 'zhangsan'}

• 不要为对齐赋值语句而使用的额外空格

# 正确的写法
x = 1
y = 2
long_variable = 3
 
# 不推荐的写法
x             = 1
y             = 2
long_variable = 3

5、换行

Python 支持括号内的换行。这时有两种情况。

1) 第二行缩进到括号的起始处

foo = long_function_name(var_one, var_two,
                         var_three, var_four)

2) 第二行缩进 4 个空格，适用于起始括号就换行的情形

def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

使用反斜杠\换行，二元运算符+ .等应出现在行末；长字符串也可以用此法换行

session.query(MyTable).\
        filter_by(id=1).\
        one()
 
print 'Hello, '\
      '%s %s!' %\
      ('Harry', 'Potter')

禁止复合语句，即一行中包含多个语句：

# 正确的写法
do_first()
do_second()
do_third()
 
# 不推荐的写法
do_first();do_second();do_third();

if/for/while一定要换行：

# 正确的写法
if foo == 'blah':
    do_blah_thing()
 
# 不推荐的写法
if foo == 'blah': do_blash_thing()

二、注释

1、行注释

至少使用两个空格分开，“#“号后空一格，注意不要使用无意义的注释。

# 正确的写法
x = x + 1  # 让表框加粗一个像素

# 不推荐的写法（无意义的注释）
x = x + 1  # x加1

三、命名规范

1、模块

• 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

# 正确的模块名
import decoder
import html_parser
 
# 不推荐的模块名
import Decoder

2、类名

• 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

class Farm():
    pass
 
class AnimalFarm(Farm):
    pass
 
class _PrivateFarm(Farm):
    pass

3.函数

• 函数名一律小写，如有多个单词，用下划线隔开

def run():
    pass
 
def run_with_env():
    pass

• 私有函数在函数前加一个下划线_

class Person():
 
    def _private_func():
        pass

4.普通变量名

• 普通变量名尽量小写, 如有多个单词，用下划线隔开

if __name__ == '__main__':
    count = 0
    school_name = ''

5.常量名和全局变量名

• 采用全大写，如有多个单词，使用下划线隔开

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

6.文件名

• 全小写，可使用下划线

7.命名规则

• 任何模块名或者函数名，都不要和保留的关键字一样。如用type。不要包含test。