Python 中的常见头格式

Shivam Arora 2021年10月2日 2021年7月9日
Python 中的常见头格式

标题是代码顶部的注释块,其中包括文件名、作者、日期以及文件的其他一些详细信息以及该文件的内容。内置模块导入和第三方导入遵循此。这种格式可能因程序员而异。

在本教程文章中,我们将介绍 Python 源文件最常见的头格式。

以下代码显示了 Python 中使用的常见标头格式。

#!/usr/bin/env python3  Line 1
# -*- coding: utf-8 -*- Line 2
#----------------------------------------------------------------------------
# Created By  : name_of_the_creator   Line 3
# Created Date: date/month/time ..etc
# version ='1.0'
# ---------------------------------------------------------------------------
""" Details about the module and for what purpose it was built for"""  #Line 4
# ---------------------------------------------------------------------------
# Imports Line 5
# ---------------------------------------------------------------------------
from ... import ...  #Line 6

第一行 (#!/usr/bin/env python3 ) 通过隐式调用解释器使文件作为脚本运行变得更容易,因为该行是一个可执行脚本。它还通知用户代码是为特定格式编写的,在本例中为 Python3。

( -*- coding: utf-8 -*-) 用于编码。它是将数据从一种形式转换为另一种形式的过程。UTF 代表 Unicode 转换格式,8 表示在编码过程中使用 8 位值。有多种编码类型(UTF-16、UTF-34 等),但在 python 3 中,默认字符集是 UTF-8。

第三行包含有关作者、日期、版本号、署名、电子邮件、状态、许可、版权等的详细信息。

第四行是一个由 (""" """) 表示的文档字符串,它记录了模块及其构建的目的。这是与所有函数、类和方法相关联的便捷方式。它被唯一指定来描述特定的代码。

以下行包含代码中使用的内置模块的导入,例如,os Module、sys Module、math Module 等。

第三方模块的所有导入,例如 NumPy、Matplotlib 等,都在最后一行中指定。