前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Python 编码规范

Python 编码规范

作者头像
sylan215
发布2020-02-29 17:05:03
8580
发布2020-02-29 17:05:03
举报
文章被收录于专栏:sylan215 的软件测试技术学习

目前我们公司的自动化,大部分是以 Python 语言为主,但是经常发现,不同人的编写风格都不尽相同,所以我就给自己制定了一套规则,至少从我自己做起,保持自己的编码规范一致性。

下面所有的规范都是以实用为主,请按需取用。

1.类名使用驼峰式命名法,首字母要大写,比如:

代码语言:javascript
复制
class TestClass(object):    pass

2.方法和函数名全小写,并且使用下划线做连接符,命名最好清晰易懂,比如:

代码语言:javascript
复制
def read_file():    pass

3.尽量避免使用全局变量,如果必须使用,变量名字母必须全部大写,比如:

代码语言:javascript
复制
HOST = 127.0.0.1

4.所有的缩进都是要空格,每个 tab 代表 4 个空格

5.可以使用括号把多行进行隐式链接,从而避免使用反斜杠,比如:

代码语言:javascript
复制
print('this is a very very very'    'very very long simple')

6.顶级定义之间空两行, 方法定义之间空一行;

7.括号内不要有空格,比如:

代码语言:javascript
复制
def test_fun(param=false):    pass

8.每个导入独占一行,导入顺序:标准库、第三方库、自己实现库,比如:

代码语言:javascript
复制
import osimport wximport common

9.单号注释使用 #,多行注释使用三双引号,比如:

代码语言:javascript
复制
"""功能说明:这个函数是做测试用的"""
#this is a simple

10.除了注释使用双引号,其他引号优先使用单引号,比如:

代码语言:javascript
复制
def test_fun(param='apppath'):    test_str = 'simplepath'

11.函数或方法都需要加注释说明,注释内容包含功能说明、Args、Returns信息,比如:

代码语言:javascript
复制
def test_fun(param='apppath'):    """这是个测试函数
    这个函数是为了演示注释的格式
    Args:        param:表示要传入的文件路径
    Returns:        real_path:表示文件的真实路径    """    real_path = param    return real_path

参考: http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-05-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 sylan215 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档