| | |
- builtins.tuple(builtins.object)
-
- Project
- vcorelib.dict.codec.BasicDictCodec(vcorelib.dict.codec.DictCodec)
-
- CommonConfig(yambs.schemas.YambsDictCodec, vcorelib.dict.codec.BasicDictCodec)
- yambs.schemas.YambsDictCodec(vcorelib.dict.codec.DictCodec)
-
- CommonConfig(yambs.schemas.YambsDictCodec, vcorelib.dict.codec.BasicDictCodec)
class CommonConfig(yambs.schemas.YambsDictCodec, vcorelib.dict.codec.BasicDictCodec) |
| |
CommonConfig(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> None
A common, base configuration.
|
| |
- Method resolution order:
- CommonConfig
- yambs.schemas.YambsDictCodec
- vcorelib.dict.codec.BasicDictCodec
- vcorelib.dict.codec.DictCodec
- vcorelib.dict.codec.JsonCodec
- abc.ABC
- vcorelib.schemas.mixins.SchemaMixin
- builtins.object
Methods defined here:
- directory(self, name: str, mkdir: bool = True, root: pathlib.Path = None) -> pathlib.Path
- Get a configurable directory.
- init(self, data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]) -> None
- Initialize this instance.
Class methods defined here:
- load(path: Union[pathlib.Path, str, NoneType] = 'yambs.yaml', package_config: str = 'yambs.yaml', root: Union[pathlib.Path, str, NoneType] = None) -> ~T from abc.ABCMeta
- Load a configuration.
Readonly properties defined here:
- third_party_script
- Get the path to the third-party build script.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __annotations__ = {'build_root': <class 'pathlib.Path'>, 'data': typing.Dict[str, typing.Any], 'dependencies': typing.Set[yambs.dependency.config.Dependency], 'dist_root': <class 'pathlib.Path'>, 'file': typing.Optional[pathlib.Path], 'ninja_root': <class 'pathlib.Path'>, 'root': <class 'pathlib.Path'>, 'src_root': <class 'pathlib.Path'>, 'third_party_root': <class 'pathlib.Path'>}
Data and other attributes inherited from yambs.schemas.YambsDictCodec:
- default_schemas = {'Variant': <vcorelib.schemas.json.JsonSchema ob...chemas.json.JsonSchema object at 0x7f8f1e50a6c0>}
Methods inherited from vcorelib.dict.codec.BasicDictCodec:
- asdict(self) -> Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]
- Obtain a dictionary representing this instance.
Methods inherited from vcorelib.dict.codec.DictCodec:
- __init__(self, data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> None
- Initialize this instance.
Class methods inherited from vcorelib.dict.codec.DictCodec:
- create(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> ~V from abc.ABCMeta
- A factory method to create an instance.
Methods inherited from vcorelib.dict.codec.JsonCodec:
- __copy__(self: ~T) -> ~T
- Create another instance based on this instance's data.
- __eq__(self, other) -> bool
- Determine if this instance is equal to another.
- __str__(self) -> str
- Use the dictionary representation of this instance for string
representation.
- encode(self, pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f8f1f026090>, **kwargs) -> Tuple[bool, int]
- Encode this object instance to a file.
Class methods inherited from vcorelib.dict.codec.JsonCodec:
- decode(pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f8f1f026090>, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True, require_success: bool = True, default_data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, **kwargs) -> ~T from abc.ABCMeta
- Decode an object instance from data loaded from a file.
- file_cache(pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f8f1f026090>, encode_kwargs: Dict[str, Any] = None, require_success: bool = False, **kwargs) -> Iterator[~T] from abc.ABCMeta
- Manage an instance of this class as a disk-backed file.
- normalize(data: Union[Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]], ~T]) -> ~T from abc.ABCMeta
- Ensure that some object is an instance of this class.
Data descriptors inherited from vcorelib.dict.codec.JsonCodec:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Data and other attributes inherited from vcorelib.dict.codec.JsonCodec:
- __hash__ = None
Methods inherited from vcorelib.schemas.mixins.SchemaMixin:
- validate(self, valid_attr: str = 'data') -> None
- Validate an instance attribute based on this instance's schema.
Class methods inherited from vcorelib.schemas.mixins.SchemaMixin:
- schema_name() -> str from abc.ABCMeta
- A default name for this class's schema.
|
class Project(builtins.tuple) |
| |
Project(name: str, major: int, minor: int, patch: int, repo: str, owner: Optional[str])
An object for managing project metadata.
|
| |
- Method resolution order:
- Project
- 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
- __str__(self) -> str
- Get this project as a string.
- _asdict(self)
- Return a new dict which maps field names to their values.
- _replace(self, /, **kwds)
- Return a new Project object replacing specified fields with new values
Class methods defined here:
- _make(iterable) from builtins.type
- Make a new Project object from a sequence or iterable
Static methods defined here:
- __new__(_cls, name: str, major: int, minor: int, patch: int, repo: str, owner: Optional[str])
- Create new instance of Project(name, major, minor, patch, repo, owner)
- create(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]) -> 'Project'
- Create a project instance from JSON data.
Readonly properties defined here:
- version
- Get this project's version string.
Data descriptors defined here:
- name
- Alias for field number 0
- major
- Alias for field number 1
- minor
- Alias for field number 2
- patch
- Alias for field number 3
- repo
- Alias for field number 4
- owner
- Alias for field number 5
Data and other attributes defined here:
- __annotations__ = {'major': <class 'int'>, 'minor': <class 'int'>, 'name': <class 'str'>, 'owner': typing.Optional[str], 'patch': <class 'int'>, 'repo': <class 'str'>}
- __match_args__ = ('name', 'major', 'minor', 'patch', 'repo', 'owner')
- __orig_bases__ = (<function NamedTuple>,)
- _field_defaults = {}
- _fields = ('name', 'major', 'minor', 'patch', 'repo', 'owner')
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
| |