Enforce comprehension lists simplifications in Python (project-chip#41812)

* Check for common logging errors in Python code

* Enforce comprehension lists simplifications

* Restyled by autopep8

* Use legacy typing for tuple

* Add exception for LOG015

---------

Co-authored-by: Restyled.io <[email protected]>

Author: arkq

config/common/cmake/make_gn_args.py

@@ -56,12 +56,12 @@ def write_gn_args(args):
         filtered_value = filter(lambda v: v != "D", filtered_value)
         filtered_value = filter(lambda v: v != "isystem", filtered_value)
         # Escaped quote and dollar sign characters
-        filtered_value = map(lambda v: v.replace('"', '\\"'), filtered_value)
-        filtered_value = map(lambda v: v.replace('$', '\\$'), filtered_value)
+        filtered_value = (v.replace('"', '\\"') for v in filtered_value)
+        filtered_value = (v.replace('$', '\\$') for v in filtered_value)
         # Remove white spaces around the argument and remove internal whitespace
         # for correct splitting in string_split() function
-        filtered_value = map(lambda v: v.strip(), filtered_value)
-        filtered_value = map(lambda v: v.replace(' ', ''), filtered_value)
+        filtered_value = (v.strip() for v in filtered_value)
+        filtered_value = (v.replace(' ', '') for v in filtered_value)
         #  Remove duplicates
         filtered_value = list(dict.fromkeys(filtered_value))
 

config/esp32/components/chip/create_args_gn.py

@@ -44,11 +44,13 @@
     compile_commands = json.load(compile_commands_json)
 
     def get_compile_flags(src_file):
-        compile_command = list(map(lambda res: res["command"],
-                               filter(lambda cmd: cmd["file"] == src_file, compile_commands)))
+        compile_command = [
+            res["command"]
+            for res in filter(lambda cmd: cmd["file"] == src_file, compile_commands)
+        ]
 
         if len(compile_command) != 1:
-            raise Exception("Failed to resolve compile flags for %s", src_file)
+            raise Exception(f"Failed to resolve compile flags for {src_file}")
 
         compile_command = compile_command[0]
         # Trim compiler, input and output
@@ -57,12 +59,10 @@ def get_compile_flags(src_file):
         replace = "-I%s" % args.idf_path
         replace_with = "-isystem%s" % args.idf_path
 
-        compile_flags = list(map(lambda f: ('"%s"' % f).replace(
-            replace, replace_with), compile_flags))
+        compile_flags = [f'"{f}"'.replace(replace, replace_with) for f in compile_flags]
 
         if args.filter_out:
-            filter_out = list(map(lambda f: ('"%s"' % f),
-                              args.filter_out.split(';')))
+            filter_out = [f'"{f}"' for f in args.filter_out.split(';')]
             compile_flags = [c for c in compile_flags if c not in filter_out]
 
         return compile_flags

credentials/generate_revocation_set.py

@@ -46,7 +46,7 @@
 __LOG_LEVELS__ = {
     'debug': logging.DEBUG,
     'info': logging.INFO,
-    'warn': logging.WARN,
+    'warn': logging.WARNING,
     'fatal': logging.FATAL,
 }
 

docs/_extensions/external_content.py

@@ -169,13 +169,13 @@ def sync_contents(app: Sphinx) -> None:
 
     srcdir = Path(app.srcdir).resolve()
     to_copy = []
-    to_delete = set(f for f in srcdir.glob("**/*") if not f.is_dir())
-    to_keep = set(
+    to_delete = {f for f in srcdir.glob("**/*") if not f.is_dir()}
+    to_keep = {
         f
         for k in app.config.external_content_keep
         for f in srcdir.glob(k)
         if not f.is_dir()
-    )
+    }
 
     for content in app.config.external_content_contents:
         prefix_src, glob = content

examples/chef/chef.py

@@ -69,12 +69,12 @@ def splash() -> None:
 
 
 def load_config() -> None:
-    config = dict()
-    config["nrfconnect"] = dict()
-    config["esp32"] = dict()
-    config["silabs-thread"] = dict()
-    config["ameba"] = dict()
-    config["telink"] = dict()
+    config = {}
+    config["nrfconnect"] = {}
+    config["esp32"] = {}
+    config["silabs-thread"] = {}
+    config["ameba"] = {}
+    config["telink"] = {}
     configFile = f"{_CHEF_SCRIPT_PATH}/config.yaml"
     if (os.path.exists(configFile)):
         configStream = open(configFile, 'r')

examples/common/pigweed/rpc_console/py/chip_rpc/plugins/helper_scripts.py

@@ -36,26 +36,23 @@ def get_descriptor(self) -> str:
         if not status.ok():
             raise Exception("Failed to read ep0 device type list: %s", status)
 
-        out["device_types"] = list(
-            map(lambda dt: dt.device_type, device_types))
+        out["device_types"] = [dt.device_type for dt in device_types]
         (status, parts_list) = self.rpcs.chip.rpc.Descriptor.PartsList(endpoint=0)
         if not status.ok():
             raise Exception("Failed to read ep0 parts list: %s", status)
 
-        out["parts_list"] = list(map(lambda ep: ep.endpoint, parts_list))
+        out["parts_list"] = [ep.endpoint for ep in parts_list]
         out["endpoints"] = {}
         for ep in out["parts_list"]:
             out["endpoints"][str(ep)] = {}
             (status, clusters) = self.rpcs.chip.rpc.Descriptor.ClientList(endpoint=ep)
             if not status.ok():
                 raise Exception("Failed to read ep0 parts list: %s", status)
-            out["endpoints"][str(ep)]["client_list"] = list(
-                map(lambda c: c.cluster_id, clusters))
+            out["endpoints"][str(ep)]["client_list"] = [c.cluster_id for c in clusters]
             (status, clusters) = self.rpcs.chip.rpc.Descriptor.ServerList(endpoint=ep)
             if not status.ok():
                 raise Exception("Failed to read ep0 parts list: %s", status)
-            out["endpoints"][str(ep)]["server_list"] = list(
-                map(lambda c: c.cluster_id, clusters))
+            out["endpoints"][str(ep)]["server_list"] = [c.cluster_id for c in clusters]
 
         return out
 

pyproject.toml

@@ -27,13 +27,18 @@ select = [
     "E", "W", "F",
     # Consistent commas
     "COM",
+    # Simplify the code if possible
+    "C4",
     # Ensure that scripts are executable
     "EXE",
+    # Check for common logging issues
+    "LOG",
     # Check for common optimization issues
     "SLOT",
 ]
 ignore = [
-    "COM812", # Do not enforce trailing commas in multi-line collections
+    "COM812", # Do not enforce trailing commas in multi-line collections for now
+    "LOG015", # Do not enforce non-root loggers in the entire codebase for now
     "E501", # Do not report line length issues (formatter should handle this)
     "E721", # We use it for good reasons
 ]

scripts/checkout_submodules.py

@@ -24,7 +24,7 @@
 
 CHIP_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
 
-ALL_PLATFORMS = set([
+ALL_PLATFORMS = {
     'ameba',
     'android',
     'asr',
@@ -50,7 +50,7 @@
     'genio',
     'silabs_docker',
     'unit_tests'
-])
+}
 
 Module = namedtuple('Module', 'name path platforms recursive')
 

scripts/codegen.py

@@ -62,7 +62,7 @@ def write_new_data(self, relative_path: str, content: str):
 __LOG_LEVELS__ = {
     'debug': logging.DEBUG,
     'info': logging.INFO,
-    'warn': logging.WARN,
+    'warn': logging.WARNING,
     'fatal': logging.FATAL,
 }
 

scripts/codegen_paths.py

@@ -36,7 +36,7 @@
 __LOG_LEVELS__ = {
     'debug': logging.DEBUG,
     'info': logging.INFO,
-    'warn': logging.WARN,
+    'warn': logging.WARNING,
     'fatal': logging.FATAL,
 }