restarable, standalone workers

* workers can work without the OverlayProgressWidget
* workers can be restarted
* documentation updates
* thread(s) in OverlayProgressWidget renamed to worker(s) to avoid
confusion what is really set

Author: kaotika

examples/ThreadedExample.py

@@ -59,7 +59,7 @@ def initUI(self):
             threads.append(thread)
             worker.finished.connect(self.debugPrint)
 
-        self.pgFrame = OverlayProgressWidget(self.imgContainer, threads=workers)
+        self.pgFrame = OverlayProgressWidget(self.imgContainer, workers=workers)
 
         for t in threads:
             t.start()

pandasqt/models/ProgressThread.py

@@ -1,29 +1,53 @@
 from pandasqt.compat import QtCore, QtGui, Qt, Signal, Slot
 
-
 class ProgressWorker(QtCore.QObject):
-    progressChanged = Signal(int)
+    
+    progressChanged = Signal(int)       # set value of OverlayProgressView
     finished = Signal()
 
     def __init__(self, name):
+        """Worker object that will be passed to the thread.
+        
+        Args:
+            name (str): name shown in progress ui.
+
+        """
         super(ProgressWorker, self).__init__()
         self.name = name
 
     @Slot()
     def doWork(self):
+        """start the thread"""
         self.run()
         # emit the result of the operation?
         self.finished.emit()
 
     def run(self):
+        """Implement your job here. This is what the thread will do.
+        
+        """
         raise NotImplemented
 
 
 
-def createThread(parent, worker):
+def createThread(parent, worker, deleteWorkerLater=False):
+    """Create a new thread for given worker.
+    
+    Args:
+        parent (QObject): parent of thread and worker.
+        worker (ProgressWorker): worker to use in thread.
+        deleteWorkerLater (bool, optional): delete the worker if thread finishes.
+
+    Returns:
+        QThread
+
+    """
     thread = QtCore.QThread(parent)
     thread.started.connect(worker.doWork)
-    thread.finished.connect(worker.deleteLater)
-
+    worker.finished.connect(thread.quit)
+    if deleteWorkerLater:
+        thread.finished.connect(worker.deleteLater)
+    
     worker.moveToThread(thread)
+    worker.setParent(parent)
     return thread

pandasqt/views/OverlayProgressView.py

@@ -1,21 +1,21 @@
 from pandasqt.compat import QtCore, QtGui, Qt, Signal, Slot
 
 class OverlayProgressWidget(QtGui.QFrame):
-    def __init__(self, parent, threads=[], debug=True):
+    def __init__(self, parent, workers=[], debug=True, margin=0):
         super(OverlayProgressWidget, self).__init__(parent)
         self._debug = debug
-        self._threads = threads
+        self._workers = workers
         self._detailProgressBars = []
         self._addedBars = 0
         self._minHeight = 50
-        self._width = parent.width() / 3
-        self._margin = 20
+        self._width = parent.width() * 0.38
+        self._margin = margin
         self._totalProgress = 0
 
         self.initUi()
 
-        for thread in threads:
-            self._addProgressBar(thread)
+        for worker in workers:
+            self._addProgressBar(worker)
 
 
     def initUi(self):
@@ -39,29 +39,29 @@ def initUi(self):
         self.glayout.addWidget(self.totalProgressBar, 0, 0, 1, 1)
         self.glayout.addWidget(self.toggleButton, 0, 1, 1, 1)
 
-        styleSheet = """.QProgressBar {
-            border: none;
-            border-radius: 3px;
-            text-align: center;
-            background-color: rgba(37, 37, 37, 50%);
-            color: white;
-            margin: 1px;
-            border-bottom-left-radius:5px;
-            border-top-left-radius:5px;
-        }
-
-        .QProgressBar::chunk {
-            background-color: #05B8CC;
-            border-radius: 3px;
-        }
-
-        .OverlayProgressWidget {
-            background-color: white;
-        }
-
-        """
-        # set stylesheet for all progressbars in this widget
-        self.setStyleSheet(styleSheet)
+        #styleSheet = """.QProgressBar {
+            #border: none;
+            #border-radius: 3px;
+            #text-align: center;
+            #background-color: rgba(37, 37, 37, 50%);
+            #color: white;
+            #margin: 1px;
+            #border-bottom-left-radius:5px;
+            #border-top-left-radius:5px;
+        #}
+
+        #.QProgressBar::chunk {
+            #background-color: #05B8CC;
+            #border-radius: 3px;
+        #}
+
+        #.OverlayProgressWidget {
+            #background-color: white;
+        #}
+
+        #"""
+        ## set stylesheet for all progressbars in this widget
+        #self.setStyleSheet(styleSheet)
 
         parent = self.parent()
         xAnchor = parent.width() - self._width - self._margin
@@ -91,11 +91,15 @@ def _addProgressBar(self, worker):
         self._detailProgressBars.append((progressBar, label))
         worker.progressChanged.connect(progressBar.setValue)
         worker.progressChanged.connect(self.calculateTotalProgress)
-
-
-    def addThread(self, thread):
-        self._threads.append(thread)
-        self._addProgressBar(thread)
+        
+        worker.progressChanged.connect(self.debugProgressChanged)
+        
+    def debugProgressChanged(self, value):
+        print "debugProgressChanged", value
+
+    def addWorker(self, worker):
+        self._workers.append(worker)
+        self._addProgressBar(worker)
         self.resizeFrame()
 
     def resizeFrame(self):

setup.py

@@ -65,7 +65,7 @@ def run_tests(self):
     install_requires=['pandas>=0.15.1', 'chardet', 'pytest', 'pytest-qt==1.2.2', 'pytest-cov'],
     cmdclass={'test': PyTest},
     author_email='m.Ludwig@datalyze-solutions.com',
-    description='catches exceptions inside qt applications and writes them to a message box and into a log file',
+    description='Utilities to use pandas (the data analysis / manipulation library for Python) with Qt.',
     long_description=long_description,
     packages=['pandasqt'],
     include_package_data=True,