Pylint warning and error fix
Changes:
- import orders and remove unused import module
- doctring changes
Tested: python3 -m pylint lib/utilities.py
There are other warnings still.
Change-Id: I913806ac5ae02f13068940a166405c1b9328c52d
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/lib/utilities.py b/lib/utilities.py
index 2b7660f..1599ffb 100755
--- a/lib/utilities.py
+++ b/lib/utilities.py
@@ -1,10 +1,13 @@
#!/usr/bin/env python3 -u
-import sys
-from robot.libraries.BuiltIn import BuiltIn
+
+r"""
+Generic utility functions.
+"""
import imp
import string
import random
import subprocess
+from robot.libraries.BuiltIn import BuiltIn
from robot.utils import DotDict
@@ -27,6 +30,9 @@
def get_sensor(module_name, value):
+ r"""
+ Return sensor matched ID name.
+ """
m = imp.load_source('module.name', module_name)
for i in m.ID_LOOKUP['SENSOR']:
@@ -38,6 +44,9 @@
def get_inventory_sensor(module_name, value):
+ r"""
+ Return sensor matched ID name from inventory.
+ """
m = imp.load_source('module.name', module_name)
value = string.replace(value, m.INVENTORY_ROOT, '<inventory_root>')
@@ -55,10 +64,13 @@
#
# i.e. get_inventory_list('../data/Palmetto.py')
#
-# [/org/openbmc/inventory//system/chassis/motherboard/cpu0/core0,
+# [/org/openbmc/inventory/system/chassis/motherboard/cpu0/core0,
# /org/openbmc/inventory/system/chassis/motherboard/dimm0]
################################################################
def get_inventory_list(module_name):
+ r"""
+ Return all FRU URI(s) list available from inventory.
+ """
inventory_list = []
m = imp.load_source('module.name', module_name)
@@ -76,10 +88,13 @@
#
# i.e. get_inventory_fru_type_list('../data/Witherspoon.py', 'CPU')
#
-# [/org/openbmc/inventory//system/chassis/motherboard/cpu0,
-# /org/openbmc/inventory//system/chassis/motherboard/cpu1]
+# [/org/openbmc/inventory/system/chassis/motherboard/cpu0,
+# /org/openbmc/inventory/system/chassis/motherboard/cpu1]
################################################################
def get_inventory_fru_type_list(module_name, fru):
+ r"""
+ Return FRU URI(s) list of a given type from inventory.
+ """
inventory_list = []
m = imp.load_source('module.name', module_name)
@@ -100,6 +115,9 @@
# /org/openbmc/inventory/system/chassis/motherboard/dimm1]
################################################################
def get_vpd_inventory_list(module_name, fru):
+ r"""
+ Return VPD URI(s) list of a FRU type from inventory.
+ """
inventory_list = []
m = imp.load_source('module.name', module_name)
@@ -114,10 +132,16 @@
def call_keyword(keyword):
+ r"""
+ Return result of the execute robot keyword.
+ """
return BuiltIn().run_keyword(keyword)
def main():
+ r"""
+ Python main func call.
+ """
print(get_vpd_inventory_list('../data/Palmetto.py', 'DIMM'))