如何使用来自 Python 的导入正确调用 jsonnet

How to correctly call jsonnet with imports from Python

我正在使用 jsonnet 构建将由 Python 代码使用的 json 对象,使用 Python 从 Python 调用 jsonnet bindings。我想设置我的目录结构,以便 jsonnet 文件位于相对于 Python 代码为 运行 的一个或多个子目录中,例如:

foo.py jsonnet/ jsonnet/bar.jsonnet jsonnet/baz.libsonnet

运行 foo.py 然后应该能够对从 jsonnet/ 中的文件读取的字符串使用 _jsonnet.evaluate_snippet(),这些字符串从 jsonnet/ 导入其他文件。执行此操作的最佳方法是什么?

我不完全明白你为什么要使用 evaluate_snippet()(也许通过将文件名从 python 加载到字符串 + evaluate_snippet("blah", str) 来掩盖实际文件名?),而不是 evaluate_file() - 在任何情况下,该结构都应该可以正常工作。

示例:

jsonnet_test.py:

import json:
import _jsonnet

jsonnet_file = "jsonnet/bar.jsonnet"
data = json.loads(_jsonnet.evaluate_file(jsonnet_file))
print("{str} => {num}".format(**data))

jsonnet/bar.jsonnet:

local baz = import "baz.libsonnet";
{
  str: "The answer to life ...",
  num: baz.mult(6, 7),
}

jsonnet/baz.libsonnet:

{
  mult(a, b):: (
    a * b
  ),
}

输出:

$ python jsonnet_test.py
The answer to life ... => 42

默认导入器使用相对于导入它们的文件的路径。在 evaluate_snippet 的情况下,您需要手动传递路径。这样 jsonnet 就知道在哪里寻找导入的文件。

如果您打算处理文件,您可以使用自定义导入器。 (题外话:jsonnet试图避免对源文件进行预处理,所以jsonnet可能有更好的方法或缺少的功能。)

下面是关于如何在 Python 中使用自定义导入器的完整工作示例(根据提供的目录结构进行了调整):

import os
import unittest

import _jsonnet


#  Returns content if worked, None if file not found, or throws an exception
def try_path(dir, rel):
    if not rel:
        raise RuntimeError('Got invalid filename (empty string).')
    if rel[0] == '/':
        full_path = rel
    else:
        full_path = dir + rel
    if full_path[-1] == '/':
        raise RuntimeError('Attempted to import a directory')

    if not os.path.isfile(full_path):
        return full_path, None
    with open(full_path) as f:
        return full_path, f.read()


def import_callback(dir, rel):
    full_path, content = try_path(dir, rel)
    if content:
        return full_path, content
    raise RuntimeError('File not found')


class JsonnetTests(unittest.TestCase):
    def setUp(self):
        self.input_filename = os.path.join(
            "jsonnet",
            "bar.jsonnet",
        )
        self.expected_str = '{\n   "num": 42,\n   "str": "The answer to life ..."\n}\n'
        with open(self.input_filename, "r") as infile:
            self.input_snippet = infile.read()

    def test_evaluate_file(self):
        json_str = _jsonnet.evaluate_file(
            self.input_filename,
            import_callback=import_callback,
        )
        self.assertEqual(json_str, self.expected_str)

    def test_evaluate_snippet(self):
        json_str = _jsonnet.evaluate_snippet(
            "jsonnet/bar.jsonnet",
            self.input_snippet,
            import_callback=import_callback,
        )
        self.assertEqual(json_str, self.expected_str)

if __name__ == '__main__':
    unittest.main()

注意:它是an example from jsonnet repo的修改版本。