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`.`trial`.`reporter`.`MinimalReporter``

class documentation

`class MinimalReporter(Reporter): (source)`

View In Hierarchy

A minimalist reporter that prints only a summary of the test result, in the form of (timeTaken, #tests, #tests, #errors, #failures, #skips).

Method | `_printErrors` | Don't print a detailed summary of errors. We only care about the counts.
Method | `_printSummary` | Print out a one-line summary of the form: '%(runtime) %(number_of_tests) %(number_of_tests) %(num_errors) %(num_failures) %(num_skips)'

Inherited from `Reporter`:

Method | `__init__` | Undocumented
Method | `addError` | Called when a test raises an error. If `realtime` is set, then it prints the error to the stream.
Method | `addFailure` | Called when a test fails. If `realtime` is set, then it prints the error to the stream.
Method | `cleanupErrors` | Undocumented
Method | `done` | Summarize the result of the test run.
Method | `startTest` | Called when a test begins to run. Records the time when it was first called and resets the warning cache.
Method | `upDownError` | Undocumented
Instance Variable | `realtime` | Undocumented
Instance Variable | `tbformat` | Undocumented
Method | `_formatFailureTraceback` | Undocumented
Method | `_getSummary` | Return a formatted count of tests status results.
Method | `_groupResults` | Group tests together based on their results.
Method | `_observeWarnings` | Observe warning events and write them to `self._stream`.
Method | `_printExpectedFailure` | Undocumented
Method | `_printResults` | Print a group of errors to the stream.
Method | `_printUnexpectedSuccess` | Undocumented
Method | `_trimFrames` | Trim frames to remove internal paths.
Method | `_write` | Safely write to the reporter's stream.
Method | `_writeln` | Safely write a line to the reporter's stream. Newline is appended to the format string.
Class Variable | `_doubleSeparator` | Undocumented
Class Variable | `_separator` | Undocumented
Instance Variable | `_publisher` | The log publisher which will be observed for warning events.
Instance Variable | `_startTime` | The time when the first test was started. It defaults to `None`, which means that no test was actually launched.
Instance Variable | `_stream` | Undocumented
Instance Variable | `_warningCache` | A `set` of tuples of warning message (file, line, text, category) which have already been written to the output stream during the currently executing test. This is used to avoid writing duplicates of the same warning to the output stream.

Inherited from `TestResult` (via `Reporter`):

Method | `__repr__` | Undocumented
Method | `addExpectedFailure` | Report that the given test failed, and was expected to do so.
Method | `addSkip` | Report that the given test was skipped.
Method | `addSuccess` | Report that the given test succeeded.
Method | `addUnexpectedSuccess` | Report that the given test succeeded against expectations.
Method | `stopTest` | This must be called after the given test is completed.
Method | `wasSuccessful` | Report whether or not this test suite was successful or not.
Instance Variable | `expectedFailures` | Undocumented
Instance Variable | `skips` | Undocumented
Instance Variable | `successes` | count the number of successes achieved by the test run.
Instance Variable | `unexpectedSuccesses` | Undocumented
Method | `_getFailure` | Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.
Method | `_getTime` | Undocumented
Constant | `_DEFAULT_TODO` | Undocumented
Instance Variable | `_lastTime` | Undocumented
Instance Variable | `_testStarted` | Undocumented
Instance Variable | `_timings` | Undocumented

def _printErrors(self): (source)
overrides `twisted.trial.reporter.Reporter._printErrors`

Don't print a detailed summary of errors. We only care about the counts.

def _printSummary(self): (source)
overrides `twisted.trial.reporter.Reporter._printSummary`

Print out a one-line summary of the form: '%(runtime) %(number_of_tests) %(number_of_tests) %(num_errors) %(num_failures) %(num_skips)'