pyfemtet.dispatch_extensions package

モジュール内容

exception pyfemtet.dispatch_extensions.DispatchExtensionException

ベースクラス: Exception

pyfemtet.dispatch_extensions.dispatch_femtet(timeout=120, subprocess_log_prefix='')

既存の Femtet プロセスに接続します。

Dispatch() のラッパーで、IFemtet 付きの PID を返します。

パラメータ:

• timeout (int, optional) – 指定したタイムアウト内に接続が確立されない場合、エラーを発生させます。

• subprocess_log_prefix (str, optional) – ログに出力するプレフィックス。通常は内部処理のみで使用されます。

例外:

FemtetConnectionTimeoutError – 何らかの理由で Femtet プロセスに接続できませんでした(例：Femtet.exe が起動していません)。

戻り値:

Femtetと制御対象のFemtetのPIDを制御するためのオブジェクト。

戻り値の型:

tuple[IFemtet, int]

pyfemtet.dispatch_extensions.dispatch_specific_femtet(pid, timeout=120)

戻り値の型:

tuple[CDispatch, int]

pyfemtet.dispatch_extensions.launch_and_dispatch_femtet(timeout=120, strictly_pid_specify=True)

新しい Femtet のプロセスを起動して接続します。

Dispatch() のラッパーで、IFemtet 付きの PID を返します。

パラメータ:

• timeout (int, optional) – 指定したタイムアウト内に接続が確立されない場合、エラーを発生させます。

• strictly_pid_specify (bool, optional) – 起動したFemtetへの接続を厳密に確立しようとします。これにより、プロセス排他制御のため処理が遅くなる可能性があります。

例外:

FemtetConnectionTimeoutError – 何らかの理由で Femtet プロセスに接続できませんでした(例：Femtet.exe が起動していません)。

戻り値:

Femtetと制御対象のFemtetのPIDを制御するためのオブジェクト。

戻り値の型:

tuple[IFemtet, int]