Python PEP8: 空行约定

我有兴趣知道程序部件之间换行符的 Python 约定是什么:

import os


def func1():


def func2():

理想的换行分隔是什么:

  1. import模块和 功能？
  2. 功能本身？

我已经阅读了 PEP8，但我想确认以上两点。

55965 次浏览
小开
最佳答案
  1. Two blank lines between the import statements and other code.
  2. Two blank lines between each function.
小开

If one will check with 'Blank Lines' section of PEP8 — one will find the following:

Surround top-level function and class definitions with two blank lines.

Method definitions inside a class are surrounded 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).

Use blank lines in functions, sparingly, to indicate logical sections.

Regarding imports, PEP8 states:

Imports should usually be on separate lines

...

Imports should be grouped in the following order:

  1. standard library imports
  2. related third party imports
  3. local application/library specific imports

You should put a blank line between each group of imports.

So, for your example, PEP8 compliant formatting would be:

import os




def func1():




def func2():

Just to give a more comprehensive illustration:

import re
import glob
import sys


import requests
import scrapy


from flask import Flask
from my_local_module import MyClass




def top_level_function1():
pass




def top_level_function2():
pass




class TestClass(object):
    

def class_method1():
pass


def class_method2():
pass




class TestClass2(object):
    

def class2_method1():
pass


def class2_method2():
pass
小开

Perfectly explained by user8554766

Just a simple modification

#Standard system imports
import re
import glob
import sys


#Related third party imports
import requests
import scrapy
from flask import Flask


#Local application/library specific imports
from my_local_module import MyClass1, MyClass

Reference


提交答案