Package Contents

Classes
		builtins.object Status Failed InProgress NotStarted Succeeded   class Failed(Status)     Failed() -&gt; 'Failed'   Represents that the event has failed.     Method resolution order: Failed Status builtins.object Methods defined here: __init__(self: 'Failed') -> 'Failed' Initializes a Status, but is actually unused. Instead you should initialize one of:   - `Failed` - `NotStarted` - `InProgress(progress)` - `Succeeded` __repr__(self: 'Failed') -> str Returns the string representation of this `Failure` `Status`. Methods inherited from Status: __eq__(self: 'Status', other: 'Status') -> bool Determines if two status are equal.   Two statues are considered equal if they are of the same Status type; if both `Status`es are `InProgress`, then their progress values must compare equal also. __ge__(self, other, NotImplemented=NotImplemented) Return a >= b.  Computed by @total_ordering from (not a < b). __gt__(self, other, NotImplemented=NotImplemented) Return a > b.  Computed by @total_ordering from (not a < b) and (a != b). __le__(self, other, NotImplemented=NotImplemented) Return a <= b.  Computed by @total_ordering from (a < b) or (a == b). __lt__(self: 'Status', other: 'Status') -> bool Determines if one `Status` is less than another one.   The `Status` ordering hierarchy is as follows:   ``` Failed < NotStarted < InProgress(x) < InProgress(y) < Succeeded # (where x is < y) ```   The `Status.__lte__`, `Status.__gt__`, and `Status.__gte__` methods are autogenerated from this method using `functools.total_ordering` and subsequently have no documentation. Data descriptors inherited from Status: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined) in_progress Determines if this `Status` is in progress or not.   This is different from a comparison to an `InProgress` because said comparison would require both `Status` to have the same `progress` values (if they are both indeed `InProgress`), while this method returns true for any `InProgress` progress value. Data and other attributes inherited from Status: __hash__ = None   class InProgress(Status)     InProgress(progress: numbers.Real = 0) -&gt; 'InProgress'   Represents that the event is in progress.     Method resolution order: InProgress Status builtins.object Methods defined here: __init__(self: 'InProgress', progress: numbers.Real = 0) -> 'InProgress' Creates a new `InProgress` status.   If the given `progress` is not `0 <= progress <= 100`, then the value is either reduced to 100 or increased to 0. This is done because sometime programatic progress updating can end up creating a `InProgress` with a negative or > 100 progress. __repr__(self: 'InProgress') -> str Returns the string representation of this `InProgress` `Status`. Methods inherited from Status: __eq__(self: 'Status', other: 'Status') -> bool Determines if two status are equal.   Two statues are considered equal if they are of the same Status type; if both `Status`es are `InProgress`, then their progress values must compare equal also. __ge__(self, other, NotImplemented=NotImplemented) Return a >= b.  Computed by @total_ordering from (not a < b). __gt__(self, other, NotImplemented=NotImplemented) Return a > b.  Computed by @total_ordering from (not a < b) and (a != b). __le__(self, other, NotImplemented=NotImplemented) Return a <= b.  Computed by @total_ordering from (a < b) or (a == b). __lt__(self: 'Status', other: 'Status') -> bool Determines if one `Status` is less than another one.   The `Status` ordering hierarchy is as follows:   ``` Failed < NotStarted < InProgress(x) < InProgress(y) < Succeeded # (where x is < y) ```   The `Status.__lte__`, `Status.__gt__`, and `Status.__gte__` methods are autogenerated from this method using `functools.total_ordering` and subsequently have no documentation. Data descriptors inherited from Status: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined) in_progress Determines if this `Status` is in progress or not.   This is different from a comparison to an `InProgress` because said comparison would require both `Status` to have the same `progress` values (if they are both indeed `InProgress`), while this method returns true for any `InProgress` progress value. Data and other attributes inherited from Status: __hash__ = None   class NotStarted(Status)     NotStarted() -&gt; 'NotStarted'   Represents that the event has not yet been started.     Method resolution order: NotStarted Status builtins.object Methods defined here: __init__(self: 'NotStarted') -> 'NotStarted' Initializes a Status, but is actually unused. Instead you should initialize one of:   - `Failed` - `NotStarted` - `InProgress(progress)` - `Succeeded` __repr__(self: 'NotStarted') -> str Returns the string representation of this `NotStarted` `Status`. Methods inherited from Status: __eq__(self: 'Status', other: 'Status') -> bool Determines if two status are equal.   Two statues are considered equal if they are of the same Status type; if both `Status`es are `InProgress`, then their progress values must compare equal also. __ge__(self, other, NotImplemented=NotImplemented) Return a >= b.  Computed by @total_ordering from (not a < b). __gt__(self, other, NotImplemented=NotImplemented) Return a > b.  Computed by @total_ordering from (not a < b) and (a != b). __le__(self, other, NotImplemented=NotImplemented) Return a <= b.  Computed by @total_ordering from (a < b) or (a == b). __lt__(self: 'Status', other: 'Status') -> bool Determines if one `Status` is less than another one.   The `Status` ordering hierarchy is as follows:   ``` Failed < NotStarted < InProgress(x) < InProgress(y) < Succeeded # (where x is < y) ```   The `Status.__lte__`, `Status.__gt__`, and `Status.__gte__` methods are autogenerated from this method using `functools.total_ordering` and subsequently have no documentation. Data descriptors inherited from Status: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined) in_progress Determines if this `Status` is in progress or not.   This is different from a comparison to an `InProgress` because said comparison would require both `Status` to have the same `progress` values (if they are both indeed `InProgress`), while this method returns true for any `InProgress` progress value. Data and other attributes inherited from Status: __hash__ = None   class Status(builtins.object)     The `Status` class represents the status of some event. It is one of either:   - `Failed` - `NotStarted` - `InProgress(progress)` - `Succeeded`     Methods defined here: __eq__(self: 'Status', other: 'Status') -> bool Determines if two status are equal.   Two statues are considered equal if they are of the same Status type; if both `Status`es are `InProgress`, then their progress values must compare equal also. __ge__(self, other, NotImplemented=NotImplemented) Return a >= b.  Computed by @total_ordering from (not a < b). __gt__(self, other, NotImplemented=NotImplemented) Return a > b.  Computed by @total_ordering from (not a < b) and (a != b). __init__(self: 'Status') Initializes a Status, but is actually unused. Instead you should initialize one of:   - `Failed` - `NotStarted` - `InProgress(progress)` - `Succeeded` __le__(self, other, NotImplemented=NotImplemented) Return a <= b.  Computed by @total_ordering from (a < b) or (a == b). __lt__(self: 'Status', other: 'Status') -> bool Determines if one `Status` is less than another one.   The `Status` ordering hierarchy is as follows:   ``` Failed < NotStarted < InProgress(x) < InProgress(y) < Succeeded # (where x is < y) ```   The `Status.__lte__`, `Status.__gt__`, and `Status.__gte__` methods are autogenerated from this method using `functools.total_ordering` and subsequently have no documentation. Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined) in_progress Determines if this `Status` is in progress or not.   This is different from a comparison to an `InProgress` because said comparison would require both `Status` to have the same `progress` values (if they are both indeed `InProgress`), while this method returns true for any `InProgress` progress value. Data and other attributes defined here: __hash__ = None   class Succeeded(Status)     Succeeded() -&gt; 'Succeeded'   Represents that an event has succeeded.     Method resolution order: Succeeded Status builtins.object Methods defined here: __init__(self: 'Succeeded') -> 'Succeeded' Initializes a Status, but is actually unused. Instead you should initialize one of:   - `Failed` - `NotStarted` - `InProgress(progress)` - `Succeeded` __repr__(self: 'Succeeded') -> str Returns the string representation of this `Succeeded` `Status`. Methods inherited from Status: __eq__(self: 'Status', other: 'Status') -> bool Determines if two status are equal.   Two statues are considered equal if they are of the same Status type; if both `Status`es are `InProgress`, then their progress values must compare equal also. __ge__(self, other, NotImplemented=NotImplemented) Return a >= b.  Computed by @total_ordering from (not a < b). __gt__(self, other, NotImplemented=NotImplemented) Return a > b.  Computed by @total_ordering from (not a < b) and (a != b). __le__(self, other, NotImplemented=NotImplemented) Return a <= b.  Computed by @total_ordering from (a < b) or (a == b). __lt__(self: 'Status', other: 'Status') -> bool Determines if one `Status` is less than another one.   The `Status` ordering hierarchy is as follows:   ``` Failed < NotStarted < InProgress(x) < InProgress(y) < Succeeded # (where x is < y) ```   The `Status.__lte__`, `Status.__gt__`, and `Status.__gte__` methods are autogenerated from this method using `functools.total_ordering` and subsequently have no documentation. Data descriptors inherited from Status: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined) in_progress Determines if this `Status` is in progress or not.   This is different from a comparison to an `InProgress` because said comparison would require both `Status` to have the same `progress` values (if they are both indeed `InProgress`), while this method returns true for any `InProgress` progress value. Data and other attributes inherited from Status: __hash__ = None