Fix typos in comments (#1233)

matthiasstraka · web-flow · commit 6224f71bf238 · 2023-01-02T10:58:33.000+01:00
Fix typos
diff --git a/examples/client_payload.py b/examples/client_payload.py
@@ -27,8 +27,8 @@ async def run_payload_calls(client):
     If you need to build a complex message to send, you can use the payload
     builder to simplify the packing logic
 
-    Packing/unpacking depends on your CPU´s word/byte order. Modbus messages
-    are always using big endian. BinaryPayloadBuilder will pr default use
+    Packing/unpacking depends on your CPU's word/byte order. Modbus messages
+    are always using big endian. BinaryPayloadBuilder will per default use
     what your CPU uses.
     The wordorder is applicable only for 32 and 64 bit values
     Lets say we need to write a value 0x12345678 to a 32 bit register
diff --git a/examples/server_async.py b/examples/server_async.py
@@ -121,7 +121,7 @@ def setup_server(args):
     # ----------------------------------------------------------------------- #
     # initialize the server information
     # ----------------------------------------------------------------------- #
-    # If you don"t set this or any fields, they are defaulted to empty strings.
+    # If you don't set this or any fields, they are defaulted to empty strings.
     # ----------------------------------------------------------------------- #
     args.identity = ModbusDeviceIdentification(
         info_name={
diff --git a/examples/v2.5.3/asynchronous_asyncio_modbus_tls_client.py b/examples/v2.5.3/asynchronous_asyncio_modbus_tls_client.py
@@ -22,7 +22,7 @@
 sslctx.verify_mode = ssl.CERT_REQUIRED
 sslctx.check_hostname = True
 
-# Prepare client"s certificate which the server requires for TLS full handshake
+# Prepare client's certificate which the server requires for TLS full handshake
 # sslctx.load_cert_chain(certfile="client.crt", keyfile="client.key",
 #                        password="pwd")
 
diff --git a/examples/v2.5.3/concurrent_client.py b/examples/v2.5.3/concurrent_client.py
@@ -218,7 +218,7 @@ def execute(self, request):
         of the call.
 
         :param request: The request to execute
-        :returns: A future linked to the call"s response
+        :returns: A future linked to the call's response
         """
         fut, work_id = Future(), next(self.counter)
         self.input_queue.put(WorkRequest(request, work_id))
diff --git a/examples/v2.5.3/custom_synchronous_server.py b/examples/v2.5.3/custom_synchronous_server.py
@@ -103,7 +103,7 @@ def run_server():
     # ----------------------------------------------------------------------- #
     # initialize the server information
     # ----------------------------------------------------------------------- #
-    # If you don"t set this or any fields, they are defaulted to empty strings.
+    # If you don't set this or any fields, they are defaulted to empty strings.
     # ----------------------------------------------------------------------- #
     identity = ModbusDeviceIdentification(
         info_name={
diff --git a/examples/v2.5.3/deviceinfo_showcase_server.py b/examples/v2.5.3/deviceinfo_showcase_server.py
@@ -48,7 +48,7 @@ def run_server():
     # ----------------------------------------------------------------------- #
     # initialize the server information
     # ----------------------------------------------------------------------- #
-    # If you don"t set this or any fields, they are defaulted to empty strings.
+    # If you don't set this or any fields, they are defaulted to empty strings.
     # ----------------------------------------------------------------------- #
     identity = ModbusDeviceIdentification(
         info_name={
diff --git a/examples/v2.5.3/libmodbus_client.py b/examples/v2.5.3/libmodbus_client.py
@@ -142,7 +142,7 @@ class NotImplementedException(Exception):
 class LibmodbusLevel1Client:
     """A raw wrapper around the libmodbus c library.
 
-    Feel free to use it if you want increased performance and don"t mind the
+    Feel free to use it if you want increased performance and don't mind the
     entire protocol not being implemented.
     """
 
diff --git a/examples/v2.5.3/modbus_simulator.py b/examples/v2.5.3/modbus_simulator.py
@@ -22,14 +22,14 @@
 # -------------------------------------------------------------------------- #
 # Extra Global Functions
 # -------------------------------------------------------------------------- #
-# These are extra helper functions that don"t belong in a class
+# These are extra helper functions that don't belong in a class
 # -------------------------------------------------------------------------- #
 # import getpass
 
 
 def root_test():
     """Check to see if we are running as root"""
-    return True  # removed for the time being as it isn"t portable
+    return True  # removed for the time being as it isn't portable
     # return getpass.getuser() == "root"
 
 
diff --git a/examples/v2.5.3/modbus_tls_client.py b/examples/v2.5.3/modbus_tls_client.py
@@ -20,7 +20,7 @@
 sslctx.verify_mode = ssl.CERT_REQUIRED
 sslctx.check_hostname = True
 
-# Prepare client"s certificate which the server requires for TLS full handshake
+# Prepare client's certificate which the server requires for TLS full handshake
 # sslctx.load_cert_chain(certfile="client.crt", keyfile="client.key",
 #                        password="pwd")
 
diff --git a/examples/v2.5.3/remote_server_context.py b/examples/v2.5.3/remote_server_context.py
@@ -198,7 +198,7 @@ def __contains__(self, slave):
         :param slave: slave The slave to check for existence
         :returns: True if the slave exists, False otherwise
         """
-        # we don"t want to check the cache here as the
+        # we don't want to check the cache here as the
         # slave may not exist yet or may not exist any
         # more. The best thing to do is try and fail.
         return True
@@ -209,14 +209,14 @@ def __setitem__(self, slave, context):
         :param slave: The slave context to set
         :param context: The new context to set for this slave
         """
-        raise NotImplementedException()  # doesn"t make sense here
+        raise NotImplementedException()  # doesn't make sense here
 
     def __delitem__(self, slave):
         """Use to access the slave context
 
         :param slave: The slave context to remove
         """
-        raise NotImplementedException()  # doesn"t make sense here
+        raise NotImplementedException()  # doesn't make sense here
 
     def __getitem__(self, slave):
         """Use to get access to a slave context
diff --git a/examples/v2.5.3/tornado_twisted/asynchronous_processor.py b/examples/v2.5.3/tornado_twisted/asynchronous_processor.py
@@ -104,7 +104,7 @@ def error_handler(self, failure):
 # --------------------------------------------------------------------------- #
 # a factory for the example protocol
 # --------------------------------------------------------------------------- #
-# This is used to build client protocol"s if you tie into twisted"s method
+# This is used to build client protocol's if you tie into twisted's method
 # of processing. It basically produces client instances of the underlying
 # protocol::
 #
diff --git a/examples/v2.5.3/tornado_twisted/asynchronous_server.py b/examples/v2.5.3/tornado_twisted/asynchronous_server.py
@@ -115,7 +115,7 @@ def run_async_server():
     # ----------------------------------------------------------------------- #
     # initialize the server information
     # ----------------------------------------------------------------------- #
-    # If you don"t set this or any fields, they are defaulted to empty strings.
+    # If you don't set this or any fields, they are defaulted to empty strings.
     # ----------------------------------------------------------------------- #
     identity = ModbusDeviceIdentification(
         info_name={
diff --git a/examples/v2.5.3/tornado_twisted/modbus_scraper.py b/examples/v2.5.3/tornado_twisted/modbus_scraper.py
@@ -138,7 +138,7 @@ def error_handler(self, failure):
 # --------------------------------------------------------------------------- #
 # a factory for the example protocol
 # --------------------------------------------------------------------------- #
-# This is used to build client protocol"s if you tie into twisted"s method
+# This is used to build client protocol's if you tie into twisted's method
 # of processing. It basically produces client instances of the underlying
 # protocol::
 #
diff --git a/pymodbus/bit_read_message.py b/pymodbus/bit_read_message.py
@@ -111,7 +111,7 @@ def resetBit(self, address):  # pylint: disable=invalid-name
         self.setBit(address, 0)
 
     def getBit(self, address):  # pylint: disable=invalid-name
-        """Get the specified bit"s value.
+        """Get the specified bit's value.
 
         :param address: The bit to query
         :returns: The value of the requested bit
diff --git a/pymodbus/client/base.py b/pymodbus/client/base.py
@@ -26,7 +26,7 @@ class ModbusBaseClient(ModbusClientMixin):
 
     :param framer: (optional) Modbus Framer class.
     :param timeout: (optional) Timeout for a request, in seconds.
-    :param retries: (optional) Max number of retries pr request.
+    :param retries: (optional) Max number of retries per request.
     :param retry_on_empty: (optional) Retry on empty response.
     :param close_comm_on_error: (optional) Close connection on error.
     :param strict: (optional) Strict timing, 1.5 character between requests.
diff --git a/pymodbus/client/serial.py b/pymodbus/client/serial.py
@@ -27,14 +27,14 @@ class AsyncModbusSerialClient(ModbusBaseClient):
 
     :param port: Serial port used for communication.
     :param framer: (optional) Framer class.
-    :param baudrate: (optional) Bits pr second.
-    :param bytesize: (optional) Number of bits pr byte 7-8.
+    :param baudrate: (optional) Bits per second.
+    :param bytesize: (optional) Number of bits per byte 7-8.
     :param parity: (optional) 'E'ven, 'O'dd or 'N'one
     :param stopbits: (optional) Number of stop bits 0-2¡.
     :param handle_local_echo: (optional) Discard local echo from dongle.
     :param kwargs: (optional) Experimental parameters
 
-    The serial communication is RS-485 based, and usually used vith a usb RS485 dongle.
+    The serial communication is RS-485 based, and usually used with a usb RS485 dongle.
 
     Example::
 
@@ -153,14 +153,14 @@ class ModbusSerialClient(ModbusBaseClient):
 
     :param port: Serial port used for communication.
     :param framer: (optional) Framer class.
-    :param baudrate: (optional) Bits pr second.
-    :param bytesize: (optional) Number of bits pr byte 7-8.
+    :param baudrate: (optional) Bits per second.
+    :param bytesize: (optional) Number of bits per byte 7-8.
     :param parity: (optional) 'E'ven, 'O'dd or 'N'one
     :param stopbits: (optional) Number of stop bits 0-2¡.
     :param handle_local_echo: (optional) Discard local echo from dongle.
     :param kwargs: (optional) Experimental parameters
 
-    The serial communication is RS-485 based, and usually used vith a usb RS485 dongle.
+    The serial communication is RS-485 based, and usually used with a usb RS485 dongle.
 
     Example::
 
diff --git a/pymodbus/client/sync_diag.py b/pymodbus/client/sync_diag.py
@@ -128,7 +128,7 @@ def recv(self, size):
 
             return result
         except ConnectionException as exc:
-            # Only log actual network errors, "if not self.socket" then it"s a internal code issue
+            # Only log actual network errors, "if not self.socket" then it's a internal code issue
             if "Connection unexpectedly closed" in exc.string:
                 _logger.error(LOG_MSGS["unexpected_dc_msg"], self, exc)
             raise ConnectionException from exc
diff --git a/pymodbus/client/tcp.py b/pymodbus/client/tcp.py
@@ -21,9 +21,9 @@ class AsyncModbusTcpClient(ModbusBaseClient):
     """**AsyncModbusTcpClient**.
 
     :param host: Host IP address or host name
-    :param port: (optional) Port used for communication.
-    :param framer: (optional) Framer class.
-    :param source_address: (optional) source address of client,
+    :param port: (optional) Port used for communication
+    :param framer: (optional) Framer class
+    :param source_address: (optional) source address of client
     :param kwargs: (optional) Experimental parameters
 
     Example::
@@ -153,9 +153,9 @@ class ModbusTcpClient(ModbusBaseClient):
     """**ModbusTcpClient**.
 
     :param host: Host IP address or host name
-    :param port: (optional) Port used for communication.
-    :param framer: (optional) Framer class.
-    :param source_address: (optional) source address of client,
+    :param port: (optional) Port used for communication
+    :param framer: (optional) Framer class
+    :param source_address: (optional) source address of client
     :param kwargs: (optional) Experimental parameters
 
     Example::
@@ -257,7 +257,7 @@ def recv(self, size):
 
         timeout = self.params.timeout
 
-        # If size isn"t specified read up to 4096 bytes at a time.
+        # If size isn't specified read up to 4096 bytes at a time.
         if size is None:
             recv_size = 4096
         else:
@@ -281,12 +281,12 @@ def recv(self, size):
                 data_length += len(recv_data)
             time_ = time.time()
 
-            # If size isn"t specified continue to read until timeout expires.
+            # If size isn't specified continue to read until timeout expires.
             if size:
                 recv_size = size - data_length
 
             # Timeout is reduced also if some data has been received in order
-            # to avoid infinite loops when there isn"t an expected response
+            # to avoid infinite loops when there isn't an expected response
             # size and the slave sends noisy data continuously.
             if time_ > end:
                 break
diff --git a/pymodbus/client/tls.py b/pymodbus/client/tls.py
@@ -23,9 +23,9 @@ def sslctx_provider(
 
     :param sslctx: The user defined 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 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 decrypting client's private key file
     """
     if sslctx:
         return sslctx
@@ -46,15 +46,15 @@ class AsyncModbusTlsClient(AsyncModbusTcpClient):
     """**AsyncModbusTlsClient**.
 
     :param host: Host IP address or host name
-    :param port: (optional) Port used for communication.
-    :param framer: (optional) Framer class.
-    :param source_address: (optional) Source address of client,
+    :param port: (optional) Port used for communication
+    :param framer: (optional) Framer class
+    :param source_address: (optional) Source address of client
     :param sslctx: (optional) SSLContext to use for TLS
     :param certfile: (optional) Cert file path for TLS server request
     :param keyfile: (optional) Key file path for TLS server request
     :param password: (optional) Password for for decrypting private key file
-    :param server_hostname: (optional) Bind certificate to host,
-    :param kwargs: (optional) Experimental parameters.
+    :param server_hostname: (optional) Bind certificate to host
+    :param kwargs: (optional) Experimental parameters
 
     Example::
 
@@ -116,15 +116,15 @@ class ModbusTlsClient(ModbusTcpClient):
     """**ModbusTlsClient**.
 
     :param host: Host IP address or host name
-    :param port: (optional) Port used for communication.
-    :param framer: (optional) Framer class.
-    :param source_address: (optional) Source address of client,
+    :param port: (optional) Port used for communication
+    :param framer: (optional) Framer class
+    :param source_address: (optional) Source address of client
     :param sslctx: (optional) SSLContext to use for TLS
     :param certfile: (optional) Cert file path for TLS server request
     :param keyfile: (optional) Key file path for TLS server request
-    :param password: (optional) Password for for decrypting private key file
-    :param server_hostname: (optional) Bind certificate to host,
-    :param kwargs: (optional) Experimental parameters.
+    :param password: (optional) Password for decrypting private key file
+    :param server_hostname: (optional) Bind certificate to host
+    :param kwargs: (optional) Experimental parameters
 
     Example::
 
diff --git a/pymodbus/constants.py b/pymodbus/constants.py
@@ -56,12 +56,12 @@ class Defaults(Singleton):  # pylint: disable=too-few-public-methods
 
     .. attribute:: ProtocolId
 
-       The modbus protocol id.  Currently this is set to 0 in all
+       The modbus protocol id. Currently, this is set to 0 in all
        but proprietary implementations.
 
     .. attribute:: Slave
 
-       The modbus slave address.  Currently this is set to 0x00 which
+       The modbus slave address. 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 respond).
 
@@ -188,11 +188,11 @@ class Endian(Singleton):  # pylint: disable=too-few-public-methods
 
     .. attribute:: Big
 
-       This indicates that the bytes are in little endian format
+       This indicates that the bytes are in big endian format
 
     .. attribute:: Little
 
-       This indicates that the bytes are in big endian format
+       This indicates that the bytes are in little endian format
 
     .. note:: I am simply borrowing the format strings from the
        python struct module for my convenience.
diff --git a/pymodbus/diag_message.py b/pymodbus/diag_message.py
@@ -296,7 +296,7 @@ def __init__(self, toggle=False, **kwargs):
 #  Diagnostic Sub Code 02
 # ---------------------------------------------------------------------------#
 class ReturnDiagnosticRegisterRequest(DiagnosticStatusSimpleRequest):
-    """The contents of the remote device"s 16-bit diagnostic register are returned in the response."""
+    """The contents of the remote device's 16-bit diagnostic register are returned in the response."""
 
     sub_function_code = 0x0002
 
@@ -313,7 +313,7 @@ def execute(self, *args):
 class ReturnDiagnosticRegisterResponse(DiagnosticStatusSimpleResponse):
     """Return diagnostic register.
 
-    The contents of the remote device"s 16-bit diagnostic register are
+    The contents of the remote device's 16-bit diagnostic register are
     returned in the response
     """
 
diff --git a/pymodbus/factory.py b/pymodbus/factory.py
@@ -2,7 +2,7 @@
 
 The following factories make it easy to decode request/response messages.
 To add a new request/response pair to be decodeable by the library, simply
-add them to the respective function lookup table (order doesn"t matter, but
+add them to the respective function lookup table (order doesn't matter, but
 it does help keep things organized).
 
 Regardless of how many functions are added to the lookup, O(1) behavior is
diff --git a/pymodbus/framer/ascii_framer.py b/pymodbus/framer/ascii_framer.py
@@ -129,7 +129,7 @@ def resetFrame(self):  # pylint: disable=invalid-name
         This allows us to skip ovver errors that may be in the stream.
         It is hard to know if we are simply out of sync or if there is
         an error in the stream as we have no way to check the start or
-        end of the message (python just doesn"t have the resolution to
+        end of the message (python just doesn't have the resolution to
         check for millisecond delays).
         """
         self._buffer = b""
diff --git a/pymodbus/framer/binary_framer.py b/pymodbus/framer/binary_framer.py
@@ -227,7 +227,7 @@ def resetFrame(self):  # pylint: disable=invalid-name
         This allows us to skip ovver errors that may be in the stream.
         It is hard to know if we are simply out of sync or if there is
         an error in the stream as we have no way to check the start or
-        end of the message (python just doesn"t have the resolution to
+        end of the message (python just doesn't have the resolution to
         check for millisecond delays).
         """
         self._buffer = b""
diff --git a/pymodbus/framer/rtu_framer.py b/pymodbus/framer/rtu_framer.py
@@ -122,7 +122,7 @@ def resetFrame(self):  # pylint: disable=invalid-name
         This allows us to skip over errors that may be in the stream.
         It is hard to know if we are simply out of sync or if there is
         an error in the stream as we have no way to check the start or
-        end of the message (python just doesn"t have the resolution to
+        end of the message (python just doesn't have the resolution to
         check for millisecond delays).
         """
         txt = (
diff --git a/pymodbus/framer/socket_framer.py b/pymodbus/framer/socket_framer.py
diff --git a/pymodbus/framer/tls_framer.py b/pymodbus/framer/tls_framer.py
diff --git a/pymodbus/other_message.py b/pymodbus/other_message.py
diff --git a/pymodbus/payload.py b/pymodbus/payload.py
diff --git a/pymodbus/pdu.py b/pymodbus/pdu.py
diff --git a/pymodbus/register_write_message.py b/pymodbus/register_write_message.py
diff --git a/pymodbus/repl/client/mclient.py b/pymodbus/repl/client/mclient.py
diff --git a/pymodbus/server/async_io.py b/pymodbus/server/async_io.py
diff --git a/pymodbus/utilities.py b/pymodbus/utilities.py
diff --git a/test/test_factory.py b/test/test_factory.py
diff --git a/test/test_interfaces.py b/test/test_interfaces.py
diff --git a/test/test_server_asyncio.py b/test/test_server_asyncio.py
