博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
零基础如何学好python之Python代码规范,简明概述!
阅读量:5251 次
发布时间:2019-06-14

本文共 3179 字,大约阅读时间需要 10 分钟。

本来不应该把这个章节放在那面前面的,因为还没进行学习之前,直接看这个章节,会感觉有很多莫名其妙的东西。

但是把这个章节放在前面的用意,只是让大家预览一下,有个印象,而且在以后的学习中,也方便大家查阅。

目录

一、简明概述

1、编码
如无特殊情况, 文件一律使用 UTF-8 编码
如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识
2、代码格式
2.1、缩进
统一使用 4 个空格进行缩进
2.2、行宽
每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ,但最长不得超过 120)

理由:

这在查看 side-by-side 的 diff 时很有帮助

方便在控制台下查看代码
太长可能是设计有缺陷
2.3、引号
简单说,自然语言使用双引号,机器标示使用单引号,因此 代码里 多数应该使用 单引号

自然语言 使用双引号 "..."

例如错误信息;很多情况还是 unicode,使用u"你好世界"
机器标识 使用单引号 '...' 例如 dict 里的 key
正则表达式 使用原生的双引号 r"..."
文档字符串 (docstring) 使用三个双引号 """......"""
2.4、空行
模块级函数和类定义之间空两行;
类成员函数之间空一行;

1 ''' 2 在学习过程中有什么不懂得可以加我的 3 python学习交流扣扣qun,934109170 4 群里有不错的学习教程、开发工具与电子书籍。 5 与你分享python企业当下人才需求及怎么从零基础学习好python,和学习什么内容。 6 ''' 7 class A: 8   9     def __init__(self):10         pass11  12     def hello(self):13         pass14  15  16 def main():17     pass

可以使用多个空行分隔多组相关的函数

函数中可以使用空行分隔出逻辑相关的代码
2.5、编码
文件使用 UTF-8 编码
文件头部加入#-*-conding:utf-8-*-标识
3、import 语句
import 语句应该分行书写

1 # 正确的写法 2 import os 3 import sys 4  5 # 不推荐的写法 6 import sys,os 7  8 # 正确的写法 9 from subprocess import Popen, PIPE10 import语句应该使用 absolute import11 # 正确的写法12 from foo.bar import Bar13 14 # 不推荐的写法15 from ..bar import Bar

 

import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前;
import语句应该按照顺序排列,每组之间用一个空行分隔

1 import os2 import sys3 4 import msgpack5 import zmq6 7 import foo

 

导入其他模块的类定义时,可以使用相对导入

from myclass import MyClass
如果发生命名冲突,则可使用命名空间

1 import bar2 import foo.bar3 4 bar.Bar()5 foo.bar.Bar()

4、空格

  • 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:
1 # 正确的写法 2 i = i + 1 3 submitted += 1 4 x = x * 2 - 1 5 hypot2 = x * x + y * y 6 c = (a + b) * (a - b) 7  8 # 不推荐的写法 9 i=i+110 submitted +=111 x = x*2 - 112 hypot2 = x*x + y*y13 c = (a+b) * (a-b)

 

  • 函数的参数列表中,,之后要有空格
1 # 正确的写法2 def complex(real, imag):3     pass4 5 # 不推荐的写法6 def complex(real,imag):7     pass
  • 函数的参数列表中,默认值等号两边不要添加空格
1 # 正确的写法2 def complex(real, imag=0.0):3     pass4 5 # 不推荐的写法6 def complex(real, imag = 0.0):7     pass

 

  • 左括号之后,右括号之前不要加多余的空格
1 # 正确的写法2 spam(ham[1], {eggs: 2})3 4 # 不推荐的写法5 spam( ham[1], { eggs : 2 } )

 

  • 字典对象的左括号之前不要多余的空格
1 # 正确的写法2 dict['key'] = list[index]3 4 # 不推荐的写法5 dict ['key'] = list [index]

 

  • 不要为对齐赋值语句而使用的额外空格
1 # 正确的写法2 x = 13 y = 24 long_variable = 35 6 # 不推荐的写法7 x             = 18 y             = 29 long_variable = 3

 

5、换行

Python 支持括号内的换行。这时有两种情况。

  1. 第二行缩进到括号的起始处
1 foo = long_function_name(var_one, var_two,2                          var_three, var_four)

 

  1. 第二行缩进 4 个空格,适用于起始括号就换行的情形
1 def long_function_name(2         var_one, var_two, var_three,3         var_four):4     print(var_one)

 

使用反斜杠\换行,二元运算符+ .等应出现在行末;长字符串也可以用此法换行

1 session.query(MyTable).\2         filter_by(id=1).\3         one()4 5 print 'Hello, '\6       '%s %s!' %\7       ('Harry', 'Potter')

 

禁止复合语句,即一行中包含多个语句:

1 # 正确的写法2 do_first()3 do_second()4 do_third()5 6 # 不推荐的写法7 do_first();do_second();do_third();

 

if/for/while一定要换行:

1 # 正确的写法2 if foo == 'blah':3     do_blah_thing()4 5 # 不推荐的写法6 if foo == 'blah': do_blash_thing()

 

6、docstring

docstring 的规范中最其本的两点:

  1. 所有的公共模块、函数、类、方法,都应该写 docstring 。私有方法不一定需要,但应该在 def 后提供一个块注释来说明。
  2. docstring 的结束"""应该独占一行,除非此 docstring 只有一行。
1 """Return a foobar2 Optional plotz says to frobnicate the bizbaz first.3 """4 5 """Oneline docstring"""

 

转载于:https://www.cnblogs.com/xiaoyiq/p/11394240.html

你可能感兴趣的文章
字符串转 Boolean 的正确方式
查看>>
给你的网站404页面加上“宝贝寻亲”公益页面
查看>>
整理推荐的CSS属性书写顺序
查看>>
协程, IO阻塞模型 和 IO非阻塞模型
查看>>
ServerSocket和Socket通信
查看>>
css & input type & search icon
查看>>
jQuery插件开发详细教程
查看>>
Crontab 在linux中的非常有用的Schedule Jobs
查看>>
ProxySQL Scheduler
查看>>
源代码的下载和编译读后感
查看>>
Kafka学习笔记
查看>>
Octotree Chrome安装与使用方法
查看>>
用CALayer实现下载进度条控件
查看>>
Windows 环境下基于 Redis 的 Celery 任务调度模块的实现
查看>>
趣谈Java变量的可见性问题
查看>>
C# 强制关闭当前程序进程(完全Kill掉不留痕迹)
查看>>
ssm框架之将数据库的数据导入导出为excel文件
查看>>
语音识别中的MFCC的提取原理和MATLAB实现
查看>>
java string
查看>>
验证组件FluentValidation的使用示例
查看>>