Python/仮想環境のソースを表示

[[Category:開発]]
[[Category:プログラミング言語]]
[[en:Python/Virtual environment]]
[[es:Python/Virtual environment]]
[[zh-hans:Python/Virtualenv]]
''virtualenv'' は [[Python]] の隔離環境を作成するために使われるツールです。モジュールを隔離環境にインストールできる、作業環境をエクポートできる、[[Python]] プログラムをその環境で実行できるといった様々な利点があります。

==仮想環境の概要==
仮想環境はいくつかのバイナリとシェルスクリプトがインストールされたディレクトリです。バイナリはスクリプトを実行するための ''python'' と 環境に他のモジュールをインストールするための ''pip'' を含んでいます。また環境に入るためのシェルスクリプト ([[bash]]、csh、[[fish]]で動作します) も含まれています。基本的に、仮想環境はシステムにインストールされた [[Python]] とすべての望まれたモジュールを、アプリケーションがどんなシステム上で動作しようと干渉されずに模倣します。

== インストール ==

[[Python]] 3.3 以上では ''pyvenv'' と呼ばれるツールとネイティブ実装を拡張するための ''venv'' と呼ばれる API が付属しています。古いバージョンの Python を必要とするアプリケーションでは ''virtualenv'' を使う必要があります。

=== パッケージ ===

Python の仮想環境を利用するために [[公式リポジトリ]] から次のパッケージを[[インストール]]してください。
* Python 3.3+: {{pkg|python}}
* Python 3: {{pkg|python-virtualenv}}

Pipenv 用:
* Python 3: {{pkg|python-pipenv}}

== 使い方 ==

3つのツールの使い方は似ています。

=== 作成 ===

あなたのプロジェクトディレクトリ内で ''venv'' か ''virtualenv'' を使って仮想環境を作成してください。必ず venv ディレクトリをバージョン管理から外してください。{{ic|pip freeze}} のコピーがあればリビルドすることができます。

==== venv ====

{{Note|このメソッドは、{{pkg|python}} 3.8 で削除された ''pyvenv'' スクリプトを置き換えます。}}

このツールは {{pkg|python}} (3.3 以上) で提供されています。
 $ python -m venv ''envname''

==== virtualenv ====

Python 3 には {{pkg|python-virtualenv}} に含まれる ''virtualenv'' を使ってください。
 $ virtualenv ''envname''

=== 有効化 ===

環境を有効化・無効化するために提供されているシェルスクリプトを使います。この例は bash が使われていると仮定します。

 $ source venv/bin/activate
 (envname) $

仮想環境の中に入ると、''pip'' を使ってモジュールをインストールしたり通常通りにスクリプトを実行することができます。

仮想環境から抜けるには {{ic|bin/activate}} によって提供される関数を実行してください:

 (envname) $ deactivate

== Python のバージョン ==

バイナリのバージョンはどの仮想環境ツールが使われたかに依存します。例えば、Python 2 の例では ''python'' コマンドは {{ic|bin/python2.7}} を指しますが、''pyvenv'' の例では {{ic|bin/python3.5}} を指します。

''pyvenv'' と ''virtualenv'' 大きな違いは、前者はデフォルトでシステムの Python バイナリを使います:
 $ ls -l pyvenv/bin/python3.5
 lrwxrwxrwx 1 foo foo 7 Jun  3 19:57 pyvenv/bin/python3.5 -> /usr/bin/python3

''virtualenv'' は環境のディレクトリ内の別の Python バイナリを使います:
 $ ls -l venv3/bin/python3.5
 lrwxrwxrwx 1 foo foo 7 Jun  3 19:58 venv3/bin/python3.5 -> python3

== Virtualenvwrapper ==

''virtualenvwrapper'' は virtualenv を作成・有効化・削除する便利なコマンドを使えるようにして、より自然なコマンドライン操作で virtualenv を扱えるようにします。{{Pkg|python-virtualenv}} と {{Pkg|python2-virtualenv}} 両方のラッパーになっています。

===インストール===
[[公式リポジトリ]]から {{Pkg|python-virtualenvwrapper}} パッケージを[[インストール]]してください。

そして {{ic|~/.bashrc}} に以下の行を追加:

 export WORKON_HOME=~/.virtualenvs
 source /usr/bin/virtualenvwrapper.sh

Python 3 が Arch においてシステムのデフォルトなので、Python 2 の環境を作るためには {{ic|~/.bashrc}} で {{ic|virtualenvwrapper.sh}} を読み込む前に {{ic|VIRTUALENVWRAPPER_PYTHON}} と {{ic|VIRTUALENVWRAPPER_VIRTUALENV}} をセットする必要がります:

 export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python2.7
 export VIRTUALENVWRAPPER_VIRTUALENV=/usr/bin/virtualenv2

Python 3 をデフォルトにしていない場合 ({{ic|$ python --version}} の出力を確認してください)、{{ic|virtualenvwrapper.sh}} スクリプトを source する前に {{ic|~/.bashrc}} に以下の行も追加する必要があります。

 export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3

コンソールを再度開いて {{ic|WORKON_HOME}} フォルダを作成してください:
 $ mkdir $WORKON_HOME

===基本的な使い方===
virtualenvwrapper の使い方に関しては Doug Hellmann の [http://www.doughellmann.com/docs/virtualenvwrapper/ ページ] が参考になります。

* virtualenv を作成:
 $ mkvirtualenv -p /usr/bin/python2.7 my_env
* virtualenv の有効化:
 $ workon my_env
* virtualenv の中にパッケージをインストール (例: Django):
 (my_env)$ pip install django
* virtualenv を離脱:
 (my_env)$ deactivate

== Pipenv ==

''pipenv'' は上記のツールのすべての機能を実行する単一のプログラムを提供することで、より良い管理された CLI 対話を可能にします。

=== インストール ===

[[公式リポジトリ]] の {{Pkg|python-pipenv}} パッケージを [https://wiki.archlinux.jp/index.php/%E3%83%98%E3%83%AB%E3%83%97:%E8%AA%AD%E3%81%BF%E6%96%B9#.E3.83.91.E3.83.83.E3.82.B1.E3.83.BC.E3.82.B8.E3.81.AE.E3.82.A4.E3.83.B3.E3.82.B9.E3.83.88.E3.83.BC.E3.83.AB インストール] します。

=== 基本的な使い方 ===

すべてのコマンドはプロジェクトフォルダ内で実行でき、 pipenv は特定の状況を認識します。つまり、 pipenv が実行されると、ディレクトリ内に virtualenv が存在するかどうかを調べ、特定の仮想インタプリタ上で実行されます。

詳細については、 [https://pipenv.readthedocs.io/en/latest/]  [https://realpython.com/pipenv-guide/]  [https://docs.python-guide.org/dev/virtualenvs/#pipenv-virtual-environments] を参照してください。

== 参照 ==
* [https://docs.python.org/3/library/venv.html Python venv]
* [https://pypi.org/project/virtualenv/ virtualenv PyPI page]
* [https://virtualenvwrapper.readthedocs.io/en/latest/ virtualenvwrapper documentation]