带有默认值的可选键 (Map/Optional)

实验性

此功能处于 Alpha 阶段。API 可能会在次要版本增量中更改。

yaml_snippet 示例

a: 1

from strictyaml import Map, Int, Str, Bool, EmptyNone, Optional, load, as_document
from collections import OrderedDict
from ensure import Ensure

schema = Map({"a": Int(), Optional("b", default=False): Bool(), })

解析后的结果将包含可选值

Ensure(load(yaml_snippet, schema).data).equals(OrderedDict([("a", 1), ("b", False)]))

如果解析后再次输出到 YAML，则默认数据将不存在

print(load(yaml_snippet, schema).as_yaml())

a: 1

当默认数据输出到 YAML 时，它将被删除

print(as_document({"a": 1, "b": False}, schema).as_yaml())

a: 1

当你希望键保留并默认设置为 None 时

schema = Map({"a": Int(), Optional("b", default=None, drop_if_none=False): EmptyNone() | Bool(), })
Ensure(load(yaml_snippet, schema).data).equals(OrderedDict([("a", 1), ("b", None)]))

可执行规范

从 optional-with-defaults.story storytests 自动生成的文档。