《Python 快速入门》一千个程序员有一千套编码规范
一千个读者有一千个哈姆莱特。 -- 莎士比亚
一千个程序员有一千套编码规范。 -- 不吃西红柿
目录
1、分号
2、命名
3、行长度
4、缩进
5、空行
6、空格
7、类
8、块注释和行注释
9、字符串
10、导包
【总结】
1.命名
2.空白
3.语句
4.注释
Python 编码规范重要性的原因用一句话来概括就是:统一的编码规范可以提高开发效率。
无论你是 编程者,还是 阅读者,好的规范能让你的效率事半功倍,甚至机器在运行时,提高程序运行的效率。今天西红柿就带你盘一盘python的编码规范。
ps.python的代码编写基本上都要遵循PEP8的风格
1、分号
不要在行尾加分号, 也不要用分号将两条命令放在同一行。
2、命名
module_name, package_name, ClassName, method_name
应该避免的名称
- 单字符名称, 除了计数器和迭代器.
- 包/模块名中的连字符(-)
- 双下划线开头并结尾的名称(Python保留, 例如__init__)
命名约定
- 所谓"内部(Internal)"表示仅模块内可用, 或者, 在类内是保护或私有的.
- 用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).
- 用双下划线(__)开头的实例变量或方法表示类内私有.
- 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
- 对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.
3、行长度
每行不超过80个字符
以下情况除外:
- 长的导入模块语句
- 注释里的URL
不要使用反斜杠连接行。
Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。
推荐:
foo_bar(self, width, height, color='black', design=None, x='foo',emphasis=None, highlight=0)if (width == 0 and height == 0 andcolor == 'red' and emphasis == 'strong'):
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:
x = ('这是一个非常长非常长非常长非常长 ''非常长非常长非常长非常长非常长非常长的字符串')
4、缩进
用4个空格来缩进代码
绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:`行长度 <line_length>` 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):
# 与起始变量对齐foo = long_function_name(var_one, var_two,var_three, var_four)# 字典中与起始值对齐foo = {long_dictionary_key: value1 +value2,...}
5、空行
顶级定义之间空两行, 方法定义之间空一行
顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.
6、空格
按照标准的排版规范来使用标点两边的空格
括号内不要有空格.
按照标准的排版规范来使用标点两边的空格
正确示范: spam(ham[1], {eggs: 2}, [])
错误示范: spam( ham[ 1 ], { eggs: 2 }, [ ] )
7、类
类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相同的格式.
class SampleClass(object):"""Summary of class here.Longer class information....Longer class information....Attributes:likes_spam: A boolean indicating if we like SPAM or not.eggs: An integer count of the eggs we have laid."""def __init__(self, likes_spam=False):"""Inits SampleClass with blah."""self.likes_spam = likes_spamself.eggs = 0def public_method(self):"""Performs operation blah."""
8、块注释和行注释
最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.
# We use a weighted dictionary search to find out where i is in # the array. We extrapolate position based on the largest num # in the array and the array size and then do binary search to # get the exact number.if i & (i-1) == 0: # true iff i is a power of 2
为了提高可读性, 注释应该至少离开代码2个空格.
另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要做什么.
# BAD COMMENT: Now go through the b array and make sure whenever i occurs # the next element is i+1
9、字符串
正确示范: x = a + bx = '%s, %s!' % (imperative, expletive)x = '{}, {}!'.format(imperative, expletive)x = 'name: %s; score: %d' % (name, n)x = 'name: {}; score: {}'.format(name, n)
错误示范: x = '%s%s' % (a, b) # use + in this casex = '{}{}'.format(a, b) # use + in this casex = imperative + ', ' + expletive + '!'x = 'name: ' + name + '; score: ' + str(n)
10、导包
每个导入应该独占一行
正确示范:import osimport sys
错误示范: import os, sys
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:
- 标准库导入
- 第三方库导入
- 应用程序指定导入
【总结】
1.命名
- 函数、变量及属性都应该用小写单词拼写,只见用_连接,不遵循驼峰命名法
- 类与异常应该首字母大写,不要用_连接
- 受保护的实例属性,应以单下划线开头
- 实例的私有属性,应以双下划线开头
- 模块级别的变量单词都要大写,中间以单下划线隔开
- 变量要尽可能有意义
2.空白
- 和语法相关的每一层缩进都用4个空格表示
- 赋值时等号两边都要有一个空格
- 每一行所占用的字符数应不超过79,实际操作中应当尽量不让代码编辑器的行滚动条显示出来
- 在使用函数进行函数式编程时,函数之间要空两行
- 在类中的函数,函数之间应该空一行
- 函数与类是同一个级别,则他们之间应该空两行
- 对于超出每行规定的字符数的长表达式,应当敲回车缩进,通常除了首行其余各行都要在原来的基础上再次缩进4个空格
3.语句
- 判断变量是否为None、False或True时不要用==,要用is,例如,if a is None
- import语句应放在句首,导入时要尽量使用绝对导入不要使用相对导入,并且导入时最好指定相应的模块的某一具体功能,例如,from datetime import datetime
- 模块导入时应根据标准库模块、第三方模块以及自用模块进行分类
- 检测容器不为空时,应使用if 容器名,例如,lists = [] if lists
- 采用内联形式的否定词,不要把否定词放在整个表达式的前面,例如,应该if a is not None 而不是 if not a is None
4.注释
- 对某些重要的代码块的功能说明,应使用单行注释
- 对整个模块功能的说明应使用多行注释
- 对类或函数的功能及使用方法的详细说明应使用文档字符串
- python的注释尽量使用英文
《Python 快速入门》一千个程序员有一千套编码规范相关推荐
- 100天精通Python丨基础知识篇 —— 06、一千个程序员有一千套编码规范
一千个读者有一千个哈姆莱特. -- 莎士比亚 一千个程序员有一千套编码规范. -- 不吃西红柿 目录 1.分号 2.命名 3.行长度 4.缩进 5.空行 6.空格
- Python快速入门(贼快)
文章目录 Python快速入门 1.注释 1.1 注释介绍 1.2 注释的分类 2.变量以及数据类型 2.1 变量的定义 2.2 变量的类型 2.3 查看数据类型 3. 标识符和关键字 3.1 命名规 ...
- python程序员的浪漫-千行生日祝福代码
python程序员的浪漫-千行生日祝福代码
- python快速编程入门教程-半小时带你快速入门Python编程,Python快速入门教程
1,Introduction to Python (Python入门) 2,Python是什么? Python 官方网站的描述 Python is a programming language tha ...
- python的快速入门-Python快速入门,你想要的就在这里了!
原标题:Python快速入门,你想要的就在这里了! 学习Python您是否会面临以下问题?"网上充斥着大量的学习资源.书籍.视频教程和博客,但是大部分都是讲解基础知识,不够深入:也有的比较晦 ...
- python快速入门 pdf-Python快速入门 (第3版) PDF 下载
相关截图: 资料简介: 这是一本Python快速入门书,基于Python 3.6编写.本书分为4部分,*部分讲解Python的基础知识,对Python进行概要的介绍:第二部分介绍Python编程的重点 ...
- python快速入门第三版-Python 快速入门:第3版 配套资源 PDF 完整版
给大家带来的一篇关于Python入门相关的电子文档资源,介绍了关于Python.快速入门方面的内容,本书是由Python官网出版,格式为PDF,资源大小23 MB,码小辫编写,目前豆瓣.亚马逊.当当. ...
- python快速入门精讲_Python快速入门精讲
基础入门篇 第0章从零开始3 0.1克服编程恐惧3 0.2如何写出好程序4 0.3为什么选择Python5 0.4Python的发展和应用6 0.5一些建议8 0.6多平台搭建Python开发环境10 ...
- Python 快速入门(第3版)15、16章 读书笔记
<Python 快速入门(第3版)>娜奥米·赛德 15.4 类变量 类变量(class variable)是与类关联的变量,并且可供类的所有实例访问. 类变量是通过类定义代码中的赋值语句创 ...
最新文章
- C++拾趣——STL容器的插入、删除、遍历和查找操作性能对比(Windows VirtualStudio)——删除
- jquery 使用小技巧
- Redis适用于高并发的递增、递减功能
- linux下载文件一直超时,Linux下connect超时处理(总结)
- 谨慎使用JUnit的预期异常
- 罗德里格斯(Rodrigues)旋转向量与矩阵的变换
- msf:Known bug in WMI query, try migrating to another process
- 去除KMPplayer2.9的驴头提示
- 网页中加载flash的方法
- C++中使用GSoap
- python 字典类型 get 参数_python如何利用urllib解析url参数成字典
- 数据降维——因子分析
- Java泛型类继承实现
- MATLAB :xlim 、 ylim 、zlim简介
- Python实现将人脸表情数据集fer2013转化为图像形式存储本地
- Spring循环引用-@Async注解启动报错,而@Transactional则不会
- java months between,ORACLE函数MONTHS_BETWEEN
- 组态王虚拟服务器,组态王客户端服务器是什么
- h5微信自定义分享(前端+后端java)
- 该公司myRIO不仅有丰富的硬体生态系统
热门文章
- 想成长为一名实战型架构师?7大实战技能经验分享
- 基于Flask+Nginx+uWSGI实现CentOS服务端模型部署及预加载
- 实时事理逻辑知识库(事理图谱)终身学习项目-EventKGNELL(学迹)
- 运用事理图谱搞事情:新闻预警、事件监测、文本可视化、出行规划与历时事件流生成
- 特定热点事件监控与分析项目
- 国科大高级人工智能+prml4-CNN
- 如何做一名优秀的电子工程师[zz]
- 编程开发之--java多线程学习总结(3)类锁
- SpringBoot核心
- Algorithm-Gossip(4) 三色棋(Three_Color_Flag)