Skip to content

Requests Helpers

Refer to the smp documentation for a complete description of each SMP Request and Response.

Generics and TypeGuards for SMP Requests and Responses.

TEr1 = TypeVar('TEr1', bound=smperror.ErrorV1) module-attribute

Type of SMP Error V1.

TEr2 = TypeVar('TEr2', bound=smperror.ErrorV2) module-attribute

Type of SMP Error V2.

TRep = TypeVar('TRep', bound=Union[smpmessage.ReadResponse, smpmessage.WriteResponse]) module-attribute

Type of successful SMP Response (ReadResponse or WriteResponse).

SMPRequest

Bases: Protocol[TRep, TEr1, TEr2]

A Protocol that groups the expected response and errors with a request.

To use, inherit from an SMP Read or Write Request and define its expected Response, ErrorV1, and ErrorV2.

Example: 

class ImageStatesRead(smpimg.ImageStatesReadRequest):
    _Response = smpimg.ImageStatesReadResponse
    _ErrorV1 = smpimg.ImageManagementErrorV1
    _ErrorV2 = smpimg.ImageManagementErrorV2

Source code in smpclient/generics.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class SMPRequest(Protocol[TRep, TEr1, TEr2]):
    """A `Protocol` that groups the expected response and errors with a request.

    To use, inherit from an SMP Read or Write `Request` and define its expected
    `Response`, `ErrorV1`, and `ErrorV2`.

    Example:
    ```python
    class ImageStatesRead(smpimg.ImageStatesReadRequest):
        _Response = smpimg.ImageStatesReadResponse
        _ErrorV1 = smpimg.ImageManagementErrorV1
        _ErrorV2 = smpimg.ImageManagementErrorV2
    ```
    """

    _Response: Type[TRep]
    _ErrorV1: Type[TEr1]
    _ErrorV2: Type[TEr2]

    @property
    def BYTES(self) -> bytes:  # pragma: no cover
        ...

    @property
    def header(self) -> smphdr.Header:  # pragma: no cover
        ...

BYTES: bytes property

header: smphdr.Header property

error_v1(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV1]

TypeGuard that returns True if the response is an ErrorV1.

Parameters:

Name Type Description Default
response ErrorV1 | TEr2 | TRep

The response to check.

 required

Returns:

Type Description
TypeGuard[ErrorV1]

True if the response is an ErrorV1.
Source code in smpclient/generics.py 
50
51
52
53
54
55
56
57
58
59
def error_v1(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV1]:
    """`TypeGuard` that returns `True` if the `response` is an `ErrorV1`.

    Args:
        response: The response to check.

    Returns:
        `True` if the `response` is an `ErrorV1`.
    """
    return response.RESPONSE_TYPE == smpmessage.ResponseType.ERROR_V1

error_v2(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TEr2]

TypeGuard that returns True if the response is an ErrorV2.

Parameters:

Name Type Description Default
response ErrorV1 | TEr2 | TRep

The response to check.

 required

Returns:

Type Description
TypeGuard[TEr2]

True if the response is an ErrorV2.
Source code in smpclient/generics.py 
62
63
64
65
66
67
68
69
70
71
def error_v2(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TEr2]:
    """`TypeGuard` that returns `True` if the `response` is an `ErrorV2`.

    Args:
        response: The response to check.

    Returns:
        `True` if the `response` is an `ErrorV2`.
    """
    return response.RESPONSE_TYPE == smpmessage.ResponseType.ERROR_V2

error(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV1 | TEr2]

TypeGuard that returns True if the response is an ErrorV1 or ErrorV2.

Parameters:

Name Type Description Default
response ErrorV1 | TEr2 | TRep

The response to check.

 required

Returns:

Type Description
TypeGuard[ErrorV1 | TEr2]

True if the response is an ErrorV1 or ErrorV2.
Source code in smpclient/generics.py 
74
75
76
77
78
79
80
81
82
83
def error(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV1 | TEr2]:
    """`TypeGuard` that returns `True` if the `response` is an `ErrorV1` or `ErrorV2`.

    Args:
        response: The response to check.

    Returns:
        `True` if the `response` is an `ErrorV1` or `ErrorV2`.
    """
    return error_v1(response) or error_v2(response)

success(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TRep]

TypeGuard that returns True if the response is a successful Response.

Parameters:

Name Type Description Default
response ErrorV1 | TEr2 | TRep

The response to check.

 required

Returns:

Type Description
TypeGuard[TRep]

True if the response is a successful Response.
Source code in smpclient/generics.py 
86
87
88
89
90
91
92
93
94
95
def success(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TRep]:
    """`TypeGuard` that returns `True` if the `response` is a successful `Response`.

    Args:
        response: The response to check.

    Returns:
        `True` if the `response` is a successful `Response`.
    """
    return response.RESPONSE_TYPE == smpmessage.ResponseType.SUCCESS