Convert comments to docstrings as appropriate.
Remove unnecessary paren in if statement.
Remove extra whitespace after print.
Signed-off-by: Stephen Hemminger <step...@networkplumber.org>
---
usertools/dpdk-telemetry-client.py | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
diff --git a/usertools/dpdk-telemetry-client.py
b/usertools/dpdk-telemetry-client.py
index fa599046a46b..7a22d1b99864 100755
--- a/usertools/dpdk-telemetry-client.py
+++ b/usertools/dpdk-telemetry-client.py
@@ -32,7 +32,8 @@ def __del__(self):
class Client:
- def __init__(self): # Creates a client instance
+ def __init__(self):
+ ''' Creates a client instance '''
self.socket = Socket()
self.file_path = None
self.choice = None
@@ -45,16 +46,18 @@ def __del__(self):
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 +
").")
--
2.27.0
