Install codespell, and correct spell errors. (#846)

Author: janiversen

TODO_add_checks

@@ -1,7 +1,6 @@
 1) add .pre-commit and commit-hook
 
 2) new checks
-- codespell
 - flake8 addons:
     pycodestyle
     pyflakes

doc/INSTALL

@@ -62,7 +62,7 @@ The API documents can be generated using one of four programs:
 * pydoctor
 * doxygen
 
-To bulid these, simply run the following command and the available
+To build these, simply run the following command and the available
 packages will sipmly be built::
 
     python setup.py build_apidocs

doc/api/epydoc/build.py

@@ -37,4 +37,4 @@
         shutil.move("html", "../../../build/epydoc")
 except Exception: # pylint: disable=broad-except
     traceback.print_exc(file=sys.stdout)
-    print( "Epydoc not avaliable...not building")
+    print( "Epydoc not available...not building")

requirements-checks.txt

@@ -2,4 +2,5 @@
 flake8 >= 2.6.0
 flake8-docstrings >= 0.2.8
 pyflakes >= 1.2.3
-pylint >=2.13.3
+pylint >= 2.13.3
+codespell >= 2.1.0

test/test_datastore.py

@@ -118,7 +118,7 @@ def test_modbus_sparse_data_block(self):
         block = ModbusSparseDataBlock()
         self.assertEqual(block.values, {})
 
-        # mark block as unmutable and see if parameter exeception
+        # mark block as unmutable and see if parameter exception
         # is raised for invalid offset writes
         block = ModbusSparseDataBlock({1: 100}, mutable=False)
         self.assertRaises(ParameterException, block.setValues, 0, 1)
@@ -403,7 +403,7 @@ def test_set(self):
         )
 
     def test_update_success(self):
-        """ Test update succcess. """
+        """ Test update success. """
         self.slave._connection.execute = MagicMock( # pylint: disable=protected-access
             return_value=MockSqlResult(rowcount=len(self.mock_values))
         )

test/test_device.py

@@ -165,7 +165,7 @@ def test_modbus_control_block_counters(self):
         self.assertEqual(0, self.control.Counter.SlaveMessage)
 
     def test_modbus_control_block_update(self):
-        """ Tests the MCB counters upate methods """
+        """ Tests the MCB counters update methods """
         values = {'SlaveMessage':5, 'BusMessage':5}
         self.control.Counter.BusMessage += 1
         self.control.Counter.SlaveMessage += 1

test/test_exceptions.py

@@ -18,7 +18,7 @@ def setUp(self):
         self.exceptions = [
                 ModbusException("bad base"),
                 ModbusIOException("bad register"),
-                ParameterException("bad paramater"),
+                ParameterException("bad parameter"),
                 NotImplementedException("bad function"),
                 ConnectionException("bad connection"),
         ]

test/test_other_messages.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-""" Test other messsages. """
+""" Test other messages. """
 import unittest
 import mock
 
@@ -30,7 +30,7 @@ def tearDown(self):
         del self.responses
 
     def test_other_messages_to_string(self):
-        """ Test other messsages to string. """
+        """ Test other messages to string. """
         for message in self.requests:
             self.assertNotEqual(str(message()), None)
         for message in self.responses:

test/test_pdu.py

@@ -31,7 +31,7 @@ def tearDown(self):
         del self.exception
 
     def test_not_impelmented(self):
-        """ Test a base classes for not implemented funtions """
+        """ Test a base classes for not implemented functions """
         for request in self.bad_requests:
             self.assertRaises(NotImplementedException, request.encode)
 

test/test_server_async.py

@@ -76,7 +76,7 @@ def test_connection_lost(self): # pylint: disable=no-self-use
     def test_data_received(self):
         """ Test data received. """
         protocol = ModbusTcpProtocol()
-        # mock_data = "Hellow world!"
+        # mock_data = "Hello world!"
         mock_data = b"\x00\x01\x12\x34\x00\x04\xff\x02\x12\x34"
         protocol.factory = MagicMock()
         protocol.factory.control.ListenOnly = False