QFileSystemWatcher¶
The
QFileSystemWatcher
class provides an interface for monitoring files and directories for modifications. More…
Synopsis¶
Functions¶
def
addPath
(file)def
addPaths
(files)def
directories
()def
files
()def
removePath
(file)def
removePaths
(files)
Detailed Description¶
QFileSystemWatcher
monitors the file system for changes to files and directories by watching a list of specified paths.Call
addPath()
to watch a particular file or directory. Multiple paths can be added using theaddPaths()
function. Existing paths can be removed by using theremovePath()
andremovePaths()
functions.
QFileSystemWatcher
examines each path added to it. Files that have been added to theQFileSystemWatcher
can be accessed using thefiles()
function, and directories using thedirectories()
function.The
fileChanged()
signal is emitted when a file has been modified, renamed or removed from disk. Similarly, thedirectoryChanged()
signal is emitted when a directory or its contents is modified or removed. Note thatQFileSystemWatcher
stops monitoring files once they have been renamed or removed from disk, and directories once they have been removed from disk.
- class PySide2.QtCore.QFileSystemWatcher([parent=None])¶
PySide2.QtCore.QFileSystemWatcher(paths[, parent=None])
- param parent:
- param paths:
list of strings
Constructs a new file system watcher object with the given
parent
.Constructs a new file system watcher object with the given
parent
which monitors the specifiedpaths
list.
- PySide2.QtCore.QFileSystemWatcher.addPath(file)¶
- Parameters:
file – str
- Return type:
bool
Adds
path
to the file system watcher ifpath
exists. The path is not added if it does not exist, or if it is already being monitored by the file system watcher.If
path
specifies a directory, thedirectoryChanged()
signal will be emitted whenpath
is modified or removed from disk; otherwise thefileChanged()
signal is emitted whenpath
is modified, renamed or removed.If the watch was successful, true is returned.
Reasons for a watch failure are generally system-dependent, but may include the resource not existing, access failures, or the total watch count limit, if the platform has one.
Note
There may be a system dependent limit to the number of files and directories that can be monitored simultaneously. If this limit is been reached,
path
will not be monitored, and false is returned.See also
- PySide2.QtCore.QFileSystemWatcher.addPaths(files)¶
- Parameters:
files – list of strings
- Return type:
list of strings
Adds each path in
paths
to the file system watcher. Paths are not added if they not exist, or if they are already being monitored by the file system watcher.If a path specifies a directory, the
directoryChanged()
signal will be emitted when the path is modified or removed from disk; otherwise thefileChanged()
signal is emitted when the path is modified, renamed, or removed.The return value is a list of paths that could not be watched.
Reasons for a watch failure are generally system-dependent, but may include the resource not existing, access failures, or the total watch count limit, if the platform has one.
Note
There may be a system dependent limit to the number of files and directories that can be monitored simultaneously. If this limit has been reached, the excess
paths
will not be monitored, and they will be added to the returnedQStringList
.See also
- PySide2.QtCore.QFileSystemWatcher.directories()¶
- Return type:
list of strings
Returns a list of paths to directories that are being watched.
See also
- PySide2.QtCore.QFileSystemWatcher.files()¶
- Return type:
list of strings
Returns a list of paths to files that are being watched.
See also
- PySide2.QtCore.QFileSystemWatcher.removePath(file)¶
- Parameters:
file – str
- Return type:
bool
Removes the specified
path
from the file system watcher.If the watch is successfully removed, true is returned.
Reasons for watch removal failing are generally system-dependent, but may be due to the path having already been deleted, for example.
See also
- PySide2.QtCore.QFileSystemWatcher.removePaths(files)¶
- Parameters:
files – list of strings
- Return type:
list of strings
Removes the specified
paths
from the file system watcher.The return value is a list of paths which were not able to be unwatched successfully.
Reasons for watch removal failing are generally system-dependent, but may be due to the path having already been deleted, for example.
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.