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`.`internet`.`inotify`.`_Watch``

class documentation

`class _Watch: (source)`

Constructor: `_Watch(path, mask, autoAdd, callbacks)`

View In Hierarchy

Watch object that represents a Watch point in the filesystem. The user should let INotify to create these objects

Method | `__init__` | Undocumented
Instance Variable | `autoAdd` | Flag that determines whether this watch point should automatically add created subdirectories
Instance Variable | `callbacks` | `list` of callback functions that will be called when an event occurs on this watch.
Instance Variable | `mask` | The events monitored by this watchpoint
Instance Variable | `path` | The path over which this watch point is monitoring
Method | `_notify` | Callback function used by `INotify` to dispatch an event.

def __init__(self, path, mask=IN_WATCH_MASK, autoAdd=False, callbacks=None): (source)

Undocumented

autoAdd = (source)

Flag that determines whether this watch point should automatically add created subdirectories

callbacks = (source)

`list` of callback functions that will be called when an event occurs on this watch.

mask = (source)

The events monitored by this watchpoint

path = (source)

The path over which this watch point is monitoring

def _notify(self, filepath, events): (source)

Callback function used by `INotify` to dispatch an event.