Active pylint missing-docstring. (#850)

Author: janiversen

.pylintrc

@@ -81,6 +81,7 @@ fail-on=
 enable=
     attribute-defined-outside-init,
     fixme,
+    missing-docstring,
     protected-access,
     too-few-public-methods,
     useless-suppression
@@ -89,7 +90,6 @@ disable=
     duplicate-code,
     invalid-name,
     logging-too-many-args,
-    missing-docstring,
     use-symbolic-message-instead,
     format # handled by black
 

examples/common/async_tornado_client.py

@@ -47,6 +47,7 @@ def on_done(f):
 
 
 def _print(value):
+    """ Internal print. """
     if hasattr(value, "bits"):
         result = value.bits
     elif hasattr(value, "registers"):

examples/common/async_tornado_client_serial.py

@@ -54,6 +54,7 @@ def on_done(f):
 
 
 def _print(value):
+    """ Internal print """
     if hasattr(value, "bits"):
         result = value.bits
     elif hasattr(value, "registers"):

examples/contrib/thread_safe_datastore.py

@@ -51,6 +51,7 @@ def __init__(self):
         self.writer = False                   # is there a current writer
 
     def __is_pending_writer(self):
+        """ Internal is pending writer. """
         return (self.writer                     # if there is a current writer
                 or (self.queue                    # or if there is a waiting writer
                     and (self.queue[0] != self.read_condition)))

pymodbus/__init__.py

@@ -11,6 +11,7 @@
 """
 
 import logging as __logging
+from logging import NullHandler as __null
 import pymodbus.version as __version
 __version__ = __version.version.short()
 __author__  = 'Galen Collins'
@@ -19,11 +20,4 @@
 #---------------------------------------------------------------------------#
 # Block unhandled logging
 #---------------------------------------------------------------------------#
-try:
-    from logging import NullHandler as __null
-except ImportError:
-    class __null(__logging.Handler): # pylint: disable=invalid-name
-        def emit(self, record):
-            pass
-
 __logging.getLogger(__name__).addHandler(__null())

pymodbus/client/asynchronous/async_io/__init__.py

@@ -270,6 +270,7 @@ def _create_protocol(self):
         return protocol
 
     async def _connect(self):
+        """ Internal connect. """
         _logger.debug('Connecting.')
         try:
             transport, protocol = await self.loop.create_connection(
@@ -311,6 +312,7 @@ def protocol_lost_connection(self, protocol):
 
 
     async def _reconnect(self):
+        """ Internal reconnect. """
         txt = f"Waiting {self.delay_ms} ms before next connection attempt."
         _logger.debug(txt)
         await asyncio.sleep(self.delay_ms / 1000)
@@ -528,6 +530,7 @@ def _create_protocol(self, host=None, port=0):
 
 
     async def _connect(self):
+        """ Internal connect. """
         _logger.debug('Connecting.')
         try:
             endpoint = await self.loop.create_datagram_endpoint(
@@ -571,6 +574,7 @@ def protocol_lost_connection(self, protocol):
                           'callback called while not connected.')
 
     async def _reconnect(self):
+        """ Internal reconnect. """
         txt = f"Waiting {self.delay_ms} ms before next connection attempt."
         _logger.debug(txt)
         await asyncio.sleep(self.delay_ms / 1000)
@@ -705,12 +709,14 @@ def stop(self):
                     self.protocol.transport.close()
 
     def _create_protocol(self):
+        """ Internal create protocol. """
         protocol = self.protocol_class(framer=self.framer)
         protocol.factory = self
         return protocol
 
     @property
     def _connected(self):
+        """ Internal connected. """
         return self._connected_event.is_set()
 
     async def connect(self):

pymodbus/client/sync.py

@@ -144,6 +144,7 @@ def trace(self, writeable):
         self._debugfd = writeable
 
     def _dump(self, data):
+        """ Internal dump. """
         fd = self._debugfd if self._debugfd else sys.stdout
         try:
             fd.write(hexlify_packets(data))
@@ -218,6 +219,7 @@ def close(self):
         self.socket = None
 
     def _check_read_buffer(self):
+        """ Internal check read buffer. """
         time_ = time.time()
         end = time_ + self.timeout
         data = None
@@ -656,6 +658,7 @@ def close(self):
         self.socket = None
 
     def _in_waiting(self):
+        """ Internal _in_waiting. """
         in_waiting = ("in_waiting" if hasattr(
             self.socket, "in_waiting") else "inWaiting")
 
@@ -699,6 +702,7 @@ def _send(self, request):
         return 0
 
     def _wait_for_data(self):
+        """ Internal wait for data. """
         size = 0
         more_data = False
         if self.timeout is not None and self.timeout:

pymodbus/client/sync_diag.py

@@ -130,6 +130,7 @@ def _recv(self, size):
             raise ConnectionException from exc
 
     def _log_delayed_response(self, result_len, size, delay):
+        """ Internal log delayed response. """
         if not size and result_len > 0:
             _logger.info(self.timelimit_read_msg, delay, result_len)
         elif ((not result_len) or (size and result_len < size)) and delay >= self.timeout:

pymodbus/datastore/database/sql_datastore.py

@@ -131,6 +131,7 @@ def _build_set(self, type, offset, values, prefix=''): # pylint: disable=no-self
         return result
 
     def _check(self, type, offset, values): #NOSONAR pylint: disable=unused-argument,redefined-builtin
+        """ Internal check. """
         result = self._get(type, offset, count=1)
         return False if len(result) > 0 else True # pylint: disable=simplifiable-if-expression
 

pymodbus/datastore/store.py

@@ -262,6 +262,7 @@ def getValues(self, address, count=1):
         return [self.values[i] for i in range(address, address + count)]
 
     def _process_values(self, values):
+        """ Internal process values. """
         def _process_as_dict(values):
             for idx, val in iter(values.items()):
                 if isinstance(val, (list, tuple)):