black: re-format
black and isort are enabled in the openbmc-build-scripts on Python files
to have a consistent formatting. Re-run the formatter on the whole
repository.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I944f1915ece753f72a3fa654902d445a9749d0f9
diff --git a/lib/gen_plug_in.py b/lib/gen_plug_in.py
index fc57cef..d6ab0a6 100755
--- a/lib/gen_plug_in.py
+++ b/lib/gen_plug_in.py
@@ -4,27 +4,29 @@
This module provides functions which are useful for running plug-ins.
"""
-import sys
-import os
import glob
+import os
+import sys
-import gen_print as gp
import gen_misc as gm
+import gen_print as gp
# Some help text that is common to more than one program.
-plug_in_dir_paths_help_text = \
- 'This is a colon-separated list of plug-in directory paths. If one' +\
- ' of the entries in the list is a plain directory name (i.e. no' +\
- ' path info), it will be taken to be a native plug-in. In that case,' +\
- ' %(prog)s will search for the native plug-in in the "plug-ins"' +\
- ' subdirectory of each path in the PATH environment variable until it' +\
- ' is found. Also, integrated plug-ins will automatically be appended' +\
- ' to your plug_in_dir_paths list. An integrated plug-in is any plug-in' +\
- ' found using the PATH variable that contains a file named "integrated".'
+plug_in_dir_paths_help_text = (
+ "This is a colon-separated list of plug-in directory paths. If one"
+ + " of the entries in the list is a plain directory name (i.e. no"
+ + " path info), it will be taken to be a native plug-in. In that case,"
+ + ' %(prog)s will search for the native plug-in in the "plug-ins"'
+ + " subdirectory of each path in the PATH environment variable until it"
+ + " is found. Also, integrated plug-ins will automatically be appended"
+ + " to your plug_in_dir_paths list. An integrated plug-in is any plug-in"
+ + ' found using the PATH variable that contains a file named "integrated".'
+)
-mch_class_help_text = \
- 'The class of machine that we are testing (e.g. "op" = "open power",' +\
- ' "obmc" = "open bmc", etc).'
+mch_class_help_text = (
+ 'The class of machine that we are testing (e.g. "op" = "open power",'
+ + ' "obmc" = "open bmc", etc).'
+)
PATH_LIST = gm.return_path_list()
@@ -64,17 +66,16 @@
global plug_in_base_path_list
for plug_in_base_dir_path in plug_in_base_path_list:
- candidate_plug_in_dir_path = os.path.normpath(plug_in_base_dir_path
- + plug_in_name) + \
- os.sep
+ candidate_plug_in_dir_path = (
+ os.path.normpath(plug_in_base_dir_path + plug_in_name) + os.sep
+ )
if os.path.isdir(candidate_plug_in_dir_path):
return candidate_plug_in_dir_path
return ""
-def validate_plug_in_package(plug_in_dir_path,
- mch_class="obmc"):
+def validate_plug_in_package(plug_in_dir_path, mch_class="obmc"):
r"""
Validate the plug in package and return the normalized plug-in directory path.
@@ -88,33 +89,42 @@
if os.path.isabs(plug_in_dir_path):
# plug_in_dir_path begins with a slash so it is an absolute path.
- candidate_plug_in_dir_path = os.path.normpath(plug_in_dir_path) +\
- os.sep
+ candidate_plug_in_dir_path = (
+ os.path.normpath(plug_in_dir_path) + os.sep
+ )
if not os.path.isdir(candidate_plug_in_dir_path):
- gp.print_error_report("Plug-in directory path \""
- + plug_in_dir_path + "\" does not exist.\n")
+ gp.print_error_report(
+ 'Plug-in directory path "'
+ + plug_in_dir_path
+ + '" does not exist.\n'
+ )
exit(1)
else:
# The plug_in_dir_path is actually a simple name (e.g. "OBMC_Sample")...
candidate_plug_in_dir_path = find_plug_in_package(plug_in_dir_path)
if candidate_plug_in_dir_path == "":
global PATH_LIST
- gp.print_error_report("Plug-in directory path \""
- + plug_in_dir_path + "\" could not be found"
- + " in any of the following directories:\n"
- + gp.sprint_var(PATH_LIST))
+ gp.print_error_report(
+ 'Plug-in directory path "'
+ + plug_in_dir_path
+ + '" could not be found'
+ + " in any of the following directories:\n"
+ + gp.sprint_var(PATH_LIST)
+ )
exit(1)
# Make sure that this plug-in supports us...
supports_file_path = candidate_plug_in_dir_path + "supports_" + mch_class
if not os.path.exists(supports_file_path):
- gp.print_error_report("The following file path could not be"
- + " found:\n"
- + gp.sprint_varx("supports_file_path",
- supports_file_path)
- + "\nThis file is necessary to indicate that"
- + " the given plug-in supports the class of"
- + " machine we are testing, namely \""
- + mch_class + "\".\n")
+ gp.print_error_report(
+ "The following file path could not be"
+ + " found:\n"
+ + gp.sprint_varx("supports_file_path", supports_file_path)
+ + "\nThis file is necessary to indicate that"
+ + " the given plug-in supports the class of"
+ + ' machine we are testing, namely "'
+ + mch_class
+ + '".\n'
+ )
exit(1)
return candidate_plug_in_dir_path
@@ -136,22 +146,25 @@
integrated_plug_ins_list = []
- DEBUG_SKIP_INTEGRATED = int(os.getenv('DEBUG_SKIP_INTEGRATED', '0'))
+ DEBUG_SKIP_INTEGRATED = int(os.getenv("DEBUG_SKIP_INTEGRATED", "0"))
if DEBUG_SKIP_INTEGRATED:
return integrated_plug_ins_list
for plug_in_base_path in plug_in_base_path_list:
# Get a list of all plug-in paths that support our mch_class.
- mch_class_candidate_list = glob.glob(plug_in_base_path
- + "*/supports_" + mch_class)
+ mch_class_candidate_list = glob.glob(
+ plug_in_base_path + "*/supports_" + mch_class
+ )
for candidate_path in mch_class_candidate_list:
- integrated_plug_in_dir_path = os.path.dirname(candidate_path) +\
- os.sep
+ integrated_plug_in_dir_path = (
+ os.path.dirname(candidate_path) + os.sep
+ )
integrated_file_path = integrated_plug_in_dir_path + "integrated"
if os.path.exists(integrated_file_path):
- plug_in_name = \
- os.path.basename(os.path.dirname(candidate_path))
+ plug_in_name = os.path.basename(
+ os.path.dirname(candidate_path)
+ )
if plug_in_name not in integrated_plug_ins_list:
# If this plug-in has not already been added to the list...
integrated_plug_ins_list.append(plug_in_name)
@@ -159,8 +172,7 @@
return integrated_plug_ins_list
-def return_plug_in_packages_list(plug_in_dir_paths,
- mch_class="obmc"):
+def return_plug_in_packages_list(plug_in_dir_paths, mch_class="obmc"):
r"""
Return a list of plug-in packages given the plug_in_dir_paths string. This function calls
validate_plug_in_package so it will fail if plug_in_dir_paths contains any invalid plug-ins.
@@ -184,8 +196,13 @@
plug_in_packages_list = plug_in_packages_list + integrated_plug_ins_list
- plug_in_packages_list = \
- list(set([validate_plug_in_package(path, mch_class)
- for path in plug_in_packages_list]))
+ plug_in_packages_list = list(
+ set(
+ [
+ validate_plug_in_package(path, mch_class)
+ for path in plug_in_packages_list
+ ]
+ )
+ )
return plug_in_packages_list