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”:
Search in specific fields. The following search matches all objects
in "twisted.mail" that matches “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”:
Results provided by Lunr.js
class LogBeginner: (source)
LogBeginner holds state related to logging before logging has begun, and begins logging when told to do so. Logging "begins" when someone has selected a set of observers, like, for example, a
FileLogObserver that writes to a file on disk, or to standard output.
Applications will not typically need to instantiate this class, except those which intend to initialize the global logging system themselves, which may wish to instantiate this for testing. The global instance for the current process is exposed as
Before logging has begun, a
- Log any critical messages (e.g.: unhandled exceptions) to the given file-like object.
- Save (a limited number of) log events in a
||Begin logging to the given set of observers. This will:|
||Twisted-enabled wrapper around
||The default size for the initial log events buffer.|
||A buffer of messages logged before logging began.|
||The logger used to log messages about the operation of the
||The log publisher passed in to
||An object with stderr and stdout attributes (like the
Optional[= None): (source) ¶
|initial||The size of the event buffer into which events are collected until beginLoggingTo is called. Or None to use the default size.|
bool= False, redirectStandardIO:
bool= True): (source) ¶
Begin logging to the given set of observers. This will:
- Add all the observers given in observers to the
LogPublisherassociated with this
- Optionally re-direct standard output and standard error streams to the logging system.
- Re-play any messages that were previously logged to that publisher to the new observers, if discardBuffer is not set.
- Stop logging critical errors from the
LogPublisheras strings to the errorStream associated with this
LogBeginner, and allow them to be logged normally.
- Re-direct warnings from the
warningsmodule associated with this
LogBeginnerto log messages.
|observers:||The observers to register.|
|discard||Whether to discard the buffer and not re-play it to the added observers. (This argument is provided mainly for compatibility with legacy concerns.)|
|redirect||If true, redirect standard output and standard error to the observers.|
|Since a |
Optional[= None, line:
Optional[= None): (source) ¶
Twisted-enabled wrapper around
|message:||A warning message to emit.|
|category:||A warning category to associate with message.|
|filename:||A file name for the source code file issuing the warning.|
|lineno:||A line number in the source file where the warning was issued.|
|file:||A file to write the warning message to. If |
|line:||A line of source code to include with the warning message. If |
An object with stderr and stdout attributes (like the
sys module) which will be replaced when redirecting standard I/O.