Skip to content

info

info

This part defines the structure how a running QSL worker exposes its capabilities.

EngineInfo dataclass

Source code in src/qgis_server_light/interface/worker/info.py 
33
34
35
36
37
38
@dataclass
class EngineInfo:
    id: str = field(metadata={"type": "Element"})
    qgis_info: QgisInfo = field(metadata={"type": "Element"})
    status: Status = field(metadata={"type": "Element"})
    started: float = field(metadata={"type": "Element"})

id: str = field(metadata={'type': 'Element'}) class-attribute instance-attribute

qgis_info: QgisInfo = field(metadata={'type': 'Element'}) class-attribute instance-attribute

started: float = field(metadata={'type': 'Element'}) class-attribute instance-attribute

status: Status = field(metadata={'type': 'Element'}) class-attribute instance-attribute

__init__(id: str, qgis_info: QgisInfo, status: Status, started: float) -> None

QgisInfo dataclass

Information container to ship minimal knowledge of the underlying QGIS.

Attributes:

  • version (int) –

    The integer representation of the QGIS version e.g. 34400

  • version_name (str) –

    The string representation which also includes the codename e.g. "QGIS Version 4.0.0-Norrköping"

Source code in src/qgis_server_light/interface/worker/info.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@dataclass
class QgisInfo:
    """
    Information container to ship minimal knowledge of the underlying
    QGIS.

    Attributes:
        version: The integer representation of the QGIS version e.g. 34400
        version_name: The string representation which also includes the codename e.g.
            "QGIS Version 4.0.0-Norrköping"

    """

    version: int = field(metadata={"type": "Element"})
    version_name: str = field(metadata={"type": "Element"})
    path: str = field(metadata={"type": "Element"})

path: str = field(metadata={'type': 'Element'}) class-attribute instance-attribute

version: int = field(metadata={'type': 'Element'}) class-attribute instance-attribute

version_name: str = field(metadata={'type': 'Element'}) class-attribute instance-attribute

__init__(version: int, version_name: str, path: str) -> None

Status

Bases: str, Enum

Source code in src/qgis_server_light/interface/worker/info.py 
 8
 9
10
11
12
class Status(str, Enum):
    STARTING = "starting"
    CRASHED = "crashed"
    WAITING = "waiting"
    PROCESSING = "processing"

CRASHED = 'crashed' class-attribute instance-attribute

PROCESSING = 'processing' class-attribute instance-attribute

STARTING = 'starting' class-attribute instance-attribute

WAITING = 'waiting' class-attribute instance-attribute