tools for validating, documenting, and editing json and yaml data
Tools for loading and validating yaml config files.
package is shipped with 2 entry points scripts:
yamlvalidate: This tool can validate a yaml file against its spec.
The spec file can be either automatically found given the filename or given as parameter with --meta
yaml2rst: This tool automatically creates a rst documentation of the types defined in a directory.
A common problem for the complex CI system developer is to separate its configuration logic from its configuration data.
YamlConfig helps to resolve this problem by providing tools to create and describe a set of yaml files that are used as input for your master.cfg
Originally made for buildbot configuration, the spec format it defines can be used to describe any kind of json compatible data.
Each parsed yaml file can be given a .meta.yaml file that acts as a schema file describing what is allowed in the file, and potencially how to present it in an edition UI.
the meta yaml file is a yaml file made of nested dicts, describing the type of data the type checker is waiting for.
the meta yaml file must describe the root type, which will snowball all the nested type checks
root: type: dict kids: param1: type: int param2: type: string
param1: 1 param2: stringvalue
The meta yaml file can use types described in another file. For that, it will import a list of .types.yaml files.
A .types.yaml is a yaml file defining a map of named types. ex:
foo: type: string values: [bar]
can be used in a myconfig.meta.yaml:
imports: - foo.type.yaml root: type: dict kids: foo: type: listoffoos
base types are:
A value of compound type is composed of several subtypes values or key/value:
For map, list, set, it is possible to specify what type is expected as the values. The syntax is:
for example, following types are valid
type: mapofstrings type: listofints type: listofsetsofints
You can specify a meta.yaml file defining the map of types, you can reuse inside your main meta.yaml file. e.g:
location: type: string values: [l1,l2,l3,l4,l5,l6]
This defines a location type, which is a string with 6 possible values.
Each type can be associated with a number of modifiers, that will extend the number of specification you describe for it:
root: type: dict kids: slaves: type: listofdicts name: Build Slaves kids: caps: type: dict name: Capabilities kids: builder: name: Used by builder type: setofstrings values: [ autolint, build ] required: true location: type: location required: true speed: type: string default: fast values: [fast,slow] slaves: type: setofstrings
matches a yaml file like:
slaves: - caps: builder: [build] location: l4 slaves: [buildbot1build] - caps: builder: [autolint, build] location: l1 speed: fast slaves: [build3build, build4build, build5build]
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|yamltypes-1.0.tar.gz (18.2 kB) Copy SHA256 Checksum SHA256||–||Source||Jan 22, 2015|
|yamltypes-1.0.zip (23.1 kB) Copy SHA256 Checksum SHA256||–||Source||Jan 22, 2015|