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`.`persisted`.`sob``

module documentation
(source)

Save and load Small OBjects to and from files, using various formats.

Maintainer: Moshe Zadka

Interface | `IPersistable` | An object which can be saved in several formats to a file
Class | `Persistent` | No class docstring; 0/3 instance variable, 2/6 methods documented
Function | `guessType` | Undocumented
Function | `load` | Load an object from a file.
Function | `loadValueFromFile` | Load the value of a variable in a Python file.
Class | `_EverythingEphemeral` | No class docstring; 0/1 instance variable, 0/1 class variable, 1/2 method documented

def guessType(filename): (source)

Undocumented

def load(filename, style): (source)

Load an object from a file.

Deserialize an object from a file. The file can be encrypted.

Parameters
filename | string
style | string (one of 'pickle' or 'source')

def loadValueFromFile(filename, variable): (source)

Load the value of a variable in a Python file.

Run the contents of the file in a namespace and return the result of the variable named `variable`.

Parameters
filename | string
variable | string