PyCharm - 作者如何在导入之前出现?
当你在创建新的Python文件并添加新的导入时,PyCharm会自动帮你添加这些导入和__author__标签,只要它能做到。不过,默认情况下,__author__标签总是出现在所有导入的下面。我觉得__author__标签应该放在文件的最上面,那里也可以放一些文档字符串。这样,描述文件的所有内容都在顶部,实际的代码(包括导入)就在下面。
所以有两个问题:
- 把__author__标签放在导入下面有什么好的理由吗?
- 我怎么能设置PyCharm,让__author__标签默认放在导入上面呢?
1 个回答
10
根据PEP-8的“导入”部分:
导入的内容总是放在文件的最上面,紧接着模块的注释和文档字符串,然后是模块的全局变量和常量。
__author__
是一个全局“变量”,所以应该放在导入语句的下面。你可以去Pycharm的设置(按Ctrl-Alt-S),选择“文件和代码模板”,然后根据自己的喜好调整“Python脚本”模板。
请注意:正如Martijn在下面评论中提到的,上述第一条已经不再适用,因为PEP8在2016年6月进行了更新,这里有个很好的例子。
"""
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 os
import sys