| | |
- vcorelib.task.subprocess.run.SubprocessLogMixin(vcorelib.task.Task)
-
- RequirementsInstaller(vmklib.tasks.mixins.concrete.ConcreteBuilderMixin, vcorelib.task.subprocess.run.SubprocessLogMixin)
- Venv(vmklib.tasks.mixins.concrete.ConcreteBuilderMixin, vcorelib.task.subprocess.run.SubprocessLogMixin)
- vmklib.tasks.mixins.concrete.ConcreteBuilderMixin(vmklib.tasks.VmklibBase)
-
- RequirementsInstaller(vmklib.tasks.mixins.concrete.ConcreteBuilderMixin, vcorelib.task.subprocess.run.SubprocessLogMixin)
- Venv(vmklib.tasks.mixins.concrete.ConcreteBuilderMixin, vcorelib.task.subprocess.run.SubprocessLogMixin)
class RequirementsInstaller(vmklib.tasks.mixins.concrete.ConcreteBuilderMixin, vcorelib.task.subprocess.run.SubprocessLogMixin) |
| |
RequirementsInstaller(name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
A task for installing requirements files.
|
| |
- Method resolution order:
- RequirementsInstaller
- vmklib.tasks.mixins.concrete.ConcreteBuilderMixin
- vmklib.tasks.VmklibBase
- vcorelib.task.subprocess.run.SubprocessLogMixin
- vcorelib.task.Task
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- async run(self, inbox: Dict[str, Dict[str, Any]], outbox: Dict[str, Any], *args, **kwargs) -> bool
- Install a requirements file.
Data and other attributes defined here:
- __annotations__ = {}
Methods inherited from vmklib.tasks.mixins.concrete.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.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_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 Venv(vmklib.tasks.mixins.concrete.ConcreteBuilderMixin, vcorelib.task.subprocess.run.SubprocessLogMixin) |
| |
Venv(name: 'str', *args, execute: 'TaskExecute' = None, log: 'Logger' = None, timer: 'Timer' = None, target: 'Target' = None, **kwargs) -> 'None'
A target prototype for creating a virtual environment.
|
| |
- Method resolution order:
- Venv
- vmklib.tasks.mixins.concrete.ConcreteBuilderMixin
- vmklib.tasks.VmklibBase
- vcorelib.task.subprocess.run.SubprocessLogMixin
- vcorelib.task.Task
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- async run(self, inbox: Dict[str, Dict[str, Any]], outbox: Dict[str, Any], *args, **kwargs) -> bool
- Create or update a project's virtual environment.
- async run_enter(self, _inbox: Dict[str, Dict[str, Any]], _outbox: Dict[str, Any], *_args, **_kwargs) -> bool
- Check if the virtual environment gets created and expose useful data
to the outbox.
Data and other attributes defined here:
- __annotations__ = {}
Methods inherited from vmklib.tasks.mixins.concrete.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.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.
- 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
| |