Configure pylint and improve code quality

Author: AgenttiX

.github/workflows/main.yml

@@ -24,7 +24,7 @@ jobs:
           pip --cache-dir=.pip install pylint
           pip --cache-dir=.pip install -r requirements.txt
       - name: Run Pylint
-        run: pylint tests 2>&1 | tee pylint.txt
+        run: pylint startup tests f3.py kernel_remover.py maintenance.py modem.py utils.py 2>&1 | tee pylint.txt
         working-directory: ${{ github.workspace }}
       - name: Upload results
         uses: actions/upload-artifact@v2

kernel_remover.py

@@ -11,7 +11,7 @@
 def main():
     running = os.uname().release
 
-    process = subprocess.run(["dpkg", "--list", "linux-image-*"], stdout=subprocess.PIPE)
+    process = subprocess.run(["dpkg", "--list", "linux-image-*"], stdout=subprocess.PIPE, check=True)
     dpkg_output = process.stdout.decode("utf-8")
 
     kernels = []
@@ -65,11 +65,11 @@ def main():
     continue_str = input()  # nosec
     if continue_str == "y":
         print("Removing old kernels")
-        subprocess.run(["apt-get", "purge"] + purge_these)
+        subprocess.run(["apt-get", "purge"] + purge_these, check=True)
         print("Old kernels removed. Updating.")
-        subprocess.run(["apt-get", "update"])
-        subprocess.run(["apt-get", "dist-upgrade"])
-        subprocess.run(["apt-get", "autoremove"])
+        subprocess.run(["apt-get", "update"], check=True)
+        subprocess.run(["apt-get", "dist-upgrade"], check=True)
+        subprocess.run(["apt-get", "autoremove"], check=True)
         print("Update complete")
 
 

maintenance.py

@@ -165,9 +165,7 @@ def apt() -> None:
         apt_ret = run(["apt-get", "dist-upgrade", "-y"], check=False)
         if apt_ret == 0:
             break
-        elif apt_ret == 100:
-            pass
-        else:
+        if apt_ret != 100:
             raise ValueError(f"Got unknown APT return code: {apt_ret}")
         print("Waiting for APT lock to be freed")
         time.sleep(APT_WAIT_TIME)
@@ -257,7 +255,7 @@ def main():
     parser.add_argument("--firefox", help="Deep-clean Firefox", action="store_true")
     parser.add_argument("--thunderbird", help="Deep-clean Thunderbird", action="store_true")
     args = parser.parse_args()
-    logger.info(f"Args: {args}")
+    logger.info("Args: %s", args)
 
     if args.deep:
         print("Deep scan has been selected. Some processes may take a long time.")

modem.py

@@ -18,8 +18,8 @@
 
 
 def read_pin(path: str) -> str:
-    with open(path) as f:
-        pin = f.read().rstrip()
+    with open(path) as file:
+        pin = file.read().rstrip()
     if not pin.isnumeric():
         raise ValueError("PIN should be numeric")
     return pin
@@ -38,8 +38,8 @@ def modem_number() -> int:
     modem_path = rows[row_ind].strip("\t").split()[0]
     try:
         number = int(modem_path.split("/")[-1])
-    except ValueError:
-        raise ValueError("Invalid modem path")
+    except ValueError as e:
+        raise ValueError("Invalid modem path") from e
     return number
 
 
@@ -116,7 +116,8 @@ def send_pin(modem: int, pin: str) -> None:
 
 def connect(bearer: int):
     subprocess.run(
-        ["mmcli", "-b", str(bearer), "--connect"]
+        ["mmcli", "-b", str(bearer), "--connect"],
+        check=True
     )
 
 

pylintrc

@@ -6,7 +6,7 @@
 extension-pkg-whitelist=
 
 # Specify a score threshold to be exceeded before program exits with error.
-fail-under=10.0
+fail-under=9
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
@@ -138,7 +138,12 @@ disable=print-statement,
         xreadlines-attribute,
         deprecated-sys-function,
         exception-escape,
-        comprehension-escape
+        comprehension-escape,
+        # Custom additions
+        missing-class-docstring,
+        missing-function-docstring,
+        missing-module-docstring,
+        too-few-public-methods
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -211,7 +216,7 @@ indent-after-paren=4
 indent-string='    '
 
 # Maximum number of characters on a single line.
-max-line-length=100
+max-line-length=120
 
 # Maximum number of lines in a module.
 max-module-lines=1000
@@ -407,7 +412,9 @@ good-names=i,
            k,
            ex,
            Run,
-           _
+           _,
+           # Custom additions
+           e
 
 # Good variable names regexes, separated by a comma. If names match any regex,
 # they will always be accepted

startup/agx-startup.py

@@ -6,6 +6,7 @@
 
 To enable this script, run startup-enabler.sh
 """
+# pylint: disable=invalid-name
 
 import enum
 import glob
@@ -232,7 +233,7 @@ class ALPM_LevelOptions(enum.Enum):
         "/sys/bus/pci/devices/0000:20:00.2",
         "/sys/bus/pci/devices/0000:00:08.0",
         "/sys/bus/pci/devices/0000:60:00.2",
-        
+
         # PCIe
         "/sys/bus/pci/devices/0000:40:07.0",
         "/sys/bus/pci/devices/0000:61:00.0",
@@ -469,7 +470,7 @@ def custom_commands() -> None:
         return
 
     for command in CUSTOM_COMMANDS[board]:
-        subprocess.run(command)
+        subprocess.run(command, check=True)
 
 
 def disable_wakeups() -> None:
@@ -498,7 +499,7 @@ def hdparm() -> None:
         drive_path = os.path.join("/dev/disk/by-id", drive)
 
         for param, value in params.items():
-            subprocess.run(["hdparm", param, str(value), drive_path])
+            subprocess.run(["hdparm", param, str(value), drive_path], check=True)
 
 
 def power_control() -> None:

utils.py

@@ -67,9 +67,10 @@ def run(
     :param check: whether to check the return code and raise an error accordingly
     :param get_output: whether to extract output to Python
     :param print_output: print command output to console
+    :param stderr: whether to capture stderr output as well
     :return: return code of the command
     """
-    logger.info(f"Running {command}")
+    logger.info("Running %s", command)
     kwargs = {}
     if stderr:
         kwargs["stderr"] = sp.PIPE