userfs.project
index
/home/vkottler/src/vkottler/workspace/userfs/userfs/project/__init__.py

A module for interfacing with projects.

 
Package Contents
       

 
Classes
       
builtins.tuple(builtins.object)
ProjectInteractionTask

 
class ProjectInteractionTask(builtins.tuple)
    ProjectInteractionTask(kind: userfs.config.project.ProjectInteraction, root: pathlib.Path, project: userfs.config.project.ProjectSpecification, cli_options: Dict[str, Any], hooks: Dict[str, Optional[Callable[[pathlib.Path, userfs.config.project.ProjectSpecification, Dict[str, Any], Dict[str, Any]], NoneType]]], hooks_only: bool = False)
 
A data structure containing all information necessary for interacting with
a project.
 
 
Method resolution order:
ProjectInteractionTask
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 ProjectInteractionTask object replacing specified fields with new values
interact(self, interaction: Callable[[pathlib.Path, userfs.config.project.ProjectSpecification, Dict[str, Any], Dict[str, Any]], NoneType] = None) -> None
Run a project-interaction method.

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

Static methods defined here:
__new__(_cls, kind: userfs.config.project.ProjectInteraction, root: pathlib.Path, project: userfs.config.project.ProjectSpecification, cli_options: Dict[str, Any], hooks: Dict[str, Optional[Callable[[pathlib.Path, userfs.config.project.ProjectSpecification, Dict[str, Any], Dict[str, Any]], NoneType]]], hooks_only: bool = False)
Create new instance of ProjectInteractionTask(kind, root, project, cli_options, hooks, hooks_only)

Data descriptors defined here:
kind
Alias for field number 0
root
Alias for field number 1
project
Alias for field number 2
cli_options
Alias for field number 3
hooks
Alias for field number 4
hooks_only
Alias for field number 5

Data and other attributes defined here:
__annotations__ = {'cli_options': typing.Dict[str, typing.Any], 'hooks': typing.Dict[str, typing.Optional[typing.Callable....Any], typing.Dict[str, typing.Any]], NoneType]]], 'hooks_only': <class 'bool'>, 'kind': <enum 'ProjectInteraction'>, 'project': <class 'userfs.config.project.ProjectSpecification'>, 'root': <class 'pathlib.Path'>}
__match_args__ = ('kind', 'root', 'project', 'cli_options', 'hooks', 'hooks_only')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {'hooks_only': False}
_fields = ('kind', 'root', 'project', 'cli_options', 'hooks', 'hooks_only')

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

 
Functions
       
execute_interactions(interactions: Iterable[userfs.config.project.ProjectInteraction], projects: Iterable[str], config: userfs.config.Config, cli_options: Dict[str, Any], hooks_only: bool = False) -> int
Execute project interactions in parallel.
interact(task: userfs.project.ProjectInteractionTask) -> None
Perform a project interaction.

 
Data
        Dict = typing.Dict
INTERACTIONS = {<ProjectInteraction.FETCH: 'fetch'>: <function fetch>, <ProjectInteraction.UPDATE: 'update'>: <function update>, <ProjectInteraction.BUILD: 'build'>: <function build>, <ProjectInteraction.DEPLOY: 'deploy'>: <function deploy>}
Interact = typing.Callable[[pathlib.Path, userfs.config.pro...ng.Any], typing.Dict[str, typing.Any]], NoneType]
Iterable = typing.Iterable
Optional = typing.Optional