python - 测试生成 Altair 图的 Python 代码

Question

是否有推荐的方法来为使用 Altair 生成图形的 Python 代码编写测试？

一个简单的例子是:

df = pandas.DataFrame(...)
chart = alt.Chart(df).mark_point().encode(x='...', y='...')

对于简单的图形，可以只测试 DataFrame 的内容，检查 Altair 调用是否引发异常，并检查 chart.save() 也没有引发异常异常，没有测试 Altair 输出的内容。

但对于更复杂的 Altair 图定义，我们真的希望我们的测试也能检查 Altair 的输出。

我一直在做的是为 chart.to_json()(Vega JSON 文件)的输出使用黄金文件(即 checkin 测试期望文件)。

对于更复杂的情况，需要对 JSON 文件进行一些调整，如下所示:

# Disabling "consolidate_datasets" makes the JSON output more
# stable, making it better to use as a golden file.  Without that
# disabled, Altair deduplicates the datasets by hash, and orders
# them in the JSON output by hash, so small changes can cause the
# datasets to be reordered.
with alt.data_transformers.enable(consolidate_datasets=False):
  json_data = chart.to_json() + '\n'
# Selector names can vary across runs of the test, so replace them
# with a placeholder.
json_data = re.sub(r'selector\d+', 'selectorXXX', json_data)
# Remove the schema URL so that the tests' golden files do not change
# across updates to Altair/Vega when only the version number in the
# URL changes.
json_data = re.sub(r'"\$schema": ".*"', '"$schema": "<removed>"', json_data)
self.assert_golden_file_equal('vega_graph.json', json_data)

有更好的方法吗？

Answer 1

您可以通过面向对象的 API 测试图表输出的特定部分:

assert chart.mark == 'bar'

由于 the Chart representation can change after displaying a chart ,您可能想改用 .to_dict():

assert chart.to_dict()['mark'] == 'bar'

您可以使用此语法检查任何现有图表属性，例如

assert chart.to_dict()['encoding']['y']['field'] == 'species'
assert chart.to_dict()['encoding']['x']['type'] == 'quantitative'
assert chart.to_dict()['encoding']['x']['aggregate'] == 'count'

如果您的评分设置支持共享变量您可以将 chart.to_dict() 分配给一个变量，而不是每次都重新创建它。

由于 Altair/Vega-Lite returning abbreviated specs when possible，您有时可能需要检查丢失的 key .