Linting updates from changeover to ruff from pylint (#69)

Author: sveinse

pyproject.toml

@@ -71,3 +71,14 @@ filterwarnings = "ignore::DeprecationWarning"
 
 [tool.ruff]
 line-length = 120
+exclude = [
+    "tests/od/**",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "S101",  # Allow use of assert statements in tests
+]
+"tests/test_imports.py" = [
+    "F401",  # Allow unused imports in this file
+]

src/objdictgen/__main__.py

@@ -63,7 +63,7 @@ def inner(*args, **kw):
             opts = DebugOpts()
             try:
                 return fn(opts, *args, **kw)
-            except Exception as exc:  # pylint: disable=broad-except
+            except Exception as exc:
                 if opts.show_debug:
                     raise
                 print(f"{ODG_PROGRAM}: {exc.__class__.__name__}: {exc}")
@@ -212,8 +212,8 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
     if opts.command == "help":
         if opts.subcommand:
             for subparsers_action in (
-                    a for a in parser._actions  # pylint: disable=protected-access
-                    if isinstance(a, argparse._SubParsersAction)  # pylint: disable=protected-access
+                    a for a in parser._actions
+                    if isinstance(a, argparse._SubParsersAction)
             ):
                 for choice, subparser in subparsers_action.choices.items():
                     if choice != opts.subcommand:
@@ -294,8 +294,7 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
     elif opts.command == "edit":
 
         # Import here to prevent including optional UI components for cmd-line use
-        from .ui.objdictedit import \
-            uimain  # pylint: disable=import-outside-toplevel
+        from .ui.objdictedit import uimain
         uimain(opts.od)
 
 
@@ -322,17 +321,15 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
     elif opts.command == "network":
 
         # Import here to prevent including optional UI components for cmd-line use
-        from .ui.networkedit import \
-            uimain  # pylint: disable=import-outside-toplevel
+        from .ui.networkedit import uimain
         uimain(opts.dir)
 
 
     # -- NODELIST command --
     elif opts.command == "nodelist":
 
         # Import here to prevent including optional UI components for cmd-line use
-        from .nodelist import \
-            main as _main  # pylint: disable=import-outside-toplevel
+        from .nodelist import main as _main
         _main(opts.dir)
 
 
@@ -342,5 +339,4 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
 
 # To support -m objdictgen
 if __name__ == '__main__':
-    # pylint: disable=no-value-for-parameter
     main()

src/objdictgen/eds_utils.py

@@ -60,9 +60,9 @@
 }
 
 # Function for verifying data values
-is_integer = lambda x: isinstance(x, int)  # pylint: disable=unnecessary-lambda-assignment
-is_string = lambda x: isinstance(x, str)  # pylint: disable=unnecessary-lambda-assignment
-is_boolean = lambda x: x in (0, 1)  # pylint: disable=unnecessary-lambda-assignment
+is_integer = lambda x: isinstance(x, int)  # noqa: E731
+is_string = lambda x: isinstance(x, str)  # noqa: E731
+is_boolean = lambda x: x in (0, 1)  # noqa: E731
 
 # Define checking of value for each attribute
 ENTRY_ATTRIBUTES: dict[str, Callable[[Any], bool]] = {
@@ -505,7 +505,6 @@ def generate_eds_content(node: Node, filepath: TPath):
     entries = list(node)
 
     # FIXME: Too many camelCase vars in here
-    # pylint: disable=invalid-name
 
     try:
         value = node.GetEntry(0x1018)

src/objdictgen/gen_cfile.py

@@ -114,7 +114,7 @@ def text(self, s: str = "") -> Text:
     # FIXME: Delete this method when everything is converted to f-strings
     def ftext(self, s: str) -> Text:
         """Format a text string."""
-        return Text(self, "").__imod__(s)  # pylint: disable=unnecessary-dunder-call
+        return Text(self, "").__imod__(s)
 
     def get_valid_type_infos(self, typename: str, items=None) -> TypeInfos:
         """Get valid type infos from a typename.
@@ -191,7 +191,6 @@ def generate_file_content(node: NodeProtocol, headerfile: str, pointers_dict=Non
     """
 
     # FIXME: Too many camelCase vars in here
-    # pylint: disable=invalid-name
 
     # Setup the main context to store the data
     ctx = CFileContext()

src/objdictgen/jsonod.py

@@ -31,15 +31,25 @@
 import jsonschema
 
 import objdictgen
+
 # Accessed by node.py, so we need to import node as module to avoid circular references
 from objdictgen import maps
 from objdictgen import node as nodelib
 from objdictgen.maps import OD, ODMapping, ODMappingList
-from objdictgen.typing import (TDiffNodes, TIndexEntry, TODJson, TODObj,
-                               TODObjJson, TODSubObj, TODSubObjJson, TODValue,
-                               TParamEntry, TPath, TProfileMenu)
-from objdictgen.utils import (copy_in_order, exc_amend, maybe_number,
-                              str_to_int, strip_brackets)
+from objdictgen.typing import (
+    TDiffNodes,
+    TIndexEntry,
+    TODJson,
+    TODObj,
+    TODObjJson,
+    TODSubObj,
+    TODSubObjJson,
+    TODValue,
+    TParamEntry,
+    TPath,
+    TProfileMenu,
+)
+from objdictgen.utils import copy_in_order, exc_amend, maybe_number, str_to_int, strip_brackets
 
 T = TypeVar('T')
 M = TypeVar('M', bound=Mapping)
@@ -352,10 +362,10 @@ def generate_jsonc(node: Node, compact=False, sort=False, internal=False,
 
     if jsonc:
         # In jsonc the field is converted to "<field>,  // <comment>"
-        repl = lambda m: m[1].replace('\\"', '"') + m[3] + m[2]
+        repl = lambda m: m[1].replace('\\"', '"') + m[3] + m[2]  # noqa: E731
     else:
         # In json the field is converted to "<field>,"
-        repl = lambda m: m[1].replace('\\"', '"') + m[3]
+        repl = lambda m: m[1].replace('\\"', '"') + m[3]  # noqa: E731
 
     # Convert the special @@ fields to jsonc comments
     # Syntax:  "@@<field>,  // <comment>@@"
@@ -396,7 +406,7 @@ def generate_node(contents: str|TODJson, validate: bool = True) -> Node:
     #        validate_fromdict() is better at giving useful errors
     #        than the json validator. However the type checking of the json
     #        validator is better.
-    global SCHEMA  # pylint: disable=global-statement
+    global SCHEMA
     if not SCHEMA:
         with open(objdictgen.JSON_SCHEMA, 'r', encoding="utf-8") as f:
             SCHEMA = json.loads(remove_jsonc(f.read()))

src/objdictgen/maps.py

@@ -30,8 +30,7 @@
 from typing import TYPE_CHECKING, Any, Callable, Generator, TypeVar
 
 import objdictgen
-from objdictgen.typing import (TODObj, TODSubObj, TODValue, TParamEntry, TPath,
-                               TProfileMenu)
+from objdictgen.typing import TODObj, TODSubObj, TODValue, TParamEntry, TPath, TProfileMenu
 
 T = TypeVar('T')
 
@@ -327,15 +326,14 @@ def import_profile(profilename: TPath) -> tuple["ODMapping", TProfileMenu]:
 
     # Mapping and AddMenuEntries are expected to be defined by the execfile
     # The profiles requires some vars to be set
-    # pylint: disable=unused-variable
     try:
         with open(profilepath, "r", encoding="utf-8") as f:
             log.debug("EXECFILE %s", profilepath)
             code = compile(f.read(), profilepath, 'exec')
             exec(code, globals(), locals())  # FIXME: Using exec is unsafe
-            # pylint: disable=undefined-variable
-            return Mapping, AddMenuEntries  # type: ignore[name-defined]  # due to the exec() magic
-    except Exception as exc:  # pylint: disable=broad-except
+            # NOTE: These seem missing due to the exec() magic
+            return Mapping, AddMenuEntries  # type: ignore[name-defined]  # noqa: F821
+    except Exception as exc:
         log.debug("EXECFILE FAILED: %s", exc)
         log.debug(traceback.format_exc())
         raise ValueError(f"Loading profile '{profilepath}' failed: {exc}") from exc

src/objdictgen/nodelist.py

@@ -151,7 +151,7 @@ def SaveMasterNode(self, netname: str = ""):
             masterpath = self.Root / "master.od"
         try:
             self.Manager.SaveCurrentInFile(masterpath)
-        except Exception as exc:  # pylint: disable=broad-except
+        except Exception as exc:
             raise ValueError(f"Fail to save master node in '{masterpath}'") from exc
 
     def LoadSlaveNodes(self, netname: str = ""):
@@ -174,7 +174,7 @@ def LoadSlaveNodes(self, netname: str = ""):
                             self.LoadEDS(node["DCFName"])
                             self.AddSlaveNode(node["Name"], nodeid, node["DCFName"])
                 self.Changed = False
-            except Exception as exc:  # pylint: disable=broad-except
+            except Exception as exc:
                 raise ValueError(f"Unable to load CPJ file '{cpjpath}'") from exc
 
     def SaveNodeList(self, netname: str = ""):
@@ -188,7 +188,7 @@ def SaveNodeList(self, netname: str = ""):
             with open(cpjpath, mode=mode, encoding="utf-8") as f:
                 f.write(content)
             self.Changed = False
-        except Exception as exc:  # pylint: disable=broad-except
+        except Exception as exc:
             raise ValueError(f"Fail to save node list in '{cpjpath}'") from exc
 
     def GetOrderNumber(self, nodeid: int) -> int:

src/objdictgen/nodemanager.py

@@ -44,7 +44,7 @@
 
 # Returns a new id
 def get_new_id():
-    global CURRENTID  # pylint: disable=global-statement
+    global CURRENTID
     CURRENTID += 1
     return CURRENTID
 

src/objdictgen/nosis.py

@@ -255,7 +255,7 @@ def xmldump(filehandle: io.TextIOWrapper|None, py_obj: object,
     omit = omit or ()
 
     # Store the ref id to the pickling object (if not deepcopying)
-    global VISITED  # pylint: disable=global-statement
+    global VISITED
     objid = id(py_obj)
     VISITED = {
         objid: py_obj
@@ -316,7 +316,7 @@ def xmlload(filehandle: SupportsRead[str|bytes]|bytes|str) -> Any:
     elif isinstance(filehandle, bytes):
         fh = io.BytesIO(filehandle)
 
-    global VISITED  # pylint: disable=global-statement
+    global VISITED
     VISITED = {}  # Reset the visited collection
 
     return _thing_from_dom(minidom.parse(fh), None)
@@ -511,7 +511,7 @@ def _thing_from_dom(dom_node: minidom.Element|minidom.Document, container: Any =
             # a value= attribute. ie. pickler can place it in either
             # place (based on user preference) and unpickler doesn't care
             node_valuetext = ""
-            if 'value' in node._attrs:  # type: ignore[attr-defined]  # pylint: disable=protected-access
+            if 'value' in node._attrs:
                 # text in tag
                 ttext = node.getAttribute('value')
                 node_valuetext = unsafe_string(ttext, isattr=True)
@@ -557,7 +557,6 @@ def _thing_from_dom(dom_node: minidom.Element|minidom.Document, container: Any =
             # clearer to show all cases being handled (easier to see the pattern
             # when doing later maintenance).
 
-            # pylint: disable=self-assigning-variable
             if node_type == 'None':
                 node_val = None
             elif node_type == 'numeric':

src/objdictgen/typing.py

@@ -92,8 +92,6 @@
 class NodeProtocol(Protocol):
     """Protocol for the Node class."""
 
-    # pylint: disable=unnecessary-ellipsis
-
     Name: str
     """Name of the node."""