Implement variable typing
authorChris Larson <chris_larson@mentor.com>
Tue, 9 Nov 2010 21:48:13 +0000 (14:48 -0700)
committerChris Larson <chris_larson@mentor.com>
Tue, 28 Dec 2010 16:19:51 +0000 (09:19 -0700)
commit606441e5c4f4a979231fb943b1fa39ea5371a727
treefb60c6a2b6d0656812af1cfb3c1b229d808f51b5
parent4247d8ca5b818a9b0409667d67b534cead00cb69
Implement variable typing

This implementation consists of two components:

- oe.types python module, whose job it is to construct objects of the defined
  type for a given variable in the metadata
- typecheck.bbclass, which iterates over all configuration variables with a
  type defined and uses oe.types to check the validity of the values

This gives us a few benefits:

- Automatic sanity checking of all configuration variables with a defined type
- Avoid duplicating the "how do I make use of the value of this variable"
  logic between its users.  For variables like PATH, this is simply a split(),
  for boolean variables, the duplication can result in confusing, or even
  mismatched semantics (is this 0/1, empty/nonempty, what?)
- Make it easier to create a configuration UI, as the type information could
  be used to provide a better interface than a text edit box (e.g checkbox for
  'boolean', dropdown for 'choice')

This functionality is entirely opt-in right now.  To enable the configuration
variable type checking, simply INHERIT += "typecheck".  Example of a failing
type check:

BAZ = "foo"
BAZ[type] = "boolean"

$ bitbake -p
FATAL: BAZ: Invalid boolean value 'foo'
$

Examples of leveraging oe.types in a python snippet:

PACKAGES[type] = "list"

python () {
    import oe.types
    for pkg in oe.types.value("PACKAGES", d):
        bb.note("package: %s" % pkg)
}

LIBTOOL_HAS_SYSROOT = "yes"
LIBTOOL_HAS_SYSROOT[type] = "boolean"

python () {
    import oe.types
    assert(oe.types.value("LIBTOOL_HAS_SYSROOT", d) == True)
}

Signed-off-by: Chris Larson <chris_larson@mentor.com>
classes/typecheck.bbclass [new file with mode: 0644]
lib/oe/_types.py [new file with mode: 0644]
lib/oe/test_types.py [new file with mode: 0644]
lib/oe/types.py [new file with mode: 0644]