genvid.toolbox.sdk_folder

定数

GENVID_SDK_FOLDER_GUARD_FILENAME Genvid SDK のインストールフォルダーのルートに存在する必要があるガードファイルの名前。
RE_VERSION_MATCH コンパイルされた正規表現オブジェクト。

関数

get_sdk_default_installation(() -> str) 登録されているデフォルトの Genvid MILE SDK インストールを返します。
get_sdk_version((folder: pathlib.Path) -> str) folder が指す Genvid MILE SDK のバージョンを返します。
list_registered_sdk(…) 登録されているすべてのGenvid SDKのインストールを返します。
search_for_guardfile(…) start_dir またはその親にあるガードファイルを探します。
set_sdk_default_installation(…) 登録されているデフォルトの Genvid MILE SDK インストールを設定します。
genvid.toolbox.sdk_folder.GENVID_SDK_FOLDER_GUARD_FILENAME = 'THIS_IS_GENVID_SDK_FOLDER'

Genvid SDK のインストールフォルダーのルートに存在する必要があるガードファイルの名前。

有効であるためには、ファイルに有効なバージョン番号が含まれている必要があります。

バージョン 1.40.0 で変更: BaseTool からこのモジュールに移動されました。

参考

RE_VERSION_MATCH

genvid.toolbox.sdk_folder.RE_VERSION_MATCH = re.compile('(?P<version>(\\d+).(\\d+).(\\d+).(\\d+))')

有効な Genvid MILE SDK バージョン番号にマッチするコンパイルされた正規表現です。

genvid.toolbox.sdk_folder.get_sdk_default_installation() → str

登録されているデフォルトの Genvid MILE SDK インストールを返します。

参考

GENVID_SDK_FOLDER.

genvid.toolbox.sdk_folder.set_sdk_default_installation(sdkpath: pathlib.Path)

登録されているデフォルトの Genvid MILE SDK インストールを設定します。

パラメータ:sdkpath – 設定する新しいフォルダのパス。 パスの検証は行われません。

参考

get_sdk_version()

genvid.toolbox.sdk_folder.get_sdk_version(folder: pathlib.Path) → str

folder が指す Genvid MILE SDK のバージョンを返します。

パラメータ:

folder – Genvid MILE SDK のバージョンをチェックするフォルダ。
例外:
戻り値:

Genvid MILE SDK バージョン

参考

RE_VERSION_MATCH, GENVID_SDK_FOLDER_GUARD_FILENAME, get_sdk_version().

genvid.toolbox.sdk_folder.list_registered_sdk() → typing.Iterable[typing.Tuple[str, str]]

登録されているすべてのGenvid SDKのインストールを返します。

戻り値:Genvid MILE SDK の名前とインストール先フォルダのタプルのイテラブル。
genvid.toolbox.sdk_folder.search_for_guardfile(start_dir: pathlib.Path, *, guardfile: str = 'THIS_IS_GENVID_SDK_FOLDER') → typing.Optional[str]

start_dir またはその親にあるガードファイルを探します。

パラメータ:
  • start_dir – 検索するフォルダ。
  • guardfile – 探すためのガードファイル。