Python与Javascript相互调用超详细讲解(2022年1月最新)
首先要明白的是,javascript和python都是解释型语言,它们的运行是需要具体的runtime的。
- Python: 我们最常安装的Python其实是cpython,就是基于C来运行的。除此之外还有像pypy这样的自己写了解释器的,transcrypt这种转成js之后再利用js的runtime的。基本上,不使用cpython作为python的runtime的最大问题就是通过pypi安装的那些外来包,甚至有一些cpython自己的原生包(像 collections 这种)都用不了。
- JavaScript: 常见的运行引擎有google的V8,Mozilla的SpiderMonkey等等,这些引擎会把JavaScript代码转换成机器码执行。基于这些基础的运行引擎,我们可以开发支持JS的浏览器(比如Chrome的JS运行引擎就是V8);也可以开发功能更多的JS运行环境,比如Node.js,相当于我们不需要一个浏览器,也可以跑JS代码。有了Node.js,JS包管理也变得方便许多,如果我们想把开发好的Node.js包再给浏览器用,就需要把基于Node.js的源代码编译成浏览器支持的JS代码。
在本文叙述中,假定:
- 主语言: 最终的主程序所用的语言
- 副语言: 不是主语言的另一种语言
例如,python调用js,python就是主语言,js是副语言
适用于:
- python和javascript的runtime(基本特指cpython[不是cython!]和Node.js)都装好了
- 副语言用了一些复杂的包(例如python用了numpy、javascript用了一点Node.js的C++扩展等)
- 对运行效率有要求的话:
- python与javascript之间的交互不能太多,传递的对象不要太大、太复杂,最好都是可序列化的对象
- javascript占的比重不过小。否则,python调js的话,启动Node.js子进程比实际跑程序还慢;js调python的话,因为js跑得快,要花很多时间在等python上。
- 因为IPC大概率会用线程同步输入输出,主语言少整啥多进程多、线程之类的并发编程
- JSPyBridge : pip install javascript优点:作者还在维护,回issue和更新蛮快的。支持比较新的python和node版本,安装简单基本支持互调用,包括绑定或者传回调函数之类的。缺点 :没有合理的销毁机制, import javascript 即视作连接JS端,会初始化所有要用的线程多线程。如果python主程序想重启对JS的连接,或者主程序用了多进程,想在每个进程都连接一次JS,都很难做到,会容易出错。
- PyExecJS : pip install PyExecJS ,比较老的技术文章都推的这个包优点: 支持除了Node.js以外的runtime,例如PhantomJS之类的缺点: End of Life,作者停止维护了
(因为与我的项目需求不太符合,所以了解的不太多)
- JSPyBridge : npm i pythonia
- node-python-bridge : npm install python-bridge
- python-shell : npm install python-shell
首先,该方法的前提是两种语言都要有安装好的runtime,且能通过命令行调用runtime运行文件或一串字符脚本。例如,装好cpython后我们可以通过 python a.py 来运行python程序,装好Node.js之后我们可以通过 node a.js 或者 node -e \”some script\” 等来运行JS程序。
当然,最简单的情况下,如果我们只需要调用一次副语言,也没有啥交互(或者最多只有一次交互),那直接找个方法调用CLI就OK了。把给副语言的输入用stdin或者命令行参数传递,读取命令的输出当作副语言的输出。
例如,python可以用 subprocess.Popen , subprocess.call , subprocess.check_output 或者 os.system 之类的,Node.js可以用 child_process 里的方法, exec 或者 fork 之类的。 需要注意的是,如果需要引用其他包,Node.js需要注意在 node_modules 所在的目录下运行指令,python需要注意设置好PYTHONPATH环境变量。
如果有复杂的交互,要传递复杂的对象,有的倒还可以序列化,有的根本不能序列化,咋办?
这基本要利用 进程间通信(IPC) ,通常情况下是用 管道(Pipe) 。在 stdin , stdout 和 stderr 三者之中至少挑一个建立管道。
假设我用 stdin 从python向js传数据,用 stderr 接收数据,模式大约会是这样的:
(以下伪代码仅为示意,没有严格测试过,实际使用建议直接用库)
- 新建一个副语言(假设为JS)文件 python-bridge.js :该文件不断读取 stdin 并根据发来的信息不同,进行不同的处理;同时如果需要打印信息或者传递object给主语言,将它们适当序列化后写入 stdout 或者 stderr 。process.stdin.on(\’data\’, data => { data.split(\’\\n\’).forEach(line => { // Deal with each line // write message process.stdout.write(message + \”\\n\”); // deliver object, \”$j2p\” can be any prefix predefined and agreed upon with the Python side // just to tell python side that this is an object needs parsing process.stderr.write(\”$j2p sendObj \”+JSON.stringify(obj)+\”\\n); }); } process.on(\’exit\’, () => { console.debug(\’** Node exiting\’); });
- 在python中,用Popen异步打开一个子进程,并将子进程的之中的至少一个,用管道连接。大概类似于:cmd = [\”node\”, \”–trace-uncaught\”, f\”{os.path.dirname(__file__)}/python-bridge.js\”] kwargs = dict( stdin=subprocess.PIPE, stdout=sys.stdout, stderr=subprocess.PIPE, ) if os.name == \’nt\’: kwargs[\’creationflags\’] = subprocess.CREATE_NO_WINDOW subproc = subprocess.Popen(cmd, **kwargs)
- 在需要调用JS,或者需要给JS传递数据的时候,往 subproc 写入序列化好的信息,写入后需要 flush ,不然可能会先写入缓冲区:subproc.stdin.write(f\”$p2j call funcName {json.dumps([arg1, arg2])}\”.encode()) subproc.stdin.flush() # write immediately, not writing to the buffer of the stream
- 对管道化的 stdout / stderr ,新建一个线程,专门负责读取传来的数据并进行处理。是对象的重新转换成对象,是普通信息的直接打印回主进程的 stderr 或者 stdout 。def read_stderr(): while subproc.poll() is None: # when the subprocess is still alive, keep reading line = self.subproc.stderr.readline().decode(\’utf-8\’) if line.startswith(\’$j2p\’): # receive special information _, cmd, line = line.split(\’ \’, maxsplit=2) if cmd == \’sendObj\’: # For example, received an object obj = json.loads(line) else: # otherwise, write to stderr as it is sys.stderr.write(line) stderr_thread = threading.Thread(target=read_stderr, args=(), daemon=True) stderr_thread.start()这里由于我们的 stdout 没有建立管道,所以node那边往 stdout 里打印的东西会直接打印到python的 sys.stdout 里,不用自己处理。
- 由于线程是异步进行的,什么时候知道一个函数返回的对象到了呢?答案是用线程同步手段,信号量(Semaphore)、条件(Condition),事件(Event)等等,都可以。以 python的条件 为例:func_name_cv = threading.Condition() # use a flag and a result object in case some function has no result func_name_result_returned = False func_name_result = None def func_name_wrapper(arg1, arg2): # send arguments subproc.stdin.write(f\”$p2j call funcName {json.dumps([arg1, arg2])}\”.encode()) subproc.stdin.flush() # wait for the result with func_name_cv: if not func_name_result_returned: func_name_cv.wait(timeout=10000) # when result finally returned, reset the flag func_name_result_returned = False return func_name_result同时,需要在读stderr的线程 read_stderr 里解除对这个返回值的阻塞。需要注意的是,如果JS端因为意外而退出了, subproc 也会死掉, 这时候也要记得取消主线程中的阻塞 。def read_stderr(): while subproc.poll() is None: # when the subprocess is still alive, keep reading # Deal with a line line = self.subproc.stderr.readline().decode(\’utf-8\’) if line.startswith(\’$j2p\’): # receive special information _, cmd, line = line.split(\’ \’, maxsplit=2) if cmd == \’sendObj\’: # acquire lock here to ensure the editing of func_name_result is mutex with func_name_cv: # For example, received an object func_name_result = json.loads(line) func_name_result_returned = True # unblock func_name_wrapper when receiving the result func_name_cv.notify() else: # otherwise, write to stderr as it is sys.stderr.write(line) # If subproc is terminated (mainly due to error), still need to unblock func_name_wrapper func_name_cv.notify()当然这是比较简单的版本,由于对JS的调用基本都是线性的,所以可以知道只要得到一个object的返回,那就一定是 func_name_wrapper 对应的结果。如果函数多起来的话,情况会更复杂。
- 如果想 取消对JS的连接 ,首先应该先关闭子进程,然后等待读 stdout / stderr 的线程自己自然退出,最后 一定不要忘记关闭管道 。并且 这三步的顺序不能换 ,如果先关了管道,读线程会因为 stdout / stderr 已经关了而出错。subproc.terminate() stderr_thread.join() subproc.stdin.close() subproc.stderr.close()
如果是通过这种原理javascript调用python,方法也差不多,javascript方是Node.js的话,用的是 child_process 里的指令。
- 只需要正常装好两方的runtime就能实现交互,运行环境相对比较好配。
- 只要python方和javascript方在各自的runtime里正常运行没问题,那么连上之后运行也基本不会有问题。(除非涉及并发)
- 对两种语言的所有可用的扩展包基本都能支持。
- 当python与JavaScript交互频繁,且交互的信息都很大的时候,可能会很影响程序效率。因为仅仅通过最多3个管道混合处理普通要打印的信息、python与js交互的对象、函数调用等,通信开销很大。
- 要另起一个子进程运行副语言的runtime,会花一定时间和空间开销。
JS|7种JavaScript代码调试的方法
JS是解释型语言,是逐条语句解释执行的,如果错误发生在某个语句块,此语句块以前的语句一般都可以正常执行。这不同于C等编译型语言。
代码调试的重点在于找到错误发生点,然后才能有的放矢。
通常可以使用警告框来提示变量信息。
alert(document.body.innerHTML);
当警告框弹出时,用户将需要单击“确定”来继续。
需要注意的是是,以下写法会替换整个页面的内容:
<button type=\”button\” onclick=\”document.write(5 + 6)\”>试一试</button>
即使是函数调用也是如此。
document.getElementById(\”demo\”).innerHTML =\”\”
JS的运行环境是浏览器,由浏览器引擎解释执行JS代码,一般来说,浏览器也提供调试器,如chrome按F12即可调出高试器:
如果您的浏览器支持调试,那么您可以使用 console.log() 在调试窗口中显示 JavaScript 的值:
内置的调试器可打开或关闭,强制将错误报告给用户。
通过调试器,您也可以设置断点(代码执行被中断的位置),并在代码执行时检查变量。
JavaScript 实际上会创建带有两个属性的 Error 对象:name 和 message。
name 设置或返回错误名。
message 设置或返回错误消息(一条字符串)。
debugger停止执行 JavaScript,并调用调试函数(如果可用)。
可以注释掉一些可疑代码来确定错误发生点。
或者考虑逐步增加代码的方法,逐步验证,以避免错误。
8.1 意外使用赋值运算符
如果程序员在 if 语句中意外使用赋值运算符(=)而不是比较运算符(===),JavaScript 程序可能会产生一些无法预料的结果。
8.2 令人困惑的加法和级联
加法用于加数值。
级联(Concatenation)用于加字符串。
在 JavaScript 中,这两种运算均使用相同的 + 运算符。
正因如此,将数字作为数值相加,与将数字作为字符串相加,将产生不同的结果:
而加法以外的其它算法运算符可以将字符串进行自动类型转换。
10-\”5\” // 5
8.3 令人误解的浮点数
JavaScript 中的数字均保存为 64 位的浮点数(Floats),符合IEEE754的标准。
所有编程语言,包括 JavaScript,都存在处理浮点值的困难:
8.4 错位的分号
因为一个错误的分号,此代码块无论 x 的值如何都会执行:
在一行的结尾自动关闭语句是默认的 JavaScript 行为。
在 JavaScript 中,用分号来关闭(结束)语句是可选的。
8.5 对象使用命名索引
在 JavaScript 中,数组使用数字索引。
在 JavaScript 中,对象使用命名索引。
如果您使用命名索引,那么在访问数组时,JavaScript 会将数组重新定义为标准对象。
8.6 Undefined 不是 Null
Undefined 的类型是 Undefined,Null的类型是Object。
JavaScript 对象、变量、属性和方法可以是未定义的。
此外,空的 JavaScript 对象的值可以为 null。
在测试非 null 之前,必须先测试未定义:
if (typeof myObj !== \”undefined\” && myObj !== null)
8.7 JS没有块作用域(与C语言不同)
在 ES2015 之前,JavaScript 只有两种类型的作用域:全局作用域和函数作用域。
ES2015 引入了两个重要的 JavaScript 新关键词:let 和 const。
这两个关键字在 JavaScript 中提供了块作用域(Block Scope)变量(和常量)。
-End-
本文作者及来源:Renderbus瑞云渲染农场https://www.renderbus.com
文章为作者独立观点不代本网立场,未经允许不得转载。