再現できる Python 環境を記録する:実行手順と期待結果を残す
Python と OS の版、依存パッケージ、実行コマンドを記録します。小さな分析を仮想環境で実行し、期待する CSV と照合する練習です。
コードと一緒に実行環境の情報を渡す
再現に必要なのは、コードだけでなく、そのコードを動かした環境と実行方法の記録です。最低限、Python の版、OS、外部パッケージの有無、実行コマンド、入力と期待結果を残します。複雑な分析では、システムライブラリ、ハードウェア、乱数や数値計算の設定も結果に影響します。
この章では、前章までと同じ架空の学習時間データを使います。分析は Python の標準ライブラリだけで動きます。外部パッケージを追加せずに、環境を記録し、別の仮想環境でも同じ表ができるか確かめましょう。これは音の効果を示す研究結果ではなく、再実行の練習です。
まず 学習用プロジェクト一式を空の作業場所に展開し、ターミナルで study-sessions/ フォルダへ移動します。ZIP の説明書は英語・中国語・韓国語です。日本語の説明書と日本語のデータ辞書は別に読めます。
どの Python を使っているか確認する
以下は Python 3 が python という名前で使える場合のコマンドです。環境によっては python3、Windows では py -3 を使います。以降も、自分が確認した同じ Python を使ってください。
python --version
python -c "import sys, platform; print(sys.executable); print(platform.platform())"
python analysis/analyze.py
最初のコマンドは Python の版を、次のコマンドは実行ファイルの場所と OS の情報を表示します。表示された値を自分の実行記録に残します。他人の例に書かれた版を、試していないまま自分の環境として記載しないでください。実行ファイルのパスに個人名などが含まれる場合、公開用の記録では必要に応じて省略し、使用したインタープリターの種類と版は残します。
| 記録する項目 | この練習で書く内容 |
|---|---|
| Python と OS | 上のコマンドで確認した実際の版とシステム。 |
| 外部パッケージ | なし。分析は標準ライブラリだけを使用。 |
| 開始場所とコマンド | study-sessions/ の直下で python analysis/analyze.py。 |
| 入力と出力 | data/sessions.csv から results/means.csv を生成。 |
| コードとデータの版 | 前章で記録したコミット ID、または入手した例の版と日付。 |
仮想環境を作り、その Python で実行する
仮想環境は、プロジェクトで使う Python パッケージを他の作業から分ける仕組みです。以下の venv は、そのコマンドを実行した Python をもとに環境を作ります。希望する別の版の Python を自動で入手する機能ではありません。
python -m venv .venv
macOS または Linux では、次のように環境内の Python を直接指定できます。これならシェルの有効化操作を省いても、どのインタープリターで動かすかを明示できます。
.venv/bin/python --version
.venv/bin/python analysis/analyze.py
Windows のターミナルでは、代わりに次を使います。
.venv\Scripts\python.exe --version
.venv\Scripts\python.exe analysis\analyze.py
この例には追加インストールが不要です。外部パッケージを使う実研究では、そのプロジェクトで検証したロックファイルや版を固定した依存関係の定義を用意し、新しい環境でインストールから再確認します。別プロジェクトのパッケージ一覧をそのまま持ち込まないようにしましょう。
.venv/ フォルダ自体を配布しても、別の OS や場所でそのまま使えるとは限りません。作り直せる手順を共有します。仮想環境は OS やシステムライブラリの差まで完全に隔離するものではありません。
成功の基準を CSV で確認する
分析を実行すると results/means.csv ができます。次の内容を、同梱の expected/means.csv と照合してください。静かな条件は 20 分と 30 分の平均で 25.0 分、背景音の条件は 15 分と 25 分の平均で 20.0 分です。
condition,mean_minutes
background-noise,20.0
quiet,25.0
この小さな例では、標準の Python と新しい仮想環境で同じ内容になることを確認します。実研究で数値計算ライブラリやハードウェアによる微小な差があり得る場合は、必要な許容誤差と比較方法をあらかじめ文書化します。「エラーが出なかった」だけで再現成功としないことが大切です。
前章の Git による変更履歴も合わせて確認してください。環境が分かっていても、実行したコードや入力データの版が分からなければ、結果を十分に追跡できません。
つまずいたら、最初に違う箇所を調べる
| 症状 | 確認すること |
|---|---|
| Python が見つからない | Python 3 の導入とコマンド名を確認し、使う版を明示する。 |
| CSV が見つからない | 展開したフォルダ構成と data/sessions.csv の実際の名前を確認する。 |
| venv を作れない | その Python に venv が利用可能か、環境の導入方法を確認する。作成失敗を無視して先に進まない。 |
| 別のプロジェクトで import エラー | 実行中の Python を確認し、そのプロジェクトが指定する依存関係を同じ環境に導入する。 |
| 結果が違う | 入力、コードの変更、環境の版を順に比較し、期待結果を書き換えて済ませない。 |
練習:他の人が推測せずに実行できるメモを書く
README に、自分が検証した Python と OS、外部パッケージの有無、開始フォルダ、実行コマンド、期待結果を書きます。上の架空データを新しい作業フォルダに展開し、そのメモだけで環境作成と分析を再実行してください。
確認するポイントを見る
メモには実際に試した版が書かれていますか。仮想環境の作り方と、その中の Python の呼び出し方が分かりますか。出力が 20.0 分と 25.0 分になることを照合しましたか。追加のパッケージが不要だと明記できれば、「何かをインストールし忘れたのか」という読者の迷いも減らせます。
環境の説明は、結果を他の人に渡すための部品の一つです。次はデータ、コード、説明書、期待結果をまとめる段階です。日本語の成果パッケージ章は次の公開分で扱います。
参考資料とライセンス
本章は The Turing Way Community の著作物(Copyright © The Turing Way Community、CC BY 4.0)を基に構成しています。Miss Formula が英語版を編集基準として日本語で説明を再構成し、計算例と練習問題を追加しました。原典の図やデータは転載していません。