PythonEnvironment

Python 環境の情報

R2019b 以降

説明

PythonEnvironment オブジェクトには、Python^® インタープリターの設定とステータスに関する情報が含まれています。MATLAB^® は、py. コマンドを呼び出すとインタープリターと通信します。Python 環境の情報は、複数の MATLAB セッション間で維持されます。

作成

PythonEnvironment オブジェクトを作成するか、設定を変更するには、pyenv を呼び出します。

MATLAB から py 名前空間を使用して Python 式を入力すると (py.list など)、MATLAB では Python インタープリターが選択され、読み込まれます。インタープリターを変更するには、以下を行います。

• Python が InProcess ExecutionMode で読み込まれている場合は、MATLAB を再起動し、新しいバージョン情報を指定して pyenv を実行します。

• Python が OutOfProcess モードで読み込まれている場合は、terminate を呼び出し、新しいバージョン情報を指定して pyenv を実行します。

プロパティ

Version — Python バージョン

string

この プロパティ は読み取り専用です。

Python バージョン。string として返されます。Version プロパティを設定するには、version 引数を MATLAB でサポートされているバージョン番号に設定して pyenv を呼び出します。サポートされているバージョンの詳細については、Python を使用するためのシステムの構成を参照してください。

例: "3.10"

Executable — Python 実行可能ファイルの名前

string

この プロパティ は読み取り専用です。

Python 実行可能ファイルの名前。string として返されます。Executable プロパティを設定するには、version 引数を Python の実行可能ファイルの相対パスまたは絶対パスに設定して pyenv を呼び出します。

例: "/usr/local/bin/python"

Library — 共有ライブラリ ファイル

string

この プロパティ は読み取り専用です。

共有ライブラリ ファイル。string として返されます。

例: "libpython3.10.so.1.0"

Home — ホーム フォルダー

string

この プロパティ は読み取り専用です。

ホーム フォルダー。string として返されます。

例: "/usr/local/bin/../.."

Status — プロセスのステータス

NotLoaded (既定値) | Loaded | Terminated

プロセスのステータス。NotLoaded、Loaded または Terminated として指定します。

例: Terminated

ExecutionMode — 実行モード

InProcess (既定値) | OutOfProcess

Python スクリプトを MATLAB と同じプロセスで実行するかどうかを示す実行モード。InProcess または OutOfProcess として指定します。ExecutionMode プロパティを設定するには、ExecutionMode 引数を指定して関数 pyenv を呼び出します。

例: OutOfProcess

ProcessID — プロセス ID

string

この プロパティ は読み取り専用です。

Python インタープリターが実行されているプロセスの ID。string として返されます。ExecutionMode が InProcess の場合、ProcessID は MATLAB プロセス ID になります。Status が Loaded でない場合、ProcessID は空になります。

例: "9388"

ProcessName — プロセス名

string

この プロパティ は読み取り専用です。

レジストリ内のプロセス名。string として返されます。

例: "MATLABPyHost"

オブジェクト関数

terminate

Python インタープリターに関連付けられているプロセスの終了

例

システムで使用している Python 環境の表示

pe = pyenv

pe = 

  PythonEnvironment with properties:

          Version: "3.10"
       Executable: "C:\Python310\pythonw.exe"
          Library: "C:\windows\system32\python310.dll"
             Home: "C:\Python310"
           Status: NotLoaded
    ExecutionMode: OutOfProcess
  

制限

• MAT ファイルへの PythonEnvironment オブジェクトの保存 (シリアル化) はサポートされていません。

バージョン履歴

R2019b で導入

参考

pyenv

トピック

• Python を使用するためのシステムの構成
• Python 機能のアウトプロセスでの実行