xbox.stump.json_model module¶

JSON models for deserializing Stump messages

exception xbox.stump.json_model.StumpJsonError¶: Bases: Exception

class xbox.stump.json_model.StumpRequest(*, msgid: str, request: str, params: dict = None)¶

Bases: pydantic.main.BaseModel

msgid: str¶

request: str¶

params: Optional[dict]¶

class xbox.stump.json_model.StumpResponse(*, msgid: str, response: str)¶

Bases: pydantic.main.BaseModel

msgid: str¶

response: str¶

class xbox.stump.json_model.StumpError(*, msgid: str, error: str)¶

Bases: pydantic.main.BaseModel

msgid: str¶

error: str¶

class xbox.stump.json_model.StumpNotification(*, notification: str)¶

Bases: pydantic.main.BaseModel

notification: str¶

class xbox.stump.json_model.AppChannelLineups(*, msgid: str, response: str, params: List[xbox.stump.json_model._AppProvider])¶

Bases: xbox.stump.json_model.StumpResponse

params: List[xbox.stump.json_model._AppProvider]¶

class xbox.stump.json_model.EnsureStreamingStarted(*, msgid: str, response: str, params: xbox.stump.json_model._EnsureStreamingStarted)¶

Bases: xbox.stump.json_model.StumpResponse

params: xbox.stump.json_model._EnsureStreamingStarted¶

class xbox.stump.json_model.TunerLineups(*, msgid: str, response: str, params: xbox.stump.json_model._TunerLineups)¶

Bases: xbox.stump.json_model.StumpResponse

params: xbox.stump.json_model._TunerLineups¶

class xbox.stump.json_model.SendKey(*, msgid: str, response: str, params: bool)¶

Bases: xbox.stump.json_model.StumpResponse

params: bool¶

class xbox.stump.json_model.RecentChannels(*, msgid: str, response: str, params: List[xbox.stump.json_model._RecentChannel])¶

Bases: xbox.stump.json_model.StumpResponse

params: List[xbox.stump.json_model._RecentChannel]¶

class xbox.stump.json_model.Configuration(*, msgid: str, response: str, params: List[xbox.stump.json_model._DeviceConfiguration])¶

Bases: xbox.stump.json_model.StumpResponse

params: List[xbox.stump.json_model._DeviceConfiguration]¶

class xbox.stump.json_model.LiveTvInfo(*, msgid: str, response: str, params: xbox.stump.json_model._LiveTvInfo)¶

Bases: xbox.stump.json_model.StumpResponse

params: xbox.stump.json_model._LiveTvInfo¶

class xbox.stump.json_model.HeadendInfo(*, msgid: str, response: str, params: xbox.stump.json_model._HeadendInfo)¶

Bases: xbox.stump.json_model.StumpResponse

params: xbox.stump.json_model._HeadendInfo¶

xbox.stump.json_model.deserialize_stump_message(data: dict) → Union[xbox.stump.json_model.StumpError, xbox.stump.json_model.StumpNotification, xbox.stump.json_model.StumpResponse]¶

Helper for deserializing JSON stump messages

Parameters: data (dict) – Stump message
Returns: Parsed JSON object
Return type: Model