文档章节

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

大数据之路
 大数据之路
发布于 2016/02/17 00:25
字数 1632
阅读 593
收藏 17

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/

共有 人打赏支持
大数据之路
粉丝 1543
博文 516
码字总数 343694
作品 0
武汉
架构师
私信 提问
免费的计算机编程类中文书籍

免费的编程中文书籍索引,欢迎投稿。 国外程序员在 stackoverflow 推荐的程序员必读书籍,中文版。 stackoverflow 上的程序员应该阅读的非编程类书籍有哪些? 中文版 github 上的一个流行的编...

justjavac
2014/08/13
2.8K
10
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
0
web开发快餐式入门指南 0. 写在前面

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

apachecn_飞龙
2016/02/23
0
0
python开发者的必备工具(一)

1.python开发工具 pip 可以快速安装第三方python包; virtualenv 可以创建一个与外界隔离的python运行环境,使项目更加可控; virtualenvwrapper 使用它可以更加方便的使用virtualenv提供的功...

柯南少少泡泡
2014/07/31
0
0
开源电子书

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

zting科技
2017/12/11
0
0

没有更多内容

加载失败,请刷新页面

加载更多

EOS docker开发环境

使用eos docker镜像是部署本地EOS开发环境的最轻松愉快的方法。使用官方提供的eos docker镜像,你可以快速建立一个eos开发环境,可以迅速启动开发节点和钱包服务器、创建账户、编写智能合约....

汇智网教程
今天
7
0
《唐史原来超有趣》的读后感优秀范文3700字

《唐史原来超有趣》的读后感优秀范文3700字: 作者:花若离。我今天分享的内容《唐史原来超有趣》这本书的读后感,我将这本书看了一遍之后就束之高阁了,不过里面的内容一直在在脑海中回放,...

原创小博客
今天
11
0
IC-CAD Methodology知识图谱

CAD (Computer Aided Design),计算机辅助设计,指利用计算机及其图形设备帮助设计人员进行设计工作,这个定义同样可以用来近似描述IC公司CAD工程师这个岗位的工作。 早期IC公司的CAD岗位最初...

李艳青1987
今天
13
0
CompletableFuture get方法一直阻塞或抛出TimeoutException

问题描述 最近刚刚上线的服务突然抛出大量的TimeoutException,查询后发现是使用了CompletableFuture,并且在执行future.get(5, TimeUnit.SECONDS);时抛出了TimeoutException异常,导致接口响...

xiaolyuh
今天
7
0
dubbo 搭建与使用

官网:http://dubbo.apache.org/en-us/ 一,安装监控中心(可以不安装) admin管理控制台,monitor监控中心 下载 bubbo ops 这个是新版的,需要node.js环境,我没有就用老版的了...

小兵胖胖
今天
15
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部