Class BackgroundTaskThread

python/plugin.py:1053–1088

The ``BackgroundTaskThread`` class provides an all-in-one solution for executing a :py:class:`.BackgroundTask` in a thread. See the :py:class:`.BackgroundTask` for additional information. :param initial_progress_text: text description of the task to display in the status bar in the UI, defaul

class BackgroundTaskThread(BackgroundTask):
	"""
	The ``BackgroundTaskThread`` class provides an all-in-one solution for executing a :py:class:`.BackgroundTask`
	in a thread.

	See the :py:class:`.BackgroundTask` for additional information.

	:param initial_progress_text: text description of the task to display in the status bar in the UI, defaults to `""`
	:param can_cancel: whether to enable cancellation of the task, defaults to `False`
	"""
	def __init__(self, initial_progress_text: str = "", can_cancel: bool = False):
		class _Thread(threading.Thread):
			def __init__(self, task: 'BackgroundTaskThread'):
				threading.Thread.__init__(self)
				self.task = task

			def run(self):
				if self.task is None:
					raise Exception("Can not call run more than once per thread")
				try:
					self.task.run()
				finally:
					self.task.finish()
					self.task = None

		BackgroundTask.__init__(self, initial_progress_text, can_cancel)
		self.thread = _Thread(self)

	def run(self):
		pass

	def start(self):
		self.thread.start()

	def join(self, timeout=None):
		self.thread.join(timeout)