python 編碼風格

2021-05-28 01:32:35 字數 3200 閱讀 7211

#!/usr/bin/env python     #在檔案頭部 ( 第一行 ) 加上   設定 python 直譯器

# -*- coding: utf-8 -*- #在檔案頭部 ( 第二行 ) 加上 在編輯器中設定以 utf-8 預設編碼儲存檔案

# docstring 是 python 特有的注釋風格,它是模 塊、類或函式的第乙個語句,可以通過 __doc__ 方法訪問

# 用英語撰寫注釋,短注釋可以忽略末尾的句號 (.)

# docstring 為每個模組、類或函式撰寫 docstring 推薦使用三個雙引號 (」」」) 來定義 docsting , 不推薦使用三個單引號 (''')

# 模組的 docsting 放在檔案頭部,版權資訊之後

」」」this is a one line docstring.」」」

」」」the title of a multiline docstring:

after title is the content.you can write it as long as needed.

」」」# 把 import 語句放在檔案頭部,在模組 docstring 之後,在模組全域性變數或全域性常量之前

# 按照從一般到特殊的原則分組 import 語句,先 import 標準庫,然後 import 第三方庫,最後 import 程式中的自定義庫

# 在不同分組的 import 語句之間加空行

# 每個 import 語句只匯入乙個模組

import sys

import time

from pyqt.qtcore import signal, qtimer

# 在終端中使用中文字元 在檔案頭部加上

# import sys

# reload(sys)

# sys.setdefaultencoding('utf-8')

# 一行**的長度不能超過 79 個字元

# 在括號 ( 圓括號、方括號、花括號 ) 內部折行是 推薦使用的方式

foobar(self, width, height, color='balck', design=none, x='foo',

emphasis=none, highlight=0)

# 需要時可以在表示式兩側加上額外的括號

if (width == 0 and height == 0 and

color == 'red' and empasis == 'strong'):

# 括號內的長字串可以直接寫成兩個短字串

x = ('this will build a very long long '

'long long long long long long string')

# 使用續行符號,折行的位置可以在逗號 (,) 後或 運算子前,折行後要多乙個縮排

from pyqt4.qtcore import qtextcodec, signal, slot, \

qlibraryinfo, qtimer

verylongvariablea = verylongvariableb \

+ verlongvariablec

# 使用 4 個空格進行縮排 不要使用 tab 或者混合使用空格和 tab

# 適當的空行可以提高**的可讀性 加空行的原則:

## 在不同分組的 import 語句之間加空行

## 在頂層的類或函式定義之間加兩個空行

## 在類或函式定義之間加空行

## 相關的函式定義可以放在一起,並使用兩個空行來分 隔 ( 應謹慎地使用額外的空行 )

## 在函式或方法內部可以加空行,也就是把相關的** 緊湊地寫在一起,形成邏輯段落,段落之間用空行分 隔 ( 應謹慎地使用額外的空行 )

# 加空格的情況:

## 逗號 (,) 、冒號 (:) 後要加空格

## 二元運算子前後要加空格,如賦值運算子 (=) 、比較 運算子 (==, <, >, !=, <=, >=, in, not in, is, is not) 和邏 輯運算子 (and, or, not)

## 算數運算子前後要加空格

# 不加空格的情況:

## 逗號 (,) 、冒號 (:) 前不加空格 引數列表、索引 (index) 或切片 (slice) 的前括號 ( 圓

## 括號, 方括號)前不加空格 前括號 ( 圓括號、 方括號、花括號 ) 後不加空格,後

## 括號前不加空格 一元運算子前後不加空格

## 函式或方法定義或呼叫時引數列表中的等號 (=) 前後 不加空格

## 冒號 (:) 在行尾時不加空格,如類定義、函式定義、 分支語句、迴圈語句

# 謹慎地使用括號

# 不要在返回語句和條件語句中使用括號,除非是 為了換行

if foo:

bar()

return foo

# 可以在元組 (tuple) 兩側使用括號

for (x, y) in dict.items():

# 恰當的命名可以提高**的可讀性 命名時只使用 ascii 字元,並盡量使用英文單詞 命名規則

# 型別 公共 內部

# 包 lower_with_under

# 模組 lower_with_under _lower_with_under

# 類 capwords _capwords

# 函式 capwords() _capwords()

# 全域性常量 / 類常量 caps_with_under _caps_with_under

# 全域性變數 / 類變數 capwords _capwords

# 方法 capwrods() _capwords() ( 保護 ) __capwords() ( 私有 )

# 函式引數 / 方法引數 capwords

# 區域性變數 capwrods

# 不要使用l(小寫的l)、o(小寫的o)和i(大寫的 i) 作為單字元變數名,因為在某些字型下很難把 它們和數字1、0區分開

## 當需要使用 l( 小寫的 l) 時可以使用 l 代替

## 當需要使用保留關鍵字作為函式名時,可以在名 字後加乙個下劃線 (_) ,而不要破壞正常的拼寫

# 模組的主要功能要放在 main() 函式中

def main():

//do something

if __name__ == '__main__':

main()

python風格編碼 Python編碼風格 概述

對於 python 而言,pep 8 已成為大多數專案遵循的風格指南 它給出了乙個高度可讀,視覺友好的編碼風格。每個 python 開發者應該閱讀一下 這裡是為你提取出來的最重要的要點 from pymongo import mongoclient import gridfs,datetime,ti...

python編碼風格

usr bin env python 在檔案頭部 第一行 加上 設定 python 直譯器 coding utf 8 在檔案頭部 第二行 加上 在編輯器中設定以 utf 8 預設編碼儲存檔案使用中文字元,在檔案頭部加上 import sys reload sys sys.setdefaultenco...

python 編碼風格

usr bin env python 在檔案頭部 第一行 加上 設定 python 直譯器 encoding utf 8 在檔案頭部 第二行 加上 在編輯器中設定以 utf 8 預設編碼儲存檔案 docstring 是 python 特有的注釋風格,它是模 塊 類或函式的第乙個語句,可以通過 doc...