Main Content

matlab.engine.connect_matlab

将共享 MATLAB 会话连接到用于 PythonMATLAB 引擎

说明

示例

eng = matlab.engine.connect_matlab(name=None) 连接到共享 MATLAB® 会话,name,并以 eng 形式返回一个 MatlabEngine 对象。输入参数 name 指定已在本地计算机上运行的 MATLAB 会话的名称。

  • 如果您指定 name,而引擎找不到同名的共享 MATLAB 会话,则您会收到 EngineError 异常。

  • 如果您未指定 name,并且引擎找不到任何共享 MATLAB 会话,则它会启动新的共享 MATLAB 会话。

  • 如果您未指定 name,并且引擎找到多个正在运行的共享 MATLAB 会话,则它会连接到创建的第一个会话。

如果 backgroundTrue,则 eng = matlab.engine.connect_matlab(___,background) 进行异步连接。您可以将这些与以上语法中的任何 name 输入参数结合使用。

如果 asyncTrue,则 eng = matlab.engine.connect_matlab(___,async) 进行异步连接。不推荐。请改用 background 参数。请不要用于 Python® 版本 3.7 或更高版本。有关详细信息,请参阅兼容性考虑

示例

全部折叠

连接到本地计算机上已运行的共享 MATLAB 会话。

import matlab.engine
eng = matlab.engine.connect_matlab()
eng.sqrt(4.0)
2.0

matlab.engine.connect_matlab 连接到创建的第一个共享 MATLAB 会话。如果没有共享的 MATLAB 会话,则 matlab.engine.connect_matlab 会启动一个新会话。

当您的本地计算机上有多个共享 MATLAB 会话时,可通过指定会话名称一次连接到两个不同的会话。

连接到创建的第一个 MATLAB 会话。

import matlab.engine
names = matlab.engine.find_matlab()
names
('MATLAB_6830', 'MATLAB_7090')

连接到下一个 MATLAB 会话。

eng = matlab.engine.connect_matlab('MATLAB_7090')
eng.sqrt(4.0)
2.0

输入参数

全部折叠

共享 MATLAB 会话的名称,指定为字符数组。该名称必须是有效的 MATLAB 变量名称。

同步或异步连接到 MATLAB,指定为逻辑关键字参数。

示例: matlab.engine.connect_matlab(background=True)

同步或异步连接到 MATLAB,指定为逻辑关键字参数。不推荐。请改用 background 参数。有关详细信息,请参阅兼容性考虑

输出参数

全部折叠

Python 变量,用于与 MATLAB 通信,以 MatlabEngine 对象形式返回。eng 与已在本地计算机上运行的共享 MATLAB 会话通信

局限性

  • 不要将引擎多次连接到同一个共享 MATLAB 会话。

版本历史记录

在 R2015b 中推出

全部展开