1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
#!/usr/bin/env python
#############################################################################
##
## Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
## Contact: http://www.qt-project.org/legal
##
## This file is part of the release tools of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and Digia. For licensing terms and
## conditions see http://qt.digia.com/licensing. For further information
## use the contact form at http://qt.digia.com/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 2.1 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL included in the
## packaging of this file. Please review the following information to
## ensure the GNU Lesser General Public License version 2.1 requirements
## will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
##
## In addition, as a special exception, Digia gives you certain additional
## rights. These rights are described in the Digia Qt LGPL Exception
## version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3.0 as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL included in the
## packaging of this file. Please review the following information to
## ensure the GNU General Public License version 3.0 requirements will be
## met: http://www.gnu.org/copyleft/gpl.html.
##
##
## $QT_END_LICENSE$
##
#############################################################################
# import the print function which is used in python 3.x
from __future__ import print_function
import itertools
# to get the cpu number
import multiprocessing
import os
import threading
import traceback
import time
import Queue as queue # The Queue module has been renamed to queue in Python 3.
import sys
import __builtin__
# we are using RLock, because threadedPrint is using the same lock
outputLock = threading.RLock()
outputStates = None
outputFormatString = ''
# prepare our std output hooks
class StdOutHook:
def write(self, text):
# general print method sends line break just ignore that
strippedText = text.strip()
if strippedText == "":
return
global outputStates
global outputFormatString
localProgressIndicator = None
if len(strippedText) > 6:
localProgressIndicator = nextProgressIndicator()
else:
localProgressIndicator = strippedText
newValue = "{:d}: {}".format(threadData.taskNumber, localProgressIndicator)
with outputLock:
if newValue != outputStates[threadData.workerThreadId]:
oldOutput = "\r" + outputFormatString.format(*outputStates).strip()
outputStates[threadData.workerThreadId] = newValue
newOutput = "\r" + outputFormatString.format(*outputStates).strip()
# cleanup old output if the new line is shorter
cleanerString = ""
if len(oldOutput) > len(newOutput):
cleanerString = " " * (len(oldOutput) - len(newOutput))
sys.__stdout__.write(newOutput + cleanerString)
class StdErrHook:
def write(self, text):
with outputLock:
sys.__stderr__.write(text)
# builtin print() isn't threadsafe, lets make it threadsafe
def threadedPrint(*a, **b):
with outputLock:
org_print(*a, **b)
# this is really a HACK or better only useful in this complicate situation
__builtin__.org_print = __builtin__.print
__builtin__.org_stdout = sys.stdout
__builtin__.org_sterr = sys.stderr
def enableThreadedPrint(enable = True, threadCount = multiprocessing.cpu_count()):
if enable:
global outputStates
global outputFormatString
outputStates = [""] * (threadCount)
outputFormatString = ""
for x in xrange(threadCount):
outputFormatString = outputFormatString + "{" + str(x) + ":10}"
sys.stdout = StdOutHook()
sys.stderr = StdErrHook()
__builtin__.print = threadedPrint
else:
sys.stdout = __builtin__.org_stdout
sys.stderr = __builtin__.org_sterr
__builtin__.print = __builtin__.org_print
threadData = threading.local()
def nextProgressIndicator():
return next(threadData.progressIndicator)
class TaskFunction():
def __init__(self, function, *arguments):
self.function = function
self.arguments = arguments
def __str__(self):
return str(self.__dict__)
class Task():
def __init__(self, description, function = None, *arguments):
self.taskNumber = 0 # will be set from outside
self.description = description
self.listOfFunctions = []
if function:
firstFunction = TaskFunction(function, *arguments)
self.listOfFunctions.append(firstFunction)
# exit the complete program with code -1, sys.exit would just close the thread
self.exitFunction = os._exit
self.exitFunctionArguments = [-1]
def addFunction(self, function, *arguments):
aFunction = TaskFunction(function, *arguments)
self.listOfFunctions.append(aFunction)
def do(self):
try:
for taskFunction in self.listOfFunctions:
taskFunction.function(*(taskFunction.arguments))
except Exception as e:
print("FAIL")
with outputLock:
# there is no clean exit so we adding linesep here
sys.__stdout__.write(os.linesep)
sys.__stdout__.flush()
sys.__stderr__.write(format(taskFunction))
sys.__stderr__.write(os.linesep)
sys.__stderr__.write(traceback.format_exc())
sys.__stderr__.flush()
self.exitFunction(*(self.exitFunctionArguments))
print("Done")
class ThreadedWork():
def __init__(self, description):
self.description = os.linesep + "##### {} #####".format(description)
self.queue = queue.Queue()
self.legend = []
self.taskNumber = 0
self.exitFunction = None
def setExitFailFunction(self, function, *arguments):
self.exitFunction = function
self.exitFunctionArguments = arguments
def addTask(self, description, function, *arguments):
self.addTaskObject(Task(description, function, *arguments))
def addTaskObject(self, task):
task.taskNumber = self.taskNumber
if self.exitFunction:
task.exitFunction = self.exitFunction
task.exitFunctionArguments = self.exitFunctionArguments
self.legend.append(("{:d}: " + os.linesep +"\t{}" + os.linesep).format(task.taskNumber, task.description))
self.queue.put(task)
self.taskNumber = self.taskNumber + 1
def run(self, maxThreads=None):
if not maxThreads:
maxThreads = min(multiprocessing.cpu_count(), self.taskNumber)
print(self.description)
print(os.linesep.join(self.legend))
if maxThreads > 1:
enableThreadedPrint(True, maxThreads)
listOfConsumers = []
for i in range(maxThreads):
# every Consumer needs a stop/none item
self.queue.put(None)
newConsumer = Consumer(self.queue, i)
listOfConsumers.append(newConsumer)
newConsumer.daemon = True
newConsumer.start()
# block until everything is done
for consumer in listOfConsumers:
while consumer.isAlive():
try:
#wait 1 second, then go back and ask if thread is still alive
time.sleep(1)
except KeyboardInterrupt: #if ctrl-C is pressed within that second,
#catch the KeyboardInterrupt exception
sys.exit(0)
# self.queue.join() <- this ignoring the KeyboardInterrupt
if maxThreads > 1:
enableThreadedPrint(False)
print(os.linesep + self.description + ' ... done')
class Consumer(threading.Thread):
def __init__(self, queue, workerThreadId):
self.queue = queue
self.workerThreadId = workerThreadId
threading.Thread.__init__(self)
def run(self, stableRunIndicator = True):
if stableRunIndicator:
threadData.progressIndicator = itertools.cycle(['..'])
else:
threadData.progressIndicator = itertools.cycle(['|', '/', '-', '\\'])
threadData.workerThreadId = self.workerThreadId
# run as long we have something in that queue
while True:
task = self.queue.get()
if task is None:
self.queue.task_done()
break
else:
# we like to know which task get the progress -> see std handling
threadData.taskNumber = task.taskNumber
task.do()
self.queue.task_done()
|
