Python小知识：Python代码规范和命名规范_python 布尔值 函数 命名 规范(1)

def hello(self):
       passdef main():
   pass

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


##### 3、import 语句


* import 语句应该分行书写

正确的写法

import os
import sys

不推荐的写法

import sys,os

正确的写法

from subprocess import Popen, PIPE

* import语句应该使用 absolute import

正确的写法

from foo.bar import Bar

不推荐的写法

from …bar import Bar

* import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；
* import语句应该按照顺序排列，每组之间用一个空行分隔

import os
import sys

import msgpack
import zmq

import foo

* 导入其他模块的类定义时，可以使用相对导入

from myclass import MyClass

* 如果发生命名冲突，则可使用命名空间

import bar
import foo.bar

bar.Bar()
foo.bar.Bar()

##### 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 = x2 - 1
hypot2 = xx + y*y
c = (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 = 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()

##### 6、docstring


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


* 1）所有的公共模块、函数、类、方法，都应该写 docstring 。私有方法不一定需要，但应该在 def 后提供一个块注释来说明。
* 2）docstring 的结束”””应该独占一行，除非此 docstring 只有一行。

“”“Return a foobar
Optional 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给出自动提示.


* 文档注释以 “”” 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例

-*- coding: utf-8 -*-

“”"Example docstrings.

This module demonstrates documentation as specified by the Google Python Style Guide_. Docstrings may extend over multiple lines. Sections are created
with 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.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
“”"

* 不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等

不推荐的写法(不要写函数原型等废话)

def function(a, b):
   “”“function(a, b) -> list”“”

一、Python所有方向的学习路线

Python所有方向路线就是把Python常用的技术点做整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。

二、学习软件

工欲善其事必先利其器。学习Python常用的开发软件都在这里了，给大家节省了很多时间。

三、入门学习视频

我们在看视频学习的时候，不能光动眼动脑不动手，比较科学的学习方法是在理解之后运用它们，这时候练手项目就很适合了。

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里无偿获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！