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 ) は、この行が実行可能スクリプトであるため、インタプリタを暗黙的に呼び出すことにより、ファイルをスクリプトとして実行するのを容易にします。また、コードが特定の形式（この場合は Python 3）用に記述されていることもユーザーに通知します。

行 ( -*- coding: utf-8 -*-) はエンコードに使用されます。これは、データをある形式から別の形式に変換するプロセスです。UTF は UnicodeTransformation Format の略で、8 はエンコードプロセスで 8 ビット値が使用されていることを示します。エンコーディングには複数のタイプ（UTF-16、UTF-34 など）がありますが、Python 3 では、デフォルトの文字セットは UTF-8 です。

3 行目には、作成者、日付、バージョン番号、クレジット、電子メール、ステータス、ライセンス、著作権などの詳細が含まれています。

4 行目は、(""" """) で示される docstring であり、モジュールとその構築目的を文書化しています。これは、すべての関数、クラス、およびメソッドに関連付けるのに便利な方法です。特定のコードを記述するために一意に指定されます。

次の行には、コードで使用される組み込みモジュールのインポートが含まれています。たとえば、os モジュール、sys モジュール、math モジュールなどです。

NumPy、Matplotlib などのサードパーティモジュールのすべてのインポートは、最後の行で指定されます。