Git で Python PYC ファイルを無視する

Azhar Bashir Khan 2023年6月20日
Git で Python PYC ファイルを無視する

このチュートリアルでは、Git で Python .pyc ファイルを無視する方法を説明します。

Git は、Git リポジトリを使用してプロジェクト ディレクトリの変更を追跡するバージョン管理システムです。 Git では、プロジェクト ディレクトリ内のすべてのファイルが Git リポジトリで追跡されます。

通常、プロジェクト ファイルをビルドおよび実行すると、一時ファイルまたは中間ファイルが作成されます。 Python .pyc ファイルは、中間ファイルのそのような例の 1つです。

これらのファイルを無視して、Git リポジトリでそのようなファイルを追跡しないようにすることもできます。 このような目的には、Git の .gitignore ファイルを使用できます。

Git で Python .pyc ファイルを無視する

通常、開発環境では、開発プロセスの一環として多くの一時ファイルと中間ファイルが作成されます。

Python インタープリターは、.py ファイルがインポートされると、.pyc ファイルを作成します。 .pyc ファイルには、インポートされたプログラムのコンパイル済みバイトコードが含まれているため、後続のインポートでソース コードからバイトコードへの変換をスキップできます。

これらの .pyc は、Git リポジトリで追跡する必要はありません。 Git リポジトリ内の .pyc ファイルを無視して追跡を回避できます。

このような目的には、.gitignore ファイルを使用する必要があります。 .gitignore ファイルに行を追加する必要があります。

*.pyc

Git ツールは、.gitignore ファイルで上記の行を検出すると、.pyc 拡張子を持つファイルをスキップし、Git リポジトリに含まれないようにそれらを無視します。 したがって、Git ツールは Git リポジトリ内の .pyc ファイルの追跡を回避します。

通常、.gitignore ファイルは Git リポジトリのルート ディレクトリに保存されます。 場合によっては、Git リポジトリに .pyc ファイルを既に追加した後で、.gitignore ファイルに上記の行を追加した可能性があります。

このような場合、これらのファイルを Git リポジトリから削除する必要があります。 --cached オプションを指定して Git コマンド git rm を使用する必要があります。

次のように git rm コマンドを実行する必要があります。

$ git rm --cached *.pyc

Git コマンド git rm に指定された --cached オプションは、インデックスから .pyc ファイルのパスをアンステージして削除します。 作業ツリー ファイルは削除されません。

Git リポジトリのプロジェクト ディレクトリからすべての .pyc ファイルを追跡解除するには、次のようにコマンドを実行する必要があります。

$ find . -name '*.pyc' | xargs -n 1 git rm --cached

したがって、Git リポジトリで追跡されているプロジェクトのルート ディレクトリで上記のコマンドを実行すると、追跡からすべての .pyc ファイルが削除されます。 したがって、Git で Python .pyc ファイルを無視する方法を学びました。

詳細については、以下をご覧ください。

  1. gitignore
  2. git-rm

関連記事 - Git Ignore