pyloid 0.20.1.dev2__py3-none-any.whl → 0.20.2__py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- pyloid/__init__.py +7 -7
- pyloid/api.py +104 -104
- pyloid/autostart.py +101 -101
- pyloid/browser_window.py +1915 -1970
- pyloid/builder/__init__.py +80 -80
- pyloid/builder/build_config.schema.json +72 -72
- pyloid/builder/spec.py +246 -246
- pyloid/custom/titlebar.py +116 -116
- pyloid/filewatcher.py +163 -163
- pyloid/js_api/event_api.py +24 -24
- pyloid/js_api/window_api.py +255 -255
- pyloid/monitor.py +921 -921
- pyloid/pyloid.py +1404 -1404
- pyloid/thread_pool.py +500 -500
- pyloid/timer.py +307 -307
- pyloid/tray.py +48 -48
- pyloid/utils.py +122 -122
- {pyloid-0.20.1.dev2.dist-info → pyloid-0.20.2.dist-info}/LICENSE +200 -200
- {pyloid-0.20.1.dev2.dist-info → pyloid-0.20.2.dist-info}/METADATA +4 -2
- pyloid-0.20.2.dist-info/RECORD +21 -0
- {pyloid-0.20.1.dev2.dist-info → pyloid-0.20.2.dist-info}/WHEEL +1 -1
- pyloid-0.20.1.dev2.dist-info/RECORD +0 -21
pyloid/thread_pool.py
CHANGED
@@ -1,501 +1,501 @@
|
|
1
|
-
from PySide6.QtCore import QRunnable, QThreadPool, QDeadlineTimer, QObject, Signal
|
2
|
-
from typing import Callable, Optional, Union
|
3
|
-
|
4
|
-
class PyloidRunnable(QRunnable):
|
5
|
-
"""
|
6
|
-
A runnable task class that extends QRunnable from Qt.
|
7
|
-
|
8
|
-
Defines a unit of work that can be executed in a thread pool.
|
9
|
-
"""
|
10
|
-
|
11
|
-
def __init__(self):
|
12
|
-
"""
|
13
|
-
Initializes a PyloidRunnable instance.
|
14
|
-
|
15
|
-
By default, auto-delete is enabled.
|
16
|
-
"""
|
17
|
-
super().__init__()
|
18
|
-
self.setAutoDelete(True)
|
19
|
-
|
20
|
-
def get_auto_delete(self) -> bool:
|
21
|
-
"""
|
22
|
-
Returns whether the task is automatically deleted after completion in the thread pool.
|
23
|
-
|
24
|
-
The default value is True.
|
25
|
-
|
26
|
-
Returns
|
27
|
-
-------
|
28
|
-
bool
|
29
|
-
True if the task is automatically deleted after completion, False if manual deletion is required
|
30
|
-
|
31
|
-
Examples
|
32
|
-
--------
|
33
|
-
```python
|
34
|
-
from pyloid.thread_pool import PyloidRunnable
|
35
|
-
import time
|
36
|
-
|
37
|
-
class Worker(PyloidRunnable):
|
38
|
-
def run(self):
|
39
|
-
time.sleep(1)
|
40
|
-
print("Task executed")
|
41
|
-
|
42
|
-
worker = Worker()
|
43
|
-
print(worker.get_auto_delete())
|
44
|
-
```
|
45
|
-
"""
|
46
|
-
return self.autoDelete()
|
47
|
-
|
48
|
-
def set_auto_delete(self, value: bool) -> None:
|
49
|
-
"""
|
50
|
-
Sets whether the task is automatically deleted after completion in the thread pool.
|
51
|
-
|
52
|
-
Parameters
|
53
|
-
----------
|
54
|
-
value : bool
|
55
|
-
True to enable auto-delete after task completion,
|
56
|
-
False to require manual deletion
|
57
|
-
|
58
|
-
Examples
|
59
|
-
--------
|
60
|
-
```python
|
61
|
-
from pyloid.thread_pool import PyloidRunnable
|
62
|
-
import time
|
63
|
-
|
64
|
-
class Worker(PyloidRunnable):
|
65
|
-
def run(self):
|
66
|
-
time.sleep(1)
|
67
|
-
print("Task executed")
|
68
|
-
|
69
|
-
worker = Worker()
|
70
|
-
worker.set_auto_delete(False)
|
71
|
-
```
|
72
|
-
"""
|
73
|
-
self.setAutoDelete(value)
|
74
|
-
|
75
|
-
def run(self) -> None:
|
76
|
-
"""
|
77
|
-
Defines the actual work to be executed in the thread pool.
|
78
|
-
|
79
|
-
This method must be implemented in subclasses.
|
80
|
-
|
81
|
-
Examples
|
82
|
-
--------
|
83
|
-
```python
|
84
|
-
from pyloid.thread_pool import PyloidRunnable, PyloidThreadPool
|
85
|
-
import time
|
86
|
-
|
87
|
-
class Worker(PyloidRunnable):
|
88
|
-
def run(self):
|
89
|
-
time.sleep(1)
|
90
|
-
print("Task executed")
|
91
|
-
|
92
|
-
worker = Worker()
|
93
|
-
thread_pool = PyloidThreadPool()
|
94
|
-
thread_pool.start(worker)
|
95
|
-
```
|
96
|
-
"""
|
97
|
-
pass
|
98
|
-
|
99
|
-
class PyloidDefaultSignals(QObject):
|
100
|
-
"""
|
101
|
-
Default signal class.
|
102
|
-
|
103
|
-
Defines signals used for task start, completion, and error occurrence in the thread pool.
|
104
|
-
|
105
|
-
Attributes
|
106
|
-
----------
|
107
|
-
started : Signal
|
108
|
-
Signal emitted when a task starts
|
109
|
-
finished : Signal
|
110
|
-
Signal emitted when a task completes
|
111
|
-
error : Signal(str)
|
112
|
-
Signal emitted when an error occurs
|
113
|
-
progress : Signal(int)
|
114
|
-
Signal emitted when progress changes
|
115
|
-
|
116
|
-
Examples
|
117
|
-
--------
|
118
|
-
```python
|
119
|
-
from pyloid.thread_pool import PyloidRunnable, PyloidThreadPool, PyloidDefaultSignals
|
120
|
-
import time
|
121
|
-
|
122
|
-
class Worker(PyloidRunnable):
|
123
|
-
def __init__(self):
|
124
|
-
super().__init__()
|
125
|
-
self.signals = PyloidDefaultSignals()
|
126
|
-
|
127
|
-
def run(self):
|
128
|
-
for i in range(101):
|
129
|
-
self.signals.progress.emit(i)
|
130
|
-
time.sleep(0.1)
|
131
|
-
|
132
|
-
worker = Worker()
|
133
|
-
|
134
|
-
worker.signals.finished.connect(lambda: print("Task completed."))
|
135
|
-
worker.signals.error.connect(lambda error: print(f"Error occurred: {error}"))
|
136
|
-
worker.signals.progress.connect(lambda progress: print(f"Progress: {progress}%"))
|
137
|
-
|
138
|
-
thread_pool = PyloidThreadPool()
|
139
|
-
thread_pool.start(worker)
|
140
|
-
```
|
141
|
-
"""
|
142
|
-
started = Signal()
|
143
|
-
finished = Signal()
|
144
|
-
error = Signal(str)
|
145
|
-
progress = Signal(int)
|
146
|
-
|
147
|
-
|
148
|
-
class PyloidThreadPool:
|
149
|
-
def __init__(self):
|
150
|
-
self.thread_pool = QThreadPool.globalInstance()
|
151
|
-
|
152
|
-
def start(self, runnable: Union[PyloidRunnable, Callable], priority: int = ...) -> None:
|
153
|
-
"""
|
154
|
-
Adds a task to the thread pool and executes it.
|
155
|
-
|
156
|
-
Parameters
|
157
|
-
----------
|
158
|
-
runnable : Union[PyloidRunnable, Callable]
|
159
|
-
Task to be executed
|
160
|
-
priority : int
|
161
|
-
Task priority
|
162
|
-
|
163
|
-
Examples
|
164
|
-
--------
|
165
|
-
```python
|
166
|
-
from pyloid.thread_pool import PyloidRunnable, PyloidThreadPool
|
167
|
-
import time
|
168
|
-
|
169
|
-
class Worker(PyloidRunnable):
|
170
|
-
def run(self):
|
171
|
-
time.sleep(1)
|
172
|
-
print("Task executed")
|
173
|
-
|
174
|
-
worker = Worker()
|
175
|
-
thread_pool = PyloidThreadPool()
|
176
|
-
thread_pool.start(worker)
|
177
|
-
```
|
178
|
-
"""
|
179
|
-
self.thread_pool.start(runnable, priority)
|
180
|
-
|
181
|
-
def active_thread_count(self) -> int:
|
182
|
-
"""
|
183
|
-
Returns the number of currently active threads.
|
184
|
-
|
185
|
-
Returns
|
186
|
-
-------
|
187
|
-
int
|
188
|
-
Number of currently active threads
|
189
|
-
|
190
|
-
Examples
|
191
|
-
--------
|
192
|
-
```python
|
193
|
-
from pyloid.thread_pool import PyloidThreadPool
|
194
|
-
|
195
|
-
thread_pool = PyloidThreadPool()
|
196
|
-
print(thread_pool.active_thread_count())
|
197
|
-
```
|
198
|
-
"""
|
199
|
-
return self.thread_pool.activeThreadCount()
|
200
|
-
|
201
|
-
def max_thread_count(self) -> int:
|
202
|
-
"""
|
203
|
-
Returns the maximum number of threads that can run simultaneously in the thread pool.
|
204
|
-
|
205
|
-
Returns
|
206
|
-
-------
|
207
|
-
int
|
208
|
-
Maximum number of threads
|
209
|
-
|
210
|
-
Examples
|
211
|
-
--------
|
212
|
-
```python
|
213
|
-
from pyloid.thread_pool import PyloidThreadPool
|
214
|
-
|
215
|
-
thread_pool = PyloidThreadPool()
|
216
|
-
print(thread_pool.max_thread_count())
|
217
|
-
```
|
218
|
-
"""
|
219
|
-
return self.thread_pool.maxThreadCount()
|
220
|
-
|
221
|
-
def set_max_thread_count(self, max_thread_count: int) -> None:
|
222
|
-
"""
|
223
|
-
Sets the maximum number of threads that can run simultaneously in the thread pool.
|
224
|
-
|
225
|
-
Parameters
|
226
|
-
----------
|
227
|
-
max_thread_count : int
|
228
|
-
Maximum number of threads
|
229
|
-
|
230
|
-
Examples
|
231
|
-
--------
|
232
|
-
```python
|
233
|
-
from pyloid.thread_pool import PyloidThreadPool
|
234
|
-
|
235
|
-
thread_pool = PyloidThreadPool()
|
236
|
-
thread_pool.set_max_thread_count(10)
|
237
|
-
```
|
238
|
-
"""
|
239
|
-
self.thread_pool.setMaxThreadCount(max_thread_count)
|
240
|
-
|
241
|
-
def reserve_thread(self) -> None:
|
242
|
-
"""
|
243
|
-
Reserves a thread in the thread pool.
|
244
|
-
|
245
|
-
Examples
|
246
|
-
--------
|
247
|
-
```python
|
248
|
-
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
249
|
-
import time
|
250
|
-
|
251
|
-
class Worker(PyloidRunnable):
|
252
|
-
def run(self):
|
253
|
-
time.sleep(1)
|
254
|
-
print("Task executed on reserved thread")
|
255
|
-
|
256
|
-
# Create thread pool
|
257
|
-
thread_pool = PyloidThreadPool()
|
258
|
-
|
259
|
-
# Reserve thread
|
260
|
-
thread_pool.reserve_thread()
|
261
|
-
|
262
|
-
try:
|
263
|
-
# Execute task on reserved thread
|
264
|
-
worker = Worker()
|
265
|
-
thread_pool.start_on_reserved_thread(worker)
|
266
|
-
|
267
|
-
# Wait for task completion
|
268
|
-
thread_pool.wait_for_done()
|
269
|
-
finally:
|
270
|
-
# Important: Reserved threads must be released
|
271
|
-
thread_pool.release_thread()
|
272
|
-
```
|
273
|
-
"""
|
274
|
-
self.thread_pool.reserveThread()
|
275
|
-
|
276
|
-
def release_thread(self) -> None:
|
277
|
-
"""
|
278
|
-
Releases a reserved thread in the thread pool.
|
279
|
-
|
280
|
-
Examples
|
281
|
-
--------
|
282
|
-
```python
|
283
|
-
from pyloid.thread_pool import PyloidThreadPool
|
284
|
-
|
285
|
-
thread_pool = PyloidThreadPool()
|
286
|
-
thread_pool.release_thread()
|
287
|
-
```
|
288
|
-
"""
|
289
|
-
self.thread_pool.releaseThread()
|
290
|
-
|
291
|
-
def clear(self) -> None:
|
292
|
-
"""
|
293
|
-
Removes all pending tasks from the thread pool.
|
294
|
-
|
295
|
-
Examples
|
296
|
-
--------
|
297
|
-
```python
|
298
|
-
from pyloid.thread_pool import PyloidThreadPool
|
299
|
-
|
300
|
-
thread_pool = PyloidThreadPool()
|
301
|
-
thread_pool.clear()
|
302
|
-
```
|
303
|
-
"""
|
304
|
-
self.thread_pool.clear()
|
305
|
-
|
306
|
-
# def contains(self, thread: QThread) -> bool:
|
307
|
-
# return self.thread_pool.contains(thread)
|
308
|
-
|
309
|
-
def get_expiry_timeout(self) -> int:
|
310
|
-
"""
|
311
|
-
Returns the thread expiry timeout in the thread pool.
|
312
|
-
|
313
|
-
Returns
|
314
|
-
-------
|
315
|
-
int
|
316
|
-
Thread expiry timeout
|
317
|
-
|
318
|
-
Examples
|
319
|
-
--------
|
320
|
-
```python
|
321
|
-
from pyloid.thread_pool import PyloidThreadPool
|
322
|
-
|
323
|
-
thread_pool = PyloidThreadPool()
|
324
|
-
print(thread_pool.get_expiry_timeout())
|
325
|
-
```
|
326
|
-
"""
|
327
|
-
return self.thread_pool.expiryTimeout()
|
328
|
-
|
329
|
-
def set_expiry_timeout(self, expiry_timeout: int) -> None:
|
330
|
-
"""
|
331
|
-
Sets the thread expiry timeout in the thread pool.
|
332
|
-
|
333
|
-
Parameters
|
334
|
-
----------
|
335
|
-
expiry_timeout : int
|
336
|
-
Thread expiry timeout
|
337
|
-
|
338
|
-
Examples
|
339
|
-
--------
|
340
|
-
```python
|
341
|
-
from pyloid.thread_pool import PyloidThreadPool
|
342
|
-
|
343
|
-
thread_pool = PyloidThreadPool()
|
344
|
-
thread_pool.set_expiry_timeout(1000)
|
345
|
-
```
|
346
|
-
"""
|
347
|
-
self.thread_pool.setExpiryTimeout(expiry_timeout)
|
348
|
-
|
349
|
-
# def set_stack_size(self, stack_size: int) -> None:
|
350
|
-
# self.thread_pool.setStackSize(stack_size)
|
351
|
-
|
352
|
-
# def stack_size(self) -> int:
|
353
|
-
# return self.thread_pool.stackSize()
|
354
|
-
|
355
|
-
# def set_thread_priority(self, priority: QThread.Priority) -> None:
|
356
|
-
# self.thread_pool.setThreadPriority(priority)
|
357
|
-
|
358
|
-
# def thread_priority(self) -> QThread.Priority:
|
359
|
-
# return self.thread_pool.threadPriority()
|
360
|
-
|
361
|
-
def start_on_reserved_thread(self, runnable: QRunnable) -> None:
|
362
|
-
"""
|
363
|
-
Executes a task on a reserved thread.
|
364
|
-
|
365
|
-
Parameters
|
366
|
-
----------
|
367
|
-
runnable : QRunnable
|
368
|
-
Task to be executed
|
369
|
-
|
370
|
-
Examples
|
371
|
-
--------
|
372
|
-
```python
|
373
|
-
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
374
|
-
import time
|
375
|
-
|
376
|
-
class Worker(PyloidRunnable):
|
377
|
-
def run(self):
|
378
|
-
time.sleep(1)
|
379
|
-
print("Task executed on reserved thread")
|
380
|
-
|
381
|
-
worker = Worker()
|
382
|
-
thread_pool = PyloidThreadPool()
|
383
|
-
thread_pool.reserve_thread()
|
384
|
-
thread_pool.start_on_reserved_thread(worker)
|
385
|
-
thread_pool.wait_for_done()
|
386
|
-
thread_pool.release_thread()
|
387
|
-
```
|
388
|
-
"""
|
389
|
-
self.thread_pool.startOnReservedThread(runnable)
|
390
|
-
|
391
|
-
def try_start(self, runnable: Union[QRunnable, Callable]) -> bool:
|
392
|
-
"""
|
393
|
-
Adds a new task to the thread pool and attempts to execute it immediately.
|
394
|
-
|
395
|
-
Only executes the task if the thread pool has available capacity.
|
396
|
-
Operates in a non-blocking manner and does not start the task if the thread pool is full.
|
397
|
-
|
398
|
-
Parameters
|
399
|
-
----------
|
400
|
-
runnable : Union[QRunnable, Callable]
|
401
|
-
Task to be executed
|
402
|
-
|
403
|
-
Returns
|
404
|
-
-------
|
405
|
-
bool
|
406
|
-
True: Task successfully started
|
407
|
-
False: Task could not be started because the thread pool is full
|
408
|
-
|
409
|
-
Examples
|
410
|
-
--------
|
411
|
-
```python
|
412
|
-
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
413
|
-
|
414
|
-
class Worker(PyloidRunnable):
|
415
|
-
def run(self):
|
416
|
-
print("Task executed")
|
417
|
-
|
418
|
-
thread_pool = PyloidThreadPool()
|
419
|
-
worker = Worker()
|
420
|
-
|
421
|
-
if thread_pool.try_start(worker):
|
422
|
-
print("Task started")
|
423
|
-
else:
|
424
|
-
print("Task could not be started because the thread pool is full")
|
425
|
-
```
|
426
|
-
"""
|
427
|
-
return self.thread_pool.tryStart(runnable)
|
428
|
-
|
429
|
-
def try_take(self, runnable: QRunnable) -> bool:
|
430
|
-
"""
|
431
|
-
Attempts to remove a specific task from the thread pool queue.
|
432
|
-
|
433
|
-
Only removes tasks that have not yet been executed. Tasks that are already running cannot be removed.
|
434
|
-
Used when task cancellation is needed.
|
435
|
-
|
436
|
-
Parameters
|
437
|
-
----------
|
438
|
-
runnable : QRunnable
|
439
|
-
Task to be removed from the queue
|
440
|
-
|
441
|
-
Returns
|
442
|
-
-------
|
443
|
-
bool
|
444
|
-
True: Task successfully removed from the queue
|
445
|
-
False: Task could not be removed (already running or not found)
|
446
|
-
|
447
|
-
Examples
|
448
|
-
--------
|
449
|
-
```python
|
450
|
-
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
451
|
-
|
452
|
-
class Worker(PyloidRunnable):
|
453
|
-
def run(self):
|
454
|
-
print("Task executed")
|
455
|
-
|
456
|
-
thread_pool = PyloidThreadPool()
|
457
|
-
worker = Worker()
|
458
|
-
|
459
|
-
# Add task
|
460
|
-
thread_pool.start(worker)
|
461
|
-
|
462
|
-
# Attempt to remove task
|
463
|
-
if thread_pool.try_take(worker):
|
464
|
-
print("Task removed from queue")
|
465
|
-
else:
|
466
|
-
print("Task could not be removed (already running or not found)")
|
467
|
-
```
|
468
|
-
"""
|
469
|
-
return self.thread_pool.tryTake(runnable)
|
470
|
-
|
471
|
-
def wait_for_done(self, timeout: Optional[int] = None) -> bool:
|
472
|
-
"""
|
473
|
-
Waits for tasks to complete.
|
474
|
-
|
475
|
-
If no timeout is specified, waits indefinitely until completion.
|
476
|
-
|
477
|
-
Parameters
|
478
|
-
----------
|
479
|
-
timeout : Optional[int]
|
480
|
-
Wait time
|
481
|
-
|
482
|
-
Returns
|
483
|
-
-------
|
484
|
-
bool
|
485
|
-
True if tasks completed, False otherwise
|
486
|
-
|
487
|
-
Examples
|
488
|
-
--------
|
489
|
-
```python
|
490
|
-
from pyloid.thread_pool import PyloidThreadPool
|
491
|
-
|
492
|
-
thread_pool = PyloidThreadPool()
|
493
|
-
thread_pool.wait_for_done()
|
494
|
-
|
495
|
-
print("Tasks completed.")
|
496
|
-
```
|
497
|
-
"""
|
498
|
-
if timeout is None:
|
499
|
-
return self.thread_pool.waitForDone(-1)
|
500
|
-
else:
|
1
|
+
from PySide6.QtCore import QRunnable, QThreadPool, QDeadlineTimer, QObject, Signal
|
2
|
+
from typing import Callable, Optional, Union
|
3
|
+
|
4
|
+
class PyloidRunnable(QRunnable):
|
5
|
+
"""
|
6
|
+
A runnable task class that extends QRunnable from Qt.
|
7
|
+
|
8
|
+
Defines a unit of work that can be executed in a thread pool.
|
9
|
+
"""
|
10
|
+
|
11
|
+
def __init__(self):
|
12
|
+
"""
|
13
|
+
Initializes a PyloidRunnable instance.
|
14
|
+
|
15
|
+
By default, auto-delete is enabled.
|
16
|
+
"""
|
17
|
+
super().__init__()
|
18
|
+
self.setAutoDelete(True)
|
19
|
+
|
20
|
+
def get_auto_delete(self) -> bool:
|
21
|
+
"""
|
22
|
+
Returns whether the task is automatically deleted after completion in the thread pool.
|
23
|
+
|
24
|
+
The default value is True.
|
25
|
+
|
26
|
+
Returns
|
27
|
+
-------
|
28
|
+
bool
|
29
|
+
True if the task is automatically deleted after completion, False if manual deletion is required
|
30
|
+
|
31
|
+
Examples
|
32
|
+
--------
|
33
|
+
```python
|
34
|
+
from pyloid.thread_pool import PyloidRunnable
|
35
|
+
import time
|
36
|
+
|
37
|
+
class Worker(PyloidRunnable):
|
38
|
+
def run(self):
|
39
|
+
time.sleep(1)
|
40
|
+
print("Task executed")
|
41
|
+
|
42
|
+
worker = Worker()
|
43
|
+
print(worker.get_auto_delete())
|
44
|
+
```
|
45
|
+
"""
|
46
|
+
return self.autoDelete()
|
47
|
+
|
48
|
+
def set_auto_delete(self, value: bool) -> None:
|
49
|
+
"""
|
50
|
+
Sets whether the task is automatically deleted after completion in the thread pool.
|
51
|
+
|
52
|
+
Parameters
|
53
|
+
----------
|
54
|
+
value : bool
|
55
|
+
True to enable auto-delete after task completion,
|
56
|
+
False to require manual deletion
|
57
|
+
|
58
|
+
Examples
|
59
|
+
--------
|
60
|
+
```python
|
61
|
+
from pyloid.thread_pool import PyloidRunnable
|
62
|
+
import time
|
63
|
+
|
64
|
+
class Worker(PyloidRunnable):
|
65
|
+
def run(self):
|
66
|
+
time.sleep(1)
|
67
|
+
print("Task executed")
|
68
|
+
|
69
|
+
worker = Worker()
|
70
|
+
worker.set_auto_delete(False)
|
71
|
+
```
|
72
|
+
"""
|
73
|
+
self.setAutoDelete(value)
|
74
|
+
|
75
|
+
def run(self) -> None:
|
76
|
+
"""
|
77
|
+
Defines the actual work to be executed in the thread pool.
|
78
|
+
|
79
|
+
This method must be implemented in subclasses.
|
80
|
+
|
81
|
+
Examples
|
82
|
+
--------
|
83
|
+
```python
|
84
|
+
from pyloid.thread_pool import PyloidRunnable, PyloidThreadPool
|
85
|
+
import time
|
86
|
+
|
87
|
+
class Worker(PyloidRunnable):
|
88
|
+
def run(self):
|
89
|
+
time.sleep(1)
|
90
|
+
print("Task executed")
|
91
|
+
|
92
|
+
worker = Worker()
|
93
|
+
thread_pool = PyloidThreadPool()
|
94
|
+
thread_pool.start(worker)
|
95
|
+
```
|
96
|
+
"""
|
97
|
+
pass
|
98
|
+
|
99
|
+
class PyloidDefaultSignals(QObject):
|
100
|
+
"""
|
101
|
+
Default signal class.
|
102
|
+
|
103
|
+
Defines signals used for task start, completion, and error occurrence in the thread pool.
|
104
|
+
|
105
|
+
Attributes
|
106
|
+
----------
|
107
|
+
started : Signal
|
108
|
+
Signal emitted when a task starts
|
109
|
+
finished : Signal
|
110
|
+
Signal emitted when a task completes
|
111
|
+
error : Signal(str)
|
112
|
+
Signal emitted when an error occurs
|
113
|
+
progress : Signal(int)
|
114
|
+
Signal emitted when progress changes
|
115
|
+
|
116
|
+
Examples
|
117
|
+
--------
|
118
|
+
```python
|
119
|
+
from pyloid.thread_pool import PyloidRunnable, PyloidThreadPool, PyloidDefaultSignals
|
120
|
+
import time
|
121
|
+
|
122
|
+
class Worker(PyloidRunnable):
|
123
|
+
def __init__(self):
|
124
|
+
super().__init__()
|
125
|
+
self.signals = PyloidDefaultSignals()
|
126
|
+
|
127
|
+
def run(self):
|
128
|
+
for i in range(101):
|
129
|
+
self.signals.progress.emit(i)
|
130
|
+
time.sleep(0.1)
|
131
|
+
|
132
|
+
worker = Worker()
|
133
|
+
|
134
|
+
worker.signals.finished.connect(lambda: print("Task completed."))
|
135
|
+
worker.signals.error.connect(lambda error: print(f"Error occurred: {error}"))
|
136
|
+
worker.signals.progress.connect(lambda progress: print(f"Progress: {progress}%"))
|
137
|
+
|
138
|
+
thread_pool = PyloidThreadPool()
|
139
|
+
thread_pool.start(worker)
|
140
|
+
```
|
141
|
+
"""
|
142
|
+
started = Signal()
|
143
|
+
finished = Signal()
|
144
|
+
error = Signal(str)
|
145
|
+
progress = Signal(int)
|
146
|
+
|
147
|
+
|
148
|
+
class PyloidThreadPool:
|
149
|
+
def __init__(self):
|
150
|
+
self.thread_pool = QThreadPool.globalInstance()
|
151
|
+
|
152
|
+
def start(self, runnable: Union[PyloidRunnable, Callable], priority: int = ...) -> None:
|
153
|
+
"""
|
154
|
+
Adds a task to the thread pool and executes it.
|
155
|
+
|
156
|
+
Parameters
|
157
|
+
----------
|
158
|
+
runnable : Union[PyloidRunnable, Callable]
|
159
|
+
Task to be executed
|
160
|
+
priority : int
|
161
|
+
Task priority
|
162
|
+
|
163
|
+
Examples
|
164
|
+
--------
|
165
|
+
```python
|
166
|
+
from pyloid.thread_pool import PyloidRunnable, PyloidThreadPool
|
167
|
+
import time
|
168
|
+
|
169
|
+
class Worker(PyloidRunnable):
|
170
|
+
def run(self):
|
171
|
+
time.sleep(1)
|
172
|
+
print("Task executed")
|
173
|
+
|
174
|
+
worker = Worker()
|
175
|
+
thread_pool = PyloidThreadPool()
|
176
|
+
thread_pool.start(worker)
|
177
|
+
```
|
178
|
+
"""
|
179
|
+
self.thread_pool.start(runnable, priority)
|
180
|
+
|
181
|
+
def active_thread_count(self) -> int:
|
182
|
+
"""
|
183
|
+
Returns the number of currently active threads.
|
184
|
+
|
185
|
+
Returns
|
186
|
+
-------
|
187
|
+
int
|
188
|
+
Number of currently active threads
|
189
|
+
|
190
|
+
Examples
|
191
|
+
--------
|
192
|
+
```python
|
193
|
+
from pyloid.thread_pool import PyloidThreadPool
|
194
|
+
|
195
|
+
thread_pool = PyloidThreadPool()
|
196
|
+
print(thread_pool.active_thread_count())
|
197
|
+
```
|
198
|
+
"""
|
199
|
+
return self.thread_pool.activeThreadCount()
|
200
|
+
|
201
|
+
def max_thread_count(self) -> int:
|
202
|
+
"""
|
203
|
+
Returns the maximum number of threads that can run simultaneously in the thread pool.
|
204
|
+
|
205
|
+
Returns
|
206
|
+
-------
|
207
|
+
int
|
208
|
+
Maximum number of threads
|
209
|
+
|
210
|
+
Examples
|
211
|
+
--------
|
212
|
+
```python
|
213
|
+
from pyloid.thread_pool import PyloidThreadPool
|
214
|
+
|
215
|
+
thread_pool = PyloidThreadPool()
|
216
|
+
print(thread_pool.max_thread_count())
|
217
|
+
```
|
218
|
+
"""
|
219
|
+
return self.thread_pool.maxThreadCount()
|
220
|
+
|
221
|
+
def set_max_thread_count(self, max_thread_count: int) -> None:
|
222
|
+
"""
|
223
|
+
Sets the maximum number of threads that can run simultaneously in the thread pool.
|
224
|
+
|
225
|
+
Parameters
|
226
|
+
----------
|
227
|
+
max_thread_count : int
|
228
|
+
Maximum number of threads
|
229
|
+
|
230
|
+
Examples
|
231
|
+
--------
|
232
|
+
```python
|
233
|
+
from pyloid.thread_pool import PyloidThreadPool
|
234
|
+
|
235
|
+
thread_pool = PyloidThreadPool()
|
236
|
+
thread_pool.set_max_thread_count(10)
|
237
|
+
```
|
238
|
+
"""
|
239
|
+
self.thread_pool.setMaxThreadCount(max_thread_count)
|
240
|
+
|
241
|
+
def reserve_thread(self) -> None:
|
242
|
+
"""
|
243
|
+
Reserves a thread in the thread pool.
|
244
|
+
|
245
|
+
Examples
|
246
|
+
--------
|
247
|
+
```python
|
248
|
+
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
249
|
+
import time
|
250
|
+
|
251
|
+
class Worker(PyloidRunnable):
|
252
|
+
def run(self):
|
253
|
+
time.sleep(1)
|
254
|
+
print("Task executed on reserved thread")
|
255
|
+
|
256
|
+
# Create thread pool
|
257
|
+
thread_pool = PyloidThreadPool()
|
258
|
+
|
259
|
+
# Reserve thread
|
260
|
+
thread_pool.reserve_thread()
|
261
|
+
|
262
|
+
try:
|
263
|
+
# Execute task on reserved thread
|
264
|
+
worker = Worker()
|
265
|
+
thread_pool.start_on_reserved_thread(worker)
|
266
|
+
|
267
|
+
# Wait for task completion
|
268
|
+
thread_pool.wait_for_done()
|
269
|
+
finally:
|
270
|
+
# Important: Reserved threads must be released
|
271
|
+
thread_pool.release_thread()
|
272
|
+
```
|
273
|
+
"""
|
274
|
+
self.thread_pool.reserveThread()
|
275
|
+
|
276
|
+
def release_thread(self) -> None:
|
277
|
+
"""
|
278
|
+
Releases a reserved thread in the thread pool.
|
279
|
+
|
280
|
+
Examples
|
281
|
+
--------
|
282
|
+
```python
|
283
|
+
from pyloid.thread_pool import PyloidThreadPool
|
284
|
+
|
285
|
+
thread_pool = PyloidThreadPool()
|
286
|
+
thread_pool.release_thread()
|
287
|
+
```
|
288
|
+
"""
|
289
|
+
self.thread_pool.releaseThread()
|
290
|
+
|
291
|
+
def clear(self) -> None:
|
292
|
+
"""
|
293
|
+
Removes all pending tasks from the thread pool.
|
294
|
+
|
295
|
+
Examples
|
296
|
+
--------
|
297
|
+
```python
|
298
|
+
from pyloid.thread_pool import PyloidThreadPool
|
299
|
+
|
300
|
+
thread_pool = PyloidThreadPool()
|
301
|
+
thread_pool.clear()
|
302
|
+
```
|
303
|
+
"""
|
304
|
+
self.thread_pool.clear()
|
305
|
+
|
306
|
+
# def contains(self, thread: QThread) -> bool:
|
307
|
+
# return self.thread_pool.contains(thread)
|
308
|
+
|
309
|
+
def get_expiry_timeout(self) -> int:
|
310
|
+
"""
|
311
|
+
Returns the thread expiry timeout in the thread pool.
|
312
|
+
|
313
|
+
Returns
|
314
|
+
-------
|
315
|
+
int
|
316
|
+
Thread expiry timeout
|
317
|
+
|
318
|
+
Examples
|
319
|
+
--------
|
320
|
+
```python
|
321
|
+
from pyloid.thread_pool import PyloidThreadPool
|
322
|
+
|
323
|
+
thread_pool = PyloidThreadPool()
|
324
|
+
print(thread_pool.get_expiry_timeout())
|
325
|
+
```
|
326
|
+
"""
|
327
|
+
return self.thread_pool.expiryTimeout()
|
328
|
+
|
329
|
+
def set_expiry_timeout(self, expiry_timeout: int) -> None:
|
330
|
+
"""
|
331
|
+
Sets the thread expiry timeout in the thread pool.
|
332
|
+
|
333
|
+
Parameters
|
334
|
+
----------
|
335
|
+
expiry_timeout : int
|
336
|
+
Thread expiry timeout
|
337
|
+
|
338
|
+
Examples
|
339
|
+
--------
|
340
|
+
```python
|
341
|
+
from pyloid.thread_pool import PyloidThreadPool
|
342
|
+
|
343
|
+
thread_pool = PyloidThreadPool()
|
344
|
+
thread_pool.set_expiry_timeout(1000)
|
345
|
+
```
|
346
|
+
"""
|
347
|
+
self.thread_pool.setExpiryTimeout(expiry_timeout)
|
348
|
+
|
349
|
+
# def set_stack_size(self, stack_size: int) -> None:
|
350
|
+
# self.thread_pool.setStackSize(stack_size)
|
351
|
+
|
352
|
+
# def stack_size(self) -> int:
|
353
|
+
# return self.thread_pool.stackSize()
|
354
|
+
|
355
|
+
# def set_thread_priority(self, priority: QThread.Priority) -> None:
|
356
|
+
# self.thread_pool.setThreadPriority(priority)
|
357
|
+
|
358
|
+
# def thread_priority(self) -> QThread.Priority:
|
359
|
+
# return self.thread_pool.threadPriority()
|
360
|
+
|
361
|
+
def start_on_reserved_thread(self, runnable: QRunnable) -> None:
|
362
|
+
"""
|
363
|
+
Executes a task on a reserved thread.
|
364
|
+
|
365
|
+
Parameters
|
366
|
+
----------
|
367
|
+
runnable : QRunnable
|
368
|
+
Task to be executed
|
369
|
+
|
370
|
+
Examples
|
371
|
+
--------
|
372
|
+
```python
|
373
|
+
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
374
|
+
import time
|
375
|
+
|
376
|
+
class Worker(PyloidRunnable):
|
377
|
+
def run(self):
|
378
|
+
time.sleep(1)
|
379
|
+
print("Task executed on reserved thread")
|
380
|
+
|
381
|
+
worker = Worker()
|
382
|
+
thread_pool = PyloidThreadPool()
|
383
|
+
thread_pool.reserve_thread()
|
384
|
+
thread_pool.start_on_reserved_thread(worker)
|
385
|
+
thread_pool.wait_for_done()
|
386
|
+
thread_pool.release_thread()
|
387
|
+
```
|
388
|
+
"""
|
389
|
+
self.thread_pool.startOnReservedThread(runnable)
|
390
|
+
|
391
|
+
def try_start(self, runnable: Union[QRunnable, Callable]) -> bool:
|
392
|
+
"""
|
393
|
+
Adds a new task to the thread pool and attempts to execute it immediately.
|
394
|
+
|
395
|
+
Only executes the task if the thread pool has available capacity.
|
396
|
+
Operates in a non-blocking manner and does not start the task if the thread pool is full.
|
397
|
+
|
398
|
+
Parameters
|
399
|
+
----------
|
400
|
+
runnable : Union[QRunnable, Callable]
|
401
|
+
Task to be executed
|
402
|
+
|
403
|
+
Returns
|
404
|
+
-------
|
405
|
+
bool
|
406
|
+
True: Task successfully started
|
407
|
+
False: Task could not be started because the thread pool is full
|
408
|
+
|
409
|
+
Examples
|
410
|
+
--------
|
411
|
+
```python
|
412
|
+
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
413
|
+
|
414
|
+
class Worker(PyloidRunnable):
|
415
|
+
def run(self):
|
416
|
+
print("Task executed")
|
417
|
+
|
418
|
+
thread_pool = PyloidThreadPool()
|
419
|
+
worker = Worker()
|
420
|
+
|
421
|
+
if thread_pool.try_start(worker):
|
422
|
+
print("Task started")
|
423
|
+
else:
|
424
|
+
print("Task could not be started because the thread pool is full")
|
425
|
+
```
|
426
|
+
"""
|
427
|
+
return self.thread_pool.tryStart(runnable)
|
428
|
+
|
429
|
+
def try_take(self, runnable: QRunnable) -> bool:
|
430
|
+
"""
|
431
|
+
Attempts to remove a specific task from the thread pool queue.
|
432
|
+
|
433
|
+
Only removes tasks that have not yet been executed. Tasks that are already running cannot be removed.
|
434
|
+
Used when task cancellation is needed.
|
435
|
+
|
436
|
+
Parameters
|
437
|
+
----------
|
438
|
+
runnable : QRunnable
|
439
|
+
Task to be removed from the queue
|
440
|
+
|
441
|
+
Returns
|
442
|
+
-------
|
443
|
+
bool
|
444
|
+
True: Task successfully removed from the queue
|
445
|
+
False: Task could not be removed (already running or not found)
|
446
|
+
|
447
|
+
Examples
|
448
|
+
--------
|
449
|
+
```python
|
450
|
+
from pyloid.thread_pool import PyloidThreadPool, PyloidRunnable
|
451
|
+
|
452
|
+
class Worker(PyloidRunnable):
|
453
|
+
def run(self):
|
454
|
+
print("Task executed")
|
455
|
+
|
456
|
+
thread_pool = PyloidThreadPool()
|
457
|
+
worker = Worker()
|
458
|
+
|
459
|
+
# Add task
|
460
|
+
thread_pool.start(worker)
|
461
|
+
|
462
|
+
# Attempt to remove task
|
463
|
+
if thread_pool.try_take(worker):
|
464
|
+
print("Task removed from queue")
|
465
|
+
else:
|
466
|
+
print("Task could not be removed (already running or not found)")
|
467
|
+
```
|
468
|
+
"""
|
469
|
+
return self.thread_pool.tryTake(runnable)
|
470
|
+
|
471
|
+
def wait_for_done(self, timeout: Optional[int] = None) -> bool:
|
472
|
+
"""
|
473
|
+
Waits for tasks to complete.
|
474
|
+
|
475
|
+
If no timeout is specified, waits indefinitely until completion.
|
476
|
+
|
477
|
+
Parameters
|
478
|
+
----------
|
479
|
+
timeout : Optional[int]
|
480
|
+
Wait time
|
481
|
+
|
482
|
+
Returns
|
483
|
+
-------
|
484
|
+
bool
|
485
|
+
True if tasks completed, False otherwise
|
486
|
+
|
487
|
+
Examples
|
488
|
+
--------
|
489
|
+
```python
|
490
|
+
from pyloid.thread_pool import PyloidThreadPool
|
491
|
+
|
492
|
+
thread_pool = PyloidThreadPool()
|
493
|
+
thread_pool.wait_for_done()
|
494
|
+
|
495
|
+
print("Tasks completed.")
|
496
|
+
```
|
497
|
+
"""
|
498
|
+
if timeout is None:
|
499
|
+
return self.thread_pool.waitForDone(-1)
|
500
|
+
else:
|
501
501
|
return self.thread_pool.waitForDone(timeout)
|