Python说明

# Python说明

TaskRunner目前已支持运行Python脚本。Python是一种广泛使用的解释型、高级和通用的编程语言。最初被设计用于编写自动化脚本，随着版本的不断更新和语言新功能的添加，越来越多被用于独立的、大型项目的开发。目前AI相关的项目大部分都以Python作为基础语言使用，通过Python的引入，TaskRunner也能接入到Python生态中，从而实现更多的功能。接下来将详细介绍如何在TaskRunner中使用Python相关的功能。

# 1. 安装配置Python

TaskRunner为64位程序，需要用户自行安装Python环境，可以在https://www.python.org/ (opens new window)或者anaconda (opens new window)中获取可使用的python工具进行安装。安装完成后，需要记录Python环境安装的目录，在后续会使用。

# 2. 基本使用方法

# 2.1. 基本示例

一个基本的使用方法如下，使用控件的方式引入并执行Python脚本。

{
  var pe, ps;
  try{
    pe = new TPythonEngine(nil);
    //要调用的python dll库文件名称，在python安装目录下可查看
    pe.DllName = "python311.dll";
    //要调用的python dll库文件所在的目录
    pe.DllPath = "C:\\Users\\isoface\\anaconda3";
    pe.AutoFinalize = false;
    //不要设置为自动加载，在设置完成后，使用下方的LoadDll手动加载
    pe.AutoLoad = false;
    pe.UseLastKnownVersion = false;
    pe.LoadDll;
    //第一种用法
    //直接使用字符串执行python语句
    pe.ExecString("print(1+1)","<strings>");
    //第二种用法
    //调用执行TaskRunner目录下的python脚本文件
    pe.ExecFile("test.py",nil.nil);
    //第三种用法
    //调用执行多行python语句
    ps = new TStringList;
    ps.Add("a=1");
    ps.Add("b=2");
    ps.Add("print(a+b)");
    pe.ExecStrings(ps,"<strings>")
    ps.Free;
  }
  finally{
    pe.Free;
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# 2.2. 获取python的计算结果

假设我们提供了以下python脚本，保存文件名称为test.py：

from pathlib import Path

# 获取python 文件所在的目录
try:
    current_directory = Path(__file__).resolve().parent
except NameError:
    # 当 __file__ 不存在时，使用当前工作目录
    current_directory = Path.cwd()

# 创建日志目录
log_directory = current_directory / 'temp'
# 检测目录是否存在
if not log_directory.exists():
    # 如果目录不存在，则创建目录
    log_directory.mkdir()

# 由Var映射的变量    
test.Value = str(log_directory)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

使用以下方式进行呼叫引用，可以获取python运行过程中的变量结果。

{
  var pe, pv;
  try{
    pe = new TPythonEngine(nil);
    pv = new TPythonDelphiVar(nil);  
    pe.AutoFinalize = false;
    //不要设置为自动加载，在设置完成后，使用下方的LoadDll手动加载
    pe.AutoLoad = false;
    pe.UseLastKnownVersion = false;
    pe.DllPath = "C:\\Users\\isoface\\anaconda3";
    pe.DllName = "python311.dll";
    //pythondelphivar 要绑定pythonengine使用
    pv.Engine = pe;
    pv.Module = "__main__";
    pv.VarName = "test";
    pe.LoadDll;
    pe.ExecFile("test.py",nil,nil);
    UGMM.AddLog("test.Value = "+pv.ValueAsString);
  }
  finally{
    pe.Free;
    pv.Free;
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# 2.3. 从脚本变量与python变量相互转换

假设test.py中的脚本语句如下：

from pathlib import Path

# 获取python 文件所在的目录
try:
    current_directory = Path(__file__).resolve().parent
except NameError:
    # 当 __file__ 不存在时，使用当前工作目录
    current_directory = Path.cwd()

# 创建日志目录
log_directory = current_directory / 'temp'

test_directory = Path(test.Value)
# 检测目录是否存在
if not log_directory.exists():
    # 如果目录不存在，则创建目录
    log_directory.mkdir()
    
# 检测目录是否存在
if not test_directory.exists():
    # 如果目录不存在，则创建目录
    test_directory.mkdir()

# 映射至DelphiVar的变量    
test.Value = str(log_directory)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

使用方法如下：

//当python语句中出现引用`test.Value`时，触发此事件
function pvOnGetData(Sender,Data)
{
  Data = "F:\\Program Files (x86)\\IsoFace\\TaskRunner\\File";
}
//当python语句中出现给`test.Value`赋值的语句时，触发此事件
function pvOnSetData(Sender,Data)
{
  UGMM.AddLog("test.Value = "+Data);
}

{
  var pe, pv;
  try{
    pe = new TPythonEngine(nil);
    pv = new TPythonDelphiVar(nil);  
    pe.AutoFinalize = false;
    //不要设置为自动加载，在设置完成后，使用下方的LoadDll手动加载
    pe.AutoLoad = false;
    pe.UseLastKnownVersion = false;
    pe.DllPath = "C:\\Users\\deanj\\anaconda3";
    pe.DllName = "python311.dll";
    //pythondelphivar 要绑定pythonengine使用
    pv.Engine = pe;
    //设定运行的python模块名称，主运行模块名称通常为__main__
    pv.Module = "__main__";
    //需要注入至python模块中的变量名称
    pv.VarName = "test";
    pv.OnGetData = &pvOnGetData;
    pv.OnSetData = &pvOnSetData;
    pe.LoadDll;
    pe.ExecFile("1.py",nil,nil);
  }
  finally{
    pe.Free;
    pv.Free;
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# 2.4. 从预设资料获取Python脚本

用户除了从Python脚本文件中获取要执行的代码外，还可以从预设资料中获取Python脚本来运行，使用示例如下：

//当python语句中出现引用`test.Value`时，触发此事件
function pvOnGetData(Sender,Data)
{
  Data = "F:\\Program Files (x86)\\IsoFace\\TaskRunner\\File";
}
//当python语句中出现给`test.Value`赋值的语句时，触发此事件
function pvOnSetData(Sender,Data)
{
  UGMM.AddLog("test.Value = "+Data);
}

{
  var sl,pv;
  sl = new TStringList;
  pv = new TPythonDelphiVar(nil); 
  try{
    //从预设资料编号为`dcc_pid_train`的预设资料中获取Python脚本内容，其中包含了test的引用
    sl.Text = UGMM.GetPython("dcc_pid_train");
    //设定运行的python模块名称，主运行模块名称通常为__main__
    pv.Module = "__main__";
    //需要注入至python模块中的变量名称
    pv.VarName = "test";
    pv.OnGetData = &pvOnGetData;
    pv.OnSetData = &pvOnSetData;
    //使用设置中设定的Python引擎运行上述脚本
    UGMM.PyEngineAndGIL_ExecStrings(sl,'',pv);    
  } 
  finally{
    sl.Free;
    pv.Free;    
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# 3. 高级使用方法

Python在运行时，会收到全局解释器锁(GIL)的限制。GIL 是python的全局解释器锁，同一进程中假如有多个线程运行，一个线程在运行python程序的时候会霸占python解释器（加了一把锁即GIL），使该进程内的其他线程无法运行，等该线程运行完后其他线程才能运行。基本使用方法中提供的方式在运行时会占用Python解释器，导致其他程序无法使用Python。故在实际使用中，需要时刻注意Python GIL的情况。

使用高级方法前，请先在TaskRunner设置中设定Python路径，DLL名称，勾选自动加载选项。

TaskRunner提供了以下方法，在运行Python时不会长期占用Python解释器。点击下列方法查看详细的使用方法：

# 4. 使用线程运行Python

如果要运行的Python需要运行较长时间才能返回结果，为了避免运行Python导致的UI界面堵塞，可以考虑使用线程的方式来运行Python。但是，由于GIL的限制，实际Python线程的运行仍是有先后顺序的，并不是同时进行。

TaskRunner为此创建了一个Python任务队列，当接收到Python运行请求时，会将运行的请求创建任务，压入任务队列中。

当任务队列中存在任务，TaskRunner会取出最早创建的一个任务，开始使用Python运行。

当Python任务运行完成后，TaskRunner才会继续取下一个任务运行，直至所有任务都运行完成。这样就能够避免并发请求访问时，Python出现多线程运行被GIL阻塞的情况。

使用线程方法前，请先在TaskRunner设置中设定Python路径，DLL名称，勾选自动加载选项。

具体的使用方法，请参考Python预设资料。

← MQTT说明自定程序→