PEP8编码规范
1.代码布局设计
1.1 缩进 -4个空格进行缩进
1.2 tab键-在python2中tab和空格是混用的,但是在python中基本上使用tab(pycharm开发工具会自动对代码缩进)
1.3 最大行长度-行的最大长度是79个字符
1.4 反斜杠-反斜杠在有的时候是适用的,例如在参数很长,但是不能隐式的使用多行的时候,如下反斜杠的使用:
with open('/path/to/some/file/you/want/to/read') as file_1, \
open('/path/to/some/file/being/written', 'w') as file_2:
file_2.write(file_1.read())
1.5 空行 -Top level函数和类的定义的时候,空两行。类中方法的定义空一行。
1.6 源文件编码 -
在源文件中一直使用utf-8编码,在python2中使用ascll编码
文件,在python2中使用ascll编码,在python3中使用utf-8编码
1.7 导入 - 如 import os,import time 经理单行导入
2.避免使用空格的情况
2.1 - 在小括号,中括号,大括号中避免使用空格
Yes: spam(ham[1], {eggs: 2}) No: spam( ham[ 1 ], { eggs: 2 } )
2.2 -在逗号,分好,冒号之前不需要空格
Yes: if x == 4: print x, y; x, y = y, x No: if x == 4 : print x , y ; x , y = y , x
2.3 -在切片的时候,避免使用空格,在扩展的切片中,必须使用相同的空格个数
3.注释
3.1 块注释
在一段代码前增加注释,在#后添加一个空格,段落之间只有一个#作为行间隔
# Description : Module config. # # Input : None # # Output : None
3.2 行注释
在使用行注释的时候,在代码句子结束之后至少两个空格,然后用#开头后跟一个空格
x = x + 1 # Increment x But sometimes, this is useful: x = x + 1 # Compensate for border
3.3 文档注释
在所有的公共模块,函数,类,方法中加入文档注释,这些注释写在def之后。
在进行多行注释的时候,注意“”“结束的时候,必须独占一行,如下:
"""Return a foobang Optional plotz says to frobnicate the bizbaz first. """
4. 类名称
类名称主要遵循为CapWords约定,表示为首字母大写
5.1 异常名称
异常归于类,从而也要遵循类名的规范,主要是在后缀上必须添加“Error“
5.2 全局变量名
全局变量只在模块类有效,和function命名相同
5.3 方法名称
方法名称全部为小写,下划线是可选的(在增加可读性的基础上使用)
5.4 方法变量
类的方法第一个参数总是self
类方法的静态变量总是为crs
如果一个方法的参数和保留字相冲突,那么在后面添加下划线进行区分
PEP8编码规范的更多相关文章
- Python 常用 PEP8 编码规范
Python 常用 PEP8 编码规范 代码布局 缩进 每级缩进用4个空格. 括号中使用垂直隐式缩进或使用悬挂缩进. EXAMPLE: ? 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
- 16 pep8 编码规范
pep8 编码规范 Python Enhancement Proposals :python改进方案 https://www.python.org/dev/peps/ 1. 每级缩进用4个空格. 括号 ...
- 【翻译】Python PEP8编码规范(中文版)
原文链接:http://legacy.python.org/dev/peps/pep-0008/ item detail PEP 8 Title Style Guide for Python Code ...
- [python]pep8编码规范
一 代码编排1 缩进.4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格.2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号.换行点要在操作符的后边敲回车.3 类 ...
- Python PEP8 编码规范
代码编排 缩进.缩进4个空格,不能混合使用Tab和空格. 每行最大长度79,文档字符串和注释行最大长度为72,换行可以使用反斜杠,最好使用圆括号. 类和顶层函数定义之间空两行:类中的方法定义以单行分隔 ...
- Python PEP8 编码规范中文版
原文链接:https://legacy.python.org/dev/peps/pep-0008/ 参考:https://blog.csdn.net/ratsniper/article/details ...
- python 编码规范起源:PEP8 编码规范中文版
PEP: 8 标题: Python代码的样式指南 版: c451868df657 最后修改: 2016-06-08 10:43:53 -0400(2016年6月8日星期三) 作者: Guido van ...
- Python 常用 PEP8 编码规范和建议
代码布局 缩进 每级缩进用4个空格. 括号中使用垂直隐式缩进或使用悬挂缩进. EXAMPLE: # (垂直隐式缩进)对准左括号 foo = long_function_name(var_one, va ...
- PEP8 - Python编码规范
PEP8 - Python编码规范 PEP8 规范 官方文档:https://www.python.org/dev/peps/pep-0008/ PEP8 规范 中文翻译:http://www.cnb ...
随机推荐
- 【BZOJ】1625: [Usaco2007 Dec]宝石手镯(01背包)
http://www.lydsy.com/JudgeOnline/problem.php?id=1625 太水了. #include <cstdio> #include <cstri ...
- php 文件下载代码
1.对于一般 $file = "/tmp/dummy.tar.gz"; header("Content-type: application/octet-stream&qu ...
- 修改Apache访问权限
You don't have permission to access / on this server.错误,居然说我此台服务器上无权限,ok解决办法如下: 找到:apache文件,进入conf文件 ...
- C++之类模板
C++之类模板 代码如下: C++ Code 123456789101112131415161718192021222324252627282930313233343536373839404142 ...
- Maven项目POM.xml详解
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/20 ...
- 基于JEECG的代码模板自动生成
1.基于JEECG3.5.2,提供多种数据源的代码生成,目前支持Oracle良好: 2.可动态配置数据源: 可动态配置模板集合,基于freemarker的模板文件: 可选择需要生成的数据表: 可导入一 ...
- 打印系统所有的PID
#!/usr/bin/env python #-*- coding:utf-8 -*- ''' 打印系统所有的PID ''' import os def get_all_pid(): for pid ...
- std::ostringstream
ostringstream是C++的一个字符集操作模板类,定义在sstream.h头文件中.ostringstream类通常用于执行C风格的串流的输出操作,格式化字符串,避免申请大量的缓冲区,替代sp ...
- 【原】storm源码之一个class解决nimbus单点问题
一.storm nimbus 单节点问题概述 1.storm集群在生产环境部署之后,通常会是如下的结构:从图中可以看出zookeeper和supervisor都是多节点,任意1个zookeeper节点 ...
- Struts2使用struts标签判断变量是否为空的写法
<%@taglib uri="/struts-tags" prefix="s"%> <span id="viewOrgName&qu ...