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`.`CopiedFailure``

exception documentation

`class CopiedFailure(RemoteCopy, failure.Failure): (source)`

View In Hierarchy

A `CopiedFailure` is a `pb.RemoteCopy` of a `failure.Failure` transferred via PB.

Method | `printTraceback` | Emulate Python's standard error reporting mechanism.
Method | `throwExceptionIntoGenerator` | Throw the original exception into the given generator, preserving traceback information if available. In the case of a `CopiedFailure` where the exception type is a string, a `pb.RemoteError` is thrown instead.
Instance Variable | `traceback` | The remote traceback.
Instance Variable | `type` | The full import path of the exception class which was raised on the remote end.
Instance Variable | `value` | A str() representation of the remote value.

Inherited from `RemoteCopy`:

Method | `setCopyableState` | I will be invoked with the state to copy locally.
Method | `unjellyFor` | Perform the inverse operation of `Jellyable.jellyFor`.
Instance Variable | `__dict__` | Undocumented

Inherited from `Unjellyable` (via `RemoteCopy`):

Method | `setStateFor` | Undocumented

Inherited from `Failure` (via `RemoteCopy`, `Unjellyable`):

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 | `raiseException` | raise the original exception, preserving traceback information if available.
Method | `trap` | Trap this failure if its type is in a predetermined list.
Class Variable | `pickled` | 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
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

def printTraceback(self, file=None, elideFrameworkCode=0, detail='default'): (source)
overrides `twisted.python.failure.Failure.printTraceback`

Emulate Python's standard error reporting mechanism.

Parameters
file | If specified, a file-like object to which to write the traceback.
elideFrameworkCode | A flag indicating whether to attempt to remove uninteresting frames from within Twisted itself from the output.
detail | A string indicating how much information to include in the traceback. Must be one of `'brief'`, `'default'`, or `'verbose'`.

def throwExceptionIntoGenerator(self, g): (source)
overrides `twisted.python.failure.Failure.throwExceptionIntoGenerator`

Throw the original exception into the given generator, preserving traceback information if available. In the case of a `CopiedFailure` where the exception type is a string, a `pb.RemoteError` is thrown instead.

Returns
The next value yielded from the generator.
Raises
`StopIteration` | If there are no more values in the generator.
`RemoteError` | The wrapped remote exception.

traceback: `str` = (source)

The remote traceback.

type: `str` = (source)
overrides `twisted.python.failure.Failure.type`

The full import path of the exception class which was raised on the remote end.

value: `CopiedFailure` or `str` = (source)
overrides `twisted.python.failure.Failure.value`

A str() representation of the remote value.