python - 这些元素在 Python 模块中的顺序应该是什么？

Question

如果存在，这些元素应该在 Python 模块中声明的顺序是什么？

• 哈希爆炸 ( #!/usr/bin/env python)
• 编码 ( # coding: utf-8)
• 未来进口 ( from __future__ import unicode_literals, ...)
• 文档字符串

如果最后声明，文档字符串会在调用中工作help(module)吗？

标签： python

Answer 1

1. 哈希砰。内核从字面上查看文件的前两个字节以查看它们是否等于#!，否则它将无法工作。

2. 编码。根据Python Language Reference，它必须在“第一行或第二行”。

3. 文档字符串。根据PEP 257，文档字符串是“作为模块、函数、类或方法定义中的第一条语句出现的字符串文字”，因此它不能跟在任何导入语句之后。如果您将文档字符串放在其他位置，您可以亲自看到help(module)不再报告您的文档字符串。

4. 未来的进口，因为他们不能先于上述任何一项。