Skip to content

two

This describes the easyconfig format versions 2.x

This is a mix between version 1.0 and configparser-style configuration

Authors:

  • Stijn De Weirdt (Ghent University)
  • Kenneth Hoste (Ghent University)

FormatTwoZero

Bases: EasyConfigFormatConfigObj

Support for easyconfig format 2.0 Simple extension of FormatOneZero with configparser blocks

Doesn't set version and toolchain/toolchain version like in FormatOneZero; referencing 'version' directly in pyheader doesn't work => use templating '%(version)s'

NOT in 2.0 - order preservation: need more recent ConfigObj (more recent Python as minimal version) - nested sections (need other ConfigParser/ConfigObj, eg INITools) - type validation - command line generation (--try-X command line options)

_check_docstring()

Verify docstring. field :author: people who contributed to the easyconfig field @maintainer: people who can be contacted in case of problems

extract_comments(rawtxt)

Extract comments from raw content.

get_config_dict()

Return the best matching easyconfig dict

validate()

Format validation