[v2] dpdk-telemetry-client: fix some pylint warnings
diff mbox series

Message ID 20201104070043.27879-1-stephen@networkplumber.org
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • [v2] dpdk-telemetry-client: fix some pylint warnings
Related show

Checks

Context Check Description
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional fail Functional Testing issues
ci/iol-testing success Testing PASS
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Stephen Hemminger Nov. 4, 2020, 7 a.m. UTC
Convert comments to docstrings as appropriate.
Remove unnecessary paren in if statement.
Remove extra whitespace after print.
Remove extra semicolon; this is not C.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
v2 - fix a few more warnings.
     split this patch from the bundle

 usertools/dpdk-telemetry-client.py | 34 ++++++++++++++++++------------
 1 file changed, 21 insertions(+), 13 deletions(-)

Comments

Thomas Monjalon Nov. 15, 2020, 11:06 p.m. UTC | #1
04/11/2020 08:00, Stephen Hemminger:
> Convert comments to docstrings as appropriate.

Why inserting some spaces inside the docstrings?

> Remove unnecessary paren in if statement.
> Remove extra whitespace after print.
> Remove extra semicolon; this is not C.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Some issues are remaining:

pycodestyle usertools/dpdk-telemetry-client.py
usertools/dpdk-telemetry-client.py:12:80: E501 line too long (82 > 79 characters)
usertools/dpdk-telemetry-client.py:14:80: E501 line too long (80 > 79 characters)
usertools/dpdk-telemetry-client.py:15:80: E501 line too long (86 > 79 characters)
usertools/dpdk-telemetry-client.py:18:1: E302 expected 2 blank lines, found 1
usertools/dpdk-telemetry-client.py:30:9: E722 do not use bare 'except'
usertools/dpdk-telemetry-client.py:33:1: E302 expected 2 blank lines, found 1
usertools/dpdk-telemetry-client.py:46:9: E722 do not use bare 'except'
usertools/dpdk-telemetry-client.py:50:80: E501 line too long (80 > 79 characters)
usertools/dpdk-telemetry-client.py:71:80: E501 line too long (82 > 79 characters)
usertools/dpdk-telemetry-client.py:82:80: E501 line too long (95 > 79 characters)
usertools/dpdk-telemetry-client.py:84:24: E261 at least two spaces before inline comment
usertools/dpdk-telemetry-client.py:84:25: E262 inline comment should start with '# '
usertools/dpdk-telemetry-client.py:107:32: E261 at least two spaces before inline comment
usertools/dpdk-telemetry-client.py:107:33: E262 inline comment should start with '# '
usertools/dpdk-telemetry-client.py:107:80: E501 line too long (80 > 79 characters)
usertools/dpdk-telemetry-client.py:120:13: E722 do not use bare 'except'
usertools/dpdk-telemetry-client.py:123:1: E305 expected 2 blank lines after class or function definition, found 1

Patch
diff mbox series

diff --git a/usertools/dpdk-telemetry-client.py b/usertools/dpdk-telemetry-client.py
index d8e439027cfc..8da3e9caa126 100755
--- a/usertools/dpdk-telemetry-client.py
+++ b/usertools/dpdk-telemetry-client.py
@@ -16,7 +16,7 @@ 
 DEFAULT_FP = "/var/run/dpdk/default_client"
 
 class Socket:
-
+    ''' Opens AF_UNIX sockets to telemetry server '''
     def __init__(self):
         self.send_fd = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
         self.recv_fd = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
@@ -31,8 +31,9 @@  def __del__(self):
             print("Error - Sockets could not be closed")
 
 class Client:
-
-    def __init__(self): # Creates a client instance
+    ''' Calls for communication with telemetry server '''
+    def __init__(self):
+        ''' Creates a client instance '''
         self.socket = Socket()
         self.file_path = None
         self.choice = None
@@ -41,20 +42,22 @@  def __init__(self): # Creates a client instance
     def __del__(self):
         try:
             if self.unregistered == 0:
-                self.unregister();
+                self.unregister()
         except:
             print("Error - Client could not be destroyed")
 
-    def getFilepath(self, file_path): # Gets arguments from Command-Line and assigns to instance of client
+    def getFilepath(self, file_path):
+        '''Gets arguments from Command-Line and assigns to instance of client'''
         self.file_path = file_path
 
-    def register(self): # Connects a client to DPDK-instance
+    def register(self):
+        '''Connects a client to DPDK-instance'''
         if os.path.exists(self.file_path):
             os.unlink(self.file_path)
         try:
             self.socket.recv_fd.bind(self.file_path)
         except socket.error as msg:
-            print ("Error - Socket binding error: " + str(msg) + "\n")
+            print("Error - Socket binding error: " + str(msg) + "\n")
         self.socket.recv_fd.settimeout(2)
         self.socket.send_fd.connect("/var/run/dpdk/rte/telemetry")
         JSON = (API_REG + self.file_path + "\"}}")
@@ -63,16 +66,19 @@  def register(self): # Connects a client to DPDK-instance
         self.socket.recv_fd.listen(1)
         self.socket.client_fd = self.socket.recv_fd.accept()[0]
 
-    def unregister(self): # Unregister a given client
+    def unregister(self):
+        ''' Unregister a given client '''
         self.socket.client_fd.send((API_UNREG + self.file_path + "\"}}").encode())
         self.socket.client_fd.close()
 
-    def requestMetrics(self): # Requests metrics for given client
+    def requestMetrics(self):
+        ''' Requests metrics for given client '''
         self.socket.client_fd.send(METRICS_REQ.encode())
         data = self.socket.client_fd.recv(BUFFER_SIZE).decode()
         print("\nResponse: \n", data)
 
-    def repeatedlyRequestMetrics(self, sleep_time): # Recursively requests metrics for given client
+    def repeatedlyRequestMetrics(self, sleep_time):
+        ''' Recursively requests metrics for given client '''
         print("\nPlease enter the number of times you'd like to continuously request Metrics:")
         n_requests = int(input("\n:"))
         print("\033[F") #Removes the user input from screen, cleans it up
@@ -81,12 +87,14 @@  def repeatedlyRequestMetrics(self, sleep_time): # Recursively requests metrics f
             self.requestMetrics()
             time.sleep(sleep_time)
 
-    def requestGlobalMetrics(self): #Requests global metrics for given client
+    def requestGlobalMetrics(self):
+        ''' Requests global metrics for given client '''
         self.socket.client_fd.send(GLOBAL_METRICS_REQ.encode())
         data = self.socket.client_fd.recv(BUFFER_SIZE).decode()
         print("\nResponse: \n", data)
 
-    def interactiveMenu(self, sleep_time): # Creates Interactive menu within the script
+    def interactiveMenu(self, sleep_time):
+        ''' Creates Interactive menu within the script '''
         while self.choice != 4:
             print("\nOptions Menu")
             print("[1] Send for Metrics for all ports")
@@ -116,7 +124,7 @@  def interactiveMenu(self, sleep_time): # Creates Interactive menu within the scr
 
     sleep_time = 1
     file_path = ""
-    if (len(sys.argv) == 2):
+    if len(sys.argv) == 2:
         file_path = sys.argv[1]
     else:
         print("Warning - No filepath passed, using default (" + DEFAULT_FP + ").")