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
|
"""
***************************************************************************
fromfunction.py
---------------------
Date : May 2018
Copyright : (C) 2018 by Denis Rouzaud
Email : denis@opengis.ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
import typing as _typing
from .qgstaskwrapper import QgsTaskWrapper
from qgis._core import QgsTask
@staticmethod
def _fromFunction(
description: str,
function: _typing.Callable,
*args,
on_finished: _typing.Optional[_typing.Callable] = None,
flags=QgsTask.Flag.AllFlags,
**kwargs
) -> QgsTask:
"""
Creates a new QgsTask task from a python function.
Example
-------
.. code-block:: python
def calculate(task):
# pretend this is some complex maths and stuff we want
# to run in the background
return 5*6
def calculation_finished(exception, value=None):
if not exception:
iface.messageBar().pushMessage(
'the magic number is {}'.format(value))
else:
iface.messageBar().pushMessage(
str(exception))
task = QgsTask.fromFunction('my task', calculate,
on_finished=calculation_finished)
QgsApplication.taskManager().addTask(task)
"""
assert function
return QgsTaskWrapper(description, flags, function, on_finished, *args, **kwargs)
|
