| | |
- builtins.tuple(builtins.object)
-
- vmklib.tasks.mixins.curl.CommandResult
- vcorelib.task.subprocess.run.SubprocessLogMixin(vcorelib.task.Task)
-
- vmklib.tasks.mixins.curl.CurlMixin
- vmklib.tasks.VmklibBase(vcorelib.task.Task)
-
- vmklib.tasks.mixins.concrete.ConcreteBuilderMixin
-
- vmklib.tasks.mixins.concrete.ConcreteOnceMixin
class CommandResult(builtins.tuple) |
| |
CommandResult(code: int, stdout: str, stderr: str)
A container for a system command result.
|
| |
- Method resolution order:
- CommandResult
- 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 CommandResult object replacing specified fields with new values
Class methods defined here:
- _make(iterable) from builtins.type
- Make a new CommandResult object from a sequence or iterable
Static methods defined here:
- __new__(_cls, code: int, stdout: str, stderr: str)
- Create new instance of CommandResult(code, stdout, stderr)
Data descriptors defined here:
- code
- Alias for field number 0
- stdout
- Alias for field number 1
- stderr
- Alias for field number 2
Data and other attributes defined here:
- __annotations__ = {'code': <class 'int'>, 'stderr': <class 'str'>, 'stdout': <class 'str'>}
- __match_args__ = ('code', 'stdout', 'stderr')
- __orig_bases__ = (<function NamedTuple>,)
- _field_defaults = {}
- _fields = ('code', 'stdout', 'stderr')
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
|
class ConcreteBuilderMixin(vmklib.tasks.VmklibBase) |
| |
ConcreteBuilderMixin(name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
Create a concrete file output after a task completes.
|
| |
- Method resolution order:
- ConcreteBuilderMixin
- vmklib.tasks.VmklibBase
- vcorelib.task.Task
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- concrete_path(self, inbox: Dict[str, Dict[str, Any]], substitutions: Dict[str, Union[str, int]] = None) -> pathlib.Path
- By default name the concrete after the compiled target name.
- is_concrete_stale(self, inbox: Dict[str, Dict[str, Any]], candidates: Iterable[Union[pathlib.Path, str, NoneType]], substitutions: Dict[str, Union[str, int]] = None) -> bool
- Check if any candidate paths are modified after the concrete was.
- async run_exit(self, _inbox: Dict[str, Dict[str, Any]], _outbox: Dict[str, Any], *_args, **kwargs) -> bool
- Update the concrete target after main execution by default.
- update_concrete(self, inbox: Dict[str, Dict[str, Any]], **kwargs) -> pathlib.Path
- Write a text file to disk in the build directory based on the name of
this task.
This is useful to bootstrap compatibility with other tools like GNU
Make that assess concrete targets.
Data and other attributes defined here:
- __annotations__ = {}
Class methods inherited from vmklib.tasks.VmklibBase:
- build_dir(inbox: Dict[str, Dict[str, Any]]) -> pathlib.Path from builtins.type
- Get a path to the build directory.
Data and other attributes inherited from vmklib.tasks.VmklibBase:
- default_requirements = {'vmklib.init'}
Methods inherited from vcorelib.task.Task:
- __init__(self, name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
- Initialize this task.
- __str__(self) -> 'str'
- Convert this task into a string.
- create_execute(self, *args, **kwargs) -> 'TaskExecute'
- Create a default execute function for this task.
- depend_on(self, task: "'Task'", eloop: '_asyncio.AbstractEventLoop' = None, **kwargs) -> 'bool'
- Register other tasks' output data to your input box. Return true
if a new dependency was added.
- depend_on_all(self, tasks: "_Iterable['Task']", **kwargs) -> 'int'
- Register multiple dependencies. Return the number of dependencies
added.
- async dispatch(self, caller: "'Task'" = None, init_only: 'bool' = False, substitutions: 'Substitutions' = None, **kwargs) -> 'None'
- Dispatch this task and return whether or not it succeeded.
- dispatch_init(self, caller: "'Task'" = None, substitutions: 'Substitutions' = None, **kwargs) -> '_Tuple[Substitutions, str]'
- Perform some dispatch initialization.
- resolve(self, log: 'Logger', compiled: 'str', substitutions: 'Substitutions' = None) -> 'None'
- Mark this task resolved.
- async resolve_dependencies(self, **substitutions) -> 'None'
- A default dependency resolver for tasks. Note that the default
dependency resolver cannot propagate current-task substitutions to
its dependencies as they've already been explicitly registered.
- resolved(self, compiled: 'str', substitutions: 'Substitutions' = None) -> 'bool'
- Override this in a derived task to implement more complex logic.
- async run(self, inbox: 'Inbox', outbox: 'Outbox', *args, **kwargs) -> 'bool'
- Override this method to implement the task.
- async run_enter(self, _inbox: 'Inbox', _outbox: 'Outbox', *_args, **_kwargs) -> 'bool'
- A default enter method.
- task_fail(self, compiled: 'str', substitutions: 'Substitutions', caller: "'Task'" = None, indent: 'int' = 4) -> 'TaskFailed'
- Build an exception message for when this task fails.
Readonly properties inherited from vcorelib.task.Task:
- stack
- Get this task's execution stack.
Data and other attributes inherited from vcorelib.task.Task:
- stages = ['run_enter', 'run', 'run_exit']
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 ConcreteOnceMixin(ConcreteBuilderMixin) |
| |
ConcreteOnceMixin(name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
A mixin for tasks that only need to run once.
|
| |
- Method resolution order:
- ConcreteOnceMixin
- ConcreteBuilderMixin
- vmklib.tasks.VmklibBase
- vcorelib.task.Task
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- async run_enter(self, _inbox: Dict[str, Dict[str, Any]], _outbox: Dict[str, Any], *_args, **_kwargs) -> bool
- Ensure that this task only runs once.
Data and other attributes defined here:
- __annotations__ = {}
Methods inherited from ConcreteBuilderMixin:
- concrete_path(self, inbox: Dict[str, Dict[str, Any]], substitutions: Dict[str, Union[str, int]] = None) -> pathlib.Path
- By default name the concrete after the compiled target name.
- is_concrete_stale(self, inbox: Dict[str, Dict[str, Any]], candidates: Iterable[Union[pathlib.Path, str, NoneType]], substitutions: Dict[str, Union[str, int]] = None) -> bool
- Check if any candidate paths are modified after the concrete was.
- async run_exit(self, _inbox: Dict[str, Dict[str, Any]], _outbox: Dict[str, Any], *_args, **kwargs) -> bool
- Update the concrete target after main execution by default.
- update_concrete(self, inbox: Dict[str, Dict[str, Any]], **kwargs) -> pathlib.Path
- Write a text file to disk in the build directory based on the name of
this task.
This is useful to bootstrap compatibility with other tools like GNU
Make that assess concrete targets.
Class methods inherited from vmklib.tasks.VmklibBase:
- build_dir(inbox: Dict[str, Dict[str, Any]]) -> pathlib.Path from builtins.type
- Get a path to the build directory.
Data and other attributes inherited from vmklib.tasks.VmklibBase:
- default_requirements = {'vmklib.init'}
Methods inherited from vcorelib.task.Task:
- __init__(self, name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
- Initialize this task.
- __str__(self) -> 'str'
- Convert this task into a string.
- create_execute(self, *args, **kwargs) -> 'TaskExecute'
- Create a default execute function for this task.
- depend_on(self, task: "'Task'", eloop: '_asyncio.AbstractEventLoop' = None, **kwargs) -> 'bool'
- Register other tasks' output data to your input box. Return true
if a new dependency was added.
- depend_on_all(self, tasks: "_Iterable['Task']", **kwargs) -> 'int'
- Register multiple dependencies. Return the number of dependencies
added.
- async dispatch(self, caller: "'Task'" = None, init_only: 'bool' = False, substitutions: 'Substitutions' = None, **kwargs) -> 'None'
- Dispatch this task and return whether or not it succeeded.
- dispatch_init(self, caller: "'Task'" = None, substitutions: 'Substitutions' = None, **kwargs) -> '_Tuple[Substitutions, str]'
- Perform some dispatch initialization.
- resolve(self, log: 'Logger', compiled: 'str', substitutions: 'Substitutions' = None) -> 'None'
- Mark this task resolved.
- async resolve_dependencies(self, **substitutions) -> 'None'
- A default dependency resolver for tasks. Note that the default
dependency resolver cannot propagate current-task substitutions to
its dependencies as they've already been explicitly registered.
- resolved(self, compiled: 'str', substitutions: 'Substitutions' = None) -> 'bool'
- Override this in a derived task to implement more complex logic.
- async run(self, inbox: 'Inbox', outbox: 'Outbox', *args, **kwargs) -> 'bool'
- Override this method to implement the task.
- task_fail(self, compiled: 'str', substitutions: 'Substitutions', caller: "'Task'" = None, indent: 'int' = 4) -> 'TaskFailed'
- Build an exception message for when this task fails.
Readonly properties inherited from vcorelib.task.Task:
- stack
- Get this task's execution stack.
Data and other attributes inherited from vcorelib.task.Task:
- stages = ['run_enter', 'run', 'run_exit']
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 CurlMixin(vcorelib.task.subprocess.run.SubprocessLogMixin) |
| |
CurlMixin(name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
A task for generating ninja configurations.
|
| |
- Method resolution order:
- CurlMixin
- vcorelib.task.subprocess.run.SubprocessLogMixin
- vcorelib.task.Task
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- async curl(self, *args: str, post_data: Dict[str, Any] = None, headers: Dict[str, str] = None, method: str = None) -> vmklib.tasks.mixins.curl.CommandResult
- Run a curl command.
Data and other attributes defined here:
- __annotations__ = {}
Methods inherited from vcorelib.task.subprocess.run.SubprocessLogMixin:
- async exec(self, program: str, *caller_args: str, args: str = '', separator: str = '::', stdout: int = None, stderr: int = None, **kwargs) -> bool
- Execute a command and return whether or not it succeeded.
- async shell(self, cmd: str, *caller_args: str, args: str = '', joiner: str = ' ', separator: str = '::', stdout: int = None, stderr: int = None, **kwargs) -> bool
- Execute a shell command and return whether or not it succeeded.
- async shell_cmd_in_dir(self, path: pathlib.Path, cmd: List[str], joiner: str = ' ', cd: str = 'cd', **kwargs) -> bool
- Run a shell command in a specific directory.
- async subprocess_exec(self, program: str, *caller_args: str, args: str = '', separator: str = '::', stdout: int = None, stderr: int = None, **kwargs) -> asyncio.subprocess.Process
- Create a process using subprocess exec and log what the arguments were.
- async subprocess_shell(self, cmd: str, *caller_args: str, args: str = '', joiner: str = ' ', separator: str = '::', stdout: int = None, stderr: int = None, **kwargs) -> asyncio.subprocess.Process
- Create a process using subprocess shell and log what the command is.
Methods inherited from vcorelib.task.Task:
- __init__(self, name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
- Initialize this task.
- __str__(self) -> 'str'
- Convert this task into a string.
- create_execute(self, *args, **kwargs) -> 'TaskExecute'
- Create a default execute function for this task.
- depend_on(self, task: "'Task'", eloop: '_asyncio.AbstractEventLoop' = None, **kwargs) -> 'bool'
- Register other tasks' output data to your input box. Return true
if a new dependency was added.
- depend_on_all(self, tasks: "_Iterable['Task']", **kwargs) -> 'int'
- Register multiple dependencies. Return the number of dependencies
added.
- async dispatch(self, caller: "'Task'" = None, init_only: 'bool' = False, substitutions: 'Substitutions' = None, **kwargs) -> 'None'
- Dispatch this task and return whether or not it succeeded.
- dispatch_init(self, caller: "'Task'" = None, substitutions: 'Substitutions' = None, **kwargs) -> '_Tuple[Substitutions, str]'
- Perform some dispatch initialization.
- resolve(self, log: 'Logger', compiled: 'str', substitutions: 'Substitutions' = None) -> 'None'
- Mark this task resolved.
- async resolve_dependencies(self, **substitutions) -> 'None'
- A default dependency resolver for tasks. Note that the default
dependency resolver cannot propagate current-task substitutions to
its dependencies as they've already been explicitly registered.
- resolved(self, compiled: 'str', substitutions: 'Substitutions' = None) -> 'bool'
- Override this in a derived task to implement more complex logic.
- async run(self, inbox: 'Inbox', outbox: 'Outbox', *args, **kwargs) -> 'bool'
- Override this method to implement the task.
- async run_enter(self, _inbox: 'Inbox', _outbox: 'Outbox', *_args, **_kwargs) -> 'bool'
- A default enter method.
- async run_exit(self, _inbox: 'Inbox', _outbox: 'Outbox', *_args, **_kwargs) -> 'bool'
- A default exit method.
- task_fail(self, compiled: 'str', substitutions: 'Substitutions', caller: "'Task'" = None, indent: 'int' = 4) -> 'TaskFailed'
- Build an exception message for when this task fails.
Readonly properties inherited from vcorelib.task.Task:
- stack
- Get this task's execution stack.
Data and other attributes inherited from vcorelib.task.Task:
- default_requirements = set()
- stages = ['run_enter', 'run', 'run_exit']
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
| |