01-Python命令规范【转载】

2018-11-11  本文已影响0人  __流云

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

代码写多了就会想写规范一点,个人觉得这篇文章很好,故转载。

================================================

Python代码规范和命名规范

前言

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

目录

一、简明概述****1、编码

2、代码格式

2.1、缩进

2.2、行宽

每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ,但最长不得超过 120)

理由:

2.3、引号

简单说,自然语言使用双引号,机器标示使用单引号,因此 代码里 多数应该使用 单引号

2.4、空行

class A:     def __init__(self):        pass     def hello(self):        pass def main():    pass   

2.5、编码

3、import 语句

# 正确的写法import osimport sys # 不推荐的写法import sys,os # 正确的写法from subprocess import Popen, PIPE
# 正确的写法from foo.bar import Bar # 不推荐的写法from ..bar import Bar
import osimport sys import msgpackimport zmq import foo
from myclass import MyClass
import barimport foo.bar bar.Bar()foo.bar.Bar()

4、空格

# 正确的写法i = i + 1submitted += 1x = x * 2 - 1hypot2 = x * x + y * yc = (a + b) * (a - b) # 不推荐的写法i=i+1submitted +=1x = x*2 - 1hypot2 = x*x + y*yc = (a+b) * (a-b)
# 正确的写法def complex(real, imag):    pass # 不推荐的写法def complex(real,imag):    pass
# 正确的写法def complex(real, imag=0.0):    pass # 不推荐的写法def complex(real, imag = 0.0):    pass
# 正确的写法spam(ham[1], {eggs: 2}) # 不推荐的写法spam( ham[1], { eggs : 2 } )
# 正确的写法dict['key'] = list[index] # 不推荐的写法dict ['key'] = list [index]
# 正确的写法x = 1y = 2long_variable = 3 # 不推荐的写法x             = 1y             = 2long_variable = 3

5、换行

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

  1. 第二行缩进到括号的起始处
foo = long_function_name(var_one, var_two,                         var_three, var_four)
  1. 第二行缩进 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()

6、docstring

docstring 的规范中最其本的两点:

  1. 所有的公共模块、函数、类、方法,都应该写 docstring 。私有方法不一定需要,但应该在 def 后提供一个块注释来说明。
  2. docstring 的结束"""应该独占一行,除非此 docstring 只有一行。
"""Return a foobarOptional plotz says to frobnicate the bizbaz first.""" """Oneline docstring"""

二、注释****1、注释

1.1、块注释

“#”号后空一格,段落件用空行分开(同样需要“#”号)

# 块注释# 块注释## 块注释# 块注释

1.2、行注释

至少使用两个空格和语句分开,注意不要使用无意义的注释

# 正确的写法x = x + 1  # 边框加粗一个像素 # 不推荐的写法(无意义的注释)x = x + 1 # x加1

1.3、建议

app = create_app(name, options) # =====================================# 请勿在此处添加 get post等app路由行为 !!!# ===================================== if __name__ == '__main__':    app.run()

2、文档注释(Docstring)

作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的doc对象获取文档.
编辑器和IDE也可以根据Docstring给出自动提示.

# -*- coding: utf-8 -*-"""Example docstrings.This module demonstrates documentation as specified by the `Google PythonStyle Guide`_. Docstrings may extend over multiple lines. Sections are createdwith a section header and a colon followed by a block of indented text.Example:    Examples can be given using either the ``Example`` or ``Examples``    sections. Sections support any reStructuredText formatting, including    literal blocks::        $ python example_google.pySection breaks are created by resuming unindented text. Section breaksare also implicitly created anytime a new section starts."""
#  不推荐的写法(不要写函数原型等废话)def function(a, b):    """function(a, b) -> list"""    ... ... #  正确的写法def function(a, b):    """计算并返回a到b范围内数据的平均值"""    ... ...
def func(arg1, arg2):    """在这里写函数的一句话总结(如: 计算平均值).    这里是具体描述.    参数    ----------    arg1 : int        arg1的具体描述    arg2 : int        arg2的具体描述    返回值    -------    int        返回值的具体描述    参看    --------    otherfunc : 其它关联函数等...    示例    --------    示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行    >>> a=[1,2,3]    >>> print [x + 3 for x in a]    [4, 5, 6]    """

三、命名规范****1、模块

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

2、类名

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 = ''
MAX_CLIENT = 100MAX_CONNECTION = 1000CONNECTION_TIMEOUT = 600

5、常量

MAX_OVERFLOW = 100 Class FooBar:     def foo_bar(self, print_):

上一篇 下一篇

猜你喜欢

热点阅读