Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`spread`.`pb`.`CopyableFailure``

exception documentation

`class CopyableFailure(failure.Failure, Copyable): (source)`

View In Hierarchy

A `flavors.RemoteCopy` and `flavors.Copyable` version of `twisted.python.failure.Failure` for serialization.

Method | `getStateToCopy` | Collect state related to the exception which occurred, discarding state which cannot reasonably be serialized.
Class Variable | `unsafeTracebacks` | Undocumented

Inherited from `Failure`:

Method | `__getstate__` | Avoid pickling objects in the traceback.
Method | `__init__` | Initialize me with an explanation of the error.
Method | `__repr__` | Undocumented
Method | `__str__` | Undocumented
Method | `check` | Check if this failure's type is in a predetermined list.
Method | `cleanFailure` | Remove references to other objects, replacing them with strings.
Method | `getBriefTraceback` | Undocumented
Method | `getErrorMessage` | Get a string of the exception which caused this Failure.
Method | `getTraceback` | Undocumented
Method | `getTracebackObject` | Get an object that represents this Failure's stack that can be passed to traceback.extract_tb.
Method | `printBriefTraceback` | Print a traceback as densely as possible.
Method | `printDetailedTraceback` | Print a traceback with detailed locals and globals information.
Method | `printTraceback` | Emulate Python's standard error reporting mechanism.
Method | `raiseException` | raise the original exception, preserving traceback information if available.
Method | `throwExceptionIntoGenerator` | Throw the original exception into the given generator, preserving traceback information if available.
Method | `trap` | Trap this failure if its type is in a predetermined list.
Class Variable | `pickled` | Undocumented
Instance Variable | `__dict__` | Undocumented
Instance Variable | `captureVars` | Undocumented
Instance Variable | `count` | Undocumented
Instance Variable | `frames` | list of frames, innermost first.
Instance Variable | `parents` | Undocumented
Instance Variable | `stack` | list of frames, innermost last, excluding `Failure.__init__`.
Instance Variable | `tb` | Undocumented
Instance Variable | `type` | The exception's class.
Instance Variable | `value` | The exception instance responsible for this failure.
Class Method | `_findFailure` | Find the failure that represents the exception currently in context.
Method | `_extrapolate` | Extrapolate from one failure into another, copying its stack frames.
Class Variable | `_yieldOpcode` | Undocumented

Inherited from `Copyable` (via `Failure`):

Method | `getStateToCopyFor` | Gather state to send when I am serialized for a particular perspective.
Method | `getTypeToCopy` | Determine what type tag to send for me.
Method | `getTypeToCopyFor` | Determine what type tag to send for me.
Method | `jellyFor` | Assemble type tag and state to copy for this broker.

Inherited from `Serializable` (via `Failure`, `Copyable`):

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable` (via `Failure`, `Copyable`, `Serializable`):

Method | `getStateFor` | Undocumented

def getStateToCopy(self): (source)
overrides `twisted.spread.pb.Copyable.getStateToCopy`

Collect state related to the exception which occurred, discarding state which cannot reasonably be serialized.

unsafeTracebacks: `int` = (source)

Undocumented