Foundation types

class FastEnum(value)

Bases: object

A reimplementation of a subset of the Enum functionality, which is far quicker than Enum.

enum.Enum attributes accesses can be really slow, and slow down the execution noticeably. This reimplementation doesn’t suffer the same problems, but also does not reimplement everything.

name = None

The name of the current Enum entry, same as enum.Enum.name()

value = None

The value of the current Enum entry, same as enum.Enum.value()

classmethod values()

Get all the possible values for the enum.

Returns

the list of all possible values for the enum

Return type

list

class Scope(value)

Bases: buildstream.types.FastEnum

Defines the scope of dependencies to include for a given element when iterating over the dependency graph in APIs like Element.dependencies()

ALL = <buildstream.types.Scope object>

All elements which the given element depends on, following all elements required for building. Including the element itself.

BUILD = <buildstream.types.Scope object>

All elements required for building the element, including their respective run dependencies. Not including the given element itself.

RUN = <buildstream.types.Scope object>

All elements required for running the element. Including the element itself.

NONE = <buildstream.types.Scope object>

Just the element itself, no dependencies.

class CoreWarnings

Bases: object

Some common warnings which are raised by core functionalities within BuildStream are found in this class.

OVERLAPS = 'overlaps'

This warning will be produced when buildstream detects an overlap on an element which is not whitelisted. See Overlap Whitelist

REF_NOT_IN_TRACK = 'ref-not-in-track'

This warning will be produced when a source is configured with a reference which is found to be invalid based on the configured track

BAD_ELEMENT_SUFFIX = 'bad-element-suffix'

This warning will be produced when an element whose name does not end in .bst is referenced either on the command line or by another element

BAD_CHARACTERS_IN_NAME = 'bad-characters-in-name'

This warning will be produces when filename for a target contains invalid characters in its name.