Vox（xontrib.voxapi）

xonshのPython仮想環境マネージャであるVoxのAPI。

Voxは、仮想環境のライフサイクルに関連するいくつかのイベントを定義します。

• vox_on_create(env: str) -> None
• vox_on_activate(env: str) -> None
• vox_on_deactivate(env: str) -> None
• vox_on_delete(env: str) -> None

例外xontrib.voxapi.EnvironmentInUse

指定された環境が現在起動されており、操作を実行できません。

with_traceback（）

Exception.with_traceback（tb） - tbにself .__ traceback__を設定してselfを返します。

args

例外xontrib.voxapi.NoEnvironmentActive

現在環境が有効になっていないため、操作を実行できません。

with_traceback（）

Exception.with_traceback（tb） - tbにself .__ traceback__を設定してselfを返します。

args

クラスxontrib.voxapi.VirtualEnvironment（env、bin、lib、inc ）

VirtualEnvironmentの新しいインスタンスを作成する（env、bin、lib、inc）

count（値） →整数 - 値の出現回数を返す

index（value [、start [、stop ] ] ） →整数 - 最初の値のインデックスを返します。

値が存在しない場合、ValueErrorを発生させます。

bin

フィールド番号1の別名

env

フィールド番号0の別名

inc

フィールド番号3の別名

lib

フィールド番号2の別名

class xontrib.voxapi.Vox

voxや仮想環境へのAPIアクセスは、dict-like形式で行われます。

VirtualEnvironmentのnamedtupleを使用します。

1. env：環境への完全な道
2. bin：環境のbin / Scriptsディレクトリへのフルパス

activate（名前）

仮想環境をアクティブにします。

パラメーター：

名前 ： str

仮想環境名または絶対パス。

active（）

アクティブな仮想環境の名前を取得します。

これをキーとして使用して詳細情報を取得することができます。

アクティブな環境がない場合はNoneを返します。

create（name、*、system_site_packages = False、symlinks = False、with_pip = True ）

$ VIRTUALENV_HOMEにpython3で仮想環境を作成しますvenv。

パラメーター：

名前 ： str

仮想環境名

system_site_packages ： bool

Trueの場合、システム（グローバル）site-packagesディレクトリは作成された環境で使用できます。

シンボリックリンク ： bool

Trueの場合、ファイルを仮想環境にコピーするのではなく、シンボリックリンクを試みます。

with_pip ： bool

Trueの場合、pipが仮想環境にインストールされていることを確認します。（デフォルトはTrueです）

deactivate（）

アクティブな仮想環境を無効にします。名前を返します。

get（k [、d ] ） →D [k]（Dがkの場合）、そうでなければd。dはデフォルトでNoneに設定されます。

items（） →Dのアイテムのビューを提供する集合的なオブジェクト

keys（） →Dのキーのビューを提供する集合的なオブジェクト

upgrade（name、*、symlinks = False、with_pip = True ）

$ VIRTUALENV_HOMEにpython3で仮想環境を作成しますvenv。

警告：symlinkまたはPIPなしで仮想環境を作成した場合は、アップグレード時にこれらのオプションを再度指定する必要があります。

パラメーター：

名前 ： str

仮想環境名

シンボリックリンク ： bool

Trueの場合、ファイルを仮想環境にコピーするのではなく、シンボリックリンクを試みます。

with_pip ： bool

Trueの場合、pipが仮想環境にインストールされていることを確認します。

values（） →Dの値のビューを提供するオブジェクト