关于Python中的编码规范

2023-05-15 11:05:22 python 规范 编码

编码规范

python 编码规范重要性的原因用一句话来概括就是：统一的编码规范可以提高开发效率。

无论你是 编程者，还是 阅读者，好的规范能让你的效率事半功倍，甚至机器在运行时，提高程序运行的效率。今天西红柿就带你盘一盘Python的编码规范。

ps.python的代码编写基本上都要遵循PEP8的风格

1、分号

不要在行尾加分号, 也不要用分号将两条命令放在同一行。

2、命名

module_name, package_name, ClassName, method_name

应该避免的名称

  1. 单字符名称, 除了计数器和迭代器.
  2. 包/模块名中的连字符(-)
  3. 双下划线开头并结尾的名称(Python保留, 例如__init__)

命名约定

  1. 所谓"内部(Internal)"表示仅模块内可用, 或者, 在类内是保护或私有的.
  2. 用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含)
  3. 用双下划线(__)开头的实例变量或方法表示类内私有.
  4. 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
  5. 对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.

3、行长度

每行不超过80个字符

以下情况除外：

  1. 长的导入模块语句注释里的URL
  2. 不要使用反斜杠连接行。

Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。

推荐: 

foo_bar(self, width, height, color='black', design=None, x='foo',
             emphasis=None, highlight=0)
 
     if (width == 0 and height == 0 and
         color == '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_spam
        self.eggs = 0
 
    def 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 + b
     x = '%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 case
    x = '{}{}'.format(a, b)  # use + in this case
    x = imperative + ', ' + expletive + '!'
    x = 'name: ' + name + '; score: ' + str(n)

10、导包

每个导入应该独占一行

正确示范: 
import os 
import sys
错误示范:   import os, sys

导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:

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

【总结】

1.命名

  1. 函数、变量及属性都应该用小写单词拼写，只见用_连接，不遵循驼峰命名法
  2. 类与异常应该首字母大写，不要用_连接
  3. 受保护的实例属性，应以单下划线开头
  4. 实例的私有属性，应以双下划线开头
  5. 模块级别的变量单词都要大写，中间以单下划线隔开
  6. 变量要尽可能有意义

2.空白

  1. 和语法相关的每一层缩进都用4个空格表示
  2. 赋值时等号两边都要有一个空格
  3. 每一行所占用的字符数应不超过79，实际操作中应当尽量不让代码编辑器的行滚动条显示出来
  4. 在使用函数进行函数式编程时，函数之间要空两行
  5. 在类中的函数，函数之间应该空一行
  6. 函数与类是同一个级别，则他们之间应该空两行
  7. 对于超出每行规定的字符数的长表达式，应当敲回车缩进，通常除了首行其余各行都要在原来的基础上再次缩进4个空格

3.语句

  1. 判断变量是否为None、False或True时不要用==，要用is，例如，if a is None
  2. import语句应放在句首，导入时要尽量使用绝对导入不要使用相对导入，并且导入时最好指定相应的模块的某一具体功能，例如，from datetime import datetime
  3. 模块导入时应根据标准库模块、第三方模块以及自用模块进行分类
  4. 检测容器不为空时，应使用if 容器名，例如，lists = [] if lists
  5. 采用内联形式的否定词，不要把否定词放在整个表达式的前面，例如，应该if a is not None 而不是 if not a is None

4.注释

  1. 对某些重要的代码块的功能说明，应使用单行注释
  2. 对整个模块功能的说明应使用多行注释
  3. 对类或函数的功能及使用方法的详细说明应使用文档字符串
  4. python的注释尽量使用英文

到此这篇关于关于Python中的编码规范的文章就介绍到这了,更多相关Python编码规范内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

相关文章