Pythonファイルの一般的なヘッダフォーマット

Pythonファイルでは、スクリプトやモジュールの用途や情報を明確にするために、ヘッダを設定することが推奨されます。ここでは、よく使われるヘッダの形式と、含めるべき要素について解説します。

シェバン（Shebang）

最初の行にシェバンを記載することで、スクリプトを直接実行できるようにします。

#!/usr/bin/env python

これは主にLinuxやMacで使用され、Pythonの実行環境を指定します。モジュールファイルでは必須ではありません。

エンコーディングの指定

次に、ファイルのエンコーディングを明示するためのコメントを追加します。特にPython 2で重要でしたが、Python 3でも明示的に指定することは良い習慣です。

# -*- coding: utf-8 -*-

ドキュメンテーション文字列（docstring）

モジュールやスクリプトの説明は、最初のdocstringとして記載します。これは簡潔な要約を1行目に、詳細な説明をその下に書く形式が一般的です。

"""
This script processes data and generates reports.
"""

メタデータの追加

ファイル内に著者やバージョン情報を含めることもよくあります。

__author__ = "John Doe"
__version__ = "1.0.0"

まとめ

Pythonファイルのヘッダには、実行環境を指定するシェバン、エンコーディング、簡潔な説明やメタデータを含めることが一般的です。これらの要素を揃えておくことで、メンテナンスやドキュメント化がしやすくなります。