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`.`python`.`_inotify``

module documentation
(source)

Very low-level ctypes-based interface to Linux inotify(7).

ctypes and a version of libc which supports inotify system calls are required.

Exception | `INotifyError` | Unify all the possible exceptions that can be raised by the INotify API.
Function | `add` | Add a watch for the given path to the inotify file descriptor, and return the watch descriptor.
Function | `init` | Create an inotify instance and return the associated file descriptor.
Function | `initializeModule` | Initialize the module, checking if the expected APIs exist and setting the argtypes and restype for `inotify_init`, `inotify_add_watch`, and `inotify_rm_watch`.
Function | `remove` | Remove the given watch descriptor from the inotify file descriptor.
Variable | `libc` | Undocumented
Variable | `name` | Undocumented

def add(fd: `int`, path: `FilePath[Any]`, mask: `int`) -> `int`: (source)

Add a watch for the given path to the inotify file descriptor, and return the watch descriptor.

Parameters
fd:`int` | The file descriptor returned by `libc.inotify_init`.
path:`FilePath[Any]` | The path to watch via inotify.
mask:`int` | Bitmask specifying the events that inotify should monitor.
Returns
`int` | Undocumented

def init() -> `int`: (source)

Create an inotify instance and return the associated file descriptor.

def initializeModule(libc: `ctypes.CDLL`): (source)

Initialize the module, checking if the expected APIs exist and setting the argtypes and restype for `inotify_init`, `inotify_add_watch`, and `inotify_rm_watch`.

def remove(fd: `int`, wd: `int`): (source)

Remove the given watch descriptor from the inotify file descriptor.

libc = (source)

Undocumented

name = (source)

Undocumented