FileMonitor

class FileMonitor(**properties: Any)

Superclasses: Object

Constructors:

FileMonitor(**properties)

Methods

class FileMonitor

cancel() → bool

Cancels a file monitor.

emit_event(child: File, other_file: File, event_type: FileMonitorEvent) → None

Emits the FileMonitor::changed signal if a change has taken place. Should be called from file monitor implementations only.

Implementations are responsible to call this method from the [thread-default main context][g-main-context-push-thread-default] of the thread that the monitor was created in.

Parameters:

• child – a File.

• other_file – a File.

• event_type – a set of FileMonitorEvent flags.

is_cancelled() → bool

Returns whether the monitor is canceled.

set_rate_limit(limit_msecs: int) → None

Sets the rate limit to which the monitor will report consecutive change events to the same file.

Parameters:

limit_msecs – a non-negative integer with the limit in milliseconds to poll for changes

Properties

class FileMonitor

props.cancelled: bool

Whether the monitor has been cancelled.

props.rate_limit: int

The limit of the monitor to watch for changes, in milliseconds.

Signals

class FileMonitor.signals

changed(file: File, other_file: File | None, event_type: FileMonitorEvent) → None

Emitted when file has been changed.

If using WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), event_type may be RENAMED, MOVED_IN or MOVED_OUT.

In all cases file will be a child of the monitored directory. For renames, file will be the old name and other_file is the new name. For “moved in” events, file is the name of the file that appeared and other_file is the old name that it was moved from (in another directory). For “moved out” events, file is the name of the file that used to be in this directory and other_file is the name of the file at its new location.

It makes sense to treat MOVED_IN as equivalent to CREATED and MOVED_OUT as equivalent to DELETED, with extra information. RENAMED is equivalent to a delete/create pair. This is exactly how the events will be reported in the case that the WATCH_MOVES flag is not in use.

If using the deprecated flag SEND_MOVED flag and event_type is MOVED, file will be set to a File containing the old path, and other_file will be set to a File containing the new path.

In all the other cases, other_file will be set to None.

Parameters:

• file – a File.

• other_file – a File or None.

• event_type – a FileMonitorEvent.

Virtual Methods

class FileMonitor

do_cancel() → bool

Cancels a file monitor.

do_changed(file: File, other_file: File, event_type: FileMonitorEvent) → None

Parameters:

• file

• other_file

• event_type

Fields

class FileMonitor

parent_instance

priv