Python编码规范

编码规范 在各种编程语言中都存在，可能有的语言中体现的不是很直观而已

如果是新手学习编写代码，那么在一开始就 熟记编码规则 对日后的编写规范是影响非巨大的！

下面就来简单介绍一些初学者要牢记的几种编码规范，分为几个方面来介绍，一起来看一下吧！

Python 采用 PEP 8 作为编码规范，其中 PEP 是 Python Enhancement Proposal（Python 增强建议书）的缩写，8 代表的是 Python 代码的样式指南。

先来看一张图中的代码

对比上图 中的两段代码可以发现，它们所包含的代码时完全相同的

但是右侧的代码编写格式明显看上去比左侧的代码段更加规整，阅读起来也会比较轻松、畅快，因为它遵循了最基本的 Python 代码编写规范。

下面分为几个部分来学习一下Python的编码规范，让我们的代码更加美观、漂亮！

声明编码格式

• 一般来说，声明编码格式在脚本中是必需的

• 如果 python 源码文件 没有声明编码格式，python 解释器会默认使用 ASCII 编码

• 但是这样有个缺点就是，一旦出现非ASCII编码的字符，python 解释器就会报错

• 以 UTF-8 为例，以下两种编码格式声明都是合乎规则的。

# -*- coding: utf-8 -*-

# coding = utf-8

缩进规则

• 和其它程序设计语言（如 Java、C 语言）采用大括号“{}”分隔代码块不同，Python 采用代码缩进和冒号（ : ）来区分代码块之间的层次。

• 在 Python 中，对于类定义、函数定义、流程控制语句、异常处理语句等，行尾的冒号和下一行的缩进，表示下一个代码块的开始，而缩进的结束则表示此代码块的结束。

• 注意，Python 中实现对代码的缩进，可以使用空格或者 Tab 键实现。但无论是手动敲空格，还是使用 Tab 键，通常情况下都是采用 4 个空格长度作为一个缩进量（默认情况下，一个 Tab 键就表示 4 个空格）。

• 对于 Python 缩进规则，初学者可以这样理解，Python 要求属于同一作用域中的各行代码，它们的缩进量必须一致，但具体缩进量为多少，并不做硬性规定。

正确示例代码：

a=1if a==1:
    print("正确")  # 缩进4个空白占位else:              # 与if对齐
    print("错误")   # 缩进4个空白占位

错误示例代码：

a=1if a==1:
    print("正确") else:              
    print("错误")   
 print("end")   # 改正只需将这行代码前面的空格删除即可

只需要记住一点：统一使用 4 个空格进行缩进，不要用tab, 也不要tab和空格混用

记住这一点，一般来说缩进就不会出现太大的问题！

注释部分

Python中使用 # 进行注释，我们在使用# 的时候，# 号后面要空一格

    # 注释部分 
    # 
    # 注释部分

在行内注释的时候，中间应该至少加两个空格

print("你好，世界")  # 注释

空格

空格 使用的一般性原则：

• 在二元运算符两边各空一格，算术操作符两边的空格可灵活使用，但两侧务必要保持一致
• 不要在逗号、分号、冒号前面加空格，但应该在它们后面加（除非在行尾）
• 函数的参数列表中，逗号之后要有空格
• 函数的参数列表中，默认值等号两边不要添加空格
• 左括号之后，右括号之前不要加添加空格
• 参数列表， 索引或切片的左括号前不应加空格

通常情况下，在运算符两侧、函数参数之间以及逗号两侧，都建议使用空格进行分隔。

空行使用

空行 使用的一般性原则：

• 编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行
• 顶级定义之间空两行，方法定义之间空一行
• 在函数或方法内部，可以在必要的地方空一行以增强节奏感，但应避免连续空行

使用必要的空行可以增加代码的可读性，通常在顶级定义（如函数或类的定义）之间空两行，而方法定义之间空一行，另外在用于分隔某些功能的位置也可以空一行。

模块导入部分

导入总应该放在文件顶部，位于模块注释和文档字符串之后，模块全局变量和常量之前。

导入应该按照从最通用到最不通用的顺序分组，分组之间空一行：

• 标准库导入
• 第三方库导入
• 应用程序指定导入

每个 import 语句只导入一个模块，尽量避免一次导入多个模块

#推荐import osimport sys
#不推荐import os,sys

命名规范

命名规范这一块的大家应该都比较熟悉了，但是不同的编程语言之间的明明规范也是有所区别的~

Python命名建议遵循的一般性原则：

• 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线
• 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头
• 函数名一律小写，如有多个单词，用下划线隔开
• 私有函数可用一个下划线开头
• 变量名尽量小写, 如有多个单词，用下划线隔开
• 常量采用全大写，如有多个单词，使用下划线隔开

引号用法

Python中，输出语句中使用单双引号都是可以正确的，但是也有相应的编码规范

所以我们也不要随心所欲的添加引号，最好是遵循下面的规范！

引号使用的一般性原则：

• 自然语言使用双引号
• 机器标识使用单引号
• 正则表达式使用双引号
• 文档字符串 (docstring) 使用三个双引号

分号用法

Python跟其他几个主流编程语言的分号使用区别很大
Python的代码末尾不需要加分号，而Java和C#等都需要添加

不要在行尾添加分号，也不要用分号将两条命令放在同一行，例如：

# 不推荐print("Hello") ;  print("World")