Merge pull request #7 from BOSWatch/pyLint

Fix some pyLint error or warnings

boswatch/filter/doubeFilter.py

@@ -13,8 +13,7 @@
 @date:        15.01.2018
 @author:      Bastian Schroll
 @description: Class to implement a filter for double alarms
-@todo test, refactor and document
+@todo test, refactor and document / check_msg is not implemented yet
-@todo check_msg is not implemented yet
 """
 import logging
 import time

boswatch/network/server.py

@@ -135,7 +135,11 @@ class TCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):
 
     @staticmethod
     def getClientsConnected():
-        # todo insert comment
+        """!A list of all connected clients
+        with their IP address and last seen timestamp
+        _clients[ThreadName] = {"address", "timestamp"}
+
+        @return List of onnected clients"""
         # todo return full list or write a print/debug method?
         return _clients
 

boswatch/packet/packet.py

@@ -101,6 +101,5 @@ class Packet:
         """!Print a info message to the log on INFO level.
         Contains the most useful info about this packet.
         @todo not complete yet - must be edit to print nice formatted messages on console
-
+        """
-        @param bwPacket: BOSWatch packet instance"""
         logging.info("[%s]", self.get("mode"))

boswatch/utils/wildcard.py

@@ -13,7 +13,6 @@
 @date:        15.01.2018
 @author:      Bastian Schroll
 @description: Little Helper to replace wildcards in stings
-@todo not completed yet
 """
 import logging
 import time

bw_client.py

@@ -91,8 +91,7 @@ try:
                     bwPacket.addClientData()
                     bwClient.transmit(str(bwPacket))
 
-                    # todo should we do this in an thread, to not block receiving ???
+                    # todo should we do this in an thread, to not block receiving ??? but then we should use transmit() and receive() with Lock()
-                    # todo but then we should use transmit() and receive() with Lock()
                     failedTransmits = 0
                     while not bwClient.receive() == "[ack]":  # wait for ack or timeout
                         if failedTransmits >= 3:

plugins/template/template.py

@@ -30,7 +30,7 @@ class BoswatchPlugin(Plugin):
     def __init__(self):
         """!Do not change anything here except the PLUGIN NAME in the super() call"""
         # PLEASE SET YOU PLUGIN NAME HERE !!!!
-        Plugin.__init__("template")
+        super().__init__("template")
 
     def onLoad(self):
         """!Called by import of the plugin"""

test/test_ServerClient.py

@@ -14,9 +14,9 @@
 @author:      Bastian Schroll
 @description: Unittests for BOSWatch. File must be _run as "pytest" unittest
 """
-import pytest
 import logging
 import time
+import pytest
 
 from boswatch.network.server import TCPServer
 from boswatch.network.client import TCPClient

test/test_packet.py

@@ -14,8 +14,8 @@
 @author:      Bastian Schroll
 @description: Unittests for BOSWatch. File must be _run as "pytest" unittest
 """
-import pytest
 import logging
+import pytest
 
 from boswatch.packet.packet import Packet