yambs.environment
index
/home/vkottler/src/vkottler/workspace/yambs/yambs/environment/__init__.py

A module implementing a build environment state manager.

 
Package Contents
       
native

 
Classes
       
builtins.tuple(builtins.object)
SourceSets
vcorelib.logging.LoggerMixin(builtins.object)
BuildEnvironment

 
class BuildEnvironment(vcorelib.logging.LoggerMixin)
    BuildEnvironment(config: yambs.config.Config) -> None
 
A class implementing a simple build environment.
 
 
Method resolution order:
BuildEnvironment
vcorelib.logging.LoggerMixin
builtins.object

Methods defined here:
__init__(self, config: yambs.config.Config) -> None
Initialize this instance.
first_party_sources_headers(self) -> Iterator[pathlib.Path]
Get all first-party sources and headers. This could be useful for
formatting or static analysis tooling where third-party sources
should be excluded.
set_board_sources(self, board: yambs.config.board.Board, regular: Set[pathlib.Path], apps: Set[pathlib.Path]) -> yambs.environment.SourceSets
Finalize source sets for a given board.

Data and other attributes defined here:
__annotations__ = {}

Methods inherited from vcorelib.logging.LoggerMixin:
log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

 
class SourceSets(builtins.tuple)
    SourceSets(regular: Set[pathlib.Path], apps: Set[pathlib.Path])
 
A structure for managing different kinds of source paths.
 
 
Method resolution order:
SourceSets
builtins.tuple
builtins.object

Methods defined here:
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
__repr__(self)
Return a nicely formatted representation string
_asdict(self)
Return a new dict which maps field names to their values.
_replace(self, /, **kwds)
Return a new SourceSets object replacing specified fields with new values
implicit_sources(self) -> Iterator[Tuple[pathlib.Path, yambs.translation.SourceTranslator]]
Iterate over generated sources.
link_sources(self) -> Iterator[Tuple[pathlib.Path, yambs.translation.SourceTranslator]]
Get all sources that are directly provided to the linker.
sources(self) -> Iterator[Tuple[pathlib.Path, yambs.translation.SourceTranslator]]
Iterate over sources and their source translator.

Class methods defined here:
_make(iterable) from builtins.type
Make a new SourceSets object from a sequence or iterable

Static methods defined here:
__new__(_cls, regular: Set[pathlib.Path], apps: Set[pathlib.Path])
Create new instance of SourceSets(regular, apps)

Data descriptors defined here:
regular
Alias for field number 0
apps
Alias for field number 1

Data and other attributes defined here:
__annotations__ = {'apps': typing.Set[pathlib.Path], 'regular': typing.Set[pathlib.Path]}
__match_args__ = ('regular', 'apps')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {}
_fields = ('regular', 'apps')

Methods inherited from builtins.tuple:
__add__(self, value, /)
Return self+value.
__contains__(self, key, /)
Return bool(key in self).
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__iter__(self, /)
Implement iter(self).
__le__(self, value, /)
Return self<=value.
__len__(self, /)
Return len(self).
__lt__(self, value, /)
Return self<value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__rmul__(self, value, /)
Return value*self.
count(self, value, /)
Return number of occurrences of value.
index(self, value, start=0, stop=9223372036854775807, /)
Return first index of value.
 
Raises ValueError if the value is not present.

Class methods inherited from builtins.tuple:
__class_getitem__(...) from builtins.type
See PEP 585

 
Data
        Dict = typing.Dict
Iterator = typing.Iterator
Set = typing.Set
SourceAndTranslator = typing.Tuple[pathlib.Path, yambs.translation.SourceTranslator]
Tuple = typing.Tuple