Add isort and activate CI fail for black/isort

.github/workflows/ci.yml

@@ -190,8 +190,11 @@ jobs:
           - name: flake8
             tox: flake8
             # continue_on_error: true
+          - name: isort
+            tox: isort_CI
+            # continue_on_error: true
           - name: black
-            tox: black
+            tox: black_CI
             # continue_on_error: true
           - name: Docs
             tox: docs

examples/client_async.py

@@ -20,9 +20,9 @@
 The corresponding server must be started before e.g. as:
     python3 server_sync.py
 """
-import os
 import asyncio
 import logging
+import os
 
 # --------------------------------------------------------------------------- #
 # import the various client implementations

examples/client_async_basic_calls.py

@@ -9,8 +9,8 @@
 import asyncio
 import logging
 
-from examples.helper import get_commandline
 from examples.client_async import run_async_client, setup_async_client
+from examples.helper import get_commandline
 
 
 _logger = logging.getLogger()

examples/client_async_extended_calls.py

@@ -25,9 +25,8 @@
 import asyncio
 import logging
 
-from examples.helper import get_commandline
 from examples.client_async import run_async_client, setup_async_client
-
+from examples.helper import get_commandline
 from pymodbus.diag_message import (
     ChangeAsciiInputDelimiterRequest,
     ClearCountersRequest,
@@ -54,6 +53,7 @@
     ReportSlaveIdRequest,
 )
 
+
 _logger = logging.getLogger()
 
 UNIT = 0x01
@@ -168,6 +168,7 @@ async def run_async_ext_calls(client):
     await _execute_information_requests(client)
     await _execute_diagnostic_requests(client)
 
+
 # --------------------------------------------------------------------------- #
 # Extra code, to allow commandline parameters instead of changing the code
 # --------------------------------------------------------------------------- #

examples/client_payload.py

@@ -7,8 +7,8 @@
 
 Works out of the box together with payload_server.py
 """
-from collections import OrderedDict
 import logging
+from collections import OrderedDict
 
 from pymodbus.client import ModbusTcpClient as ModbusClient
 from pymodbus.constants import Endian

examples/client_sync.py

@@ -20,8 +20,8 @@
 The corresponding server must be started before e.g. as:
     python3 server_sync.py
 """
-import os
 import logging
+import os
 
 # --------------------------------------------------------------------------- #
 # import the various client implementations

examples/client_sync_basic_calls.py

@@ -8,8 +8,8 @@
 """
 import logging
 
-from examples.helper import get_commandline
 from examples.client_sync import run_sync_client, setup_sync_client
+from examples.helper import get_commandline
 
 
 _logger = logging.getLogger()

examples/client_sync_extended_calls.py

@@ -24,9 +24,8 @@
 """
 import logging
 
-from examples.helper import get_commandline
 from examples.client_sync import run_sync_client, setup_sync_client
-
+from examples.helper import get_commandline
 from pymodbus.diag_message import (
     ChangeAsciiInputDelimiterRequest,
     ClearCountersRequest,

examples/common/custom_synchronous_server.py

@@ -57,10 +57,6 @@ def decode(self, data):
 """
 import logging
 
-from .custom_message import (  # pylint: disable=relative-beyond-top-level
-    CustomModbusRequest,
-)
-
 from pymodbus.datastore import (
     ModbusSequentialDataBlock,
     ModbusServerContext,
@@ -70,6 +66,10 @@ def decode(self, data):
 from pymodbus.server import StartTcpServer
 from pymodbus.version import version
 
+from .custom_message import (  # pylint: disable=relative-beyond-top-level
+    CustomModbusRequest,
+)
+
 
 # --------------------------------------------------------------------------- #
 # configure the service logging

examples/common/performance.py

@@ -5,21 +5,23 @@
 The following is an quick performance check of the synchronous
 modbus client.
 """
-from concurrent.futures import ThreadPoolExecutor as eWorker, as_completed
-
 # --------------------------------------------------------------------------- #
 # import the necessary modules
 # --------------------------------------------------------------------------- #
 import logging
 import os
-from threading import Lock, Thread as tWorker
+from concurrent.futures import ThreadPoolExecutor as eWorker
+from concurrent.futures import as_completed
+from threading import Lock
+from threading import Thread as tWorker
 from time import time
 
 from pymodbus.client import ModbusTcpClient
 
 
 try:
-    from multiprocessing import Process as mWorker, log_to_stderr
+    from multiprocessing import Process as mWorker
+    from multiprocessing import log_to_stderr
 except ImportError:
     log_to_stderr = logging.getLogger
 

examples/contrib/concurrent_client.py

@@ -6,22 +6,20 @@
 a high level of concurrency by using worker threads/processes to handle
 writing/reading from one or more client handles at once.
 """
-from collections import namedtuple
-from concurrent.futures import Future
 import itertools
 
 # -------------------------------------------------------------------------- #
 # import system libraries
 # -------------------------------------------------------------------------- #
 import logging
 import multiprocessing
-from multiprocessing import (
-    Event as mEvent,
-    Process as mProcess,
-    Queue as mQueue,
-)
-from queue import Queue as qQueue
 import threading
+from collections import namedtuple
+from concurrent.futures import Future
+from multiprocessing import Event as mEvent
+from multiprocessing import Process as mProcess
+from multiprocessing import Queue as mQueue
+from queue import Queue as qQueue
 from threading import Event, Thread
 
 # -------------------------------------------------------------------------- #

examples/contrib/message_generator.py

@@ -14,6 +14,7 @@
 import logging
 from optparse import OptionParser  # pylint: disable=deprecated-module
 
+import pymodbus.diag_message as modbus_diag
 from pymodbus.bit_read_message import (
     ReadCoilsRequest,
     ReadCoilsResponse,
@@ -26,7 +27,6 @@
     WriteSingleCoilRequest,
     WriteSingleCoilResponse,
 )
-import pymodbus.diag_message as modbus_diag
 from pymodbus.file_message import (
     ReadFifoQueueRequest,
     ReadFifoQueueResponse,

examples/contrib/message_parser.py

@@ -17,8 +17,8 @@
 import codecs as c
 import collections
 import logging
-from optparse import OptionParser  # pylint: disable=deprecated-module
 import textwrap
+from optparse import OptionParser  # pylint: disable=deprecated-module
 
 from pymodbus.factory import ClientDecoder, ServerDecoder
 from pymodbus.transaction import (

examples/contrib/modbus_mapper.py

@@ -124,16 +124,14 @@
     StartTcpServer(context=context, identity=identity, address=("localhost", 5020))
 
 """
-from collections import defaultdict
 import csv
-from io import StringIO
 import json
+from collections import defaultdict
+from io import StringIO
 from tokenize import generate_tokens
 
-from pymodbus.datastore import (
-    ModbusSlaveContext,
-    ModbusSparseDataBlock,
-)
+from pymodbus.datastore import ModbusSlaveContext, ModbusSparseDataBlock
+
 
 # --------------------------------------------------------------------------- #
 # raw mapping input parsers

examples/contrib/modbus_simulator.py

@@ -5,8 +5,8 @@
 with read/write data as well as user configurable base data
 """
 import logging
-from optparse import OptionParser  # pylint: disable=deprecated-module
 import pickle  # nosec
+from optparse import OptionParser  # pylint: disable=deprecated-module
 
 from pymodbus.datastore import ModbusServerContext, ModbusSlaveContext
 from pymodbus.server import StartTcpServer

examples/contrib/thread_safe_datastore.py

@@ -1,7 +1,7 @@
 # pylint: disable=missing-type-doc
 """Thread safe datastore."""
-from contextlib import contextmanager
 import threading
+from contextlib import contextmanager
 
 from pymodbus.datastore.store import BaseModbusDataBlock
 

examples/contrib/tornado_twisted/modbus_scraper.py

@@ -5,10 +5,13 @@
 them as a collection of sequential data blocks.
 """
 import logging
-from optparse import OptionParser
 import pickle  # nosec
+from optparse import OptionParser
 
-from twisted.internet import reactor, serialport  # pylint: disable=import-error
+from twisted.internet import (  # pylint: disable=import-error
+    reactor,
+    serialport,
+)
 from twisted.internet.protocol import (
     ClientFactory,  # pylint: disable=import-error
 )

examples/serial_forwarder.py

@@ -4,14 +4,15 @@
 python3 serial_forwarder.py --log DEBUG --port "/dev/ttyUSB0" --baudrate 9600 --server_ip "192.168.1.27" --server_port 5020 --slaves 1 2 3
 """
 import argparse
+import asyncio
 import logging
 import signal
-import asyncio
 
-from pymodbus.server.async_io import ModbusTcpServer
 from pymodbus.client import ModbusSerialClient
 from pymodbus.datastore import ModbusServerContext
 from pymodbus.datastore.remote import RemoteSlaveContext
+from pymodbus.server.async_io import ModbusTcpServer
+
 
 FORMAT = "%(asctime)-15s %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s"
 logging.basicConfig(format=FORMAT)
@@ -24,7 +25,7 @@ def raise_graceful_exit(*args):  # pylint: disable=unused-argument
     raise SystemExit
 
 
-class SerialForwarderTCPServer():
+class SerialForwarderTCPServer:
     """SerialRTU2TCP Forwarder Server"""
 
     def __init__(self):
@@ -34,17 +35,19 @@ def __init__(self):
     async def run(self):
         """Run the server"""
         port, baudrate, server_port, server_ip, slaves = get_commandline()
-        client = ModbusSerialClient(method='rtu', port=port, baudrate=baudrate)
-        message = f'RTU bus on {port} - baudrate {baudrate}'
+        client = ModbusSerialClient(method="rtu", port=port, baudrate=baudrate)
+        message = f"RTU bus on {port} - baudrate {baudrate}"
         _logger.info(message)
         store = {}
         for i in slaves:
             store[i] = RemoteSlaveContext(client, unit=i)
         context = ModbusServerContext(slaves=store, single=False)
-        self.server = ModbusTcpServer(context, address=(server_ip, server_port), allow_reuse_address=True)
-        message = f'serving on {server_ip} port {server_port}'
+        self.server = ModbusTcpServer(
+            context, address=(server_ip, server_port), allow_reuse_address=True
+        )
+        message = f"serving on {server_ip} port {server_port}"
         _logger.info(message)
-        message = f'listening to slaves {context.slaves()}'
+        message = f"listening to slaves {context.slaves()}"
         _logger.info(message)
         await self.server.serve_forever()
 
@@ -61,16 +64,22 @@ def get_commandline():
 
     parser = argparse.ArgumentParser(description="Command line options")
     parser.add_argument("--log", help=",".join(logchoices), default="info", type=str)
-    parser.add_argument("--port", help="RTU serial port", default='/dev/ttyUSB0', type=str)
+    parser.add_argument(
+        "--port", help="RTU serial port", default="/dev/ttyUSB0", type=str
+    )
     parser.add_argument("--baudrate", help="RTU baudrate", default=9600, type=int)
     parser.add_argument("--server_port", help="server port", default=5020, type=int)
     parser.add_argument("--server_ip", help="server IP", default="127.0.0.1", type=str)
-    parser.add_argument("--slaves", help="list of slaves to forward", type=int, nargs="+")
+    parser.add_argument(
+        "--slaves", help="list of slaves to forward", type=int, nargs="+"
+    )
 
     args = parser.parse_args()
 
     # set defaults
-    _logger.setLevel(args.log.upper() if args.log.lower() in logchoices else logging.INFO)
+    _logger.setLevel(
+        args.log.upper() if args.log.lower() in logchoices else logging.INFO
+    )
     if not args.slaves:
         args.slaves = {1, 2, 3}
     return args.port, args.baudrate, args.server_port, args.server_ip, args.slaves

examples/server_async.py

@@ -27,9 +27,9 @@
 The corresponding client can be started as:
     python3 client_sync.py
 """
-import os
 import asyncio
 import logging
+import os
 
 from examples.helper import get_commandline
 from pymodbus.datastore import (

examples/server_sync.py

@@ -31,8 +31,8 @@
 is just a thin cover on top of the async server and is in some aspects
 a lot slower.
 """
-import os
 import logging
+import os
 
 from examples.helper import get_commandline
 from examples.server_async import setup_server

pymodbus/bit_read_message.py

@@ -3,11 +3,8 @@
 import struct
 
 from pymodbus.constants import Defaults
-from pymodbus.pdu import (
-    ModbusExceptions as merror,
-    ModbusRequest,
-    ModbusResponse,
-)
+from pymodbus.pdu import ModbusExceptions as merror
+from pymodbus.pdu import ModbusRequest, ModbusResponse
 from pymodbus.utilities import pack_bitstring, unpack_bitstring
 
 

pymodbus/bit_write_message.py

@@ -6,11 +6,8 @@
 import struct
 
 from pymodbus.constants import ModbusStatus
-from pymodbus.pdu import (
-    ModbusExceptions as merror,
-    ModbusRequest,
-    ModbusResponse,
-)
+from pymodbus.pdu import ModbusExceptions as merror
+from pymodbus.pdu import ModbusRequest, ModbusResponse
 from pymodbus.utilities import pack_bitstring, unpack_bitstring