在一篇关于Python编码指南的文档中,我遇到了Python源文件的以下标题格式:

#!/usr/bin/env python

"""Foobar.py: Description of what foobar does."""

__author__      = "Barack Obama"
__copyright__   = "Copyright 2009, Planet Earth"

这是Python世界中标题的标准格式吗?

推荐答案

这都是Foobar模块的元数据.

第一个是模块的docstring,已经在Peter's answer中解释过了.

如何组织我的模块(源文件)?(档案)

The first line of each file shoud be 100.这使得可以将文件作为隐式调用解释器的脚本运行,例如在CGI上下文中.

100如果描述很长,第一行应该是一个简短的摘要,它本身就有意义,用一个新行与其余部分隔开.

All code, including import statements, should follow the docstring.否则,解释器将无法识别文档字符串,并且您将无法在交互式会话中(即通过obj.__doc__)或在使用自动化工具生成文档时访问它.

Import built-in modules first, followed by third-party modules, followed by any changes to the path and your own modules.尤其是,模块路径和名称的添加可能会迅速改变:将它们放在一个地方会更容易找到.

Next should be authorship information.此信息应遵循以下格式:

__author__ = "Rob Knight, Gavin Huttley, and Peter Maxwell"
__copyright__ = "Copyright 2007, The Cogent Project"
__credits__ = ["Rob Knight", "Peter Maxwell", "Gavin Huttley",
                    "Matthew Wakefield"]
__license__ = "GPL"
__version__ = "1.0.1"
__maintainer__ = "Rob Knight"
__email__ = "rob@spot.colorado.edu"
__status__ = "Production"

状态通常应该是"原型"、"开发"或"生产"之一.__maintainer__应该是谁将修复错误,并作出改进,如果进口.__credits____author__的不同之处在于,__credits__包括报告错误修复、提出建议等但实际上并没有编写代码的人.

Here您有更多信息,将__author____authors____contact____copyright____license____deprecated____date____version__列为可识别的元数据.

Python相关问答推荐

在内部列表上滚动窗口

如何在具有重复数据的pandas中对groupby进行总和,同时保留其他列

我对我应该做什么以及我如何做感到困惑'

如何使Matplotlib标题以图形为中心,而图例框则以图形为中心

如何在图中标记平均点?

如何从列表框中 Select 而不出错?

在Python中调用变量(特别是Tkinter)

在代码执行后关闭ChromeDriver窗口

在Admin中显示从ManyToMany通过模型的筛选结果

基于另一列的GROUP-BY聚合将列添加到Polars LazyFrame

Python pint将1/华氏度转换为1/摄氏度°°

用两个字符串构建回文

mdates定位器在图表中显示不存在的时间间隔

没有内置pip模块的Python3.11--S在做什么?

如何使用pytest在traceback中找到特定的异常

Pandas数据框上的滚动平均值,其中平均值的中心基于另一数据框的时间

Polars定制函数返回多列

Python:在cmd中添加参数时的语法

如何在Django查询集中生成带有值列表的带注释的字段?

如何批量训练样本大小为奇数的神经网络?