搜尋

首頁 >後端開發 >Python教學 >Python編碼規範知識點整理

Python編碼規範知識點整理

WBOY
WBOY轉載
2022-07-08 14:37:322540瀏覽

本篇文章為大家帶來了關於Python的相關知識，其中主要整理了編碼規範的相關問題，想要寫好python程式碼，必須了解python相關編碼規範，有了這個的加持，編寫的程式碼不僅可以實現相應的功能，而且簡單易讀，邏輯清晰，下面一起來看一下，希望對大家有幫助。

Python編碼規範知識點整理

【相關推薦：Python3影片教學 】

想要寫好python程式碼，必須了解python相關編碼規範，有了這個的加持，編寫的程式碼不僅可以實現相應的功能，而且簡單易讀，邏輯清晰。本節技能樹主要分享對應的python編碼規範，學習python的小夥伴們請仔細閱讀，對你的python程式碼的編寫肯定有質的提升！ ！ ！

1 程式碼編碼格式

  • 一般來說，宣告編碼格式在腳本中是必要的。
  • 國際慣例，檔案編碼和 Python 編碼格式全部為 utf-8 。例如：在 Python 程式碼的開頭，要統⼀加上以下程式碼：
# -- coding: utf-8 --
  • #如果Python原始碼檔案沒有宣告編碼格式，Python解釋器會預設使用ASCII編碼。但出現非ASCII編碼的字符，Python解釋器就會報錯，因此非 ASCII 字符的字串，請需添加u前綴。
  • 若出現Python編碼問題，可依下列操作嘗試解決：
import sys
reload(sys)
sys.setdefaultencoding('utf-8')

2 分號

不要在行尾加分號，也不要用分號將兩條指令放在同一行。

3 行的最大長度

每行不超過80個字元

以下情況除外：

  1. 長的導入模組語句
  2. 註解裡的URL

不要使用反斜線連接行。

Python會將 圓括號, 中括號和花括號中的行隱式的連結起來 。

圓括號、方括號或花括號以內的表達式允許分成多個實體行，無需使用反斜線。例如：

month_names = ['Januari', 'Februari', 'Maart',      # These are the
               'April',   'Mei',      'Juni',       # Dutch names
               'Juli',    'Augustus', 'September',  # for the months
               'Oktober', 'November', 'December']   # of the year

隱含的行拼接可以帶有註解。後續行的縮排不影響程式結構。後續行也允許為空白行。

如果需要，可以在表達式外圍增加一對額外的圓括號。

如果一個文字字串在一行放不下, 可以使用圓括號來實現隱式行連接

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

4 縮排規則

  • Python 採用程式碼縮進和冒號（ : ）來區分程式碼區塊之間的層次。
  • 在Python 中，對於類別定義、函數定義、流程控制語句、異常處理語句等，行尾的冒號和下一行的縮進，表示下一個程式碼區塊的開始，而縮排的結束則表示此程式碼區塊的結束。
  • Python 中實作程式碼的縮進，可以使用空格或 Tab 鍵實作。但無論是手動敲空格，還是使用 Tab 鍵，通常情況下都是採用 4 個空格長度作為一個縮排量（預設情況下，一個 Tab 鍵就表示 4 個空格）。
  • 對於Python 縮排規則，初學者可以這樣理解，Python 要求屬於同一作用域中的各行程式碼，它們的縮排量必須一致，但具體縮排量為多少，並不做硬性規定。

建議建議使用 Emacs 的 Python-mode 預設值：4 個空格一個縮排層次。 不要用tab，也不要tab和空格混用

#正確範例程式碼:

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

或者

# 4 个空格缩进，第一行不需要
foo = long_function_name(
    var_one, var_two, var_three,
    var_four)

錯誤範例代碼:

if a==0:
    print("正确") 
else:              
    print("错误")   
 print("end")       # 错误的是这行代码前面加了一个空格

或者

# 2 个空格是禁止的
foo = long_function_name(
  var_one, var_two, var_three,
  var_four)

5 註釋

  • Python中使用# 進行註釋，# 號後面要空一格。
  • 最需要寫註解的是程式碼中那些技巧性的部分：對於複雜的操作，應該在其操作開始前寫上若干行註解.；對於不是一目了然的程式碼，應在其行尾添加註釋。
  • 為了提高可讀性，註解和程式碼隔開一定的距離，註解應該至少離開程式碼2個空格，區塊註解後面最好多留幾行空白再寫程式碼。
  • 當程式碼更改時，優先更新對應的註解。
  • 如果一個註解是一個短語或句子，它的第一個單字應該要大寫，除非它是以小寫字母開頭的識別符（永遠不要改變標識符的大小寫！）。
  • 如果註解很短，結尾的句號可以省略。塊註釋一般由完整句子的一個或多個段落組成，並且每句話結束有個句號。
  • 在句尾結束的時候應該使用兩個空格。

Python中有三種形式的註解：行註解、區塊註解、文件註解

行註解：註解應解釋自己做了什麼，而不是對程式碼本身的解釋

  • 有节制地使用行内注释
  • 行内注释是与代码语句同行的注释
  • 行内注释和代码至少要有两个空格分隔
  • 注释由#和一个空格开始。
n = input()
m = input()
t = n / 2     # t是n的一半

# 循环，条件为t*m/n 小于n
while (t * m / (n + 1) < n):
    t = 0.5 * m + n / 2     # 重新计算t值
print(t)

块注释：

  • 块注释通常适用于跟随它们的某些（或全部）代码，并缩进到与代码相同的级别
  • 块注释的每一行开头使用一个 # 和一个空格（除非块注释内部缩进文本）。
  • 块注释内部的段落通常只有一个 # 的空行分隔。
def FuncName(parameter1,parameter2):

"""

描述函数要做的事情

:param parameter1: 参数一描述(类型、用途等)

:param parameter2: 参数二描述

:return: 返回值描述

"""
# 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 if i is a power of 2

文档注释：

  • 要为所有的公共模块，函数，类和方法编写文档说明
  • 非公共的方法没有必要，但是应该有一个描述方法具体作用的注释。这个注释应该在def那一行之后
  • 多行文档注释使用的结尾三引号应该是自成一行
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."""

6 空行

  • 顶层函数和类定义，前后用两个空行隔开
  • 编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行
  • 类里面方法定义用一个空行隔开
  • 在函数或方法内部，可以在必要的地方空一行以增强节奏感，但应避免连续空行
class Class01:
    pass
 
 
class Class02:
    def function_01(self):
        pass
 
    def function_02(self):
        pass

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

7 制表符还是空格

  • 不要混用制表符和空格，因为如果混用了，虽然在编辑环境中显示两条语句为同一缩进层次，但因为制表符和空格的不同会导致 Python 解释为两个不同的层次。
  • 在调用 Python 命令行解释器时使用 -t 选项，可对代码中不合法的混合制表符和空格发出警告，使用 -tt 时警告将变成错误，这些选项是被高度推荐的。但是强烈推荐仅使用空格而不是制表符。

空格使用规则：

  • 在二元运算符两边各空一格，比如赋值(=)、比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not)，算术操作符两边的空格可灵活使用，但两侧务必要保持一致
  • 不要在逗号、分号、冒号前面加空格，但应该在它们后面加（除非在行尾）
  • 函数的参数列表中，逗号之后要有空格
  • 函数的参数列表中，默认值等号两边不要添加空格
  • 左括号之后，右括号之前不要加添加空格
  • 参数列表， 索引或切片的左括号前不应加空格
  • 当'='用于指示关键字参数或默认参数值时，不要在其两侧使用空格

    • 正确示例代码:

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

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

dict['key'] = list[index]

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

    错误示例代码:

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

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

dict ['key'] = list [index]

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

    8 命名规范

    模块名命名

    • 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)
    # 正确

import decoder

import html_parser

# 不推荐

import Decoder

    变量命名

    • 不要使用字母I (小写的L)， O （大写的O）， I （大写的I）作为单字符的变量名。在有些字体里面，这些字符无法与数字0和1区分。如果想用I， 可使用L代替。
    • 变量名尽量小写, 如有多个单词，用下划线隔开。
    count = 0
this_is_var = 0

    常量或者全局变量命名

    • 全部大写，如有多个单词，用下划线隔开
    • 全⼤写+下划线式驼峰
    MAX_CLIENT = 100

    函数命名

    • 函数名应该小写，如有多个单词，用下划线隔开。
    • 大小写混合仅在为了兼容原来主要以大小写混合风格的情况下使用，保持向后兼容。
    • 私有函数在函数前加一个下划线_。
    def run():
    pass

def run_with_env():
    pass


class Person():
    def _private_func():
        pass

    类命名

    • 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头。
    • 在接口被文档化并且主要被用于调用的情况下，可以使用函数的命名风格代替。
    • 对于内置的变量命名有一个单独的约定：大部分内置变量是单个单词（或者两个单词连接在一起），首字母大写的命名法只用于异常名或者内部的常量。
    class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass

    类里面函数和方法参数

    • 始终要将self作为实例方法的第一个参数。
    • 始终要将cls作为类方法的第一个参数。
    • 如果函数的参数名和已有关键字冲突，在最后加大意下划线比缩写或者随意拼写更好。因此class_比clss更好。

    特别注意：

    • 不要中英文混编
    • 不要有a、b、c这种没有意义的命名
    • 不要怕名字长就随便缩写，比如person_info 缩写成pi
    • 不要用大小写区分变量类型，比如a是int类型，A是String类型
    • 不要使用容易引起混淆的变量名
    • bool变量⼀般加上前缀 is_ 如：is_success
    • 变量名不要用系统关键字，如 dir type str等等

    以下用下画线作前导或结尾的特殊形式是被公认的：

    • _single_leading_underscore（以一个下画线作前导）：例如，“from M import *”不会导入以下画线开头的对象。
    • single_trailing_underscore_（以一个下画线结尾）：用于避免与 Python 关键词的冲突，例如“Tkinter.Toplevel(master, class_='ClassName')”。
    • __double_leading_underscore （双下画线）：从 Python 1.4 起为类私有名。
    • __double_leading_and_trailing_underscore__：特殊的（magic） 对象或属性，存在于
      用户控制的（user-controlled）名字空间，例如：__init__、__import__ 或 __file__。

    9 引号用法规则

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

    字符串引号规则：

    • 单引号和双引号字符串是相同的。当一个字符串中包含单引号或者双引号字符串的时候，使用和最外层不同的符号来避免使用反斜杠，从而提高可读性。
    • 在同一个文件中，保持使用字符串引号的一致性。在字符串内可以使用另外一种引号，以避免在字符串中使用。

    正确使用示例：

    Tim('Why are you hiding your eyes?')
Bob("I'm scared of lint errors.")
Juy('"Good!" thought a happy Python reviewer.')
    • 当且仅当代码中使用单引号'来引用字符串时，才可能会使用三重'''为非文档字符串的多行字符串来标识引用
    • 文档字符串必须使用三重双引号"""

    10 模块导入规则

    • 导入应该放在文件顶部，位于模块注释和文档字符串之后，模块全局变量和常量之前。
    • 导入应该按照从最通用到最不通用的顺序分组：标准库导入、第三方库导入、应用程序指定导入，分组之间空一行。
    •  模块名称要短，使用小写，并避免使用特殊符号， 比如点和问号。
    • 尽量保持模块名简单，以无需分开单词最佳（不推荐在两个单词之间使用下划线）。
    • 每个导入应该独占一行。

    正确使用例子：

    import os
import numpy
import sys

from types import StringType, ListType

    错误使用例子：

    import os, numpy, sys
    • 从一个包含类的模块中导入类时，通常可以写成这样：
    from MyClass import MyClass 
from foo.bar.YourClass import YourClass

    模块导入建议

    示例 评价
    from modu import * 差， 不清楚具体从模块中导入了哪些内容
    from modu import sqrt 稍好

    import modu

    import modu.sqrt

    		 最佳 ， 调用的时候直接使用modu.sqrt能比较清楚的知道当前方法属于哪个模块

    import os

    import sys

    		 推荐

    import os, sys

    		 不推荐
    from subprocess import Popen, PIPE 推荐

    11 Main

    主功能应该放在一个main()函数中。

    在Python中，pydoc以及单元测试要求模块必须是可导入的。代码应该在执行主程序前总是检查 if __name__ == '__main__'， 这样当模块被导入时主程序就不会被执行。

    def main():
      ...

if __name__ == '__main__':
    main()

    12 函数设计规范

    • 函数设计的主要目标就是最大化代码重用和最小化代码冗余。精心设计的函数不仅可以提高程序的健壮性，还可以增强可读性、减少维护成本。
    • 函数设计要尽量短小，嵌套层次不宜过深。 所谓短小， 就是尽量避免过长函数， 因为这样不需要上下拉动滚动条就能获得整体感观， 而不是来回翻动屏幕去寻找某个变量或者某条逻辑判断等。 函数中需要用到 if、 elif、 while 、 for 等循环语句的地方，尽量不要嵌套过深，最好能控制在3层以内。不然有时候为了弄清楚哪段代码属于内部嵌套， 哪段属于中间层次的嵌套， 哪段属于更外一层的嵌套所花费的时间比读代码细节所用时间更多。
    • 尽可能通过参数接受输入，以及通过return产生输出以保证函数的独立性。
    • 尽量减少使用全局变量进行函数间通信。
    • 不要在函数中直接修改可变类型的参数。
    • 函数申明应该做到合理、 简单、 易于使用。 除了函数名能够正确反映其大体功能外， 参数的设计也应该简洁明了， 参数个数不宜太多。 参数太多带来的弊端是： 调用者需要花费更多的时间去理解每个参数的意思，测试的时候测试用例编写的难度也会加大。
    • 函数参数设计应该考虑向下兼容。

    13 版本注记

    如果要将 RCS 或 CVS 的杂项包含在你的源文件中，按如下格式操作：

    __version__ = "$Revision: 1.4 $" 
# $Source: E:/cvsroot/python_doc/pep8.txt,v $

    对于 CVS 的服务器工作标记更应该在代码段中明确出它的使用说明，如在文档最开始的版权声明后应加入如下版本标记：

    # 文件：$id$ 
# 版本：$Revision$

    这样的标记在提交给配置管理服务器后，会自动适配成为相应的字符串，如：

    # 文件：$Id: ussp.py,v 1.22 2004/07/21 04:47:41 hd Exp $ 
# 版本：$Revision: 1.4 $

    这些应该包含在模块的文档字符串之后，所有代码之前，上下用一个空行分割。

    【相关推荐：Python3视频教程 】

    以上是Python編碼規範知識點整理的詳細內容。更多資訊請關注PHP中文網其他相關文章！

Python 正则表达式 String 常量 运算符 if for while 标识符 全局变量 字符串 变量类型 bool int 循环 接口 切片 对象 作用域 ASCII emacs
陳述：
本文轉載於：csdn.net。如有侵權，請聯絡admin@php.cn刪除
上一篇：完全掌握Python自動操作GUI之PyAutoGUI下一篇：完全掌握Python自動操作GUI之PyAutoGUI

相關文章

看更多