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`.`mail`.`mail`.`FileMonitoringService``

class documentation

`class FileMonitoringService(internet.TimerService): (source)`

View In Hierarchy

A service for monitoring changes to files.

Method | `__init__` | Initialize the file monitoring service.
Method | `monitorFile` | Start monitoring a file for changes.
Method | `startService` | Start the file monitoring service.
Method | `stopService` | Stop the file monitoring service.
Method | `unmonitorFile` | Stop monitoring a file.
Instance Variable | `files` | Information about files to be monitored. Each list entry provides the following information for a file: interval in seconds between checks, filename, callback function, time of last modification to the file.
Instance Variable | `index` | The index of the next file to be checked.
Instance Variable | `intervals` | Intervals between successive file checks.
Method | `_monitor` | Monitor a file and make a callback if it has changed.
Method | `_setupMonitor` | Schedule the next monitoring call.
Instance Variable | `_call` | The next scheduled call to check a file.

Inherited from `TimerService`:

Class Variable | `volatile` | Undocumented
Instance Variable | `call` | Function and arguments to call periodically.
Instance Variable | `clock` | Source of time. This defaults to `None` which is causes `twisted.internet.reactor` to be used. Feel free to set this to something else, but it probably ought to be set *before* calling `startService`.
Instance Variable | `step` | Undocumented
Method | `_failed` | Undocumented
Instance Variable | `_loop` | Undocumented
Instance Variable | `_loopFinished` | Undocumented

Inherited from `_VolatileDataService` (via `TimerService`):

Method | `__getstate__` | Undocumented

Inherited from `Service` (via `TimerService`, `_VolatileDataService`):

Method | `disownServiceParent` | Use this API to remove an `IService` from an `IServiceCollection`.
Method | `privilegedStartService` | Do preparation work for starting the service.
Method | `setName` | Set the name of the service.
Method | `setServiceParent` | Set the parent of the service. This method is responsible for setting the `parent` attribute on this service (the child service).
Instance Variable | `name` | A `str` which is the name of the service or `None`.
Instance Variable | `parent` | An `IServiceCollection` which is the parent or `None`.
Instance Variable | `running` | A `boolean` which indicates whether the service is running.

def __init__(self): (source)
overrides `twisted.application.internet.TimerService.__init__`

Initialize the file monitoring service.

def monitorFile(self, name, callback, interval=10): (source)

Start monitoring a file for changes.

Parameters
name:`bytes` | The name of a file to monitor.
callback:callable which takes a `bytes` argument | The function to call when the file has changed.
interval:`float` | The interval in seconds between checks.

def startService(self): (source)
from `twisted.application.service.IService`
overrides `twisted.application.internet.TimerService.startService`

Start the file monitoring service.

def stopService(self): (source)
from `twisted.application.service.IService`
overrides `twisted.application.internet.TimerService.stopService`

Stop the file monitoring service.

def unmonitorFile(self, name): (source)

Stop monitoring a file.

Parameters
name:`bytes` | A file name.

files: `list` of `list` of (1) `float`, (2) `bytes`, (3) callable which takes a `bytes` argument, (4) `float` = (source)

Information about files to be monitored. Each list entry provides the following information for a file: interval in seconds between checks, filename, callback function, time of last modification to the file.

index: `int` = (source)

The index of the next file to be checked.

intervals: `_IntervalDifferentialIterator` = (source)

Intervals between successive file checks.

def _monitor(self): (source)

Monitor a file and make a callback if it has changed.

def _setupMonitor(self): (source)

Schedule the next monitoring call.

_call: `IDelayedCall` provider = (source)

The next scheduled call to check a file.