python编码规范(英文原版)

Python (/) >>>

Python Developer's Guide (/dev/) >>>

PEP Index (/dev/peps/) >>>

PEP 8 - Style Guide for Python Code

PEP 8 - Style Guide for Python Code

PEP: 8

Title: Style Guide for Python Code

Ver sion: e98737176f1d

Last-Modified: 2014-08-31 20:18:33 -0700 (Sun, 31 Aug 2014) (https://hg.python.org/peps/file/tip/pep-0008.txt)

Author: Guido van Rossum <guido at python.org>, Barry Warsaw <barry at python.org>, Nick Coghlan <ncoghlan at gmail.com>

guidelines for the C code in the C implementation of Python [1] (#id5) .

This document and PEP 257 (/dev/peps/pep-0257) (Docstring Conventions) were adapted from Guido's original Python Style Guide essay, with some additions from Barry's style guide [2] (#id6) .

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 (#id10)

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 (/dev/peps/pep-0020) 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

Indentation (#id12)

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.

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):

# Hanging indents should add a level.

# Arguments on first line forbidden when not using vertical alignment.

def long_function_name(

var_one, var_two, var_three,

var_four):

print(var_one)

The 4-space rule is optional for continuation lines.

Optional:

# Hanging indents *may* be indented to other than 4 spaces.

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