runtimepy.channel.environment.command.result
index
/home/vkottler/src/vkottler/workspace/runtimepy/runtimepy/channel/environment/command/result.py

A module implementing a command result interface.

 
Classes
       
builtins.tuple(builtins.object)
CommandResult

 
class CommandResult(builtins.tuple)
    CommandResult(success: bool, reason: Optional[str] = None)
 
A container for command result data.
 
 
Method resolution order:
CommandResult
builtins.tuple
builtins.object

Methods defined here:
__bool__(self) -> bool
Evaluate this instance as a boolean.
__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 command result as a 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, success: bool, reason: Optional[str] = None)
Create new instance of CommandResult(success, reason)

Data descriptors defined here:
success
Alias for field number 0
reason
Alias for field number 1

Data and other attributes defined here:
__annotations__ = {'reason': typing.Optional[str], 'success': <class 'bool'>}
__match_args__ = ('success', 'reason')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {'reason': None}
_fields = ('success', 'reason')

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
        Optional = typing.Optional
SUCCESS = CommandResult(success=True, reason=None)