PyMiniRacer

本软件包现已弃用。请访问 https://github.com/bpcreech/PyMiniRacer 获取最新版本。

.. image:: https://img.shields.io/pypi/v/py_mini_racer.svg :target: https://pypi.python.org/pypi/py_mini_racer

.. image:: https://github.com/sqreen/PyMiniRacer/actions/workflows/build.yml/badge.svg :target: https://github.com/sqreen/PyMiniRacer/actions/workflows/build.yml

.. image:: https://img.shields.io/badge/License-ISC-blue.svg :target: https://opensource.org/licenses/ISC

适用于 Python 的精简、现代嵌入式 V8 引擎。

特性

• 支持最新的 ECMAScript
• 支持 Web Assembly
• 支持 Unicode
• 线程安全
• 可重用上下文

MiniRacer 可以轻松地被 Django 或 Flask 项目用于压缩资源、运行 Babel 或 WASM 模块。

示例

MiniRacer 使用起来很简单：

.. code-block:: python

>>> from py_mini_racer import MiniRacer
>>> ctx = MiniRacer()
>>> ctx.eval("1+1")
2
>>> ctx.eval("var x = {company: 'Sqreen'}; x.company")
'Sqreen'
>>> print(ctx.eval("'\N{HEAVY BLACK HEART}'"))
❤
>>> ctx.eval("var fun = () => ({ foo: 1 });")

变量会保存在上下文中：

.. code-block:: python

>>> ctx.eval("x.company")
'Sqreen'

虽然 eval 只支持返回原始数据类型（如字符串），但 call 支持返回复合类型（如对象）：

.. code-block:: python

>>> ctx.call("fun")
{'foo': 1}

复合值使用 JSON 序列化。 在发送非 JSON 可编码参数时，请使用自定义 JSON 编码器：

.. code-block:: python

import json

from datetime import datetime

class CustomEncoder(json.JSONEncoder):

        def default(self, obj):
            if isinstance(obj, datetime):
                return obj.isoformat()

            return json.JSONEncoder.default(self, obj)

.. code-block:: python

>>> ctx.eval("var f = function(args) { return args; }")
>>> ctx.call("f", datetime.now(), encoder=CustomEncoder)
'2017-03-31T16:51:02.474118'

MiniRacer 支持 ES6：

.. code-block:: python

>>> ctx.execute("[1,2,3].includes(5)")
False

可以获取 V8 堆信息：

.. code-block:: python

>>> ctx.heap_stats()
{'total_physical_size': 1613896,
 'used_heap_size': 1512520,
 'total_heap_size': 3997696,
 'total_heap_size_executable': 3145728,
 'heap_size_limit': 1501560832}

WASM 示例可在 tests_ 中找到。

.. _tests: https://github.com/sqreen/PyMiniRacer/blob/master/tests/test_wasm.py

兼容性

PyMiniRacer 兼容 Python 2 和 3，基于 ctypes。

二进制构建已在 x86_64 上进行了测试，支持：

• macOS >= 10.13
• Ubuntu >= 16.04
• Debian >= 9
• CentOS >= 7
• Alpine >= 3.11
• Windows 10

它应该可以在任何 libc >= 2.12 且使用兼容 wheel 的 pip（>= 8.1）的 Linux 上运行。

如果您使用的是 Alpine Linux，可能需要手动安装所需依赖项，使用以下命令：

.. code-block:: bash

$ apk add libgcc libstdc++

如果您的 pip 是最新版本但没有使用 wheel，可能是因为您的环境没有对应的 wheel。请开一个 issue。

安装

我们为 macOS 64 位、Linux 64 位和 Windows 64 位构建了 Python wheels（预编译二进制文件）。

.. code:: bash

$ pip install py-mini-racer

构建

警告：从源代码构建此软件包需要几 GB 的磁盘空间，并且大约需要 60 分钟。

首先检查您当前的 Python 可执行文件是否为 2.7 版本。这是 V8 构建系统所要求的。

.. code:: bash

$ python --version
Python 2.7.16

您可以使用以下命令构建扩展：

.. code:: bash

$ python helpers/v8_build.py

您可以使用以下命令为任何 Python 版本生成 wheel：

.. code:: bash

$ python3 helpers/build_package.py wheel dist

这将构建 V8、扩展，并为您当前的 Python 版本生成一个 wheel。V8 构建会被缓存在 py_mini_racer/extension/v8/ 目录中。

macOS 构建注意事项 '''''''''''''''''''''''''''

需要从以下地址下载旧版 Python 二进制构建（OSX 10.6）： https://www.python.org/downloads/

这将允许构建与较早版本 OSX 兼容的 wheel。

测试

如果您想运行测试，首先需要构建扩展，然后安装 pytest：

.. code-block:: bash

$ python -m pip install pytest

然后运行：

.. code:: bash

$ python -m pytest tests

致谢

由 Sqreen_ 倾情打造。

.. _Sqreen: https://www.sqreen.com

PyMiniRacer 的发布在这篇博文_中有详细描述。

.. _这篇博文: https://blog.sqreen.com/embedding-javascript-into-python/

PyMiniRacer 的灵感来自于 Sam Saffron 为 Ruby 世界构建的 mini_racer_。

.. _mini_racer: https://github.com/SamSaffron/mini_racer

本包的骨架使用了 Cookiecutter-pypackage_。

.. _Cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage