PyCharm - 作者是否出现在导入之前?

2024-01-07

当您创建新的 python 文件并添加新的导入时,PyCharm 会尽可能自动添加导入和 __author__ 标签。但是,默认情况下 __author__ 标签将始终出现在任何导入的下方。在我看来, __author__ 标签应该位于文件的顶部,我也可以在其中放置诸如文档字符串之类的内容。这样,描述文件的所有内容都位于顶部,然后实际代码(包括导入)位于其下方。

那么两个问题:

  1. 将 __author__ 标签放在导入下方是否有充分的理由?
  2. 如何设置 PyCharm 默认将 __author__ 标签放在导入之上?

  1. 根据“进口”部分PEP-8 http://legacy.python.org/dev/peps/pep-0008/#imports:

    导入始终放在文件的顶部,紧接在任何模块注释和文档字符串之后,以及模块全局变量和常量之前

    __author__是一个全局“变量”,因此应该出现在导入下方。

  2. 您可以进入 Pycharm 的设置(Ctrl-Alt-S),选择“文件和代码模板”并根据您的喜好调整“Python 脚本”模板。

请注意:正如下面 Martijn 的评论所提到的,上述声明的第 1 项不再正确,因为 PEP8 已更新(2016 年 6 月)https://www.python.org/dev/peps/pep-0008/#id24 https://www.python.org/dev/peps/pep-0008/#id24有一个很好的例子

"""
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
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

PyCharm - 作者是否出现在导入之前? 的相关文章

随机推荐