annotations: coding style fixes
authorAndrea Righi <andrea.righi@canonical.com>
Mon, 11 Dec 2023 13:42:43 +0000 (14:42 +0100)
committerAndrea Righi <andrea.righi@canonical.com>
Mon, 11 Dec 2023 14:06:17 +0000 (15:06 +0100)
No functional changes, just some python / shell coding style fixes.

Signed-off-by: Andrea Righi <andrea.righi@canonical.com>
annotations
build-deb.sh
kconfig/annotations.py
kconfig/run.py
kconfig/sanitize.py
kconfig/version.py
tests/test_todo_note.py

index bddfe4029f49fe6abc70c42ab922209fdb78083b..34d70da68b9a1417d46c74570fb11b77ac4a55cb 100755 (executable)
@@ -5,7 +5,6 @@
 # distribution without installing it in the system.
 
 import os
-import sys
 from kconfig import run
 
 
index 28e1d32558c62b1b59754c86a102e1051e41e39a..9107ddfab04f9538bc8c2c20948641ee98f2aa43 100755 (executable)
@@ -12,9 +12,9 @@ fi
 
 # Create upsteam tag
 deb_tag=$(dpkg-parsechangelog -S version | cut -d- -f1)
-git tag upstream/${deb_tag}
+git tag "upstream/${deb_tag}"
 
-gbp buildpackage --git-ignore-branch $*
+gbp buildpackage --git-ignore-branch "$@"
 
 # Undo packaging changes
-git tag -d upstream/${deb_tag}
+git tag -d "upstream/${deb_tag}"
index 9b7152ed0ac2d60ace86dff34ec79e1cf5d59170..98121d967fa96e7a4e571f742cebf3c86f2863bd 100644 (file)
@@ -166,10 +166,10 @@ class Annotation(Config):
 
         # Return an error if architectures are not defined
         if not self.arch:
-            raise SyntaxError(f"ARCH not defined in annotations")
+            raise SyntaxError("ARCH not defined in annotations")
         # Return an error if flavours are not defined
         if not self.flavour:
-            raise SyntaxError(f"FLAVOUR not defined in annotations")
+            raise SyntaxError("FLAVOUR not defined in annotations")
 
         # Parse body
         self._parse_body(data)
@@ -224,7 +224,7 @@ class Annotation(Config):
         # format.
         try:
             self._legacy_parse(data)
-        except SyntaxError as e:
+        except SyntaxError:
             self._json_parse(data, is_included=False)
 
     def _remove_entry(self, config: str):
@@ -305,7 +305,8 @@ class Annotation(Config):
                     if val != old_val and "note" in self.config[conf]:
                         self.config[conf]["note"] = "TODO: update note"
                         print(
-                            f"WARNING: {conf} changed from {old_val} to {val}, updating note"
+                            f"WARNING: {conf} changed from {old_val} to {val}, "
+                            "updating note"
                         )
                     self.config[conf]["policy"][flavour] = val
                 else:
index 0f35772d46ae365a70b52334e5a56a0dd6380559..5171dfc6fd0f6ce0bde5db7bd3ac7e94a2a09a9b 100644 (file)
@@ -6,10 +6,10 @@ import sys
 
 sys.dont_write_bytecode = True
 
-import os
-import argparse
-import json
-from signal import signal, SIGPIPE, SIG_DFL
+import os  # noqa: E402 Import not at top of file
+import argparse  # noqa: E402 Import not at top of file
+import json  # noqa: E402 Import not at top of file
+from signal import signal, SIGPIPE, SIG_DFL  # noqa: E402 Import not at top of file
 
 try:
     from argcomplete import autocomplete
@@ -19,9 +19,18 @@ except ModuleNotFoundError:
         pass
 
 
-from kconfig.annotations import Annotation, KConfig
-from kconfig.utils import autodetect_annotations, arg_fail
-from kconfig.version import VERSION, ANNOTATIONS_FORMAT_VERSION
+from kconfig.annotations import (  # noqa: E402 Import not at top of file
+    Annotation,
+    KConfig,
+)
+from kconfig.utils import (  # noqa: E402 Import not at top of file
+    autodetect_annotations,
+    arg_fail,
+)
+from kconfig.version import (  # noqa: E402 Import not at top of file
+    VERSION,
+    ANNOTATIONS_FORMAT_VERSION,
+)
 
 
 SKIP_CONFIGS = (
@@ -116,7 +125,8 @@ def make_parser():
         action="store",
         metavar="FILE",
         dest="update_file",
-        help="Import a partial .config into annotations (only resync configs specified in FILE)",
+        help="Import a partial .config into annotations "
+        "(only resync configs specified in FILE)",
     )
     ga.add_argument(
         "--check",
@@ -154,7 +164,7 @@ def export_result(data):
         policy = data["config"][key]["policy"]
         if "note" in data["config"][key]:
             note = data["config"][key]["note"]
-            out += f'    "{key}": {{"policy": {json.dumps(policy)}, "note": {json.dumps(note)}}},\n'
+            out += f'    "{key}": {{"policy": {json.dumps(policy)}, "note": {json.dumps(note)}}},\n'  # noqa: E501 Line too long
         else:
             out += f'    "{key}": {{"policy": {json.dumps(policy)}}},\n'
     out = out.rstrip(",\n")
@@ -330,7 +340,8 @@ def do_check(args):
     if ret:
         if os.path.exists(".git"):
             print(
-                f"check-config: {num} config options have been changed, review them with `git diff`"
+                f"check-config: {num} config options have been changed, "
+                "review them with `git diff`"
             )
         else:
             print(f"check-config: {num} config options have changed")
index f03b3006fec8c57b8a013dd39a3b4b517185ebe8..3a7da3ee36ff4861a612f42e4371a53cab6f2393 100644 (file)
@@ -7,12 +7,15 @@ import sys
 
 sys.dont_write_bytecode = True  # pylint: disable=E0402
 
-import re
-import argparse
-from argcomplete import autocomplete
-
-from kconfig.utils import autodetect_annotations, arg_fail
-from kconfig.version import VERSION
+import re  # noqa: E402 Import not at top of file
+import argparse  # noqa: E402 Import not at top of file
+from argcomplete import autocomplete  # noqa: E402 Import not at top of file
+
+from kconfig.utils import (  # noqa: E402 Import not at top of file
+    autodetect_annotations,
+    arg_fail,
+)
+from kconfig.version import VERSION  # noqa: E402 Import not at top of file
 
 
 def make_parser():
index da64538b99995e0f03237c3da9ae4086e2a9c112..833ffa34654bb6bb91e1bfa98e959888fa0511c9 100644 (file)
@@ -6,5 +6,5 @@ VERSION = "0.1"
 
 ANNOTATIONS_FORMAT_VERSION = 5
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     print(VERSION)
index 61e5611d54d54ddb0b908772477760ad57553914..30b8c126141417ccd8655d84a073c4bbc40199c3 100644 (file)
@@ -1,5 +1,4 @@
 import unittest
-import json
 
 from tests import utils