Source code for umbra.managers.fileSystemEventsManager
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
**fileSystemEventsManager.py**
**Platform:**
Windows, Linux, Mac Os X.
**Description:**
This module defines the :class:`FileSystemEventsManager` class.
**Others:**
"""
#**********************************************************************************************************************
#*** Future imports.
#**********************************************************************************************************************
from __future__ import unicode_literals
#**********************************************************************************************************************
#*** External imports.
#**********************************************************************************************************************
import os
from PyQt4.QtCore import Qt
from PyQt4.QtCore import QThread
from PyQt4.QtCore import QTimer
from PyQt4.QtCore import pyqtSignal
#**********************************************************************************************************************
#*** Internal imports.
#**********************************************************************************************************************
import foundations.exceptions
import foundations.verbose
import umbra.exceptions
from umbra.globals.constants import Constants
#**********************************************************************************************************************
#*** Module attributes.
#**********************************************************************************************************************
__author__ = "Thomas Mansencal"
__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal"
__license__ = "GPL V3.0 - http://www.gnu.org/licenses/"
__maintainer__ = "Thomas Mansencal"
__email__ = "thomas.mansencal@gmail.com"
__status__ = "Production"
__all__ = ["LOGGER", "FileSystemEventsManager"]
LOGGER = foundations.verbose.installLogger()
#**********************************************************************************************************************
#*** Module classes and definitions.
#**********************************************************************************************************************
[docs]class FileSystemEventsManager(QThread):
"""
This class defines the file system events manager.
"""
# Custom signals definitions.
fileChanged = pyqtSignal(unicode)
"""
This signal is emited by the :class:`FileSystemEventsManager` class when a file is changed. ( pyqtSignal )
:return: Current changed file. ( String )
"""
fileInvalidated = pyqtSignal(unicode)
"""
This signal is emited by the :class:`FileSystemEventsManager` class when a file is invalidated. ( pyqtSignal )
:return: Current invalidated file. ( String )
"""
directoryChanged = pyqtSignal(unicode)
"""
This signal is emited by the :class:`FileSystemEventsManager` class when a directory is changed. ( pyqtSignal )
:return: Current changed directory. ( String )
"""
directoryInvalidated = pyqtSignal(unicode)
"""
This signal is emited by the :class:`FileSystemEventsManager` class when a directory is invalidated. ( pyqtSignal )
:return: Current invalidated directory. ( String )
"""
def __init__(self, parent=None):
"""
.. Sphinx: Statements updated for auto-documentation purpose.
"""
LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__))
QThread.__init__(self, parent)
# --- Setting class attributes. ---
self.__container = parent
self.__paths = {}
self.__timer = None
self.__timerCycleMultiplier = 5
self.__toRegisterPaths = {}
self.__toUnregisterPaths = []
#******************************************************************************************************************
#*** Attributes properties.
#******************************************************************************************************************
@property
def container(self):
"""
This method is the property for **self.__container** attribute.
:return: self.__container. ( QObject )
"""
return self.__container
@container.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def container(self, value):
"""
This method is the setter method for **self.__container** attribute.
:param value: Attribute value. ( QObject )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "container"))
@container.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def container(self):
"""
This method is the deleter method for **self.__container** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "container"))
@property
def paths(self):
"""
This method is the property for **self.__paths** attribute.
:return: self.__paths. ( Dictionary )
"""
return self.__paths
@paths.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def paths(self, value):
"""
This method is the setter method for **self.__paths** attribute.
:param value: Attribute value. ( Dictionary )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "paths"))
@paths.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def paths(self):
"""
This method is the deleter method for **self.__paths** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "paths"))
@property
def timer(self):
"""
This method is the property for **self.__timer** attribute.
:return: self.__timer. ( QTimer )
"""
return self.__timer
@timer.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def timer(self, value):
"""
This method is the setter method for **self.__timer** attribute.
:param value: Attribute value. ( QTimer )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "timer"))
@timer.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def timer(self):
"""
This method is the deleter method for **self.__timer** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "timer"))
@property
def timerCycleMultiplier(self):
"""
This method is the property for **self.__timerCycleMultiplier** attribute.
:return: self.__timerCycleMultiplier. ( Float )
"""
return self.__timerCycleMultiplier
@timerCycleMultiplier.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def timerCycleMultiplier(self, value):
"""
This method is the setter method for **self.__timerCycleMultiplier** attribute.
:param value: Attribute value. ( Float )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "timerCycleMultiplier"))
@timerCycleMultiplier.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def timerCycleMultiplier(self):
"""
This method is the deleter method for **self.__timerCycleMultiplier** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "timerCycleMultiplier"))
#******************************************************************************************************************
#*** Class methods.
#******************************************************************************************************************
def __getitem__(self, path):
"""
This method reimplements the :meth:`object.__getitem__` method.
:param path: Path name. ( String )
:return: Path. ( Path )
"""
return self.__paths.__getitem__(path)
def __iter__(self):
"""
This method reimplements the :meth:`object.__iter__` method.
:return: Paths iterator. ( Object )
"""
return self.__paths.iteritems()
def __contains__(self, path):
"""
This method reimplements the :meth:`object.__contains__` method.
:param path: Path name. ( String )
:return: Path existence. ( Boolean )
"""
return path in self.__paths.keys()
def __len__(self):
"""
This method reimplements the :meth:`object.__len__` method.
:return: Paths count. ( Integer )
"""
return len(self.__paths.keys())
[docs] def run(self):
"""
This method reimplements the :meth:`QThread.run` method.
"""
self.__timer = QTimer()
self.__timer.moveToThread(self)
self.__timer.start(Constants.defaultTimerCycle * self.__timerCycleMultiplier)
self.__timer.timeout.connect(self.__watchFileSystem, Qt.DirectConnection)
self.exec_()
def __watchFileSystem(self):
"""
This method watches the file system for paths that have been changed or invalidated on disk.
"""
for path, data in self.__paths.items():
storedModifiedTime, isFile = data
try:
if not foundations.common.pathExists(path):
LOGGER.warning(
"!> {0} | '{1}' path has been invalidated and will be unregistered!".format(self.__class__.__name__, path))
del(self.__paths[path])
if isFile:
self.fileInvalidated.emit(path)
else:
self.directoryInvalidated.emit(path)
continue
except KeyError:
LOGGER.debug("> {0} | '{1}' path has been unregistered while iterating!".format(
self.__class__.__name__, path))
continue
try:
modifiedTime = os.path.getmtime(path)
except OSError:
LOGGER.debug("> {0} | '{1}' path has been invalidated while iterating!".format(
self.__class__.__name__, path))
continue
if storedModifiedTime != modifiedTime:
self.__paths[path] = (modifiedTime, os.path.isfile(path))
LOGGER.debug("> {0} | '{1}' path has been changed!".format(self.__class__.__name__, path))
if isFile:
self.fileChanged.emit(path)
else:
self.directoryChanged.emit(path)
[docs] def listPaths(self):
"""
This method returns the registered paths.
:return: Registered paths. ( List )
"""
return sorted(self.__paths.keys())
[docs] def isPathRegistered(self, path):
"""
This method returns if the given path is registered.
:param path: Path name. ( String )
:return: Is path registered. ( Boolean )
"""
return path in self
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.PathExistsError,
#*** Sphinx: Decorator commented for auto-documentation purpose. umbra.exceptions.PathRegistrationError)
[docs] def registerPath(self, path, modifiedTime=None):
"""
This method registers given path.
:param path: Path name. ( String )
:param modifiedTime: Custom modified time. ( Integer / Float )
:return: Method success. ( Boolean )
"""
if not foundations.common.pathExists(path):
raise foundations.exceptions.PathExistsError("{0} | '{1}' path doesn't exists!".format(
self.__class__.__name__, path))
if path in self:
raise umbra.exceptions.PathRegistrationError("{0} | '{1}' path is already registered!".format(
self.__class__.__name__, path))
self.__paths[path] = (os.path.getmtime(path) if modifiedTime is None else modifiedTime, os.path.isfile(path))
return True
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(umbra.exceptions.PathExistsError)
[docs] def unregisterPath(self, path):
"""
This method unregisters given path.
:param path: Path name. ( String )
:return: Method success. ( Boolean )
"""
if not path in self:
raise umbra.exceptions.PathExistsError("{0} | '{1}' path isn't registered!".format(
self.__class__.__name__, path))
del(self.__paths[path])
return True