第2章-编码规范

最新推荐文章于 2022-07-26 17:25:55 发布

原创最新推荐文章于 2022-07-26 17:25:55 发布 · 423 阅读

1 ·

CC 4.0 BY-SA版权

python 专栏收录该内容

8 篇文章

订阅专栏

Python的基础知识

一、编码规范

PEP81 编码规范

Guido的关键点之一是：代码更多是用来读而不是写。编码规范旨在改善Python代码的可读性。

风格指南强调一致性。项目、模块或函数保持一致都很重要。

1.1 注释

所谓注释，就是在程序中添加解释说明，能够大大增强程序的可读性。注释中的内容，不是真正要执行的程序，起辅助说明作用

单行注释

以#开头，#右边的所有东西当做说明

# 我是注释，可以在里写一些功能说明之类的哦
print('hello world')

多行注释

使用3引号，3个单引号或者3个双引号

'''
我是多行注释，可以写很多很多行的功能说明
        这就是我牛X指出

        哈哈哈。。。
 '''
"""
我也是多行注释啊，巴拉巴拉。。
"""

注释]![这里写图片描述

1.2 缩进

每级缩进用4个空格

python 不使用 {} 来组织代码，完全依靠缩进，所以缩进的格式非常重要。

使用4个空格来缩进，不要使用 tab ,更不能 tab 和空格混用。

使用空格的时候永远使用4个空格，不能使用其他数量的空格，否则语法错误。

建议把开发工具的tab改成4个空格。

1.3 分号

python不严格要求使用分号( ;)。

理论上应该每行放一句代码。每行代码之后可以添加分号; 也可以不添加分号;

尽量不要多句代码放在一行，如果放在一行，则需要添加分号把他们隔开。

1.4 行长度

每行不超过80个字符(最大行宽为79字符，文本长块，比如文档字符串或注释，行长度应限制为72个字符。)

以下情况除外：

长的导入模块语句
注释里的URL

不要使用反斜杠连接行。
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:

x = ('这是一个非常长非常长非常长非常长 '
     '非常长非常长非常长非常长非常长非常长的字符串')

1.5 空行

两行空行分割顶层函数和类的定义。
类的方法定义用单个空行分割。
额外的空行可以必要的时候用于分割不同的函数组，但是要尽量节约使用。
额外的空行可以必要的时候在函数中用于分割不同的逻辑块，但是要尽量节约使用。

1.6 源文件编码

在核心Python发布的代码应该总是使用UTF-8(ASCII在Python 2)。

# Python推荐使用 
#-*- coding:utf-8 -*-
# 简化写法
# encoding: utf-8

Python 3(默认UTF-8)不应有编码声明。

1.7 导入在单行

import os
from urllib2 import request

导入始终在文件的顶部，在模块注释和文档字符串之后，在模块全局变量和常量之前。

导入顺序如下：标准库进口,相关的第三方库，本地库。各组的导入之间要有空行。

禁止使用通配符导入。

1通配符导入(from import *)应该避免，因为它不清楚命名空间有哪些名称存，混淆读者和许多自动化的工具。

1.8 括号

宁缺毋滥的使用括号，除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.

括号里边避免空格

# 括号里边避免空格
# Yes
spam(ham[1], {eggs: 2})
# No
spam( ham[ 1 ], { eggs: 2 } )

1.9 空格

按照标准的排版规范来使用标点两边的空格

1.9.1括号内不要有空格.

Yes: spam(ham[1], {eggs: 2}, [])

No:  spam( ham[ 1 ], { eggs: 2 }, [ ] )

1.9.2 不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).

Yes: if x == 4:
         print x, y
     x, y = y, x

No:  if x == 4 :
         print x , y
     x , y = y , x

1.9.3参数列表, 索引或切片的左括号前不应加空格.

Yes: spam(1)

no: spam (1)

Yes: dict['key'] = list[index]

No:  dict ['key'] = list [index]

1.9.4在二元操作符两边都加上一个空格,

比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.

Yes: x == 1

No:  x<1

但是注意：当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.

Yes: def complex(real, imag=0.0): return magic(r=real, i=imag)

No:  def complex(real, imag = 0.0): return magic(r = real, i = imag)

用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):

Yes:
     foo = 1000   # 注释
     long_name = 2  # 注释不需要对齐

     dictionary = {
         "foo": 1,
         "long_name": 2,
         }

No:    ./¯9*((XQ))
     foo       = 1000  # 注释
     long_name = 2     # 注释不需要对齐

     dictionary = {
         "foo"      : 1,
         "long_name": 2,
         }

强烈不建议使用复合语句(Compound statements: 多条语句写在同一行)。

if foo == 'blah': print(100)

2.1 标识符和关键字

标识符就是对程序中变量，常量，类，方法，参数等命名时使用的字符序列。

关键字就是python中预先保留下来，具有特殊含义的词。

Python的关键字：

and as  assert  break   class   continue    def del elif    else    except  
exec    finally for from    global  if  in  import  is  lambda  not or  pass
print   raise   return  try while   with    yield

命名规则如下

标识符由字母，下划线，和数字组成，且数字不能开头
python 大小写敏感。 a 和 A 是完全不同的。
不能是python关键字。

编码习惯：

见名知意
使用有意义的，英文单词或词组，绝对不要使用汉语拼音
下划线命名和驼峰式命名

下划线：student_name

小驼峰：studentName

大驼峰：StudentNameTable
避免采用的名字

决不要用字符’l’(小写字母el)，’O’(大写字母oh)，或 ‘I’(大写字母eye) 作为单个字符的变量名。一些字体中，这些字符不能与数字1和0区别。用’L’ 代替’l’时。
python机器学习交流群:qq群 593454517 获取更多资料

补充：pycharm的一些常用快捷键

ctrl+y：删除当前行

ctrl+d：复制当前行

ctrl+/：添加或删除注释

ctrl+alt+L：格式化

shift+enter：强制换行

PEP是Python Enhancement Proposals的缩写。一个PEP是一份为Python社区提供各种增强功能的技术规格，也是提交新特性，以便让社区指出问题，精确化技术文档的提案。《Python Enhancement Proposal #8》（8号python增强提案）又叫PEP8，他针对的python代码格式而编订的风格指南。 ↩