基本格式

缩进

使用4个空格进行缩进

行宽

每行代码尽量不超过80个字符

理由:

  • 这在查看side-by-side的diff时很有帮助
  • 方便在控制台下查看代码
  • 太长可能是设计有缺陷

换行

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)

使用反斜杠\换行,二元运算符+ .等应出现在行首,并与上一行的.=对齐;或者缩进4个空格。长字符串也可以用此法换行

foo = variable_with_long_name \+ another_variable \+ variablesession.query(MyTable) \.filter_by(id=1) \ .one() this_is_a_very_long(function_call, 'with many parameters') \ .that_returns_an_object_with_an_attribute print 'Hello, ' \ '%s %s!' % \ ('Harry', 'Potter')

多个元素的list或者tuple,在起始括号后换行,第二行缩进4个空格

items = ['this is the first', 'set of items', 'with more items', 'to come in this line', 'like this' ]

禁止复合语句,即一行中包含多个语句:

# yes
do_first()
do_second()
do_third()# no
do_first();do_second();do_third();

if/for/while一定要换行:

# yes
if foo == 'blah': do_blah_thing() # no if foo == 'blah': do_blash_thing()

空行

  • 模块级函数和类定义之间空两行;
  • 类成员函数之间空一行;
  • 不要使用太多的连续空行来区分代码的逻辑块
class A:"""This is a simple docstring."""def __init__(self): pass def hello(self): pass def hello(name): print "Hello %s!" % name def main(): pass

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

表达式

空格

  • 一元运算符不加空格
  • 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:
# yes
exp = -1.05
i = i + 1 submitted += 1 x = x * 2 - 1 hypot2 = x * x + y * y c = (a + b) * (a - b) # no exp = - 1.05 i=i+1 submitted +=1 x = x*2 - 1 hypot2 = x*x + y*y c = (a+b) * (a-b)

  • 函数的参数列表中,,之后要有空格
# yes
def complex(real, imag): pass # no def complex(real,imag): pass

  • 函数的参数列表中,默认值等号两边不要添加空格
# yes
def complex(real, imag=0.0): pass # no def complex(real, imag = 0.0): pass

  • 左括号之后,右括号之前不要加多余的空格
# yes
spam(ham[1], {eggs: 2})
value = my_list[index]# no spam( ham[1], { eggs : 2 } ) value = my_list[ index ]

  • 字典、列表对象的左括号之前不要多余的空格
# yes
dict['key'] = list[index] # no dict ['key'] = list [index]

  • 不要为对齐赋值语句而使用的额外空格
# yes
x = 1
y = 2 long_variable = 3 # no x = 1 y = 2 long_variable = 3

比较

  • 使用变量在左,常量在右
  • 不显示进行对TrueFalse的比较
  • 否定比较采用,foo not in bar的形式,而不是not foo in bar
  • 使用instance(a, C)进行实例的类型检查,而不是type(A) is C
# yes
if method == 'md5': pass if not foo: pass if foo not in bar: pass if instance(a, C): pass # no if 'md5' == method: pass if foo == False: pass if not foo in bar: pass if type(A) is C: pass

引号

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

  • 自然语言 使用双引号 "..."
    例如错误信息;很多情况还是unicode,使用u"你好世界"
  • 机器标识 使用单引号 '...' 例如dict里的key
  • 正则表达式 使用原生的双引号 r"..."
  • 文档字符 使用三个双引号 """......"""

import语句

  • import语句应该分行书写
# yes
import os
import sys# no import sys,os # yes from subprocess import Popen, PIPE

  • import语句应该使用 absolute import
# yes
from foo.bar import Bar# no from ..bar import Bar

  • import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前;
  • import语句应该按照顺序排列,每组之间用空行分隔
import os
import sysimport msgpack
import zmqimport foo

  • 导入其他模块的类定义时,可以使用相对导入
from myclass import MyClass

  • 如果发生命名冲突,则可使用命名空间
import bar
import foo.barbar.Bar()
foo.bar.Bar()

注释

块注释

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

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

行注释

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

# yes
x = x + 1  # 边框加粗一个像素 # no x = x + 1 # x加1 

docstring

docstring的规范在 PEP 257 中有详细描述,其中最其本的两点:

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

命名规范

  • 应避免使用小写字母l(L),大写字母O(o)I(i)单独作为一个变量的名称,以区分数字10
  • 包和模块使用全小写命名,尽量不要使用下划线
  • 类名使用CamelCase命名风格,内部类可用一个下划线开头;
    约定的缩写保留原样,例如使用HTTPWriter而不是HttpWriter
  • 函数使用下划线分隔的小写命名,lowercase_with_underscores
  • 当参数名称和Python保留字冲突,可在最后添加一个下划线,尽量不是使用缩写或自造的词
  • 常量使用以下划线分隔的大写命名,UPPERCASE_WITH_UNDERSCORES
  • Precompiled regular expressions: name_re
MAX_OVERFLOW = 100Class FooBar:def foo_bar(self, print_): print(print_) 

Function and method arguments:

  • Class methods: cls as first parameter.
  • Instance methods: self as first parameter.
  • Lambdas for properties may have the first parameter replaced with x, as in display_name = property(lambda x: x.real_name or x.username).

编码

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

转载于:https://www.cnblogs.com/nullblogs/p/7612883.html

团队编程项目代码设计规范(爬取豆瓣电影top250)相关推荐

  1. python爬取豆瓣电影top250_Python爬虫——爬取豆瓣电影Top250代码实例

    利用python爬取豆瓣电影Top250的相关信息,包括电影详情链接,图片链接,影片中文名,影片外国名,评分,评价数,概况,导演,主演,年份,地区,类别这12项内容,然后将爬取的信息写入Excel表中 ...

  2. python爬取豆瓣电影top250的代码_Python爬虫——爬取豆瓣电影Top250代码实例

    利用python爬取豆瓣电影Top250的相关信息,包括电影详情链接,图片链接,影片中文名,影片外国名,评分,评价数,概况,导演,主演,年份,地区,类别这12项内容,然后将爬取的信息写入Excel表中 ...

  3. python爬取豆瓣电影top250_【Python3爬虫教程】Scrapy爬取豆瓣电影TOP250

    今天要实现的就是使用是scrapy爬取豆瓣电影TOP250榜单上的电影信息. 步骤如下: 一.爬取单页信息 首先是建立一个scrapy项目,在文件夹中按住shift然后点击鼠标右键,选择在此处打开命令 ...

  4. 03_使用scrapy框架爬取豆瓣电影TOP250

    前言: 本次项目是使用scrapy框架,爬取豆瓣电影TOP250的相关信息.其中涉及到代理IP,随机UA代理,最后将得到的数据保存到mongoDB中.本次爬取的内容实则不难.主要是熟悉scrapy相关 ...

  5. jsoup爬取豆瓣电影top250

    文章目录 0.准备工作 1. 分析 2. 构思 3. 编程 3.1 定义一个bean,用于保存电影的数据 3.2 按照之前的构思进行编程 4.效果图 5.获取资源 5.1GitHub 5.2百度云 0 ...

  6. scrapy1.3爬取豆瓣电影top250

    学习<爬虫框架scrapy,爬取豆瓣电影top250>,用scrapy1.3实践,记录学习过程 1 . 新建项目 进入打算存储代码的目录,命令行运行如下语句 scrapy startpro ...

  7. 一起学爬虫——通过爬取豆瓣电影top250学习requests库的使用

    一起学爬虫--通过爬取豆瓣电影top250学习requests库的使用 学习一门技术最快的方式是做项目,在做项目的过程中对相关的技术查漏补缺. 本文通过爬取豆瓣top250电影学习python req ...

  8. 案例:爬取豆瓣电影Top250中的电影信息

    案例:爬取豆瓣电影Top250中的电影信息 豆瓣电影Top250首页 分析请求地址 在豆瓣电影Top250首页的底部可以确定电影信息一共有10页内容,每页25个电影信息,如下图: 切换页面,可以看到浏 ...

  9. 利用python爬取豆瓣电影top250

    利用python爬取豆瓣电影top250: 注:本内容只是作为个人学习记录 1.业务分析 进入网页https://movie.douban.com/top250 可以看见每部电影都呈现在眼前,点击电影 ...

  10. Python爬虫 爬取豆瓣电影TOP250

    Python爬虫 爬取豆瓣电影TOP250 最近在b站上学习了一下python的爬虫,实践爬取豆瓣的电影top250,现在对这两天的学习进行一下总结 主要分为三步: 爬取豆瓣top250的网页,并通过 ...

最新文章

  1. 适应安装程序用的TreeView控件
  2. navicat for mysql 导入psc文件
  3. 10、MySQL常用运算符概述
  4. [BZOJ3545][ONTAK2010]Peaks
  5. POJ1006-Biorhythms【中国剩余定理】
  6. Java:计算类的serialVersionUID
  7. leetcode 5756. 两个数组最小的异或值之和(状态压缩dp)
  8. vbs 连oracle 负载均衡,(原)QTP中用VBS调用PLSQL并执行相关语句
  9. 你所不了解的五条面试忠告
  10. LeetCode 429. N叉树的层序遍历(queue)
  11. 什么是JAVA内容仓库(Java Content Repository)(4完)
  12. Kafka、RabbitMQ、RocketMQ比较
  13. 5个界面效果很炫的JavaScript UI 框架
  14. 下列符合c语言语法的变量名是,设有关变量已经正确定义并赋值,则下列表达式中符合C语言语法规则的是...
  15. 深度学习模型---稀疏编码 Sparse Coding
  16. 韩立刚计算机网络——第七章:Internet 上面的音频和视频
  17. Entrez Direct
  18. 洛谷刷题C语言:CRNE、CETIRI、PRASE
  19. STM32CubeMX下STM32单片机环境光传感器(ADC)
  20. matlab ewt使用方法,ewt升学e网通怎么使用,ewt升学e网通使用解析

热门文章

  1. linux变量转义,关于linux:在Bash变量中转义awk参数
  2. php类使用自己的静态方法吗,php在类中使用静态方法有几种方式
  3. latex绘图笔记(一)
  4. python3基础知识_python3基础知识梳理
  5. leetcode 4
  6. 洛谷P1122 最大子树和 树形DP初步
  7. 玩转mini2440开发板之【使用nfs无法启动的问题(Virtualbox桥接网络)】
  8. C语言中无符号数和有符号数相加问题
  9. 关于自旋锁的一些文章摘记
  10. Linux维护笔记五