多线程下,C++如何调用Python脚本的方法

视频教程:多线程场景下,用C++调用Python脚本的方法

Git: https://github.com/JasonLiThirty/C-andPython

接口函数

Python3.6提供给C/C++接口函数,基本都是定义pylifecycle.h,pythonrun.h,ceval.h中。

Py_Initialize() 和 Py_Finalize()

  • C++应用程序调用Python脚本之前,必须先调用Py_Initialize()进行初始化,这个API用来分配Python解释器使用的全局资源,应用程序结束时需要调用Py_Finalize()来关闭Python的使用环境。

Py_IsInitialized()

  • 用来判断Python解释器是否初始化成功,true为成功,false为失败。

PyErr_Print() & PyErr_Clear()

  • 执行Python出错时,PyErr_Print()可将错误信息显示出来,PyErr_Clear()将错误信息在Python解释器的缓存清除。

PyRun_SimpleString()

  • 这个函数能够用来执行简单的Python语句。

PyEval_InitThreads()

  • 如果使用多线程调用Python脚本,就需要在初始化Python解释器时调用PyEval_InitThreads()来启用线程支持(导致Python内部启用线程锁),最好在主线程启动时就调用。该API同时也锁定全局解释锁,所以,还需要在初始化完成后需要自行释放锁。
  • 如果不需要使用多线程,不建议启用该选项,互斥锁也会不可避免的增加系统开销。

PyEval_AcquireLock() & PyEval_ReleaseLock()

  • 因为Python编辑器不是线程安全的,为了支持多线程, Python 使用了互斥使访问内部数据结构串行化。这种互斥即 “全局解释器锁 – global interpreter lock”,当某个线程想使用 Python 的C API的时候,它必须获得全局解释器锁。所以多线程调用Python脚本前必须先持有这个全局解释器锁,然后才能进行对Python的一系列操作。
  • 调用了 PyEval_AcquireLock之后,可以安全地假定你的线程已经持有了锁,其他相关线程不是被阻塞就是在执行与 Python 解析器无关的代码。之后就可以开始执行与Python相关的代码了。
  • 调用了 PyEval_AcquireLock取得了锁之后,必须确保运行完需要的代码后调用 PyEval_ReleaseLock 来释放它,否则就会导致线程死锁并冻结其他 Python 线程。

PyThreadState对象及其相关函数

每个Python 线程都需要维护自己的状态信息,在被Python解释器执行时,需要先切换线程的状态信息,才可以开始执行相应的代码,这个线程状态信息就是用PyThreadState这个对象来描述的。

  • PyThreadState:每个Python 线程维护自己的状态信息,存储在 PyThreadState对象中。在多线程应用中用 C 语言调用 Python API 函数时,你必须维护自己的 PyThreadState 对象以便能安全地执行并发的 Python 代码。
  • PyInterpreterState:描述了几个协作线程共享的状态,属于同一解释器的线程共享它们的模块维护和几个其他的内部子项。
  • PyThreadState_Get():得到当前PyThreadState的指针。一般用在初始化时用来得到主线程的PyThreadState对象。
  • PyThreadState_New():为新的C++线程创建一个 PyThreadState 对象,需要用到既有的 PyInterpreterState 对象。该对象为所有参与的线程所共享的信息,初始化 Python 时,会自动创建一个 PyInterpreterState 对象,附加在主线程的 PyThreadState 对象上, 所以可以利用PyInterpreterState 对象创建新的 PyThreadState。
  • PyThreadState_Swap():将要执行Python代码的线程特定的PyThreadState对象加载到解释器
  • PyThreadState_Clear():重置线程状态对象的所有相关信息。
  • PyThreadState_Delete():销毁一个线程状态对象,该对象的线程状态必须提前调用 PyThreadState_Clear() 进行清除。

以下是几个进阶的接口函数,这些函数可以将全局解释器的加锁和释放锁的操作,以及线程切换的操作封装起来,比较方便。

PyEval_AcquireThread(PyThreadState *tstate)

  • 获得全局解释器锁并将当前线程状态设定为 tstate ,它不能为NULL。锁必须提前创建。如果线程已经拥有锁,会发生死锁。

PyEval_ReleaseThread(PyThreadState *tstate)

  • 重置当前线程状态为NULL并释放全局解释器锁。锁必须提前创建并且以在当前线程中获得。参数 tstate 不能为 NULL。它只能用于校验它描述的当前线程状态——如果它不对,会报告一个致命错误。这个函数在编译时禁用线程支持的情况下不可用。

PyGILState_STATE state = PyGILState_Ensure()

  • 获得全局解释器锁并自动创建一个线程状态,返回值是一个不透明的线程状态“句柄”。

PyGILState_Release(PyGILState_STATE state)

  • 释放全局解释器锁,Python解析器线程状态切换到调用PyGILState_Acquire之前的状态。

PyGILState_Ensure() 和 PyGILState_Release()需要成对出现,仅在CPython中有效,这样就能实现Python解释器的锁功能。只有在关闭Python的使用环境时,可以不再需要调用PyGILState_Release()函数

示例代码

Git: https://github.com/JasonLiThirty/C-andPython

PyInvoker

面向对象的方法实现Python解释器的管理和与Python脚本交互的实现。

PyLock

运用PyGILState_Acqsuire和PyGILState_ReleasePython的Global Interpreter Lock,来实现多线程之间数据完整性和状态同步,GIL机制能保证在任意时刻只有一个线程在解释器中运行,效率上会有一定的损失。

PythonGreet.py

def Hello(): print('Hello world!!!')

PythonCalc.py

def Add(num1, num2): return num1+num2

你可能感兴趣的:(多线程下,C++如何调用Python脚本的方法)