run codespell on pymodbus/pymodbus (#847)

* Install codespell, and correct spell errors.

* Codespell pymodbus.

Author: janiversen

pymodbus/bit_read_message.py

@@ -168,7 +168,7 @@ class ReadCoilsResponse(ReadBitsResponseBase):
     function_code = 1
 
     def __init__(self, values=None, **kwargs):
-        """ Intializes a new instance
+        """ Initializes a new instance
 
         :param values: The request values to respond with
         """
@@ -185,7 +185,7 @@ class ReadDiscreteInputsRequest(ReadBitsRequestBase):
     function_code = 2
 
     def __init__(self, address=None, count=None, **kwargs):
-        """ Intializes a new instance
+        """ Initializes a new instance
 
         :param address: The address to start reading from
         :param count: The number of bits to read
@@ -225,7 +225,7 @@ class ReadDiscreteInputsResponse(ReadBitsResponseBase):
     function_code = 2
 
     def __init__(self, values=None, **kwargs):
-        """ Intializes a new instance
+        """ Initializes a new instance
 
         :param values: The request values to respond with
         """

pymodbus/client/asynchronous/__init__.py

@@ -21,7 +21,7 @@
     event_loop, client = Client(schedulers.ASYNC_IO, port=5020)
 
     # Here event_loop is a thread which would control the backend and future is
-    # a Future/deffered object which would be used to
+    # a Future/deferred object which would be used to
     # add call backs to run asynchronously.
 
     # The Actual client could be accessed with future.result() with Tornado

pymodbus/client/asynchronous/deprecated/__init__.py

@@ -28,7 +28,7 @@
     event_loop, client = Client(schedulers.ASYNC_IO, port=5020)
 
     # Here event_loop is a thread which would control the backend and future is
-    # a Future/deffered object which would be used to
+    # a Future/deferred object which would be used to
     # add call backs to run asynchronously.
 
     # The Actual client could be accessed with future.result() with Tornado

pymodbus/client/asynchronous/tornado/__init__.py

@@ -65,7 +65,7 @@ def connect(self):
         raise gen.Return(self)
 
     def on_receive(self, *args):
-        """ On data recieve call back
+        """ On data receive call back
         :param args: data received
         :return:
         """
@@ -337,7 +337,7 @@ def _on_timeout():
                 transaction.set_exception(TimeOutException())
 
         def _on_write_done():
-            """ Set up reader part after sucessful write to the serial. """
+            """ Set up reader part after successful write to the serial. """
             _logger.debug("frame sent, waiting for a reply")
             self.last_frame_end = round(time.time(), 6)
             self.state = ModbusTransactionState.WAITING_FOR_REPLY

pymodbus/client/asynchronous/udp.py

@@ -1,4 +1,4 @@
-"""UDP comminication."""
+"""UDP communication."""
 from __future__ import unicode_literals
 from __future__ import absolute_import
 

pymodbus/client/sync.py

@@ -29,7 +29,7 @@
 
 
 class BaseModbusClient(ModbusClientMixin):
-    """ Inteface for a modbus synchronous client. Defined here are all the
+    """ Interface for a modbus synchronous client. Defined here are all the
     methods for performing the related request methods.  Derived classes
     simply need to implement the transport methods and set the correct
     framer.
@@ -259,7 +259,7 @@ def _recv(self, size):
         # socket.recv(size) waits until it gets some data from the host but
         # not necessarily the entire response that can be fragmented in
         # many packets.
-        # To avoid the splitted responses to be recognized as invalid
+        # To avoid split responses to be recognized as invalid
         # messages and to be discarded, loops socket.recv until full data
         # is received or timeout is expired.
         # If timeout expires returns the read data, also if its length is
@@ -408,7 +408,7 @@ def _recv(self, size):
         # socket.recv(size) waits until it gets some data from the host but
         # not necessarily the entire response that can be fragmented in
         # many packets.
-        # To avoid the splitted responses to be recognized as invalid
+        # To avoid split responses to be recognized as invalid
         # messages and to be discarded, loops socket.recv until full data
         # is received or timeout is expired.
         # If timeout expires returns the read data, also if its length is
@@ -709,12 +709,12 @@ def _wait_for_data(self):
             condition = partial(lambda dummy1, dummy2: True, dummy2=None)
         start = time.time()
         while condition(start):
-            avaialble = self._in_waiting()
-            if (more_data and not avaialble) or (more_data and avaialble == size):
+            available = self._in_waiting()
+            if (more_data and not available) or (more_data and available == size):
                 break
-            if avaialble and avaialble != size:
+            if available and available != size:
                 more_data = True
-                size = avaialble
+                size = available
             time.sleep(0.01)
         return size
 

pymodbus/constants.py

@@ -62,7 +62,7 @@ class Defaults(Singleton): # pylint: disable=too-few-public-methods
 
        The modbus slave addrss.  Currently this is set to 0x00 which
        means this request should be broadcast to all the slave devices
-       (really means that all the devices should respons).
+       (really means that all the devices should respond).
 
     .. attribute:: Baudrate
 
@@ -99,7 +99,7 @@ class Defaults(Singleton): # pylint: disable=too-few-public-methods
 
        In case a request is made to a missing slave, this defines if an error
        should be returned or simply ignored. This is useful for the case of a
-       serial server emulater where a request to a non-existant slave on a bus
+       serial server emulater where a request to a non-existent slave on a bus
        will never respond. The client in this case will simply timeout.
 
     .. attribute:: broadcast_enable
@@ -170,7 +170,7 @@ class ModbusStatus(Singleton): # pylint: disable=too-few-public-methods
 
 
 class Endian(Singleton): # pylint: disable=too-few-public-methods
-    """ An enumeration representing the various byte endianess.
+    """ An enumeration representing the various byte endianness.
 
     .. attribute:: Auto
 
@@ -247,7 +247,7 @@ class MoreData(Singleton): # pylint: disable=too-few-public-methods
 
     .. attribute:: Nothing
 
-       This indiates that no more objects are going to be returned.
+       This indicates that no more objects are going to be returned.
 
     .. attribute:: KeepReading
 

pymodbus/datastore/context.py

@@ -122,7 +122,7 @@ def __init__(self, slaves=None, single=True):
             self._slaves = {Defaults.UnitId: self._slaves}
 
     def __iter__(self):
-        """ Iterater over the current collection of slave
+        """ Iterator over the current collection of slave
         contexts.
 
         :returns: An iterator over the slave contexts

pymodbus/datastore/store.py

@@ -13,7 +13,7 @@
 
 There are two ways that the server datastore can be implemented.
 The first is a complete range from 'address' start to 'count'
-number of indecies.  This can be thought of as a straight array::
+number of indices.  This can be thought of as a straight array::
 
     data = range(1, 1 + count)
     [1,2,3,...,count]
@@ -39,7 +39,7 @@
 
 Using this, layout, the first device will implement n, n+1, and n+2,
 however, the second device may set the latter two values to 0 or
-will simply not implmented the registers thus causing a single read
+will simply not implemented the registers thus causing a single read
 or a range read to fail.
 
 I have both methods implemented, and leave it up to the user to change
@@ -120,7 +120,7 @@ def __str__(self):
         return f"DataStore({len(self.values)}, {self.default_value})"
 
     def __iter__(self):
-        """ Iterater over the data block data
+        """ Iterator over the data block data
 
         :returns: An iterator of the data block data
         """

pymodbus/device.py

@@ -31,7 +31,7 @@ class ModbusAccessControl(Singleton):
     ]
 
     def __iter__(self):
-        """ Iterater over the network access tablek
+        """ Iterator over the network access tablek
 
         :returns: An iterator of the network access table
         """
@@ -144,7 +144,7 @@ def __init__(self):
         self.reset()
 
     def __iter__(self):
-        """ Iterater over the statistics
+        """ Iterator over the statistics
 
         :returns: An iterator of the modbus plus statistics
         """
@@ -219,7 +219,7 @@ def __init__(self, info=None):
                     self.__data[key] = info[key]
 
     def __iter__(self):
-        """ Iterater over the device information
+        """ Iterator over the device information
 
         :returns: An iterator of the device information
         """
@@ -394,7 +394,7 @@ class ModbusCountersHandler:
              overrun is caused by data characters arriving at the port faster
              than they can.
 
-    .. note:: I threw the event counter in here for convinience
+    .. note:: I threw the event counter in here for convenience
     """
     __data = dict([(i, 0x0000) for i in range(9)]) # pylint: disable=consider-using-dict-comprehension
     __names   = [
@@ -410,7 +410,7 @@ class ModbusCountersHandler:
     ]
 
     def __iter__(self):
-        """ Iterater over the device counters
+        """ Iterator over the device counters
 
         :returns: An iterator of the device counters
         """
@@ -488,7 +488,7 @@ def __str__(self):
         return "ModbusControl"
 
     def __iter__(self):
-        """ Iterater over the device counters
+        """ Iterator over the device counters
 
         :returns: An iterator of the device counters
         """