Skip to main content

tools for validating, documenting, and editing json and yaml data

Project description


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.

YamlConfig module

A common problem for the complex CI system developer is to separate its configuration logic from its configuration data.

  • Logic is the configuration of the builder, what does it build, what are the buildsteps, etc
  • Data is the parameter you want to easily change in the day to day maintainance work. What are the slaves, and their capabilities? What branches are needed to be tracked? under what conditions? etc

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.

.meta.yaml file Format

the meta yaml file is a yaml file made of nested dicts, describing the type of data the type checker is waiting for.

Root Node

the meta yaml file must describe the root type, which will snowball all the nested type checks

  type: dict
     type: int
     type: string

will match:

param1: 1
param2: stringvalue

imports Node

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:

    type: string
    values: [bar]

can be used in a myconfig.meta.yaml:

    - foo.type.yaml
    type: dict
            type: listoffoos

Base types

base types are:

an integer
a string
a true/false boolean
a floating point number

Compound types

A value of compound type is composed of several subtypes values or key/value:

an associative array that has a defined list of childrens key
an associative array that has an arbitrary list childrens keys
a list of arbitrary values
a list that ensure member unicity (you cannot have several time the same value)

Specifying types of values

For map, list, set, it is possible to specify what type is expected as the values. The syntax is:

type: <compound_type>of<type>s

for example, following types are valid

type: mapofstrings
type: listofints
type: listofsetsofints

User defined types

You can specify a meta.yaml file defining the map of types, you can reuse inside your main meta.yaml file. e.g:

    type: string
    values: [l1,l2,l3,l4,l5,l6]

This defines a location type, which is a string with 6 possible values.

types modifers

Each type can be associated with a number of modifiers, that will extend the number of specification you describe for it:

a set of possible values that the attribute can take
the name of the attribute as displayed in the UI
The value the attribute takes if it is not defined explicitly
a python expression checking whether this attribute should not be defined in a particular configuration
a python expression checking whether this attribute must be defined in a particular configuration
a python expression checking whether this attribute must be defined in a particular configuration

More complex example

The meta.yaml:

  type: dict
        type: listofdicts
        name: Build Slaves
            type: dict
            name: Capabilities
                    name: Used by builder
                    type: setofstrings
                    values: [ autolint, build ]
                    required: true
                    type: location
                    required: true
                    type: string
                    default: fast
                    values: [fast,slow]
            type: setofstrings

matches a yaml file like:

-       caps:
                builder: [build]
                location: l4
        slaves: [buildbot1build]
-       caps:
                builder: [autolint, build]
                location: l1
                speed: fast
        slaves: [build3build, build4build, build5build]

Project details

Release history Release notifications | RSS feed

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for yamltypes, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size yamltypes-1.0.tar.gz (18.2 kB) File type Source Python version None Upload date Hashes View
Filename, size (23.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page