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`.`conch`.`interfaces`.`ISessionSetEnv``

interface documentation

`class ISessionSetEnv(Interface): (source)`

View In Hierarchy

A session that can set environment variables.

Method | `setEnv` | Set an environment variable for the shell or command to be started.

def setEnv(name, value): (source)

Set an environment variable for the shell or command to be started.

From RFC 4254, section 6.4: "Uncontrolled setting of environment variables in a privileged process can be a security hazard. It is recommended that implementations either maintain a list of allowable variable names or only set environment variables after the server process has dropped sufficient privileges."

(OpenSSH refuses all environment variables by default, but has an `AcceptEnv` configuration option to select specific variables to accept.)

Parameters
name:`bytes` | The name of the environment variable to set.
value:`bytes` | The value of the environment variable to set.
Raises
`EnvironmentVariableNotPermitted` | if setting this environment variable is not permitted.