-
Notifications
You must be signed in to change notification settings - Fork 0
/
mythread.py
435 lines (371 loc) · 19.3 KB
/
mythread.py
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
"""
Elias Wood ([email protected])
2015-03-20
a base thread class for doing jobs, to work with a mydb instance
shared by all workers
"""
from myloggingbase import MyLoggingBase
import threading
import time
class MyThread(MyLoggingBase,threading.Thread):
"""
Abstract threading class, to be inherited and override:
_find_job_end_value (optional)
_process_item (required!)
_before_looping (optional)
_after_looping (optional)
_flush_files (optional)
Read the docs for each method for more details.
"""
# TODO: system to tell if the thread broke or not...
_total_rows = None
_jobs_completed = None
_db = None
_batch_size = None
_my_id = None
_job = None
_CTRL_WAKE_UP,_CTRL_QUEUE,_CTRL_JOB,_CTRL_INTERRUPT = 0,1,2,3
_interupt_process = None
_continue_waiting = None
_continue_looping = None
__current_job_id = None
__current_job_start_v = None
__current_job_end_v = None
_DUMMY_END_VALUE = '<<DUMMY_END_VALUE>>' # return this means no lookup is needed when the job is resumed
_END_JOB = '<<END_JOB_COMPLETE_DO_NOT_PROCESS>>' # return this means the job shouldn't be processed - complete and move on
__job_updated_time = None
_update_interval = 30 # seconds
def __init__(self,job,db,**keys):
"""
params (required):
job: the job type the thread should process; the same job_type for MyDb.add_job(...)
db: the db object to interface with (similar to MyDb)
"""
# init logging base
MyLoggingBase.__init__(self)
# set my_id - unique identifier - and thread name (also unique)
self._my_id = id(self)
self._thread_name = '{}{}'.format(job[:2],self.get_my_id())
# init threading things...
threading.Thread.__init__(self,name=self.get_thread_name())
# set vars
self._db = db
self._batch_size = keys.pop('batch',1)
self._job = job
self._total_rows = 0
self._jobs_completed = 0
# make sure our run loop will loop... !
self._interupt_process = False
self._continue_waiting = True
self._continue_looping = True
#===========================================================================
#============================ GETTERS / SETTERS ============================
#===========================================================================
def get_thread_name(self):
"""returns the unique thread name (first two letters of the
job_type followed by the id - id(self)."""
return self._thread_name
def get_my_id(self):
"""returns the id - id(self) - for the thread"""
return self._my_id
def get_job_type(self):
"""returns the job type this thread does; find __init__ for more."""
return self._job
#===========================================================================
#========================= Thread Getters / Setters ========================
#===========================================================================
def __issue_stop(self,i):
"""add something to the queue to wake up the thread"""
#if i not in (self._CTRL_QUEUE,self._CTRL_JOB,self._CTRL_INTERRUPT)
self._db.get_event().set()
def stop(self,wait_for_empty_queue=True):
"""stops the thread, either when the queue is empty or right away
depending on the value passed.
params:
wait_for_empty_queue=True: if False, it will stop ASAP, depending
on how fequently ._check_for_interrupt() is executed in the
._process_item(...) method. If True, it stops when there are no
more pending jobs."""
if wait_for_empty_queue:
self._continue_waiting = False
self.__issue_stop(self._CTRL_QUEUE)
else: self.interupt()
def stop_after_job(self):
"""Stop the thread after the current job has ended."""
self._continue_looping = False
self.__issue_stop(self._CTRL_JOB)
def interupt(self):
"""Kills the thread ASAP!"""
self._continue_looping = False
self._interupt_process = True
self.__issue_stop(self._CTRL_INTERRUPT)
#===========================================================================
#============================= Thread runner! ==============================
#===========================================================================
def run(self):
"""started when the thread does. See threading.Thread for more."""
# see we can initialize things...
self._before_looping()
# start looping
while self._continue_looping:
# is there another job to do?
try: items = self._db.get_next_jobs(self.get_job_type(),
count=self._batch_size)
except StopIteration:
if self._continue_waiting: self._db.get_event().wait()
else:
self.logger.debug('queue is empty, and I am not waiting!')
break
else:
# check for interupt
if self._interupt_process:
self.logger.warning("we've been interrupted!")
else:
self._process_items(items)
'''
# start the job
self.__job_updated_time = job_start_time = time.clock()
self.__current_job_id = item[self._db.JOB_ID]
item = list(item)
# some logging
self.logger.debug('starting job %s with id=%s',
self.__current_job_id,
item[self._db.ITEM_ID])
# look in db to see what the end value should be (only if end_value isn't set)
if item[self._db.END_VALUE] == None:
# add it item to pass to process_item
item[self._db.END_VALUE] = self.__current_job_end_v = self._find_job_end_value(*item[1:])
if item[self._db.END_VALUE] == self._DUMMY_END_VALUE:
item[self._db.END_VALUE] = None
if item[self._db.END_VALUE] == self._END_JOB:
job_completed,rows = True,0
else:
# process item
job_completed,rows = self._process_item(*item[1:]) #item_id,init_data,start_value,end_value
# track total rows
self._total_rows += rows
job_id = self.__current_job_id
job_end_time = time.clock() # get time of completed job
# handle if job was successful
if job_completed:
# done processing task
self._complete_job() # flush files and update db
self._jobs_completed += 1 # track number of jobs
# log stats
self.logger.debug('job %s completed, %03d rows, %f seconds',
job_id,rows,job_end_time-job_start_time)
else:
self._update_current_job()
self.__current_job_id = None
# log stats
self.logger.debug('job %s failed, %03d rows, %f seconds',
job_id,rows,job_end_time-job_start_time)
'''
# give us a change to finish a few things if needed
self._after_looping()
#===========================================================================
#========== Things that should/can be Overwritten When Inherited ===========
#===========================================================================
def _find_job_end_value(self,item_id,init_data,start_value,end_value):
"""find what's the beginning value is.
* if None is returned and the job later breaks, this method will run
again.
* if self._DUMMY_END_VALUE is returned, the job wont run this every time
it breaks and resumes.
* if self._END_NOW is returned, process_item isn't called for this job
and it is considered complete (removed from the queue)
"""
return self._DUMMY_END_VALUE
def _process_items(self,items):
""" For batch sizes>1, override this method.
items is a iterable object
"""
for item in (list(i) for i in items):
# some logging
self.logger.debug('starting job %s with id=%s',
self.__current_job_id,
item[self._db.ITEM_ID])
# start the job
self.__job_updated_time = job_start_time = time.clock()
self.__current_job_id = item[self._db.JOB_ID]
job_completed,rows = self._process_item(*item[1:]) #item_id,init_data,start_value,end_value
# track total rows
self._total_rows += rows
job_id = self.__current_job_id
job_end_time = time.clock() # get time of completed job
# handle if job was successful
if job_completed:
# done processing task
self._complete_job() # flush files and update db
self._jobs_completed += 1 # track number of jobs
# log stats
self.logger.debug('job %s completed, %03d rows, %f seconds',
job_id,rows,job_end_time-job_start_time)
else:
#self._update_current_job()
self.__current_job_id = None
# log stats
self.logger.debug('job %s failed, %03d rows, %f seconds',
job_id,rows,job_end_time-job_start_time)
def _process_item(self,item_id,init_data=None,
start_value=None,end_value=None):
"""
This method is called for every job in the queue the thread gets.
return (<whether the job completed> , <number of records processed>)
make sure you use the functions below while processing! Usually,
you can just use:
if self._thread_block(new_start_value):
job_completed = False # we've been interrupted...
Or you can use the functions separately how you like:
* self._update_start_value(new_start_value) # update start_value for recovering
* self._check_for_interrupt() # returns True if you've been
interrupted (and updates db if interrupted), but doesn't set a
flag that the job has failed! there is no flag!
REMEMBER to return False for job_completed!
* self._update_if_needed() # updates based on time - handled internally.
"""
return True,0
def _before_looping(self):
"""the first method called by .run(), this method is the first
to be run by the thread when it starts. You should override and
initial any files used, etc."""
pass
def _after_looping(self):
"""the last method called by .run(), this method is the first
to be run by the thread when it starts. You should override and
close any files opened, etc."""
pass
def _flush_files(self):
"""override if you have using files. This method is called after a
job is updated or completed so files will stay accurate with the db."""
pass
#===========================================================================
# Override Get Summary info
#===========================================================================
def _get_summary_info(self):
"""override to add useful summary info."""
a = MyLoggingBase._get_summary_info(self)
a.extend(['jobs completed: {:,}'.format(self._jobs_completed),
'last data: {}'.format(self.__current_job_start_v),
'total rows: {:,}'.format(self._total_rows)])
return a
#===========================================================================
#=========== Things that should be used when class is Inherited ============
#===========================================================================
def _thread_block(self,start_value):
"""saves the start_value and updates if needed. You just need to calls
this method whenever the start_vlaue has changed to update if needed
and check if you've been told to stop - interrupted. returns True if
you've been interrupted, False otherwise."""
self._update_start_value(start_value)
if self._check_for_interrupt(): return True
else: self._update_if_needed()
return False
def _update_start_value(self,value):
"""updates the start value for the current job.
NOTE: the db will be updated with this new info only if
_update_current_job is called
(_update_if_needed updates every self._update_interval)."""
self.__current_job_start_v = value
def _update_end_value(self,value):
"""updates the start value for the current job.
NOTE: the db will be updated with this new info only if
_update_current_job is called
(_update_if_needed updates every self._update_interval)."""
self.__current_job_end_v = value
def _check_for_interrupt(self):
"""Checks if we've been interrupted; if so, saves and returns True.
Returns False otherwise."""
if self._interupt_process:
self.logger.warning("we've been interrupted!")
self._update_current_job()
return True
else: return False
def _update_if_needed(self):
"""updates the db if needed (self._update_interval time has passed)."""
if time.clock() - self.__job_updated_time > self._update_interval:
self._update_current_job()
#===========================================================================
# Before Raising Error
#===========================================================================
def _before_raising_error(self):
"""this method should be called before any errors are raised to save
the current job's progress."""
self.logger.warning("oops... well, I'll save my progress i guess...")
# save progress!
self._update_current_job()
#===========================================================================
# Waiting Wrap
#===========================================================================
def _before_waiting(self,first_time_waiting=True):
"""call before doing a wait. updates job status (in the db) if needed
it's the first time waiting."""
if first_time_waiting: self._update_current_job()
def _after_waiting(self):
"""call method after doing a wait. It updates the job updated time
so we don't update more than needed."""
self.__job_updated_time = time.clock()
#===========================================================================
#=============================== Job Things ================================
#===========================================================================
def _complete_job(self):
"""Tells the db the job is finished/complete and flush files"""
#if there is a job being worked on...
if self.__current_job_id is not None:
# updated db
self._db.remove_job(self.__current_job_id)
self.__current_job_id = None
# flush files
self._flush_files()
#===========================================================================
# Update Job
#===========================================================================
def _update_current_job(self):
"""updates the current job with start_value and end_value
and flushes the files files (see self._flush_files()."""
self.logger.info('updating job %s with data %r',self.__current_job_id,
self.__current_job_start_v)
if self.__current_job_id is not None:
#update db (update end_time if able)
if self.__current_job_end_v is None:
self._db.update_job(self.__current_job_id,
self.__current_job_start_v)
else:
self._db.update_job(self.__current_job_id,
self.__current_job_start_v,
self.__current_job_end_v)
self.__current_job_end_v = None
# flush files
self._flush_files()
# save time
self.__job_updated_time = time.clock()
#===========================================================================
# Add Job
#===========================================================================
def _add_job(self,item_id,job_type,init_data=None,*args, **keys):
"""Add a job need to be done to the database. Returns True if
the job is successfully added, false otherwise (and logs).
param:
item_id: the item to get the job needs to be done for
NOTE: item_id,job_type is the unique composite key.
job_type: the job that needs to be done
NOTE: item_id,job_type is the unique composite key.
init_data=None: a number, compared if a similar job is started to
determine if adding the job is necessary. None means it's
necessary.
"""
# add job to db and get job_id
job_id = self._db.add_job(item_id,job_type,init_data)
# log if the job failed to be added
if job_id is None:
self.logger.error('failed to add job %s,%s,%s',
item_id,job_type,init_data)
return False
else: return True
#===============================================================================
# Main
#===============================================================================
if __name__ == '__main__':
try: from tests import test_mythread
except ImportError: print 'no test for mythread'
else: test_mythread.run_test()