__all__ to module-level (#1441)

pymodbus-dev · Mar 17, 2023 · 599d57e · 599d57e
1 parent e43ab54
commit 599d57e
Show file tree

Hide file tree

Showing 34 changed files with 224 additions and 321 deletions.
diff --git a/examples/build_bcd_payload.py b/examples/build_bcd_payload.py
@@ -4,6 +4,7 @@
 that can be used in the pymodbus library. Below is a
 simple binary coded decimal builder and decoder.
 """
+
 from struct import pack
 
 from pymodbus.constants import Endian
@@ -219,9 +220,3 @@ def decode_string(self, size: int = 1):
 
 if __name__ == "__main__":
     print("Test")
-
-# --------------------------------------------------------------------------- #
-# Exported Identifiers
-# --------------------------------------------------------------------------- #
-
-__all__ = ["BcdPayloadBuilder", "BcdPayloadDecoder"]
diff --git a/pymodbus/__init__.py b/pymodbus/__init__.py
@@ -1,21 +1,17 @@
 """Pymodbus: Modbus Protocol Implementation.
 
-Released under the the BSD license
+Released under the BSD license
 """
 
+__all__ = [
+    "pymodbus_apply_logging_config",
+    "__version__",
+    "__version_full__",
+]
+
 from pymodbus.logging import pymodbus_apply_logging_config
 from pymodbus.version import version
 
 
 __version__ = version.short()
 __version_full__ = str(version)
-
-# --------------------------------------------------------------------------- #
-# Exported symbols
-# --------------------------------------------------------------------------- #
-
-__all__ = [
-    "pymodbus_apply_logging_config",
-    "__version__",
-    "__version_full__",
-]
diff --git a/pymodbus/bit_read_message.py b/pymodbus/bit_read_message.py
@@ -1,4 +1,13 @@
 """Bit Reading Request/Response messages."""
+
+__all__ = [
+    "ReadBitsResponseBase",
+    "ReadCoilsRequest",
+    "ReadCoilsResponse",
+    "ReadDiscreteInputsRequest",
+    "ReadDiscreteInputsResponse",
+]
+
 # pylint: disable=missing-type-doc
 import struct
 
@@ -256,15 +265,3 @@ def __init__(self, values=None, slave=Defaults.Slave, **kwargs):
         :param slave: Modbus slave slave ID
         """
         ReadBitsResponseBase.__init__(self, values, slave, **kwargs)
-
-
-# ---------------------------------------------------------------------------#
-#  Exported symbols
-# ---------------------------------------------------------------------------#
-__all__ = [
-    "ReadBitsResponseBase",
-    "ReadCoilsRequest",
-    "ReadCoilsResponse",
-    "ReadDiscreteInputsRequest",
-    "ReadDiscreteInputsResponse",
-]
diff --git a/pymodbus/bit_write_message.py b/pymodbus/bit_write_message.py
@@ -2,6 +2,14 @@
 
 TODO write mask request/response
 """
+
+__all__ = [
+    "WriteSingleCoilRequest",
+    "WriteSingleCoilResponse",
+    "WriteMultipleCoilsRequest",
+    "WriteMultipleCoilsResponse",
+]
+
 # pylint: disable=missing-type-doc
 import struct
 
@@ -276,14 +284,3 @@ def __str__(self):
         :returns: A string representation of the instance
         """
         return f"WriteNCoilResponse({self.address}, {self.count})"
-
-
-# ---------------------------------------------------------------------------#
-#  Exported symbols
-# ---------------------------------------------------------------------------#
-__all__ = [
-    "WriteSingleCoilRequest",
-    "WriteSingleCoilResponse",
-    "WriteMultipleCoilsRequest",
-    "WriteMultipleCoilsResponse",
-]
diff --git a/pymodbus/client/__init__.py b/pymodbus/client/__init__.py
@@ -1,14 +1,5 @@
 """Client"""
-from pymodbus.client.base import ModbusBaseClient
-from pymodbus.client.serial import AsyncModbusSerialClient, ModbusSerialClient
-from pymodbus.client.tcp import AsyncModbusTcpClient, ModbusTcpClient
-from pymodbus.client.tls import AsyncModbusTlsClient, ModbusTlsClient
-from pymodbus.client.udp import AsyncModbusUdpClient, ModbusUdpClient
-
 
-# ---------------------------------------------------------------------------#
-#  Exported symbols
-# ---------------------------------------------------------------------------#
 __all__ = [
     "AsyncModbusSerialClient",
     "AsyncModbusTcpClient",
@@ -20,3 +11,9 @@
     "ModbusTlsClient",
     "ModbusUdpClient",
 ]
+
+from pymodbus.client.base import ModbusBaseClient
+from pymodbus.client.serial import AsyncModbusSerialClient, ModbusSerialClient
+from pymodbus.client.tcp import AsyncModbusTcpClient, ModbusTcpClient
+from pymodbus.client.tls import AsyncModbusTlsClient, ModbusTlsClient
+from pymodbus.client.udp import AsyncModbusUdpClient, ModbusUdpClient
diff --git a/pymodbus/client/sync_diag.py b/pymodbus/client/sync_diag.py
@@ -1,4 +1,10 @@
 """Sync diag."""
+
+__all__ = [
+    "ModbusTcpDiagClient",
+    "get_client",
+]
+
 import socket
 import time
 
@@ -160,10 +166,3 @@ def get_client():
     :returns: ModbusTcpClient or a child class thereof
     """
     return ModbusTcpDiagClient
-
-
-# --------------------------------------------------------------------------- #
-# Exported symbols
-# --------------------------------------------------------------------------- #
-
-__all__ = ["ModbusTcpDiagClient", "get_client"]
diff --git a/pymodbus/constants.py b/pymodbus/constants.py
@@ -307,16 +307,3 @@ class MoreData:  # pylint: disable=too-few-public-methods
     def __init__(self):
         """Prohibit objects."""
         raise RuntimeError(INTERNAL_ERROR)
-
-
-# ---------------------------------------------------------------------------#
-#  Exported Identifiers
-# ---------------------------------------------------------------------------#
-__all__ = [
-    "Defaults",
-    "ModbusStatus",
-    "Endian",
-    "ModbusPlusOperation",
-    "DeviceInformation",
-    "MoreData",
-]
diff --git a/pymodbus/datastore/__init__.py b/pymodbus/datastore/__init__.py
@@ -1,4 +1,14 @@
 """Datastore."""
+
+__all__ = [
+    "ModbusBaseSlaveContext",
+    "ModbusSequentialDataBlock",
+    "ModbusSparseDataBlock",
+    "ModbusSlaveContext",
+    "ModbusServerContext",
+    "ModbusSimulatorContext",
+]
+
 from pymodbus.datastore.context import (
     ModbusBaseSlaveContext,
     ModbusServerContext,
@@ -9,16 +19,3 @@
     ModbusSequentialDataBlock,
     ModbusSparseDataBlock,
 )
-
-
-# ---------------------------------------------------------------------------#
-#  Exported symbols
-# ---------------------------------------------------------------------------#
-__all__ = [
-    "ModbusBaseSlaveContext",
-    "ModbusSequentialDataBlock",
-    "ModbusSparseDataBlock",
-    "ModbusSlaveContext",
-    "ModbusServerContext",
-    "ModbusSimulatorContext",
-]
diff --git a/pymodbus/device.py b/pymodbus/device.py
@@ -4,6 +4,13 @@
 maintained in the server context and the various methods
 should be inserted in the correct locations.
 """
+
+__all__ = [
+    "ModbusPlusStatistics",
+    "ModbusDeviceIdentification",
+    "DeviceInformationFactory",
+]
+
 import struct
 
 # pylint: disable=missing-type-doc
@@ -599,14 +606,3 @@ def getDiagnosticRegister(self):
         :returns: The diagnostic register collection
         """
         return self.__diagnostic
-
-
-# ---------------------------------------------------------------------------#
-#  Exported Identifiers
-# ---------------------------------------------------------------------------#
-__all__ = [
-    "ModbusPlusStatistics",
-    "ModbusDeviceIdentification",
-    "DeviceInformationFactory",
-    "ModbusControlBlock",
-]
diff --git a/pymodbus/diag_message.py b/pymodbus/diag_message.py
@@ -3,6 +3,46 @@
 These need to be tied into a the current server context
 or linked to the appropriate data
 """
+
+__all__ = [
+    "DiagnosticStatusRequest",
+    "DiagnosticStatusResponse",
+    "ReturnQueryDataRequest",
+    "ReturnQueryDataResponse",
+    "RestartCommunicationsOptionRequest",
+    "RestartCommunicationsOptionResponse",
+    "ReturnDiagnosticRegisterRequest",
+    "ReturnDiagnosticRegisterResponse",
+    "ChangeAsciiInputDelimiterRequest",
+    "ChangeAsciiInputDelimiterResponse",
+    "ForceListenOnlyModeRequest",
+    "ForceListenOnlyModeResponse",
+    "ClearCountersRequest",
+    "ClearCountersResponse",
+    "ReturnBusMessageCountRequest",
+    "ReturnBusMessageCountResponse",
+    "ReturnBusCommunicationErrorCountRequest",
+    "ReturnBusCommunicationErrorCountResponse",
+    "ReturnBusExceptionErrorCountRequest",
+    "ReturnBusExceptionErrorCountResponse",
+    "ReturnSlaveMessageCountRequest",
+    "ReturnSlaveMessageCountResponse",
+    "ReturnSlaveNoResponseCountRequest",
+    "ReturnSlaveNoResponseCountResponse",
+    "ReturnSlaveNAKCountRequest",
+    "ReturnSlaveNAKCountResponse",
+    "ReturnSlaveBusyCountRequest",
+    "ReturnSlaveBusyCountResponse",
+    "ReturnSlaveBusCharacterOverrunCountRequest",
+    "ReturnSlaveBusCharacterOverrunCountResponse",
+    "ReturnIopOverrunCountRequest",
+    "ReturnIopOverrunCountResponse",
+    "ClearOverrunCountRequest",
+    "ClearOverrunCountResponse",
+    "GetClearModbusPlusRequest",
+    "GetClearModbusPlusResponse",
+]
+
 # pylint: disable=missing-type-doc
 import struct
 
@@ -826,46 +866,3 @@ class GetClearModbusPlusResponse(DiagnosticStatusSimpleResponse):
     """
 
     sub_function_code = 0x0015
-
-
-# ---------------------------------------------------------------------------#
-#  Exported symbols
-# ---------------------------------------------------------------------------#
-__all__ = [
-    "DiagnosticStatusRequest",
-    "DiagnosticStatusResponse",
-    "ReturnQueryDataRequest",
-    "ReturnQueryDataResponse",
-    "RestartCommunicationsOptionRequest",
-    "RestartCommunicationsOptionResponse",
-    "ReturnDiagnosticRegisterRequest",
-    "ReturnDiagnosticRegisterResponse",
-    "ChangeAsciiInputDelimiterRequest",
-    "ChangeAsciiInputDelimiterResponse",
-    "ForceListenOnlyModeRequest",
-    "ForceListenOnlyModeResponse",
-    "ClearCountersRequest",
-    "ClearCountersResponse",
-    "ReturnBusMessageCountRequest",
-    "ReturnBusMessageCountResponse",
-    "ReturnBusCommunicationErrorCountRequest",
-    "ReturnBusCommunicationErrorCountResponse",
-    "ReturnBusExceptionErrorCountRequest",
-    "ReturnBusExceptionErrorCountResponse",
-    "ReturnSlaveMessageCountRequest",
-    "ReturnSlaveMessageCountResponse",
-    "ReturnSlaveNoResponseCountRequest",
-    "ReturnSlaveNoResponseCountResponse",
-    "ReturnSlaveNAKCountRequest",
-    "ReturnSlaveNAKCountResponse",
-    "ReturnSlaveBusyCountRequest",
-    "ReturnSlaveBusyCountResponse",
-    "ReturnSlaveBusCharacterOverrunCountRequest",
-    "ReturnSlaveBusCharacterOverrunCountResponse",
-    "ReturnIopOverrunCountRequest",
-    "ReturnIopOverrunCountResponse",
-    "ClearOverrunCountRequest",
-    "ClearOverrunCountResponse",
-    "GetClearModbusPlusRequest",
-    "GetClearModbusPlusResponse",
-]
diff --git a/pymodbus/exceptions.py b/pymodbus/exceptions.py
@@ -3,6 +3,17 @@
 Custom exceptions to be used in the Modbus code.
 """
 
+__all__ = [
+    "ModbusException",
+    "ModbusIOException",
+    "ParameterException",
+    "NotImplementedException",
+    "ConnectionException",
+    "NoSuchSlaveException",
+    "InvalidMessageReceivedException",
+    "MessageRegisterException",
+]
+
 
 class ModbusException(Exception):
     """Base modbus exception."""
@@ -104,18 +115,3 @@ def __init__(self, string=""):
         """Initialize."""
         message = f"[Error registering message] {string}"
         ModbusException.__init__(self, message)
-
-
-# --------------------------------------------------------------------------- #
-# Exported symbols
-# --------------------------------------------------------------------------- #
-__all__ = [
-    "ModbusException",
-    "ModbusIOException",
-    "ParameterException",
-    "NotImplementedException",
-    "ConnectionException",
-    "NoSuchSlaveException",
-    "InvalidMessageReceivedException",
-    "MessageRegisterException",
-]
diff --git a/pymodbus/factory.py b/pymodbus/factory.py
@@ -8,6 +8,7 @@
 Regardless of how many functions are added to the lookup, O(1) behavior is
 kept as a result of a pre-computed lookup dictionary.
 """
+
 # pylint: disable=missing-type-doc
 from pymodbus.bit_read_message import (
     ReadCoilsRequest,
@@ -367,11 +368,3 @@ def register(self, function):
             self.__sub_lookup[function.function_code][
                 function.sub_function_code
             ] = function
-
-
-# --------------------------------------------------------------------------- #
-# Exported symbols
-# --------------------------------------------------------------------------- #
-
-
-__all__ = ["ServerDecoder", "ClientDecoder"]