qemu.aqmp.models module

QMP Data Models

This module provides simplistic data classes that represent the few structures that the QMP spec mandates; they are used to verify incoming data to make sure it conforms to spec.

class qemu.aqmp.models.Model(raw: Mapping[str, Any])[source]

Bases: object

Abstract data model, representing some QMP object of some kind.

Parameters

raw – The raw object to be validated.

Raises

  • KeyError – If any required fields are absent.

  • TypeError – If any required fields have the wrong type.

class qemu.aqmp.models.Greeting(raw: Mapping[str, Any])[source]

Bases: qemu.aqmp.models.Model

Defined in qmp-spec.txt, section 2.2, “Server Greeting”.

Parameters

raw – The raw Greeting object.

Raises

  • KeyError – If any required fields are absent.

  • TypeError – If any required fields have the wrong type.

QMP: qemu.aqmp.models.QMPGreeting

‘QMP’ member

class qemu.aqmp.models.QMPGreeting(raw: Mapping[str, Any])[source]

Bases: qemu.aqmp.models.Model

Defined in qmp-spec.txt, section 2.2, “Server Greeting”.

Parameters

raw – The raw QMPGreeting object.

Raises

  • KeyError – If any required fields are absent.

  • TypeError – If any required fields have the wrong type.

version: Mapping[str, object]

‘version’ member

capabilities: Sequence[object]

‘capabilities’ member

class qemu.aqmp.models.ErrorResponse(raw: Mapping[str, Any])[source]

Bases: qemu.aqmp.models.Model

Defined in qmp-spec.txt, section 2.4.2, “error”.

Parameters

raw – The raw ErrorResponse object.

Raises

  • KeyError – If any required fields are absent.

  • TypeError – If any required fields have the wrong type.

error: qemu.aqmp.models.ErrorInfo

‘error’ member

id: Optional[object]

‘id’ member

class qemu.aqmp.models.ErrorInfo(raw: Mapping[str, Any])[source]

Bases: qemu.aqmp.models.Model

Defined in qmp-spec.txt, section 2.4.2, “error”.

Parameters

raw – The raw ErrorInfo object.

Raises

  • KeyError – If any required fields are absent.

  • TypeError – If any required fields have the wrong type.

class_: str

‘class’ member, with an underscore to avoid conflicts in Python.

desc: str

‘desc’ member