]> code.ossystems Code Review - openembedded-core.git/commit
Implement variable typing (sync from OE)
authorChris Larson <chris_larson@mentor.com>
Tue, 9 Nov 2010 21:48:13 +0000 (14:48 -0700)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Fri, 20 May 2011 16:33:02 +0000 (17:33 +0100)
commita04ce490e933fc7534db33f635b025c25329c564
tree38bf814b03c6cb2175e6f149ebbcf5ed92f8e1c4
parent8c6bf9f6775fc5aaa8bc2c77924c95a00f1c1890
Implement variable typing (sync from OE)

This implementation consists of two components:

- Type creation python modules, 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.data
    for pkg in oe.data.typed_value("PACKAGES", d):
        bb.note("package: %s" % pkg)
}

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

python () {
    import oe.data
    assert(oe.data.typed_value("LIBTOOL_HAS_SYSROOT", d) == True)
}

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