Skip to content

Commit 599d57e

Browse files
authored
__all__ to module-level (#1441)
1 parent e43ab54 commit 599d57e

34 files changed

+224
-321
lines changed

examples/build_bcd_payload.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
that can be used in the pymodbus library. Below is a
55
simple binary coded decimal builder and decoder.
66
"""
7+
78
from struct import pack
89

910
from pymodbus.constants import Endian
@@ -219,9 +220,3 @@ def decode_string(self, size: int = 1):
219220

220221
if __name__ == "__main__":
221222
print("Test")
222-
223-
# --------------------------------------------------------------------------- #
224-
# Exported Identifiers
225-
# --------------------------------------------------------------------------- #
226-
227-
__all__ = ["BcdPayloadBuilder", "BcdPayloadDecoder"]

pymodbus/__init__.py

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
"""Pymodbus: Modbus Protocol Implementation.
22
3-
Released under the the BSD license
3+
Released under the BSD license
44
"""
55

6+
__all__ = [
7+
"pymodbus_apply_logging_config",
8+
"__version__",
9+
"__version_full__",
10+
]
11+
612
from pymodbus.logging import pymodbus_apply_logging_config
713
from pymodbus.version import version
814

915

1016
__version__ = version.short()
1117
__version_full__ = str(version)
12-
13-
# --------------------------------------------------------------------------- #
14-
# Exported symbols
15-
# --------------------------------------------------------------------------- #
16-
17-
__all__ = [
18-
"pymodbus_apply_logging_config",
19-
"__version__",
20-
"__version_full__",
21-
]

pymodbus/bit_read_message.py

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
"""Bit Reading Request/Response messages."""
2+
3+
__all__ = [
4+
"ReadBitsResponseBase",
5+
"ReadCoilsRequest",
6+
"ReadCoilsResponse",
7+
"ReadDiscreteInputsRequest",
8+
"ReadDiscreteInputsResponse",
9+
]
10+
211
# pylint: disable=missing-type-doc
312
import struct
413

@@ -256,15 +265,3 @@ def __init__(self, values=None, slave=Defaults.Slave, **kwargs):
256265
:param slave: Modbus slave slave ID
257266
"""
258267
ReadBitsResponseBase.__init__(self, values, slave, **kwargs)
259-
260-
261-
# ---------------------------------------------------------------------------#
262-
# Exported symbols
263-
# ---------------------------------------------------------------------------#
264-
__all__ = [
265-
"ReadBitsResponseBase",
266-
"ReadCoilsRequest",
267-
"ReadCoilsResponse",
268-
"ReadDiscreteInputsRequest",
269-
"ReadDiscreteInputsResponse",
270-
]

pymodbus/bit_write_message.py

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
33
TODO write mask request/response
44
"""
5+
6+
__all__ = [
7+
"WriteSingleCoilRequest",
8+
"WriteSingleCoilResponse",
9+
"WriteMultipleCoilsRequest",
10+
"WriteMultipleCoilsResponse",
11+
]
12+
513
# pylint: disable=missing-type-doc
614
import struct
715

@@ -276,14 +284,3 @@ def __str__(self):
276284
:returns: A string representation of the instance
277285
"""
278286
return f"WriteNCoilResponse({self.address}, {self.count})"
279-
280-
281-
# ---------------------------------------------------------------------------#
282-
# Exported symbols
283-
# ---------------------------------------------------------------------------#
284-
__all__ = [
285-
"WriteSingleCoilRequest",
286-
"WriteSingleCoilResponse",
287-
"WriteMultipleCoilsRequest",
288-
"WriteMultipleCoilsResponse",
289-
]

pymodbus/client/__init__.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
"""Client"""
2-
from pymodbus.client.base import ModbusBaseClient
3-
from pymodbus.client.serial import AsyncModbusSerialClient, ModbusSerialClient
4-
from pymodbus.client.tcp import AsyncModbusTcpClient, ModbusTcpClient
5-
from pymodbus.client.tls import AsyncModbusTlsClient, ModbusTlsClient
6-
from pymodbus.client.udp import AsyncModbusUdpClient, ModbusUdpClient
7-
82

9-
# ---------------------------------------------------------------------------#
10-
# Exported symbols
11-
# ---------------------------------------------------------------------------#
123
__all__ = [
134
"AsyncModbusSerialClient",
145
"AsyncModbusTcpClient",
@@ -20,3 +11,9 @@
2011
"ModbusTlsClient",
2112
"ModbusUdpClient",
2213
]
14+
15+
from pymodbus.client.base import ModbusBaseClient
16+
from pymodbus.client.serial import AsyncModbusSerialClient, ModbusSerialClient
17+
from pymodbus.client.tcp import AsyncModbusTcpClient, ModbusTcpClient
18+
from pymodbus.client.tls import AsyncModbusTlsClient, ModbusTlsClient
19+
from pymodbus.client.udp import AsyncModbusUdpClient, ModbusUdpClient

pymodbus/client/sync_diag.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
"""Sync diag."""
2+
3+
__all__ = [
4+
"ModbusTcpDiagClient",
5+
"get_client",
6+
]
7+
28
import socket
39
import time
410

@@ -160,10 +166,3 @@ def get_client():
160166
:returns: ModbusTcpClient or a child class thereof
161167
"""
162168
return ModbusTcpDiagClient
163-
164-
165-
# --------------------------------------------------------------------------- #
166-
# Exported symbols
167-
# --------------------------------------------------------------------------- #
168-
169-
__all__ = ["ModbusTcpDiagClient", "get_client"]

pymodbus/constants.py

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -307,16 +307,3 @@ class MoreData: # pylint: disable=too-few-public-methods
307307
def __init__(self):
308308
"""Prohibit objects."""
309309
raise RuntimeError(INTERNAL_ERROR)
310-
311-
312-
# ---------------------------------------------------------------------------#
313-
# Exported Identifiers
314-
# ---------------------------------------------------------------------------#
315-
__all__ = [
316-
"Defaults",
317-
"ModbusStatus",
318-
"Endian",
319-
"ModbusPlusOperation",
320-
"DeviceInformation",
321-
"MoreData",
322-
]

pymodbus/datastore/__init__.py

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
"""Datastore."""
2+
3+
__all__ = [
4+
"ModbusBaseSlaveContext",
5+
"ModbusSequentialDataBlock",
6+
"ModbusSparseDataBlock",
7+
"ModbusSlaveContext",
8+
"ModbusServerContext",
9+
"ModbusSimulatorContext",
10+
]
11+
212
from pymodbus.datastore.context import (
313
ModbusBaseSlaveContext,
414
ModbusServerContext,
@@ -9,16 +19,3 @@
919
ModbusSequentialDataBlock,
1020
ModbusSparseDataBlock,
1121
)
12-
13-
14-
# ---------------------------------------------------------------------------#
15-
# Exported symbols
16-
# ---------------------------------------------------------------------------#
17-
__all__ = [
18-
"ModbusBaseSlaveContext",
19-
"ModbusSequentialDataBlock",
20-
"ModbusSparseDataBlock",
21-
"ModbusSlaveContext",
22-
"ModbusServerContext",
23-
"ModbusSimulatorContext",
24-
]

pymodbus/device.py

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
maintained in the server context and the various methods
55
should be inserted in the correct locations.
66
"""
7+
8+
__all__ = [
9+
"ModbusPlusStatistics",
10+
"ModbusDeviceIdentification",
11+
"DeviceInformationFactory",
12+
]
13+
714
import struct
815

916
# pylint: disable=missing-type-doc
@@ -599,14 +606,3 @@ def getDiagnosticRegister(self):
599606
:returns: The diagnostic register collection
600607
"""
601608
return self.__diagnostic
602-
603-
604-
# ---------------------------------------------------------------------------#
605-
# Exported Identifiers
606-
# ---------------------------------------------------------------------------#
607-
__all__ = [
608-
"ModbusPlusStatistics",
609-
"ModbusDeviceIdentification",
610-
"DeviceInformationFactory",
611-
"ModbusControlBlock",
612-
]

pymodbus/diag_message.py

Lines changed: 40 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,46 @@
33
These need to be tied into a the current server context
44
or linked to the appropriate data
55
"""
6+
7+
__all__ = [
8+
"DiagnosticStatusRequest",
9+
"DiagnosticStatusResponse",
10+
"ReturnQueryDataRequest",
11+
"ReturnQueryDataResponse",
12+
"RestartCommunicationsOptionRequest",
13+
"RestartCommunicationsOptionResponse",
14+
"ReturnDiagnosticRegisterRequest",
15+
"ReturnDiagnosticRegisterResponse",
16+
"ChangeAsciiInputDelimiterRequest",
17+
"ChangeAsciiInputDelimiterResponse",
18+
"ForceListenOnlyModeRequest",
19+
"ForceListenOnlyModeResponse",
20+
"ClearCountersRequest",
21+
"ClearCountersResponse",
22+
"ReturnBusMessageCountRequest",
23+
"ReturnBusMessageCountResponse",
24+
"ReturnBusCommunicationErrorCountRequest",
25+
"ReturnBusCommunicationErrorCountResponse",
26+
"ReturnBusExceptionErrorCountRequest",
27+
"ReturnBusExceptionErrorCountResponse",
28+
"ReturnSlaveMessageCountRequest",
29+
"ReturnSlaveMessageCountResponse",
30+
"ReturnSlaveNoResponseCountRequest",
31+
"ReturnSlaveNoResponseCountResponse",
32+
"ReturnSlaveNAKCountRequest",
33+
"ReturnSlaveNAKCountResponse",
34+
"ReturnSlaveBusyCountRequest",
35+
"ReturnSlaveBusyCountResponse",
36+
"ReturnSlaveBusCharacterOverrunCountRequest",
37+
"ReturnSlaveBusCharacterOverrunCountResponse",
38+
"ReturnIopOverrunCountRequest",
39+
"ReturnIopOverrunCountResponse",
40+
"ClearOverrunCountRequest",
41+
"ClearOverrunCountResponse",
42+
"GetClearModbusPlusRequest",
43+
"GetClearModbusPlusResponse",
44+
]
45+
646
# pylint: disable=missing-type-doc
747
import struct
848

@@ -826,46 +866,3 @@ class GetClearModbusPlusResponse(DiagnosticStatusSimpleResponse):
826866
"""
827867

828868
sub_function_code = 0x0015
829-
830-
831-
# ---------------------------------------------------------------------------#
832-
# Exported symbols
833-
# ---------------------------------------------------------------------------#
834-
__all__ = [
835-
"DiagnosticStatusRequest",
836-
"DiagnosticStatusResponse",
837-
"ReturnQueryDataRequest",
838-
"ReturnQueryDataResponse",
839-
"RestartCommunicationsOptionRequest",
840-
"RestartCommunicationsOptionResponse",
841-
"ReturnDiagnosticRegisterRequest",
842-
"ReturnDiagnosticRegisterResponse",
843-
"ChangeAsciiInputDelimiterRequest",
844-
"ChangeAsciiInputDelimiterResponse",
845-
"ForceListenOnlyModeRequest",
846-
"ForceListenOnlyModeResponse",
847-
"ClearCountersRequest",
848-
"ClearCountersResponse",
849-
"ReturnBusMessageCountRequest",
850-
"ReturnBusMessageCountResponse",
851-
"ReturnBusCommunicationErrorCountRequest",
852-
"ReturnBusCommunicationErrorCountResponse",
853-
"ReturnBusExceptionErrorCountRequest",
854-
"ReturnBusExceptionErrorCountResponse",
855-
"ReturnSlaveMessageCountRequest",
856-
"ReturnSlaveMessageCountResponse",
857-
"ReturnSlaveNoResponseCountRequest",
858-
"ReturnSlaveNoResponseCountResponse",
859-
"ReturnSlaveNAKCountRequest",
860-
"ReturnSlaveNAKCountResponse",
861-
"ReturnSlaveBusyCountRequest",
862-
"ReturnSlaveBusyCountResponse",
863-
"ReturnSlaveBusCharacterOverrunCountRequest",
864-
"ReturnSlaveBusCharacterOverrunCountResponse",
865-
"ReturnIopOverrunCountRequest",
866-
"ReturnIopOverrunCountResponse",
867-
"ClearOverrunCountRequest",
868-
"ClearOverrunCountResponse",
869-
"GetClearModbusPlusRequest",
870-
"GetClearModbusPlusResponse",
871-
]

0 commit comments

Comments
 (0)