Fix parameter documentation of methods.

doc/api/doxygen/build.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Doxygen API Builder."""
 import os
 import shutil

examples/common/callback_server.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc
 """Pymodbus Server With Callbacks.
 
 This is an example of adding callbacks to a running modbus server

examples/common/custom_datablock.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc
 """Pymodbus Server With Custom Datablock Side Effect.
 
 This is an example of performing custom logic after a value has been

examples/common/custom_message.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Pymodbus Synchronous Client Examples.
 
 The following is an example of how to use the synchronous modbus client

examples/common/custom_synchronous_server.py

@@ -60,8 +60,6 @@ def decode(self, data):
 # --------------------------------------------------------------------------- #
 # import the various server implementations
 # --------------------------------------------------------------------------- #
-from custom_message import CustomModbusRequest
-
 from pymodbus.version import version
 from pymodbus.server.sync import StartTcpServer
 from pymodbus.device import ModbusDeviceIdentification
@@ -70,6 +68,7 @@ def decode(self, data):
     ModbusSlaveContext,
     ModbusServerContext,
 )
+from .custom_message import CustomModbusRequest  # pylint: disable=relative-beyond-top-level
 
 # --------------------------------------------------------------------------- #
 # configure the service logging

examples/common/dbstore_update_server.py

@@ -1,3 +1,4 @@
+# pylint: disable=differing-param-doc,missing-any-param-doc
 """Pymodbus Server With Updating Thread.
 
 This is an example of having a background thread updating the

examples/common/performance.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Pymodbus Performance Example.
 
 The following is an quick performance check of the synchronous
@@ -52,8 +53,8 @@
 def single_client_test(n_host, n_cycles):
     """Perform a single threaded test of a synchronous client against the specified host
 
-    :param host: The host to connect to
-    :param cycles: The number of iterations to perform
+    :param n_host: The host to connect to
+    :param n_cycles: The number of iterations to perform
     """
     logger = log_to_stderr()
     logger.setLevel(logging.WARNING)

examples/common/updating_server.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-any-param-doc,differing-param-doc
 """Pymodbus Server With Updating Thread.
 
 This is an example of having a background thread updating the

examples/contrib/bcd_payload.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc,missing-raises-doc,missing-any-param-doc
 """Modbus BCD Payload Builder.
 
 This is an example of building a custom payload builder

examples/contrib/concurrent_client.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc
 """Concurrent Modbus Client.
 
 This is an example of writing a high performance modbus client that allows

examples/contrib/libmodbus_client.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc,missing-raises-doc
 """Libmodbus Protocol Wrapper.
 
 What follows is an example wrapper of the libmodbus library

examples/contrib/message_generator.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Modbus Message Generator.
 
 The following is an example of how to generate example encoded messages

examples/contrib/message_parser.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc,missing-any-param-doc
 """Modbus Message Parser.
 
 The following is an example of how to parse modbus messages
@@ -105,7 +106,7 @@ def report(self, message):  # pylint: disable=no-self-use
                         "  %-12s => %s" % (k_item, v_item)  # pylint: disable=consider-using-f-string
                     )
 
-            elif isinstance(v_dict, collections.Iterable):
+            elif isinstance(v_dict, collections.Iterable):  # pylint: disable=no-member
                 print("%-15s =" % k_dict)  # pylint: disable=consider-using-f-string
                 value = str([int(x) for x in v_dict])
                 for line in textwrap.wrap(value, 60):

examples/contrib/modbus_mapper.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-type-doc,differing-param-doc
 r"""This is used to generate decoder blocks.
 
 so that non-programmers can define the

examples/contrib/modbus_simulator.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-raises-doc
 """An example of creating a fully implemented modbus server.
 
 with read/write data as well as user configurable base data

examples/contrib/modicon_payload.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-type-doc,missing-raises-doc
 """Modbus Modicon Payload Builder.
 
 This is an example of building a custom payload builder

examples/contrib/remote_server_context.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc,missing-raises-doc
 """Although there is a remote server context already in the main library,
 
 it works under the assumption that users would have a server context

examples/contrib/thread_safe_datastore.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-type-doc
 """Thread safe datastore."""
 import threading
 from contextlib import contextmanager

pymodbus/bit_read_message.py

@@ -1,4 +1,5 @@
 """Bit Reading Request/Response messages."""
+# pylint: disable=missing-type-doc
 import struct
 from pymodbus.pdu import ModbusRequest
 from pymodbus.pdu import ModbusResponse

pymodbus/bit_write_message.py

@@ -2,6 +2,7 @@
 
 TODO write mask request/response
 """
+# pylint: disable=missing-type-doc
 import struct
 from pymodbus.constants import ModbusStatus
 from pymodbus.pdu import ModbusRequest

pymodbus/client/asynchronous/async_io/__init__.py

@@ -1,4 +1,5 @@
 """Asynchronous framework adapter for asyncio."""
+# pylint: disable=missing-type-doc
 import logging
 import socket
 import asyncio
@@ -45,7 +46,6 @@ def connection_made(self, transport):
         The transport argument is the transport representing the connection.
 
         :param transport:
-        :return:
         """
         self.transport = transport
         self._connection_made()
@@ -59,7 +59,6 @@ def connection_lost(self, reason):
         The argument is either an exception object or None
 
         :param reason:
-        :return:
         """
         self.transport = None
         self._connection_lost(reason)
@@ -73,23 +72,18 @@ def data_received(self, data):
         data is a non-empty bytes object containing the incoming data.
 
         :param data:
-        :return:
         """
         self._data_received(data)
 
     def create_future(self):  # pylint: disable=no-self-use
-        """Help function to create asyncio Future object.
-
-        :return:
-        """
+        """Help function to create asyncio Future object."""
         return asyncio.Future()
 
     def resolve_future(self, my_future, result):  # pylint: disable=no-self-use
         """Resolve the completed future and sets the result.
 
         :param my_future:
         :param result:
-        :return:
         """
         if not my_future.done():
             my_future.set_result(result)
@@ -99,7 +93,6 @@ def raise_future(self, my_future, exc):  # pylint: disable=no-self-use
 
         :param my_future:
         :param exc:
-        :return:
         """
         if not my_future.done():
             my_future.set_exception(exc)
@@ -155,6 +148,7 @@ def _handle_response(self, reply, **kwargs):  # pylint: disable=unused-argument
         """Handle the processed response and link to correct deferred
 
         :param reply: The reply to process
+        :param kwargs: The rest
         """
         if reply is not None:
             tid = reply.transaction_id
@@ -196,7 +190,6 @@ def data_received(self, data):
         data is a non-empty bytes object containing the incoming data.
 
         :param data:
-        :return:
         """
         self._data_received(data)
 
@@ -270,10 +263,7 @@ async def start(self, host, port=502):
         return await self._connect()
 
     def stop(self):
-        """Stop client.
-
-        :return:
-        """
+        """Stop client."""
         # prevent reconnect:
         self.host = None
 
@@ -642,10 +632,7 @@ def __init__(self, host=None, port=502, protocol_class=None, loop=None, **kwargs
         self._proto_args = kwargs
 
     def stop(self):
-        """Stop connection.
-
-        :return:
-        """
+        """Stop connection."""
         # prevent reconnect:
         # self.host = None
 
@@ -771,10 +758,7 @@ def _connected(self):
         return self._connected_event.is_set()
 
     async def connect(self):
-        """Connect Async client.
-
-        :return:
-        """
+        """Connect Async client."""
         _logger.debug(TEXT_CONNECTING)
         try:
             await create_serial_connection(

pymodbus/client/asynchronous/deprecated/asynchronous.py

@@ -30,6 +30,7 @@ def process():
        reactor.callLater(1, process)
        reactor.run()
 """
+# pylint: disable=missing-type-doc,differing-param-doc,missing-param-doc
 import logging
 from twisted.internet import defer, protocol
 from twisted.python.failure import Failure

pymodbus/client/asynchronous/factory/serial.py

@@ -1,4 +1,5 @@
 """Factory to create asynchronous serial clients based on twisted/tornado/asyncio."""
+# pylint: disable=missing-type-doc
 import logging
 import asyncio
 
@@ -122,6 +123,7 @@ def get_factory(scheduler):
 
     :param scheduler: REACTOR/IO_LOOP/ASYNC_IO
     :return:
+    :raises Exception: Failure
     """
     if scheduler == schedulers.REACTOR:
         return reactor_factory

pymodbus/client/asynchronous/factory/tcp.py

@@ -1,4 +1,5 @@
 """Factory to create asynchronous tcp clients based on twisted/tornado/asyncio."""
+# pylint: disable=missing-type-doc
 import logging
 import asyncio
 
@@ -107,9 +108,6 @@ def async_io_factory(host="127.0.0.1", port=Defaults.Port, **kwargs):
 
     :param host: Host IP address
     :param port: Port
-    :param framer: Modbus Framer
-    :param source_address: Bind address
-    :param timeout: Timeout in seconds
     :param kwargs:
     :return: asyncio event loop and tcp client
     """
@@ -141,6 +139,7 @@ def get_factory(scheduler):
 
     :param scheduler: REACTOR/IO_LOOP/ASYNC_IO
     :return: new factory
+    :raises Exception: Failure
     """
     if scheduler == schedulers.REACTOR:
         return reactor_factory

pymodbus/client/asynchronous/factory/tls.py

@@ -1,4 +1,5 @@
 """Factory to create asynchronous tls clients based on asyncio."""
+# pylint: disable=missing-type-doc
 import logging
 import asyncio
 
@@ -22,12 +23,8 @@ def async_io_factory(
     :param host: Target server"s name, also matched for certificate
     :param port: Port
     :param sslctx: The SSLContext to use for TLS (default None and auto create)
-    :param certfile: The optional client"s cert file path for TLS server request
-    :param keyfile: The optional client"s key file path for TLS server request
-    :param password: The password for for decrypting client"s private key file
+    :param server_hostname: Bind address
     :param framer: Modbus Framer
-    :param source_address: Bind address
-    :param timeout: Timeout in seconds
     :param kwargs:
     :return: asyncio event loop and tcp client
     """
@@ -61,7 +58,8 @@ def get_factory(scheduler):
     """Get protocol factory based on the backend scheduler being used.
 
     :param scheduler: ASYNC_IO
-    :return
+    :return: protocol object
+    :raises Exception: Failure
     """
     if scheduler == schedulers.ASYNC_IO:
         return async_io_factory

pymodbus/client/asynchronous/factory/udp.py

@@ -1,4 +1,5 @@
 """UDP implementation."""
+# pylint: disable=missing-type-doc
 import logging
 import asyncio
 
@@ -74,9 +75,6 @@ def async_io_factory(host="127.0.0.1", port=Defaults.Port, **kwargs):
 
     :param host: Host IP address
     :param port: Port
-    :param framer: Modbus Framer
-    :param source_address: Bind address
-    :param timeout: Timeout in seconds
     :param kwargs:
     :return: asyncio event loop and udp client
     """
@@ -105,6 +103,7 @@ def get_factory(scheduler):
 
     :param scheduler: REACTOR/IO_LOOP/ASYNC_IO
     :return: new factory
+    :raises Exception: Failure
     """
     if scheduler == schedulers.REACTOR:
         return reactor_factory

pymodbus/client/asynchronous/serial.py

@@ -26,6 +26,7 @@ def _framer(cls, method):
 
         :method: The serial framer to instantiate
         :returns: The requested serial framer
+        :raises Exception: Failure
         """
         method = method.lower()
         if method == "ascii":

pymodbus/client/asynchronous/thread.py

@@ -31,26 +31,17 @@ def __init__(self, name, start, stop, *args, **kwargs):
         self._event_loop.daemon = True
 
     def _start(self):
-        """Start the backend event loop
-
-        :return:
-        """
+        """Start the backend event loop."""
         self._start_loop(*self._args, **self._kwargs)
 
     def start(self):
-        """Start the backend event loop
-
-        :return:
-        """
+        """Start the backend event loop."""
         txt = f'Starting Event Loop: "PyModbus_{self._name}"'
         _logger.info(txt)
         self._event_loop.start()
 
     def stop(self):
-        """Stop the backend event loop
-
-        :return:
-        """
+        """Stop the backend event loop."""
         txt = f'Stopping Event Loop: "PyModbus_{self._name}"'
         _logger.info(txt)
         self._stop_loop()

pymodbus/client/asynchronous/tornado/__init__.py

@@ -1,4 +1,5 @@
 """Asynchronous framework adapter for tornado."""
+# pylint: skip-file
 import logging
 import abc
 import time