文档章节

Flask 开发团队内部 Python 编码风格指南

大数据之路
 大数据之路
发布于 2016/02/17 00:25
字数 1632
阅读 555
收藏 17
点赞 1
评论 0

1、Pocoo Team简介

Pocoo团队的成员来自Python社区,统一以Pocoo的名义参与多个Python库和应用的开发工作。团队由Georg Brandl和Armin Ronacher领导。

团队项目

Pocoo团队开发了许多广受欢迎的项目,其中包括:

Pocoo团队编码风格指南适用于所有Pocoo团队的项目。总体来说,Pocoo团队编码风格指南严格遵循了PEP8的要求,但略有一些不同之处,并进行了一定的扩展延伸。

2、代码布局(General Layout)

  • 缩进(Indentation)

4个空格。不能使用Tab制表符,没有例外。

  • 每行最大长度

79个字符,如果必要可以接受最多84个字符。尽量避免代码嵌套层级过多,可以通过巧妙地使用breakcontinuereturn语句实现。

  • 长语句换行

编写长语句时,可以使用换行符(\)换行。在这种情况下,下一行应该与上一行的最后一个“.”句点或“=”对齐,或者是缩进4个空格符

this_is_a_very_long(function_call, 'with many parameters') \
    .that_returns_an_object_with_an_attribute

MyModel.query.filter(MyModel.scalar > 120) \
             .order_by(MyModel.name.desc()) \
             .limit(10)

如果你使用括号“()”或花括号“{}”为长语句换行,那么下一行应与括号或花括号对齐:

this_is_a_very_long(function_call, 'with many parameters',
                    23, 42, 'and even more')

对于元素众多的列表或元组,在第一个“[”或“(”之后马上换行:

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

顶层函数与类之间空两行,此外都只空一行。不要在代码中使用太多的空行来区分不同的逻辑模块。

示例:

def hello(name):
    print 'Hello %s!' % name


def goodbye(name):
    print 'See you %s.' % name


class MyClass(object):
    """This is a simple docstring."""

    def __init__(self, name):
        self.name = name

    def get_annoying_name(self):
        return self.name.upper() + '!!!!111'

3、表达式和语句

一般空格规则

  • 单目运算符与运算对象之间不空格(例如,-,~等),即使单目运算符位于括号内部也一样。

  • 双目运算符与运算对象之间要空格。

好风格:

exp = -1.05
value = (item_value / item_count) * offset / exp
value = my_list[index]
value = my_dict['key']

坏风格:

exp = - 1.05
value = ( item_value / item_count ) * offset / exp
value = (item_value/item_count)*offset/exp
value=( item_value/item_count ) * offset/exp
value = my_list[ index ]
value = my_dict ['key']

不能编写尤达语句

(Yoda Statements,指的是类似星战中尤达大师那样颠倒句子的正常顺序):

不要拿常量与变量进行对比,应该拿变量与常量进行对比。

好风格:

if method == 'md5':
    pass

坏风格:

if 'md5' == method:
    pass

比较:

  • 任意类型之间的比较,使用“==”和“!=”。

  • 与单例(singletons)进行比较时,使用isis not

  • 永远不要与TrueFalse进行比较(例如,不要这样写:foo == False,而应该这样写:not foo)。

否定成员关系检查:

使用foo not in bar,而不是not foo in bar

实例检查:

使用isinstance(a, C),而不是type(a) is C。但是一般要避免做实例检查。建议检查实例的特性。

4、命名规范

  • 类名称:采用骆驼拼写法(CamelCase),首字母缩略词保持大写不变(HTTPWriter,而不是HttpWriter)。

  • 变量名:小写_以及_下划线(lowercase_with_underscores)。

  • 方法与函数名:小写_以及_下划线(lowercase_with_underscores)。

  • 常量:大写_以及_下划线(UPPERCASE_WITH_UNDERSCORES)。

  • 预编译的正则表达式:name_re。

受保护的元素以一个下划线为前缀。双下划线前缀只有定义混入类(mixin classes)时才使用。

如果使用关键词(keywords)作为类名称,应在名称后添加后置下划线(trailing underscore)。允许与内建变量重名,不要在变量名后添加下划线进行区分。如果函数需要访问重名的内建变量,请将内建变量重新绑定为其他名称。

函数和方法的参数:

  • 类方法:cls为第一个参数。

  • 实例方法:self为第一个参数。

  • property函数中使用匿名函数(lambdas)时,匿名函数的第一个参数可以用x替代,例如:

    display_name = property(lambda x: x.real_name or x.username)

5、文档字符串

  • 文档字符串规范:

所有文档字符串均以reStructuredText格式编写,方便Sphinx处理。文档字符串的行数不同,布局也不一样。如果只有一行,代表字符串结束的三个引号与代表字符串开始的三个引号在同一行。如果为多行,文档字符串中的文本紧接着代表字符串开始的三个引号编写,代表字符串结束的三个引号则自己独立成一行。

def foo():
    """This is a simple docstring."""


def bar():
    """This is a longer docstring with so much information in there
    that it spans three lines.  In this case, the closing triple quote
    is on its own line.
    """

一般来说,文档字符串应分成简短摘要(尽量一行)和详细介绍。如果必要的话,摘要与详细介绍之间空一行。

  • 模块头部:

模块文件的头部包含有utf-8编码声明(如果模块中使用了非ASCII编码的字符,建议进行声明),以及标准的文档字符串。

# -*- coding: utf-8 -*-
"""
    package.module
    ~~~~~~~~~~~~~~

    A brief description goes here.

    :copyright: (c) YEAR by AUTHOR.
    :license: LICENSE_NAME, see LICENSE_FILE for more details.
"""

请注意,要让你开发的Flask扩展(extension)通过官方团队审核,则必须提供相应的版权与协议文件。

6、注释

注释的规范与文档字符串编写规范类似。二者均以reStructuredText格式编写。如果使用注释来编写类属性的文档,请在#符号后添加一个冒号 :。

class User(object):
    #: the name of the user as unicode string
    name = Column(String)
    #: the sha1 hash of the password + inline salt
    pw_hash = Column(String)

Refer:

[1] The Pocoo Style Guide

http://www.pocoo.org/internal/styleguide/

本文转载自:http://codingpy.com/article/pocoo-internal-style-guide-cn/

共有 人打赏支持
大数据之路
粉丝 1476
博文 501
码字总数 343984
作品 0
武汉
架构师
时隔 8 年,Flask 1.0 终于发布,放弃支持 Py 2.6 和 3.3

(点击上方公众号,可快速关注) 【导读】:在浏览器拼版本号的时代,有些软件的更新,则显得龟速了。比如:2017 年,Python 科学计算库 SciPy 时隔 16 年后才升到 1.0 版。还有,今天本文的...

p5deyt322jacs ⋅ 05/02 ⋅ 0

web开发快餐式入门指南 0. 写在前面

Web框架层出不穷,然而它们又大同小异。绝大多数框架都按照MVC架构风格所设计,所以他们提供的组件和功能都十分类似。很多教程在讲解如何使用某一框架开发Web应用时,专注于它在这个框架的实...

apachecn_飞龙 ⋅ 2016/02/23 ⋅ 0

python-成长之路

一系列python方面有价值的参考/跟python有关的东西 http://www.path8.net/tn/archives/6017 Tools PyCharm – 来自JetBrains的强大的IDE Python Tools for Visual Studio Eclipse + pydev Ap......

_Mr_Computer_ ⋅ 2016/07/01 ⋅ 0

高手问答第 202 期 —— 想要玩转 Python?不妨从 Python 网络爬虫开始

OSCHINA 本期高手问答(2018 年 6 月 20 日 — 6 月 26 日)我们邀请到了黄永祥@XyHJw 和大家一起讨论关于 Python 爬虫的问题。 黄永祥,信息管理与信息系统专业学士,曾从事过系统开发和自动化...

局长 ⋅ 06/19 ⋅ 0

【Python搞搞轻量Blog】第一发 Flask入门

大家好,我是仙宇(其实就是咸鱼) 我发现很多小伙伴一直想着有自己的一个博客,而且还想自己写一个。 你们都这么爱折腾,我就给你们搞一个轻量级级别的Blog. 准备 我们要用Python来写一套轻量...

仙宇 ⋅ 03/30 ⋅ 0

使用PyCharm进行Python远程开发

本文翻译自 Feature Spotlight: Python remote development with PyCharm,讲述如何使用PyCharm进行Python远程开发。全文系作者原创,仅供学习参考使用,转载授权请私信联系,否则将视为侵权...

郗南枫 ⋅ 05/20 ⋅ 0

八年磨一剑,Python Web 框架 Flask 1.0 正式发布

Flask 1.0 已正式发布,Flask 是一个微型的 Python 开发的 Web 框架,最初构建于 2010 年,至今已发展 8 年。 示例代码: from flask import Flaskapp = Flask(name)@app.route("/")def hel...

王练 ⋅ 04/27 ⋅ 2

Flask 发布 1.0 稳定版

简评:现在都开始版本大跃进了吗?对,别看别人,说的就是你 pipenv(名单太长,待补齐...) Flask 其实早就已经十分稳定了,而在第一个 commit 大概 8 年之后,版本号才最终反映出了这一点。...

极小光 ⋅ 05/04 ⋅ 0

开源电子书

目录 语言无关类 操作系统 智能系统 分布式系统 编译原理 函数式概念 计算机图形学 WEB服务器 版本控制 编辑器 NoSQL PostgreSQL MySQL 管理和监控 项目相关 设计模式 Web 大数据 编程艺术 ...

zting科技 ⋅ 2017/12/11 ⋅ 0

Python:经过了十几年,你们还没有消除的对我的误解吗?

摘要: 大学毕业到现在用的最多的编程语言还是C,C++,后来学习了一下Python,觉得Python是门学了不后悔的语言。尤其适合非程序员学习,作为青少年学习计算机的首门语言也不错,大学生学习计...

雁横 ⋅ 05/03 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

Spring Cloud构建微服务架构—创建“服务注册中心”

创建一个基础的Spring Boot工程,命名为eureka-server,并在pom.xml中引入需要的依赖内容: <parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-par......

itcloud ⋅ 14分钟前 ⋅ 0

拖动

<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>event</title> <style> #box { width: 100px; height: 100px; background-color: aquamarine; position: absolute; } </style......

fyliujj ⋅ 16分钟前 ⋅ 0

es6 polyfill array

polyfill之javascript函数的兼容写法——Array篇 1. Array.isArray(obj) if (!Array.isArray) { Array.isArray = function(arg) { return Object.prototype.toString.call(arg) === '[objec......

球球 ⋅ 18分钟前 ⋅ 0

kibana启动异常

检查一下:kibana.yml 每一对key:value中,冒号之后应有空格。

增删改查1 ⋅ 20分钟前 ⋅ 0

js修改img的src属性刷新图片时的图片缓存问题

问题:上传一张图片,通过js更新src属性刷新图片使其即时显示时, 当img的src当前的url与上次地址无变化时(只更改图片,名称不变,不同图片名称相同)图片不变化(仍显示原来的图片) 但通过...

HaierBrother ⋅ 20分钟前 ⋅ 0

Mysql

1.Jdbc Url 设置allowMultiQueries为true和false mysql的批量更新是要我们主动去设置的, 就是在数据库的连接url上设置一下,加上* &allowMultiQueries=true *即可。 参数名称 参数说明 缺省...

瑟青豆 ⋅ 24分钟前 ⋅ 0

mysql导出导入表结构与数据

当我们需要进行数据迁移时,mysql自带的mysqldump会是最好的方式。 1.导出某张表的结构和数据 首先,我们应当使用服务器,打开终端,连接到所需要导出的表所在的服务器上。执行命令: mysqld...

hengbao5 ⋅ 24分钟前 ⋅ 0

世界杯也走向“比拼”大数据的时代

《日本经济新闻》6月19日报道称,俄罗斯足球世界杯已于6月14日揭开战幕。作为第21次举办的足球世界杯,如何活用大数据有可能成为决定各支球队胜负的重要因素。从对阵球队的分析到战术建议,还...

加米谷大数据 ⋅ 24分钟前 ⋅ 0

金额转为千分制,金额转中文大写

金额转关为大写 /** 数字金额大写转换(可以处理整数,小数,负数) */ function digitUppercase(n){ if(!n) reutrn "" let fraction = ['角', '分']; let digit = [...

YXMBetter ⋅ 27分钟前 ⋅ 0

开发利器JRebel部署SpringBoot项目

不要以为年纪轻轻就跌倒了人生谷底,未来还有更大的下降空间等着你。 idea下载和安装JRebel 激活JRebel 访问https://my.jrebel.com/ 使用facebook或twitter登录 勾选 Build project automati...

郑龙飞 ⋅ 33分钟前 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部