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`.`jelly`.`SecurityOptions``

class documentation

`class SecurityOptions: (source)`

View In Hierarchy

This will by default disallow everything, except for 'none'.

Method | `__init__` | SecurityOptions() initialize.
Method | `allowBasicTypes` | Allow all `basic' types. (Dictionary and list. Int, string, and float are implicitly allowed.)
Method | `allowInstancesOf` | SecurityOptions.allowInstances(klass, klass, ...): allow instances of the specified classes
Method | `allowModules` | SecurityOptions.allowModules(module, module, ...): allow modules by name. This will also allow the 'module' type.
Method | `allowTypes` | SecurityOptions.allowTypes(typeString): Allow a particular type, by its name.
Method | `isClassAllowed` | SecurityOptions.isClassAllowed(class) -> boolean Assumes the module has already been allowed. Returns 1 if the given class is allowed, 0 otherwise.
Method | `isModuleAllowed` | SecurityOptions.isModuleAllowed(moduleName) -> boolean returns 1 if a module by that name is allowed, 0 otherwise
Method | `isTypeAllowed` | SecurityOptions.isTypeAllowed(typeName) -> boolean Returns 1 if the given type is allowed, 0 otherwise.
Class Variable | `basicTypes` | Undocumented
Instance Variable | `allowedClasses` | Undocumented
Instance Variable | `allowedModules` | Undocumented
Instance Variable | `allowedTypes` | Undocumented

def __init__(self): (source)

SecurityOptions() initialize.

def allowBasicTypes(self): (source)

Allow all `basic' types. (Dictionary and list. Int, string, and float are implicitly allowed.)

def allowInstancesOf(self, *classes): (source)

SecurityOptions.allowInstances(klass, klass, ...): allow instances of the specified classes

This will also allow the 'instance', 'class' (renamed 'classobj' in Python 2.3), and 'module' types, as well as basic types.

def allowModules(self, *modules): (source)

SecurityOptions.allowModules(module, module, ...): allow modules by name. This will also allow the 'module' type.

def allowTypes(self, *types): (source)

SecurityOptions.allowTypes(typeString): Allow a particular type, by its name.

def isClassAllowed(self, klass): (source)

SecurityOptions.isClassAllowed(class) -> boolean Assumes the module has already been allowed. Returns 1 if the given class is allowed, 0 otherwise.

def isModuleAllowed(self, moduleName): (source)

SecurityOptions.isModuleAllowed(moduleName) -> boolean returns 1 if a module by that name is allowed, 0 otherwise

def isTypeAllowed(self, typeName): (source)

SecurityOptions.isTypeAllowed(typeName) -> boolean Returns 1 if the given type is allowed, 0 otherwise.

basicTypes: `list[str]` = (source)

Undocumented

allowedClasses: `dict` = (source)

Undocumented

allowedModules: `dict` = (source)

Undocumented

allowedTypes: `dict[bytes, int]` = (source)

Undocumented