diff -r 9986ec0e559a -r 10516539f238 VCS/StatusMonitorThread.py
--- a/VCS/StatusMonitorThread.py Tue Oct 15 22:03:54 2013 +0200
+++ b/VCS/StatusMonitorThread.py Fri Oct 18 23:00:41 2013 +0200
@@ -17,8 +17,8 @@
Class implementing the VCS status monitor thread base class.
@signal vcsStatusMonitorData(list of str) emitted to update the VCS status
- @signal vcsStatusMonitorStatus(str, str) emitted to signal the status of the
- monitoring thread (ok, nok, op) and a status message
+ @signal vcsStatusMonitorStatus(str, str) emitted to signal the status of
+ the monitoring thread (ok, nok, op) and a status message
"""
vcsStatusMonitorData = pyqtSignal(list)
vcsStatusMonitorStatus = pyqtSignal(str, str)
@@ -59,7 +59,8 @@
while not self.__stopIt:
# perform the checking task
self.statusList = []
- self.vcsStatusMonitorStatus.emit("wait", self.trUtf8("Waiting for lock"))
+ self.vcsStatusMonitorStatus.emit(
+ "wait", self.trUtf8("Waiting for lock"))
try:
locked = self.vcs.vcsExecutionMutex.tryLock(5000)
except TypeError:
@@ -75,7 +76,8 @@
status = "ok"
else:
status = "nok"
- self.vcsStatusMonitorStatus.emit("send", self.trUtf8("Sending data"))
+ self.vcsStatusMonitorStatus.emit(
+ "send", self.trUtf8("Sending data"))
self.vcsStatusMonitorData.emit(self.statusList)
self.vcsStatusMonitorStatus.emit(status, statusMsg)
else:
@@ -90,7 +92,8 @@
# wait until interval has expired checking for a stop condition
self.monitorMutex.lock()
if not self.__stopIt:
- self.monitorCondition.wait(self.monitorMutex, self.interval * 1000)
+ self.monitorCondition.wait(
+ self.monitorMutex, self.interval * 1000)
self.monitorMutex.unlock()
self._shutdown()
@@ -167,10 +170,10 @@
"""
Protected method implementing the real monitoring action.
- This method must be overridden and populate the statusList member variable
- with a list of strings giving the status in the first column and the
- path relative to the project directory starting with the third column.
- The allowed status flags are:
+ This method must be overridden and populate the statusList member
+ variable with a list of strings giving the status in the first column
+ and the path relative to the project directory starting with the
+ third column. The allowed status flags are:
<ul>
<li>"A" path was added but not yet comitted</li>
<li>"M" path has local changes</li>
@@ -181,8 +184,10 @@
<li>" " path is back at normal</li>
</ul>
- @return tuple of flag indicating successful operation (boolean) and
+ @ireturn tuple of flag indicating successful operation (boolean) and
a status message in case of non successful operation (string)
+ @exception RuntimeError to indicate that this method must be
+ implemented by a subclass
"""
raise RuntimeError('Not implemented')
