Fix type hints

This commit is contained in:
Nyall Dawson 2024-08-17 18:45:03 +10:00
parent bad8ad7a8e
commit 9e25dd9aaf

View File

@ -27,6 +27,11 @@ __date__ = 'November 2018'
__copyright__ = '(C) 2018, Nathan Woodrow'
import typing as _typing
from qgis.core import QgsProcessingAlgorithm as _QgsProcessingAlgorithm
from qgis.core import QgsProcessingFeedback as _QgsProcessingFeedback
from qgis.core import QgsProcessingContext as _QgsProcessingContext
from .algfactory import ProcessingAlgFactory
alg = ProcessingAlgFactory()
@ -48,11 +53,11 @@ def algorithmHelp(id: str) -> None:
raise QgsNotSupportedException('Processing plugin has not been loaded')
def run(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
def run(algOrName: _typing.Union[str, _QgsProcessingAlgorithm],
parameters: _typing.Dict[str, object],
onFinish: _typing.Optional[_typing.Callable] = None,
feedback: _typing.Optional["QgsProcessingFeedback"] = None,
context: _typing.Optional[QgsProcessingContext] = None,
feedback: _typing.Optional[_QgsProcessingFeedback] = None,
context: _typing.Optional[_QgsProcessingContext] = None,
is_child_algorithm: bool = False) -> _typing.Union[_typing.Dict, None]:
"""
Executes given algorithm and returns its outputs as dictionary object.
@ -73,10 +78,10 @@ def run(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
raise QgsNotSupportedException('Processing plugin has not been loaded')
def runAndLoadResults(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
def runAndLoadResults(algOrName: _typing.Union[str, _QgsProcessingAlgorithm],
parameters: _typing.Dict[str, object],
feedback: _typing.Optional["QgsProcessingFeedback"] = None,
context: _typing.Optional["QgsProcessingContext"] = None) -> _typing.Union[_typing.Dict, None]:
feedback: _typing.Optional[_QgsProcessingFeedback] = None,
context: _typing.Optional[_QgsProcessingContext] = None) -> _typing.Union[_typing.Dict, None]:
"""
Executes given algorithm and load its results into the current QGIS project
when possible.
@ -95,8 +100,8 @@ def runAndLoadResults(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
raise QgsNotSupportedException('Processing plugin has not been loaded')
def createAlgorithmDialog(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
parameters: _typing.Dict[str, object] = {}) -> _typing.Union[str, 'QgsProcessingAlgorithm']:
def createAlgorithmDialog(algOrName: _typing.Union[str, _QgsProcessingAlgorithm],
parameters: _typing.Dict[str, object] = {}) -> _typing.Union[str, _QgsProcessingAlgorithm]:
"""
Creates and returns an algorithm dialog for the specified algorithm, prepopulated
with a given set of parameters. It is the caller's responsibility to execute
@ -113,8 +118,8 @@ def createAlgorithmDialog(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'
raise QgsNotSupportedException('Processing plugin has not been loaded')
def execAlgorithmDialog(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
parameters: _typing.Dict[str: object] = {}) -> _typing.Union[_typing.Dict, None]:
def execAlgorithmDialog(algOrName: _typing.Union[str, _QgsProcessingAlgorithm],
parameters: _typing.Dict[str, object] = {}) -> _typing.Union[_typing.Dict, None]:
"""
Executes an algorithm dialog for the specified algorithm, prepopulated
with a given set of parameters.
@ -130,7 +135,7 @@ def execAlgorithmDialog(algOrName: _typing.Union[str, 'QgsProcessingAlgorithm'],
raise QgsNotSupportedException('Processing plugin has not been loaded')
def createContext(feedback: _typing.Optional["QgsProcessingFeedback"] = None) -> "QgsProcessingContext":
def createContext(feedback: _typing.Optional[_QgsProcessingFeedback] = None) -> _QgsProcessingContext:
"""
Creates a default processing context