class documentation

class GroupResult(dict): (source)

View In Hierarchy

Collection of results and/or exceptions arising from `.Group` methods. Acts like a dict, but adds a couple convenience methods, to wit: - Keys are the individual `.Connection` objects from within the `.Group`. - Values are either return values / results from the called method (e.g. `.runners.Result` objects), *or* an exception object, if one prevented the method from returning. - Subclasses `dict`, so has all dict methods. - Has `.succeeded` and `.failed` attributes containing sub-dicts limited to just those key/value pairs that succeeded or encountered exceptions, respectively. - Of note, these attributes allow high level logic, e.g. ``if mygroup.run('command').failed`` and so forth. .. versionadded:: 2.0

Method __init__ Undocumented
Property failed A sub-dict containing only failed results.
Property succeeded A sub-dict containing only successful results.
Method _bifurcate Undocumented
Instance Variable _failures Undocumented
Instance Variable _successes Undocumented
def __init__(self, *args, **kwargs): (source)

Undocumented

A sub-dict containing only failed results. .. versionadded:: 2.0

A sub-dict containing only successful results. .. versionadded:: 2.0

def _bifurcate(self): (source)

Undocumented

_failures: dict = (source)

Undocumented

_successes: dict = (source)

Undocumented