logo

Python で Requirements.txt ファイルを作成する方法

開発者であれば、Python プロジェクトやデータ サイエンス プロジェクトに取り組む際には、プロジェクトを利用する人に問題を引き起こすことなく、プロジェクトを再利用可能かつ反復可能にする環境で常に作業することが不可欠であることをご存知かもしれません。したがって、Python で要件 .txt ファイルを作成する方法を説明する前に、requirement.txt とは何なのか、そしてなぜそれが必要なのかを知っておいてください。

Pythonのrequirement.txtファイルとは何ですか?

パイソン 要件.txt file は、通常、特定のプロジェクトの開発中に使用されるすべてのライブラリ、モジュール、パッケージに関する情報をそれ自体に保存するファイルのタイプです。また、プロジェクトが依存している、または実行する必要があるすべてのファイルとパッケージも保存されます。通常、このファイル「requirement.txt」はプロジェクトのルート ディレクトリに保存されます (または存在します)。ここで、なぜプロジェクトにこのタイプのファイルが必要なのかという、別の重要な疑問が生じます。

なぜrequirement.txtが必要なのでしょうか?

ほぼすべての互換性の問題が解決されるため、将来プロジェクトを再検討する場合でも、いくつかの点で役立ちます。 Python プロジェクトに取り組んだり開発したことがある方なら、通常は複数のパッケージが必要であることをご存知でしょう。ただし、プロジェクトの開発中は通常、特定のバージョンのパッケージを使用しました。後で、パッケージ マネージャーまたはメンテナーがいくつかの変更を加える可能性があり、これらの変更によりアプリケーション全体が簡単に壊れる可能性があります。したがって、パッケージ内のすべての変更を追跡するのは大変な作業です。特に、プロジェクトが大きすぎる場合、予期せぬ事態を避けるために、使用している各パッケージを追跡することが不可欠です。

このような問題を解決する標準的な方法の 1 つは、仮想環境を使用することです。その理由は、パッケージと Python ライブラリが通常保存される場所には主に 2 つのタイプがあり、通常、特定のプロジェクトで作業する際にこれらのパッケージのすべてのタイプが必要になるわけではないためです。したがって、再現性を容易にするために、プロジェクトごとにどれが必要かを知る必要があります。

データベース

通常、これには次のファイルが含まれます。

  • 標準 Python ライブラリの一部を形成するシステム パッケージ
  • pip を使用してインストールするサイト パッケージ (サードパーティ パッケージ)。

仮想環境とは何ですか?

仮想環境は、ユーザーのパッケージをローカル (またはメイン) システムのインストールから分離した、隔離されたまたは人工的なワークスペースの一種です。これにより、Python プロジェクトごとに「仮想」分離環境を作成できます。これにより、特に同じ依存関係を共有する場合に、各プロジェクトを他のプロジェクトから独立させることが容易になります。仮想環境の作成に使用できるさまざまなパッケージが用意されています。基本的なパッケージの一部は次のとおりです。

  • 仮想環境
  • ピペンブ

したがって、プロジェクト用の仮想環境が作成されたら、パッケージとライブラリをインストールする方法を見てみましょう。仮想環境を使用したプロジェクトで使用する必要があるすべてのパッケージを入手するのは非常に簡単です。まずは「virtualenv」の使い方を見てみましょう。

A. 仮想環境

仮想環境を構築して利用できるライブラリの一種です。 virtualenv をインストールするには、次の手順に従ってください。

1. 以下の図に示すように、Cmd を開き、次のコマンドを入力して Enter ボタンを押します。

指示

 pip install virtualenv 

出力

Python で Requirements.txt ファイルを作成する方法

2. プロジェクトの新しい作業ディレクトリの作成

次に、不要な問題を回避するために、そのプロジェクトのディレクトリ内に新しい仮想環境を作成します。

指示

 Python3 -m venv name_of_env 

出力

Python で Requirements.txt ファイルを作成する方法

3. この新しく作成した仮想環境を使用するには、アクティブ化するだけです。この隔離された環境をアクティブにするには、以下に示すように、次のコマンドを入力して Enter ボタンを押します。

指示

 name_of_envirnmentScriptsactivate 

出力

Python で Requirements.txt ファイルを作成する方法

新しい仮想環境が作成されたことを確認するには、プロンプトでプレフィックスが新しい仮想環境の名前に変更されていることがわかります。この例では、仮想環境に「name_of_envirnmnet」という名前を付けています。プロジェクトのディレクトリ、または指定した名前の新しいディレクトリが作成されるフォルダーを開いて確認することもできます。

4. 次に、requirement.txt ファイルの作成方法を見てみましょう。

require.txt ファイルを作成するには、その内容を理解しておくとよいでしょう。

require.txt ファイルには、その特定のプロジェクトで使用されるすべてのタイプの標準パッケージとライブラリが含まれています。したがって、この require.txt ファイルは、小規模または大規模なプロジェクトを開発する際に重要な役割を果たします。また、プロジェクトの移植性を高めるのにも役立ちます。

「requirement.txt」ファイルを利用すると、いくつかの大きな問題を簡単に回避できます。さらに詳しく理解するには、次の例を検討してください。

例:

特定のバージョンのライブラリおよびパッケージと互換性のあるアプリケーションなどの新しいプロジェクトを作成したとします。したがって、何らかの理由で、あなたはこのアプリケーションを友人に転送します。

requirement.txt ファイルを使用していないため、アプリケーションが適切に実行されないか、友人のシステムで起動できない可能性があります。この背後にある主な理由は、すべてのユーザーが同じバージョンのライブラリとパッケージを使用しているわけではないことです。ただし、requirement.txt ファイルを使用した場合は、すべての必須または使用されるパッケージとライブラリもプロジェクトのファイル (requirement.txt) の形式で指定されるため、誰でもプロジェクトまたはアプリケーションを実行して使用できます。

この要件 .txt ファイルでは、ユーザーは要件に応じて必要なファイルを簡単に選択、保存、保守できます。

Requirements.txt ファイルを取得する方法: Virtualenv の使用

ここで、requirements.txt ファイルを取得できます。 require.txt ファイルを作成するには、次のコマンドを使用できます。

指示

 pip3 freeze > requirements.txt 

出力

Python で Requirements.txt ファイルを作成する方法

Requirements.txt ファイルを取得する方法: Pipenv の使用

Pipenv は、優れた機能を備えた優れた仮想環境作成ライブラリ ツールでもあります。次の指定された指示を使用して、requirement.txt ファイルを取得できます。

1. 次のコマンドを入力して、pipenv をインストールします。

指示

 pip install pipenv 

出力

Python で Requirements.txt ファイルを作成する方法

2. 次のコマンドを入力して Enter ボタンを押します。

指示

 pipenv install mypackage 

上記のコマンドは、プロジェクトに必要なパッケージをインストールするために使用されます。

出力

Python で Requirements.txt ファイルを作成する方法
  • プロジェクトのパッケージをインストールした後、仮想環境をアクティブ化する必要があります。したがって、仮想環境をアクティブ化するには、次のコマンドを使用できます。

指示

 pipenv shell 

または

 pipenv run 

以下に示すように、これらのコマンドを使用して、新しく作成した仮想環境をアクティブ化できます。

出力

Python で Requirements.txt ファイルを作成する方法

次に、次のコマンドを入力して、仮想環境でスクリプトを実行します。

指示

 pipenv run Python myscript.py 

説明

このコマンドは、次に示すように、仮想環境で指定されたスクリプトを実行するために使用されます。

出力

Python で Requirements.txt ファイルを作成する方法

これは簡単で、プロジェクトに使用されるすべてのライブラリを pipfile と pipfile で自動的に追跡します。ロックファイル。これらのファイルは、requirements.txt と同じ役割を果たし、requirement.txt に含まれていないいくつかの事項に関する追加情報も保存します。

したがって、この pipfile を、requirements.txt ファイルの代替として使用できます。ただし、requirements.txt ファイルを引き続き使用したい場合は、次のコマンドを使用できます。

 pipenv -r lock >> requirements.txt 

出力

Python で Requirements.txt ファイルを作成する方法

Requirements.txt ファイルを取得する方法: Virtualenv を使用せずに Pipreqs を使用する

パイプレックスは これは最も効率的で使いやすいツールの 1 つであり、仮想環境を作成する必要はありません。したがって、ユーザーがアプリケーションまたはプロジェクトで使用されるパッケージとライブラリのみを必要とする場合に非常に便利です。

最も重要なことの 1 つは、インポートされたライブラリのスクリプトまたは Python ファイルを自動的にスキャンし、requirements.txt を生成することです。

それがどのように機能するかを見てみましょう:

1. まず、「pipreqs」をインストールする必要があります。ダウンロードするには、cmd に次のコマンドを入力して Enter ボタンを押します。

指示

 pip install pipreqs 

出力

Python で Requirements.txt ファイルを作成する方法

2. インストールが完了したら、「pipreqs」を起動して、プロジェクト フォルダーがある場所を指定することで、requirement.txt ファイルを取得できます。

指示

 pipreqs /path/to/project 

出力

Python で Requirements.txt ファイルを作成する方法

require.txt ファイルが正常に作成されたことを確認するには、以下に示すように、プロジェクトのフォルダーに新しいファイル「requirement.txt」が作成されることがわかります。

Python で Requirements.txt ファイルを作成する方法