PEP 8——Python編碼風格指南
標簽（空格分隔）： Python PEP8 編碼規範
原文：https://lizhe2004.gitbooks.io/code-style-guideline-cn/content/python/python-pep8.html

https://python.freelycode.com/contribution/detail/47------PEP8中文版 -- Python編碼風格指南(上，中，下)

https://python.freelycode.com/contribution/list/2

介紹
This document gives coding conventions for the Python code comprising the standard library in the main Python distribution. Please see the companion informational PEP describing style guidelines for the C code in the C implementation of Python [1] . 本文提供的編碼規範用於Python主發行版中的標準庫的那些代碼。對於Python的C語言實現中的C代碼，請參考其他的PEP。

This document and PEP 257 (Docstring Conventions) were adapted from Guido‘s original Python Style Guide essay, with some additions from Barry‘s style guide [2] . 本文檔和PEP 257(Docstring約定)改編自Guido的早起的Python風格指南文章，並且添加了一些Barry的風格指南的內容。 This style guide evolves over time as additional conventions are identified and past conventions are rendered obsolete by changes in the language itself. 本風格指南會隨著時間不斷演化，因為會有新的約定被大家所認同，而又有一些老的約定會由於語言本身的改變而逐漸被廢棄。 Many projects have their own coding style guidelines. In the event of any conflicts, such project-specific guides take precedence for that project.

A Foolish Consistency is the Hobgoblin of Little Minds One of Guido‘s key insights is that code is read much more often than it is written. The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of Python code. As PEP 20 says, "Readability counts".

A style guide is about consistency. Consistency with this style guide is important. Consistency within a project is more important. Consistency within one module or function is most important.

But most importantly: know when to be inconsistent -- sometimes the style guide just doesn‘t apply. When in doubt, use your best judgment. Look at other examples and decide what looks best. And don‘t hesitate to ask!

In particular: do not break backwards compatibility just to comply with this PEP!

Some other good reasons to ignore a particular guideline:

When applying the guideline would make the code less readable, even for someone who is used to reading code that follows this PEP. To be consistent with surrounding code that also breaks it (maybe for historic reasons) -- although this is also an opportunity to clean up someone else‘s mess (in true XP style). Because the code in question predates the introduction of the guideline and there is no other reason to be modifying that code. When the code needs to remain compatible with older versions of Python that don‘t support the feature recommended by the style guide.

Code lay-out
代碼布局
Indentation
縮進
Use 4 spaces per indentation level. 每一級縮進使用4個空格。 Continuation lines should align wrapped elements either vertically using Python‘s implicit line joining inside parentheses, brackets and braces, or using a hanging indent . When using a hanging indent the following considerations should be applied; there should be no arguments on the first line and further indentation should be used to clearly distinguish itself as a continuation line. 續行應該將換行的元素垂直對齊，可以使用Python的圓括號、方括號、花括號中的隱式的連接符，也可以使用懸掛式縮進[5]。當采用懸掛式縮進方式時，應該符合下列考慮條件：第一行不應該有參數，而且應該能夠清楚無誤地將後面采用縮進的行作為後續行從其他行中區分出來。 Yes:

# Aligned with opening delimiter.
# 使用分隔符來對齊
foo = long_function_name(var_one, var_two,
var_three, var_four)

# More indentation included to distinguish this from the rest.
# 多使用一些縮進來與其他行進行區分
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)

# Hanging indents should add a level.
# 懸掛式縮進應該增加一個級別。
foo = long_function_name(
var_one, var_two,
var_three, var_four)
No:

# Arguments on first line forbidden when not using vertical alignment.
# 當不使用垂直對齊方式時，第一行不能有參數
foo = long_function_name(var_one, var_two,
var_three, var_four)

# Further indentation required as indentation is not distinguishable.
# 需要增加額外的縮進，因為現在的續行的縮進不夠明顯，不能將其與其他行的縮進區分開來
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)
The 4-space rule is optional for continuation lines. 對於續行而言，4個空格的規定是可選的。 Optional:

# Hanging indents *may* be indented to other than 4 spaces.
# 懸掛式縮進的空格個數*可以*不為4。
foo = long_function_name(
var_one, var_two,
var_three, var_four)
When the conditional part of an if -statement is long enough to require that it be written across multiple lines, it‘s worth noting that the combination of a two character keyword (i.e. if ), plus a single space, plus an opening parenthesis creates a natural 4-space indent for the subsequent lines of the multiline conditional. This can produce a visual conflict with the indented suite of code nested inside the if -statement, which would also naturally be indented to 4 spaces. This PEP takes no explicit position on how (or whether) to further visually distinguish such conditional lines from the nested suite inside the if -statement. Acceptable options in this situation include, but are not limited to: 當if語句由於條件判斷部分太長而需要跨多行時，值得註意的是，這一兩個字母的關鍵字（比如if）加上一個空格，再加上一個左括號，就使得需要在這一多行的條件語句的後面添加4個空格的縮進，這是很自然的事情。 這可能會與if語句所嵌套的那套分支代碼產生視覺上的沖突，因為很自然地，分支執行代碼也是縮進4個空格的。對於如何（或者是否要）將條件判斷語句與if語句中的分支代碼明確地區分出來，本PEP文檔沒有明確的立場。對於這種情況，下面的選項都是可以接受的，但是又不限於此：

# No extra indentation.
# 沒有多余縮進
if (this_is_one_thing and
that_is_another_thing):
do_something()

# Add a comment, which will provide some distinction in editors
# supporting syntax highlighting.
# 添加一條註釋來在編輯器中提供一些不同之處
# 支持與語法高亮
if (this_is_one_thing and
that_is_another_thing):
# Since both conditions are true, we can frobnicate.
# 當兩種條件都為true時，我們可以執行操作
do_something()

# Add some extra indentation on the conditional continuation line.
# 在條件判斷語句所在行添加一些額外的縮進
if (this_is_one_thing
and that_is_another_thing):
do_something()
The closing brace/bracket/parenthesis on multi-line constructs may either line up under the first non-whitespace character of the last line of list, as in: 在多行的代碼結構中，右花括號/中括號/小括號可以排在列出的元素的最後一行的第一個非空格字符的下面，比如：

my_list = [
1, 2, 3,
4, 5, 6,
]
result = some_function_that_takes_arguments(
‘a‘, ‘b‘, ‘c‘,
‘d‘, ‘e‘, ‘f‘,
)
or it may be lined up under the first character of the line that starts the multi-line construct, as in: 也可以排在該多行代碼結構的起始行的第一個字符下面。

my_list = [
1, 2, 3,
4, 5, 6,
]
result = some_function_that_takes_arguments(
‘a‘, ‘b‘, ‘c‘,
‘d‘, ‘e‘, ‘f‘,
)
Tabs or Spaces? Tab鍵還是空格鍵？ Spaces are the preferred indentation method. 空格是首選的縮進方法。 Tabs should be used solely to remain consistent with code that is already indented with tabs. Tab符只能用在哪些已經使用tab符來進行縮進的代碼中用來保持一致性。 Python 3 disallows mixing the use of tabs and spaces for indentation. Python 3 不允許將tab和空格鍵混合使用用於縮進。 Python 2 code indented with a mixture of tabs and spaces should be converted to using spaces exclusively. Python 2 中混合使用tab和空格來進行縮進的代碼必須轉換成僅僅使用空格。

When invoking the Python 2 command line interpreter with the -t option, it issues warnings about code that illegally mixes tabs and spaces. When using -tt these warnings become errors. These options are highly recommended! 當使用-t 選項來調用Python 2的命令行解釋器時，它對那些非法混合使用tab和空格的代碼會發出警告。而當使用-tt選項時，這些warning就會變成error。強烈推薦使用這些選項。 Maximum Line Length 行的最大長度 Limit all lines to a maximum of 79 characters. 所有行的最大長度是79個字符。 For flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters. 對於那些結構化限制比較少的連貫的比較長的文本塊（docstring或者註釋），每行的長度應該限制為72個字符。 Limiting the required editor window width makes it possible to have several files open side-by-side, and works well when using code review tools that present the two versions in adjacent columns. 對所要求的編輯器的窗口寬度進行限制就可以並排打開多個文件了，而當使用代碼review工具來在相鄰的兩列窗口中分別顯示兩個版本的內容時，效果很好。 The default wrapping in most tools disrupts the visual structure of the code, making it more difficult to understand. The limits are chosen to avoid wrapping in editors with the window width set to 80, even if the tool places a marker glyph in the final column when wrapping lines. Some web based tools may not offer dynamic line wrapping at all. 大部分的工具的默認換行功能會破壞代碼的可視化結構，使得代碼更加難以理解。選擇這個數值作為限制是用於避免在窗口寬度設為80的編輯器中出現代碼換行的情況。

Some teams strongly prefer a longer line length. For code maintained exclusively or primarily by a team that can reach agreement on this issue, it is okay to increase the nominal line length from 80 to 100 characters (effectively increasing the maximum length to 99 characters), provided that comments and docstrings are still wrapped at 72 characters. 有一些團隊更加傾向於更長一些的行最大長度。如果代碼只由或者主要由一個團隊維護，並且這個團隊能夠在這個問題上達成一致，那麽在將註釋和docstring的長度保留在72個字符串的限制的前提下，行最大長度從80增加到100個字符（）是沒有問題的。

The Python standard library is conservative and requires limiting lines to 79 characters (and docstrings/comments to 72). Python標準庫是保守的，它要求將每行限制為79個字符（docstring/註釋 則限制為72個字符）。 The preferred way of wrapping long lines is by using Python‘s implied line continuation inside parentheses, brackets and braces. Long lines can be broken over multiple lines by wrapping expressions in parentheses. These should be used in preference to using a backslash for line continuation.

對於那些比較長的行進行換行的首先方式是使用Python中花括號、中括號、圓括號裏面的隱含的連續符。可以通過將圓括號中的表達式換行來把較長的行產分成多行。這種續行的使用方式應該優先於使用右斜杠（\）符號的方式。 Backslashes may still be appropriate at times. For example, long, multiple with -statements cannot use implicit continuation, so backslashes are acceptable: 有些時候，右斜杠可以比較合適的。比如，比較長的多行的 with語句不能使用隱式的連接方式，所以右斜杠是可以接受的：

with open(‘/path/to/some/file/you/want/to/read‘) as file_1, \
open(‘/path/to/some/file/being/written‘, ‘w‘) as file_2:
file_2.write(file_1.read())
(See the previous discussion on multiline if-statements for further thoughts on the indentation of such multiline with -statements.) （參考之前對多行的if語句的討論，來對這種多行的with語句中的縮進作進一步思考） Another such case is with assert statements. 另一個使用右斜杠的例子就是 assert語句。

Make sure to indent the continued line appropriately. The preferred place to break around a binary operator is after the operator, not before it. Some examples: 要確保對續行進行適當的縮進。在二進制操作符處進行換行的首先位置是該操作符的後面，而不是前面。比如

class Rectangle(Blob):

def __init__(self, width, height,
color=‘black‘, emphasis=None, highlight=0):
if (width == 0 and height == 0 and
color == ‘red‘ and emphasis == ‘strong‘ or
highlight > 100):
raise ValueError("sorry, you lose")
if width == 0 and height == 0 and (color == ‘red‘ or
emphasis is None):
raise ValueError("I don‘t think so -- values are %s, %s" %
(width, height))
Blob.__init__(self, width, height,
color, emphasis, highlight)
Blank Lines

空行
Separate top-level function and class definitions with two blank lines. 用兩個空行來將最上層的方法與類定義分開。 Method definitions inside a class are separated by a single blank line. 使用一個空行來將類裏面的方法定義分開 Extra blank lines may be used (sparingly) to separate groups of related functions. Blank lines may be omitted between a bunch of related one-liners (e.g. a set of dummy implementations). 可以多使用一些空行（盡量少用這種方式）來將一些相關的方法進行分組。在一批相關的單行代碼(比如一組dummy實現)之間的空行可以省略。

Use blank lines in functions, sparingly, to indicate logical sections. 在函數中有節制地使用空行來將代碼分塊，來表明它們是不同的邏輯代碼塊。

Python accepts the control-L (i.e. ^L) form feed character as whitespace; Many tools treat these characters as page separators, so you may use them to separate pages of related sections of your file. Note, some editors and web-based code viewers may not recognize control-L as a form feed and will show another glyph in its place. Python把 control-L (也就是^L)換頁符是為空白符號；許多工具把它們當作頁分隔符來進行處理，所以你可以使用它們來將你的文件分頁，將相關聯的代碼塊分到一頁裏。註意：有一些編輯器和基於web的代碼查看器可能不把control-L當作換頁，會在相應的地方顯示一個圖像字符。

Source File Encoding

源文件編碼
Code in the core Python distribution should always use UTF-8 (or ASCII in Python 2). 核心的Python發行版中的代碼總是應該使用UTF-8(或者在Python 2中使用ASCII碼)。

Files using ASCII (in Python 2) or UTF-8 (in Python 3) should not have an encoding declaration. 使用ASCII(在Python 2）或者UTF-8(在Python 3)的文件不應該需要進行編碼聲明。

In the standard library, non-default encodings should be used only for test purposes or when a comment or docstring needs to mention an author name that contains non-ASCII characters; otherwise, using \x , \u , \U , or \N escapes is the preferred way to include non-ASCII data in string literals. 在標準庫中，非默認的編碼應該只能用於測試目的，或者用於在註釋或docstring中記錄包含非ASCII字符的作者姓名；否則以字符串文字（string literals）的形式包含非ASCII碼數據的首選方式是使用\x , \u , \U , or \N 轉義符。

For Python 3.0 and beyond, the following policy is prescribed for the standard library (see PEP 3131 ): All identifiers in the Python standard library MUST use ASCII-only identifiers, and SHOULD use English words wherever feasible (in many cases, abbreviations and technical terms are used which aren‘t English). In addition, string literals and comments must also be in ASCII. The only exceptions are (a) test cases testing the non-ASCII features, and (b) names of authors. Authors whose names are not based on the latin alphabet MUST provide a latin transliteration of their names. 對於Python 3.0以及更新的版本，相對應的策略已經在標準庫（見PEP 3131）中進行了規定：所有在Python標準庫中的標識符必須使用ASCII標識符，並且應該在可行的情況下使用英文單詞（在許多情況下會使用非英文的縮略詞和技術術語）。另外，字符串文字和註釋必須同樣使用ASCII。唯一的例外是(a)測試非ASCII的功能的測試用例 (b)作者的名字。如果作者的名字不是基於拉丁字母的，那麽必須提供對應的拉丁翻譯。 Open source projects with a global audience are encouraged to adopt a similar policy. 我們鼓勵具有國際受眾的開源項目采用類似的策略。 Imports Imports should usually be on separate lines, e.g.: Import語句通常應該分在不同的行，比如

Yes:

import os
import sys
No:

import sys, os
It‘s okay to say this though: 下面這種方式是可以的：

from subprocess import Popen, PIPE
Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants. Import語句每次都是放在文件的開頭，它位於模塊的註釋和docstring以及模塊的全局變量和常量之間。 Imports should be grouped in the following order: Import語句應該按照下面的順序進行分組：

standard library imports 標準庫import語句 related third party imports 相關的第三方庫import語句 local application/library specific imports 本地應用/庫的指定的import語句 You should put a blank line between each group of imports. 你應該在每組import之間插入一個空行。 Put any relevant all specification after the imports. 在import語句後面可以放入任何相關的all聲明。 Absolute imports are recommended, as they are usually more readable and tend to be better behaved (or at least give better error messages) if the import system is incorrectly configured (such as when a directory inside a package ends up on sys.path ): 建議使用絕對的import，因為這種方式通常可讀性更強，並且在import系統配置錯誤（比如 當某個包裏面的路徑沒有在sys.path出現）的情況下，表現往往會更加好一些。

import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example
However, explicit relative imports are an acceptable alternative to absolute imports, especially when dealing with complex package layouts where using absolute imports would be unnecessarily verbose: 然而，相對於絕對import，顯式的相對import也是一種可以接受的選擇，特別是當處理復雜的包結構，而使用絕對import會顯得特別繁瑣和啰嗦的時候。

from . import sibling
from .sibling import example
Standard library code should avoid complex package layouts and always use absolute imports. 標準庫代碼應該避免復雜的包結構，並且始終使用絕對import。

Implicit relative imports should never be used and have been removed in Python 3. 不能使用隱式的相對import，並且這種隱式的相對import已經在Python 3中移掉了。

When importing a class from a class-containing module, it‘s usually okay to spell this: 當從某個包含類的模塊中導入類時，下面這種拼寫方式是可以的：

from myclass import MyClass
from foo.bar.yourclass import YourClass
If this spelling causes local name clashes, then spell them 如果這種方式導致本地命名沖突，就要用下面這種方式：

import myclass
import foo.bar.yourclass
and use "myclass.MyClass" and "foo.bar.yourclass.YourClass". 然後使用"myclass.MyClass" 和 "foo.bar.yourclass.YourClass"

Wildcard imports ( from import ) should be avoided, as they make it unclear which names are present in the namespace, confusing both readers and many automated tools. There is one defensible use case for a wildcard import, which is to republish an internal interface as part of a public API (for example, overwriting a pure Python implementation of an interface with the definitions from an optional accelerator module and exactly which definitions will be overwritten isn‘t known in advance). 應該避免使用通配符形式的import (`from import `)，因為 而讓讀者和許多自動化工具搞不清楚哪些名稱在當前命名空間出現。有一種使用通配符形式的import的用例是情有可原的，那就是將某個內部接口重新發布為公開的API的一部分（比如，按照某個accelerator模塊的定義將某個接口的純Python實現進行重寫，而並不能提前知道哪些接口將被重寫）

When republishing names this way, the guidelines below regarding public and internal interfaces still apply. 當采用這種方式 String Quotes 字符串引號

In Python, single-quoted strings and double-quoted strings are the same. This PEP does not make a recommendation for this. Pick a rule and stick to it. When a string contains single or double quote characters, however, use the other one to avoid backslashes in the string. It improves readability. 在Python中，單引號的字符串和雙引號的字符串是相同的。本PEP規範並不對此進行要求。只要選擇一種方式並一直用下去就可以了。當字符串包含單引號或者雙引號字符串時，選擇使用另一種方式可以避免在字符串中出現右下劃線。這會增加可讀性。 For triple-quoted strings, always use double quote characters to be consistent with the docstring convention in PEP 257 . 對於三個引號的字符串， Whitespace in Expressions and Statements 表達式和代碼語句中的空白 Pet Peeves Avoid extraneous whitespace in the following situations: 避免在下面的場景中使用無關的空白 Immediately inside parentheses, brackets or braces. 在圓括號、中括號、花括號的內側附近 Yes:

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

spam( ham[ 1 ], { eggs: 2 } )
Immediately before a comma, semicolon, or colon: 在逗號、分號、冒號的前面 Yes: if x == 4: print x, y; x, y = y, x No: if x == 4 : print x , y ; x , y = y , x However, in a slice the colon acts like a binary operator, and should have equal amounts on either side (treating it as the operator with the lowest priority). In an extended slice, both colons must have the same amount of spacing applied. Exception: when a slice parameter is omitted, the space is omitted.

Yes:

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]
No:

ham[lower + offset:upper + offset]
ham[1: 9], ham[1 :9], ham[1:9 :3]
ham[lower : : upper]
ham[ : upper]
Immediately before the open parenthesis that starts the argument list of a function call:

Yes: spam(1) No: spam (1) Immediately before the open parenthesis that starts an indexing or slicing:

Yes: dct[‘key‘] = lst[index] No: dct [‘key‘] = lst [index] More than one space around an assignment (or other) operator to align it with another.

Yes:

x = 1
y = 2
long_variable = 3
No:

x = 1
y = 2
long_variable = 3
Other Recommendations Always surround these binary operators with a single space on either side: assignment ( = ), augmented assignment ( += , -= etc.), comparisons ( == , < , > , != , <> , <= , >= , in , not in , is , is not ), Booleans ( and , or , not ).

If operators with different priorities are used, consider adding whitespace around the operators with the lowest priority(ies). Use your own judgment; however, never use more than one space, and always have the same amount of whitespace on both sides of a binary operator.

Yes:

i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)
No:

i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)
Don‘t use spaces around the = sign when used to indicate a keyword argument or a default parameter value.

Yes:

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

def complex(real, imag = 0.0):
return magic(r = real, i = imag)
Do use spaces around the = sign of an annotated function definition. Additionally, use a single space after the : , as well as a single space on either side of the -> sign representing an annotated return value.

Yes:

def munge(input: AnyStr):
def munge(sep: AnyStr = None):
def munge() -> AnyStr:
def munge(input: AnyStr, sep: AnyStr = None, limit=1000):
No:

def munge(input: AnyStr=None):
def munge(input:AnyStr):
def munge(input: AnyStr)->PosInt:
Compound statements (multiple statements on the same line) are generally discouraged.

Yes:

if foo == ‘blah‘:
do_blah_thing()
do_one()
do_two()
do_three()
Rather not:

if foo == ‘blah‘: do_blah_thing()
do_one(); do_two(); do_three()
While sometimes it‘s okay to put an if/for/while with a small body on the same line, never do this for multi-clause statements. Also avoid folding such long lines!

Rather not:

if foo == ‘blah‘: do_blah_thing()
for x in lst: total += x
while t < 10: t = delay()
Definitely not:

if foo == ‘blah‘: do_blah_thing()
else: do_non_blah_thing()

try: something()
finally: cleanup()

do_one(); do_two(); do_three(long, argument,
list, like, this)

if foo == ‘blah‘: one(); two(); three()
Comments Comments that contradict the code are worse than no comments. Always make a priority of keeping the comments up-to-date when the code changes!

Comments should be complete sentences. If a comment is a phrase or sentence, its first word should be capitalized, unless it is an identifier that begins with a lower case letter (never alter the case of identifiers!).

If a comment is short, the period at the end can be omitted. Block comments generally consist of one or more paragraphs built out of complete sentences, and each sentence should end in a period.

You should use two spaces after a sentence-ending period.

When writing English, follow Strunk and White.

Python coders from non-English speaking countries: please write your comments in English, unless you are 120% sure that the code will never be read by people who don‘t speak your language.

Block Comments Block comments generally apply to some (or all) code that follows them, and are indented to the same level as that code. Each line of a block comment starts with a # and a single space (unless it is indented text inside the comment).

Paragraphs inside a block comment are separated by a line containing a single # .

Inline Comments Use inline comments sparingly.

An inline comment is a comment on the same line as a statement. Inline comments should be separated by at least two spaces from the statement. They should start with a # and a single space.

Inline comments are unnecessary and in fact distracting if they state the obvious. Don‘t do this:

x = x + 1 # Increment x
But sometimes, this is useful:

x = x + 1 # Compensate for border
Documentation Strings Conventions for writing good documentation strings (a.k.a. "docstrings") are immortalized in PEP 257 .

Write docstrings for all public modules, functions, classes, and methods. Docstrings are not necessary for non-public methods, but you should have a comment that describes what the method does. This comment should appear after the def line.

PEP 257 describes good docstring conventions. Note that most importantly, the """ that ends a multiline docstring should be on a line by itself, e.g.:

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.
"""
For one liner docstrings, please keep the closing """ on the same line.

Version Bookkeeping If you have to have Subversion, CVS, or RCS crud in your source file, do it as follows.

__version__ = "$Revision$"
# $Source$
These lines should be included after the module‘s docstring, before any other code, separated by a blank line above and below.

Naming Conventions The naming conventions of Python‘s library are a bit of a mess, so we‘ll never get this completely consistent -- nevertheless, here are the currently recommended naming standards. New modules and packages (including third party frameworks) should be written to these standards, but where an existing library has a different style, internal consistency is preferred.

Overriding Principle Names that are visible to the user as public parts of the API should follow conventions that reflect usage rather than implementation.

Descriptive: Naming Styles There are a lot of different naming styles. It helps to be able to recognize what naming style is being used, independently from what they are used for.

The following naming styles are commonly distinguished:

b (single lowercase letter)

B (single uppercase letter)

lowercase

lower_case_with_underscores

UPPERCASE

UPPER_CASE_WITH_UNDERSCORES

CapitalizedWords (or CapWords, or CamelCase -- so named because of the bumpy look of its letters [3] ). This is also sometimes known as StudlyCaps.

Note: When using abbreviations in CapWords, capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError.

mixedCase (differs from CapitalizedWords by initial lowercase character!)

Capitalized_Words_With_Underscores (ugly!)

There‘s also the style of using a short unique prefix to group related names together. This is not used much in Python, but it is mentioned for completeness. For example, the os.stat() function returns a tuple whose items traditionally have names like st_mode , st_size , st_mtime and so on. (This is done to emphasize the correspondence with the fields of the POSIX system call struct, which helps programmers familiar with that.)

The X11 library uses a leading X for all its public functions. In Python, this style is generally deemed unnecessary because attribute and method names are prefixed with an object, and function names are prefixed with a module name.

In addition, the following special forms using leading or trailing underscores are recognized (these can generally be combined with any case convention):

_single_leading_underscore : weak "internal use" indicator. E.g. from M import * does not import objects whose name starts with an underscore.

singletrailing_underscore : used by convention to avoid conflicts with Python keyword, e.g.

Tkinter.Toplevel(master, class_=‘ClassName‘) double_leading_underscore : when naming a class attribute, invokes name mangling (inside class FooBar, boo becomes _FooBar__boo ; see below).

double_leading_and_trailing_underscore : "magic" objects or attributes that live in user-controlled namespaces. E.g. init , import or file . Never invent such names; only use them as documented.

Prescriptive: Naming Conventions Names to Avoid Never use the characters ‘l‘ (lowercase letter el), ‘O‘ (uppercase letter oh), or ‘I‘ (uppercase letter eye) as single character variable names.

In some fonts, these characters are indistinguishable from the numerals one and zero. When tempted to use ‘l‘, use ‘L‘ instead.

Package and Module Names Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

Since module names are mapped to file names, and some file systems are case insensitive and truncate long names, it is important that module names be chosen to be fairly short -- this won‘t be a problem on Unix, but it may be a problem when the code is transported to older Mac or Windows versions, or DOS.

When an extension module written in C or C++ has an accompanying Python module that provides a higher level (e.g. more object oriented) interface, the C/C++ module has a leading underscore (e.g. _socket ).

Class Names Class names should normally use the CapWords convention.

The naming convention for functions may be used instead in cases where the interface is documented and used primarily as a callable.

Note that there is a separate convention for builtin names: most builtin names are single words (or two words run together), with the CapWords convention used only for exception names and builtin constants.

Exception Names Because exceptions should be classes, the class naming convention applies here. However, you should use the suffix "Error" on your exception names (if the exception actually is an error).

Global Variable Names (Let‘s hope that these variables are meant for use inside one module only.) The conventions are about the same as those for functions.

Modules that are designed for use via from M import * should use the all mechanism to prevent exporting globals, or use the older convention of prefixing such globals with an underscore (which you might want to do to indicate these globals are "module non-public").

Function Names Function names should be lowercase, with words separated by underscores as necessary to improve readability.

mixedCase is allowed only in contexts where that‘s already the prevailing style (e.g. threading.py), to retain backwards compatibility.

Function and method arguments Always use self for the first argument to instance methods.

Always use cls for the first argument to class methods.

If a function argument‘s name clashes with a reserved keyword, it is generally better to append a single trailing underscore rather than use an abbreviation or spelling corruption. Thus class_ is better than clss . (Perhaps better is to avoid such clashes by using a synonym.)

Method Names and Instance Variables Use the function naming rules: lowercase with words separated by underscores as necessary to improve readability.

Use one leading underscore only for non-public methods and instance variables.

To avoid name clashes with subclasses, use two leading underscores to invoke Python‘s name mangling rules.

Python mangles these names with the class name: if class Foo has an attribute named a , it cannot be accessed by Foo.a . (An insistent user could still gain access by calling Foo._Foo__a .) Generally, double leading underscores should be used only to avoid name conflicts with attributes in classes designed to be subclassed.

Note: there is some controversy about the use of __names (see below).

Constants Constants are usually defined on a module level and written in all capital letters with underscores separating words. Examples include MAX_OVERFLOW and TOTAL .

Designing for inheritance Always decide whether a class‘s methods and instance variables (collectively: "attributes") should be public or non-public. If in doubt, choose non-public; it‘s easier to make it public later than to make a public attribute non-public.

Public attributes are those that you expect unrelated clients of your class to use, with your commitment to avoid backward incompatible changes. Non-public attributes are those that are not intended to be used by third parties; you make no guarantees that non-public attributes won‘t change or even be removed.

We don‘t use the term "private" here, since no attribute is really private in Python (without a generally unnecessary amount of work).

Another category of attributes are those that are part of the "subclass API" (often called "protected" in other languages). Some classes are designed to be inherited from, either to extend or modify aspects of the class‘s behavior. When designing such a class, take care to make explicit decisions about which attributes are public, which are part of the subclass API, and which are truly only to be used by your base class.

With this in mind, here are the Pythonic guidelines:

Public attributes should have no leading underscores. 公共屬性不應該前置下劃線 If your public attribute name collides with a reserved keyword, append a single trailing underscore to your attribute name. This is preferable to an abbreviation or corrupted spelling. (However, notwithstanding this rule, ‘cls‘ is the preferred spelling for any variable or argument which is known to be a class, especially the first argument to a class method.) 如果你的公共屬性的名字和某個保留關鍵字沖突的話，在你的屬性名後面添加一個下劃線後綴。這種方式要好於使用縮寫或者更改拼寫。（但是，盡管有這麽一條規則，但是對於那些已經知道是一個class的變量或者參數，‘cls’任然是首選拼寫，尤其是類方法中的第一個參數）。

Note 1: See the argument name recommendation above for class methods. 註意 1： 對於class方法可參閱上面的參數命名建議。 For simple public data attributes, it is best to expose just the attribute name, without complicated accessor/mutator methods. Keep in mind that Python provides an easy path to future enhancement, should you find that a simple data attribute needs to grow functional behavior. In that case, use properties to hide functional implementation behind simple data attribute access syntax.

對於簡單的共有數據屬性，最好的方式是直接暴露屬性名稱，而不要使用復雜的訪問和賦值方法。要記住的是，為了便於未來的擴展，Python提供了一種簡單的方式，你會發現，簡單的數據屬性需要擴充函數行為。在這種情況下，使用properties來將函數實現隱藏在簡單的數據屬性訪問語法的背後。 ``` class Movie(object): def init(self, title, rating, runtime, budget, gross):

self._budget = None

self.title = title
self.rating = rating
self.runtime = runtime
self.gross = gross
self.budget = budget
@property def budget(self):

return self._budget
@budget.setter def budget(self, value):

if value < 0:
raise ValueError("Negative value not allowed: %s" % value)
self._budget = value
def profit(self):

return self.gross - self.budget
m = Movie(‘Casablanca‘, 97, 102, 964000, 1300000) print m.budget # calls m.budget(), returns result try: m.budget = -100 # calls budget.setter(-100), and raises ValueError except ValueError: print "Woops. Not allowed"

Note 1: Properties only work on new-style classes.
註意 1： Properties 只能在新型類中使用。
Note 2: Try to keep the functional behavior side-effect free, although side-effects such as caching are generally fine.
註意 2： 盡量保持函數行為沒有副作用，盡管想緩存caching這樣的副作用一般是沒有問題的。

Note 3: Avoid using properties for computationally expensive operations; the attribute notation makes the caller believe that access is (relatively) cheap.
註意 3： 避免對那些很耗費計算的操作使用properties；這種屬性表示法會讓掉用房認為對其進行訪問的代價是（相對）比較便宜的。
If your class is intended to be subclassed, and you have attributes that you do not want subclasses to use, consider naming them with double leading underscores and no trailing underscores. This invokes Python‘s name mangling algorithm, where the name of the class is mangled into the attribute name. This helps avoid attribute name collisions should subclasses inadvertently contain attributes with the same name.
如果你打算繼承某個類，並且你不希望子類使用某些屬性，可以考慮用雙前置下劃線來對這些屬性命名，不要帶後置下劃線。它會調用Python的name managling算法，類的名字會被修改為屬性名。這有助於避免子類無意中包含的屬性的名字和父類的屬性名相同而相沖突。
Note 1: Note that only the simple class name is used in the mangled name, so if a subclass chooses both the same class name and attribute name, you can still get name collisions.
註意 1：

Note 2: Name mangling can make certain uses, such as debugging and __getattr__() , less convenient. However the name mangling algorithm is well documented and easy to perform manually.

Note 3: Not everyone likes name mangling. Try to balance the need to avoid accidental name clashes with potential use by advanced callers.

Public and internal interfaces
##共開的接口和內部接口
Any backwards compatibility guarantees apply only to public interfaces. Accordingly, it is important that users be able to clearly distinguish between public and internal interfaces.
所有向後兼容性的保證只適用於公開的接口。因此，讓用戶能夠清楚地將公開接口和內部接口區分出來是非常重要的。
Documented interfaces are considered public, unless the documentation explicitly declares them to be provisional or internal interfaces exempt from the usual backwards compatibility guarantees. All undocumented interfaces should be assumed to be internal.
文檔所記錄下來的接口被認為是公開的，除非文檔顯式地將它們聲明為臨時或者內部接口來免除通常的向後兼容性的保證。所有沒有記錄下來的接口都應該被假定為是內部的接口。
To better support introspection, modules should explicitly declare the names in their public API using the __all__ attribute. Setting __all__ to an empty list indicates that the module has no public API.
為了更好地支持自省（introspection），模塊應該顯式地使用__all_屬性在它們的公開的API中來聲明它們的名字。將沒有公開API的模塊的__all__設置為空的list。
Even with __all__ set appropriately, internal interfaces (packages, modules, classes, functions, attributes or other names) should still be prefixed with a single leading underscore.

An interface is also considered internal if any containing namespace (package, module or class) is considered internal.

Imported names should always be considered an implementation detail. Other modules must not rely on indirect access to such imported names unless they are an explicitly documented part of the containing module‘s API, such as os.path or a package‘s __init__ module that exposes functionality from submodules.

Programming Recommendations
##編程建議
Code should be written in a way that does not disadvantage other implementations of Python (PyPy, Jython, IronPython, Cython, Psyco, and such).

For example, do not rely on CPython‘s efficient implementation of in-place string concatenation for statements in the form a += b or a = a + b . This optimization is fragile even in CPython (it only works for some types) and isn‘t present at all in implementations that don‘t use refcounting. In performance sensitive parts of the library, the ‘‘.join() form should be used instead. This will ensure that concatenation occurs in linear time across various implementations.

Comparisons to singletons like None should always be done with is or is not , never the equality operators.

Also, beware of writing if x when you really mean if x is not None -- e.g. when testing whether a variable or argument that defaults to None was set to some other value. The other value might have a type (such as a container) that could be false in a boolean context!

Use is not operator rather than not ... is . While both expressions are functionally identical, the former is more readable and preferred.

Yes:
if foo is not None:

No:
if not foo is None:

When implementing ordering operations with rich comparisons, it is best to implement all six operations ( __eq__ , __ne__ , __lt__ , __le__ , __gt__ , __ge__ ) rather than relying on other code to only exercise a particular comparison.

To minimize the effort involved, the functools.total_ordering() decorator provides a tool to generate missing comparison methods.

PEP 207 indicates that reflexivity rules are assumed by Python. Thus, the interpreter may swap y > x with x < y , y >= x with x <= y , and may swap the arguments of x == y and x != y . The sort() and min() operations are guaranteed to use the < operator and the max() function uses the > operator. However, it is best to implement all six operations so that confusion doesn‘t arise in other contexts.

Always use a def statement instead of an assignment statement that binds a lambda expression directly to an identifier.

Yes:
def f(x): return 2*x

No:
f = lambda x: 2*x

The first form means that the name of the resulting function object is specifically ‘f‘ instead of the generic ‘<lambda>‘. This is more useful for tracebacks and string representations in general. The use of the assignment statement eliminates the sole benefit a lambda expression can offer over an explicit def statement (i.e. that it can be embedded inside a larger expression)

Derive exceptions from Exception rather than BaseException . Direct inheritance from BaseException is reserved for exceptions where catching them is almost always the wrong thing to do.

Design exception hierarchies based on the distinctions that code catching the exceptions is likely to need, rather than the locations where the exceptions are raised. Aim to answer the question "What went wrong?" programmatically, rather than only stating that "A problem occurred" (see PEP 3151 for an example of this lesson being learned for the builtin exception hierarchy)

Class naming conventions apply here, although you should add the suffix "Error" to your exception classes if the exception is an error. Non-error exceptions that are used for non-local flow control or other forms of signaling need no special suffix.

Use exception chaining appropriately. In Python 3, "raise X from Y" should be used to indicate explicit replacement without losing the original traceback.

When deliberately replacing an inner exception (using "raise X" in Python 2 or "raise X from None" in Python 3.3+), ensure that relevant details are transferred to the new exception (such as preserving the attribute name when converting KeyError to AttributeError, or embedding the text of the original exception in the new exception message).

When raising an exception in Python 2, use raise ValueError(‘message‘) instead of the older form raise ValueError, ‘message‘ .

The latter form is not legal Python 3 syntax.

The paren-using form also means that when the exception arguments are long or include string formatting, you don‘t need to use line continuation characters thanks to the containing parentheses.

When catching exceptions, mention specific exceptions whenever possible instead of using a bare except: clause.

For example, use:
try: import platform_specific_module except ImportError: platform_specific_module = None

A bare except: clause will catch SystemExit and KeyboardInterrupt exceptions, making it harder to interrupt a program with Control-C, and can disguise other problems. If you want to catch all exceptions that signal program errors, use except Exception: (bare except is equivalent to except BaseException: ).

A good rule of thumb is to limit use of bare ‘except‘ clauses to two cases:

If the exception handler will be printing out or logging the traceback; at least the user will be aware that an error has occurred.
If the code needs to do some cleanup work, but then lets the exception propagate upwards with raise . try...finally can be a better way to handle this case.
When binding caught exceptions to a name, prefer the explicit name binding syntax added in Python 2.6:
try: process_data() except Exception as exc: raise DataProcessingFailedError(str(exc))

This is the only syntax supported in Python 3, and avoids the ambiguity problems associated with the older comma-based syntax.

When catching operating system errors, prefer the explicit exception hierarchy introduced in Python 3.3 over introspection of errno values.

Additionally, for all try/except clauses, limit the try clause to the absolute minimum amount of code necessary. Again, this avoids masking bugs.

Yes:
try: value = collection[key] except KeyError: return key_not_found(key) else: return handle_value(value)

No:
try:

# Too broad!
return handle_value(collection[key])
except KeyError:

# Will also catch KeyError raised by handle_value()
return key_not_found(key)
When a resource is local to a particular section of code, use a with statement to ensure it is cleaned up promptly and reliably after use. A try/finally statement is also acceptable.

Context managers should be invoked through separate functions or methods whenever they do something other than acquire and release resources. For example:

Yes:
with conn.begin_transaction(): do_stuff_in_transaction(conn)

No:
with conn: do_stuff_in_transaction(conn)

The latter example doesn‘t provide any information to indicate that the __enter__ and __exit__ methods are doing something other than closing the connection after a transaction. Being explicit is important in this case.

Be consistent in return statements. Either all return statements in a function should return an expression, or none of them should. If any return statement returns an expression, any return statements where no value is returned should explicitly state this as return None , and an explicit return statement should be present at the end of the function (if reachable).

Yes:
def foo(x): if x >= 0: return math.sqrt(x) else: return None

def bar(x): if x < 0: return None return math.sqrt(x)

No:
def foo(x): if x >= 0: return math.sqrt(x)

def bar(x): if x < 0: return return math.sqrt(x) ``` Use string methods instead of the string module.

String methods are always much faster and share the same API with unicode strings. Override this rule if backward compatibility with Pythons older than 2.0 is required.

Use ‘‘.startswith() and ‘‘.endswith() instead of string slicing to check for prefixes or suffixes.

startswith() and endswith() are cleaner and less error prone. For example:

Yes: if foo.startswith(‘bar‘): No: if foo[:3] == ‘bar‘: Object type comparisons should always use isinstance() instead of comparing types directly.

Yes: if isinstance(obj, int):

No: if type(obj) is type(1): When checking if an object is a string, keep in mind that it might be a unicode string too! In Python 2, str and unicode have a common base class, basestring, so you can do:

if isinstance(obj, basestring): Note that in Python 3, unicode and basestring no longer exist (there is only str ) and a bytes object is no longer a kind of string (it is a sequence of integers instead)

For sequences, (strings, lists, tuples), use the fact that empty sequences are false.

Yes: if not seq: if seq:

No: if len(seq) if not len(seq) Don‘t write string literals that rely on significant trailing whitespace. Such trailing whitespace is visually indistinguishable and some editors (or more recently, reindent.py) will trim them.

Don‘t compare boolean values to True or False using == .

Yes: if greeting: No: if greeting == True: Worse: if greeting is True: The Python standard library will not use function annotations as that would result in a premature commitment to a particular annotation style. Instead, the annotations are left for users to discover and experiment with useful annotation styles.

It is recommended that third party experiments with annotations use an associated decorator to indicate how the annotation should be interpreted.

Early core developer attempts to use function annotations revealed inconsistent, ad-hoc annotation styles. For example:

[str] was ambiguous as to whether it represented a list of strings or a value that could be either str or None . The notation open(file:(str,bytes)) was used for a value that could be either bytes or str rather than a 2-tuple containing a str value followed by a bytes value. The annotation seek(whence:int) exhibited a mix of over-specification and under-specification: int is too restrictive (anything with index would be allowed) and it is not restrictive enough (only the values 0, 1, and 2 are allowed). Likewise, the annotation write(b: bytes) was also too restrictive (anything supporting the buffer protocol would be allowed). Annotations such as read1(n: int=None) were self-contradictory since None is not an int . Annotations such as source_path(self, fullname:str) -> object were confusing about what the return type should be. In addition to the above, annotations were inconsistent in the use of concrete types versus abstract types: int versus Integral and set/frozenset versus MutableSet/Set. Some annotations in the abstract base classes were incorrect specifications. For example, set-to-set operations require other to be another instance of Set rather than just an Iterable . A further issue was that annotations become part of the specification but weren‘t being tested. In most cases, the docstrings already included the type specifications and did so with greater clarity than the function annotations. In the remaining cases, the docstrings were improved once the annotations were removed. The observed function annotations were too ad-hoc and inconsistent to work with a coherent system of automatic type checking or argument validation. Leaving these annotations in the code would have made it more difficult to make changes later so that automated utilities could be supported. Footnotes

[5] Hanging indentation is a type-setting style where all the lines in a paragraph are indented except the first line. In the context of Python, the term is used to describe a style where the opening parenthesis of a parenthesized statement is the last non-whitespace character of the line, with subsequent lines being indented until the closing parenthesis. References [1] PEP 7 , Style Guide for C Code, van Rossum [2] Barry‘s GNU Mailman style guide http://barry.warsaw.us/software/STYLEGUIDE.txt [3] http://www.wikipedia.com/wiki/CamelCase [4] PEP 8 modernisation, July 2013 http://bugs.python.org/issue18472 Copyright This document has been placed in the public domain.

Source: https://hg.python.org/peps/file/tip/pep-0008.txt

致謝： 本文參考了http://wiki.hiaero.net/doku.php?id=python:pep8一文特此表示感謝?

(轉)PEP 8——Python編碼風格指南