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 等,都在最後一行中指定。