python编程规范 谷歌_Python最新编程规范,新手必学
最近,團隊又來了幾個小伙伴,經過一段時間磨合之后,發現彼此之間還是比較默契的,但有一個很大的問題是,每個人的編程風格和習慣都不同,導致現在代碼看起來非常混亂。
這里還要注意:不管你是想學Python還是想找python高薪工作,記住:項目實戰永遠是核心,如果你沒有Python入門到高級實戰視頻教程,可以關注我,后臺私信我 ‘py’ 自動獲取最新python教程資料!還有老司機解答哦!
所以,有一個統一的開發編碼規范還是很重要的。我在網上搜索了一些資料,在 PEP8 的基礎上,同時結合目前代碼的特點,總結出下文,分享給大家。
代碼布局
縮進
每個縮進級別采用 4 個空格,注意不是 Tab。
當一行超出單行最大長度時,采用 Python 隱式續行,即垂直對齊于圓括號、方括號和花括號。
例如:
# 調用函數foo = long_function_name(var_one, var_two, var_three, var_four) # 定義列表my_list = [ 1, 2, 3, 4, 5, 6,]# 定義字典my_dict = { 'a': 'hello', 'b': 'world'}復制代碼每行最大長度
傳統來說一直都是 80,但我覺得以現在的瀏覽器屏寬來說,設置 120 都沒問題,我設置的是 120.
二元運算符前換行
例如:
# 更容易匹配運算符與操作數income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)復制代碼空行
- 使用 1 個空行來分隔類中的方法(method)定義。
- 使用 2 個空行來分隔最外層的函數(function)和類(class)定義。
模塊引用
Imports 應該寫在代碼文件的開頭,并按照下面這樣的順序引用:
禁止使用 import * 這樣的方式。
模塊級的雙下劃線命名
模塊中的「雙下滑線」變量,比如 __all__,__author__,__version__ 等,直接寫在文件開頭。
例如:
"""This is the example module.This module does stuff."""from __future__ import barry_as_FLUFL__all__ = ['a', 'b', 'c']__version__ = '0.1'__author__ = 'Cardinal Biggles'import osimport sys復制代碼字符串引用
使用單引號來表示字符串,對于三引號字符串,使用雙引號字符表示。
例如:
# 單引號字符串a = 'hello'# 三引號字符串"""這是一個三引號字符串"""復制代碼表達式和語句中的空格
在下列情形中避免使用過多的空白:
1、方括號,圓括號和花括號之后:
# 正確的例子:spam(ham[1], {eggs: 2})# 錯誤的例子:spam( ham[ 1 ], { eggs: 2 } )復制代碼2、逗號,分號或冒號之前:
# 正確的例子:if x == 4: print x, y; x, y = y, x# 錯誤的例子:if x == 4 : print x , y ; x , y = y , x復制代碼3、切片操作
# 正確的例子:ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]ham[lower:upper], ham[lower:upper:], ham[lower::step]ham[lower+offset : upper+offset]ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]ham[lower + offset : upper + offset]# 錯誤的例子:ham[lower + offset:upper + offset]ham[1: 9], ham[1 :9], ham[1:9 :3]ham[lower : : upper]ham[ : upper]復制代碼4、賦值
# 正確的例子:x = 1y = 2long_variable = 3# 錯誤的例子:x = 1y = 2long_variable = 3復制代碼還有一點需要注意的是,一定要把行尾的空格刪掉。
注釋
對代碼進行必要的注釋,如果修改代碼,還要修改對應的注釋內容。
刪除無用的注釋內容,增加代碼可讀性。
塊注釋
要使用塊注釋,禁止使用行內注釋,注釋時,# 和后面的注釋內容要有空格。
例如:
# 這是一個注釋x = 1 + 1復制代碼不要使用下面的注釋方式:
x = 1 + 1 # 這是一個注釋復制代碼TODO 注釋
主要包含以下三點內容:
例如:
# TODO(xiaoming): 明確需求之后再開發復制代碼文檔字符串
對于公共模塊,函數,類和方法,使用文檔字符串。內容包括三個方面,分別是功能描述、參數、返回值。
例如:
class MyClass: """ 這是一個自定義類 """ something def func(): """ 這是一個自定義函數 params: params1: 第一個參數 params2: 第二個參數 return: {'data': {}, 'status': 200} """ something 復制代碼命名
1、文件名
采用小寫字母和下劃線的方式。
例如:
utils.pymail_lib.py復制代碼2、函數名
采用小寫字母和下劃線的方式。
例如:
def func(): passdef send_mail(): pass復制代碼3、類名
采用大駝峰方式。
例如:
class MyClass: pass復制代碼4、常量和變量:
例如:
# 常量TOTALMAX_COUNT# 變量totalmax_total復制代碼最后送python教程:不管你是想學Python還是想找python高薪工作,記住:項目實戰永遠是核心,如果你沒有Python入門到高級實戰視頻教程,可以關注我,后臺私信我 ‘py’ 自動獲取最新python教程資料!還有老司機解答哦!
本文的文字及圖片來源于網絡加上自己的想法,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯系我們以作處理。
總結
以上是生活随笔為你收集整理的python编程规范 谷歌_Python最新编程规范,新手必学的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: python pil png合成gif储
- 下一篇: google浏览器javascript没