Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion pymodbus/client/mixin.py
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,9 @@ def convert_from_registers( # noqa: C901
if not (data_len := data_type.value[1]):
byte_list = bytearray()
if word_order == "little":
registers.reverse()
# Reverse a copy; the numeric branch below also works on a

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for this comment, it does not provide more information than the the code

# slice copy, so decoding must not mutate the caller's list.
registers = list(reversed(registers))
for x in registers:
byte_list.extend(int.to_bytes(x, 2, "big"))
if data_type == cls.DATATYPE.STRING:
Expand Down
35 changes: 35 additions & 0 deletions test/client/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,41 @@ def test_client_mixin_convert_1234(self, datatype, registers, value):
assert result == value
assert regs == registers

@pytest.mark.parametrize("word_order", ["big", "little"])
@pytest.mark.parametrize(
("datatype", "value"),
[
(ModbusClientMixin.DATATYPE.STRING, "Hello"),
(ModbusClientMixin.DATATYPE.STRING, "abcdefghij"),
(ModbusClientMixin.DATATYPE.BITS, [True, False, True] + [False] * 17),
(ModbusClientMixin.DATATYPE.INT32, 123456),
(ModbusClientMixin.DATATYPE.INT32, [1, 2, 3, 4]),
],
)
def test_client_mixin_convert_from_registers_no_mutation(
self, datatype, value, word_order
):
"""convert_from_registers must not mutate input and stay deterministic.

Regression: for STRING/BITS with word_order="little" the registers list

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not explain bugs in comments! doing that would make the comments larger than the code and with nothing more than historic value.

Seems to continue, please remove all comments that either only have historic value, or explain what the code does without adding value.

was reversed in place, corrupting the caller's data so a second identical
call decoded garbage (non-deterministic output).
"""
registers = ModbusClientMixin.convert_to_registers(
value, datatype, word_order=word_order
)
snapshot = list(registers)
first = ModbusClientMixin.convert_from_registers(
registers, datatype, word_order=word_order
)
# Decoding must leave the caller's list untouched ...
assert registers == snapshot
# ... so repeating the identical call yields the identical result.
second = ModbusClientMixin.convert_from_registers(
registers, datatype, word_order=word_order
)
assert first == second

def test_client_mixin_convert_fail(self):
"""Test convert fail."""
with pytest.raises(TypeError):
Expand Down
Loading