Fix pylint issues, move dev utils to bin

Author: webketje

.pylintrc

@@ -0,0 +1,2 @@
+[MESSAGES CONTROL]
+disable=missing-docstring,anomalous-backslash-in-string,broad-except,too-many-instance-attributes,too-many-ancestors

pack.sh renamed to bin/pack

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 if [ ! -d dist ]; then
   mkdir dist
 else

bin/pylint

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pylint --rcfile $PWD/.pylintrc $PWD/src/usr/share/tuxedo-backlight-control/**.py

src/usr/share/tuxedo-backlight-control/backlight.py

@@ -1,8 +1,7 @@
 #!/usr/bin/pkexec /usr/bin/python3
 
 import os
-import subprocess
-from sys import argv
+import sys
 
 from backlight_control import BacklightControl, backlight
 
@@ -23,53 +22,53 @@ def error_no_driver():
 
 
 if __name__ == "__main__":
-    if len(argv) == 1:
-        exit(error_missing_cmd())
+    if len(sys.argv) == 1:
+        sys.exit(error_missing_cmd())
 
-    cmd = argv[1]
-    if cmd == "--help" or cmd == "-h":
+    CMD = sys.argv[1]
+    if CMD in ("--help", "-h"):
         with open(sd + "/help.txt", "r") as fin:
-            exit(fin.read())
+            sys.exit(fin.read())
 
-    if cmd == "--version" or cmd == "-v":
-        exit(BacklightControl.VERSION)
+    if CMD in ("--version", "-v"):
+        sys.exit(BacklightControl.VERSION)
 
     if not os.path.isdir(BacklightControl.DEVICE_PATH):
-        exit(error_no_driver())
+        sys.exit(error_no_driver())
 
-    colorlist = list(BacklightControl.colors.keys())
+    COLOR_LIST = list(BacklightControl.colors.keys())
 
-    if cmd == "ui":
+    if CMD == "ui":
         from ui import init
         init()
-        exit()
+        sys.exit()
 
-    if cmd == "off":
+    if CMD == "off":
         backlight.state = 0
-        exit()
+        sys.exit()
 
-    if len(argv) == 2 and cmd in backlight.modes:
+    if len(sys.argv) == 2 and CMD in backlight.modes:
         backlight.state = 1
-        backlight.mode = cmd
+        backlight.mode = CMD
 
-    if len(argv) < 3:
-        exit(error_missing_arg(cmd))
+    if len(sys.argv) < 3:
+        sys.exit(error_missing_arg(CMD))
 
-    arg = argv[2]
-    if cmd == "brightness":
+    ARG = sys.argv[2]
+    if CMD == "brightness":
         backlight.state = 1
         try:
-            arg = int(arg)
+            ARG = int(ARG)
         except ValueError as error:
-            exit(error_invalid_brightness(arg))
-        if arg > 255 or arg < 0:
-            exit(error_invalid_brightness(arg))
+            sys.exit(error_invalid_brightness(ARG))
+        if ARG > 255 or ARG < 0:
+            sys.exit(error_invalid_brightness(ARG))
 
-        backlight.brightness = str(arg)
-    elif len(argv) == 3 and cmd == "color" and arg in colorlist:
+        backlight.brightness = str(ARG)
+    elif len(sys.argv) == 3 and CMD == "color" and ARG in COLOR_LIST:
         backlight.state = 1
-        backlight.set_single_color(arg)
-    elif len(argv) == 6:
+        backlight.set_single_color(ARG)
+    elif len(sys.argv) == 6:
         backlight.state = 1
         for index, region in enumerate(backlight.regions):
-            setattr(backlight, "color_" + region, argv[2 + index])
+            setattr(backlight, "color_" + region, sys.argv[2 + index])

src/usr/share/tuxedo-backlight-control/backlight_control.py

@@ -6,8 +6,8 @@
 from colors import colors
 
 if os.path.isfile('/etc/tuxedo-backlight-control/colors.conf'):
-    colors_conf = open('/etc/tuxedo-backlight-control/colors.conf')
-    for line in colors_conf:
+    COLORS_CONF = open('/etc/tuxedo-backlight-control/colors.conf')
+    for line in COLORS_CONF:
         match = re.search('([\da-z_]+)=([\da-f]{6})', line)
         if match and len(match.groups()) == 2:
             colors[match.groups()[0]] = match.groups()[1]
@@ -34,18 +34,26 @@ class BacklightControl():
 
     colors = colors
     regions = ('left', 'center', 'right', 'extra')
-    params = ('state', 'mode', 'color_left', 'color_center', 'color_right', 'color_extra', 'brightness')
+    params = (
+        'state',
+        'mode',
+        'color_left',
+        'color_center',
+        'color_right',
+        'color_extra',
+        'brightness'
+    )
 
     @staticmethod
-    def get_device_param(prop:str):
+    def get_device_param(prop: str):
         """ read driver param value directly from '/sys/devices/platform/tuxedo_keyboard/' """
 
         if os.path.isfile(BacklightControl.DEVICE_PATH + prop):
             return open(BacklightControl.DEVICE_PATH + prop).read()
         return None
 
     @staticmethod
-    def get_device_color(region:str):
+    def get_device_color(region: str):
         """ read driver color value directly from '/sys/devices/platform/tuxedo_keyboard/' """
 
         color = BacklightControl.get_device_param('color_' + region)
@@ -58,20 +66,20 @@ def get_device_color(region:str):
         return None
 
     @staticmethod
-    def set_device_param(prop:str, value:str):
-        fh = open(BacklightControl.DEVICE_PATH + prop, mode='w')
-        fh.write(value)
-        fh.close()
+    def set_device_param(prop: str, value: str):
+        filehandle = open(BacklightControl.DEVICE_PATH + prop, mode='w')
+        filehandle.write(value)
+        filehandle.close()
 
     @staticmethod
-    def set_device_color(region:str, color:str):
+    def set_device_color(region: str, color: str):
         if color in BacklightControl.colors.keys():
             index = list(BacklightControl.colors.values()).index(color.strip().upper())
             values = list(BacklightControl.colors.keys())
             BacklightControl.set_device_param('color_' + region, values[index])
 
     @staticmethod
-    def find_color_by_key(color:str):
+    def find_color_by_key(color: str):
         index = list(BacklightControl.colors.keys()).index(color)
         return '0x' + list(BacklightControl.colors.values())[index]
 
@@ -86,8 +94,7 @@ def is_single_color():
             if last_color not in (None, color):
                 is_single = False
                 break
-            else:
-                last_color = color
+            last_color = color
 
         return is_single
 
@@ -99,7 +106,7 @@ def set_single_color(color:str):
             BacklightControl.set_device_param('color_' + region, mapped_color)
 
     @staticmethod
-    def capitalize(label:str):
+    def capitalize(label: str):
         """ capitalizes a string """
         return label.capitalize()
 
@@ -111,7 +118,7 @@ def state(self):
         return 1
 
     @state.setter
-    def state(self, value:int):
+    def state(self, value: int):
         self.set_device_param('state', str(value))
 
     @property
@@ -122,7 +129,7 @@ def mode(self):
         return None
 
     @mode.setter
-    def mode(self, value:str):
+    def mode(self, value: str):
         index = self.modes.index(value)
         self.set_device_param('mode', str(index))
 
@@ -132,7 +139,7 @@ def color_left(self):
         return self.get_device_color('left')
 
     @color_left.setter
-    def color_left(self, value:str):
+    def color_left(self, value: str):
         """ set hex code for color_left, with color name present in colors dict """
         self.set_device_param('color_left', self.find_color_by_key(value))
 
@@ -142,7 +149,7 @@ def color_center(self):
         return self.get_device_color('center')
 
     @color_center.setter
-    def color_center(self, value:str):
+    def color_center(self, value: str):
         """ set hex code for color_center, with color name present in colors dict """
         self.set_device_param('color_center', self.find_color_by_key(value))
 
@@ -152,7 +159,7 @@ def color_right(self):
         return self.get_device_color('right')
 
     @color_right.setter
-    def color_right(self, value:str):
+    def color_right(self, value: str):
         """ set hex code for color_right, with color name present in colors dict """
         self.set_device_param('color_right', self.find_color_by_key(value))
 
@@ -161,8 +168,8 @@ def color_extra(self):
         """ get hex code for color_extra """
         return self.get_device_color('extra')
 
-    @color_extra.setter 
-    def color_extra(self, value:str):
+    @color_extra.setter
+    def color_extra(self, value: str):
         """ set hex code for color_extra, with color name present in colors dict """
         self.set_device_param('color_extra', self.find_color_by_key(value))
 
@@ -172,7 +179,7 @@ def brightness(self):
         return self.get_device_param('brightness')
 
     @brightness.setter
-    def brightness(self, value:int):
+    def brightness(self, value: int):
         """ set brightness value """
         self.set_device_param('brightness', value)
 

src/usr/share/tuxedo-backlight-control/ui.py

@@ -15,36 +15,21 @@ class App(ttk.Frame):
     shcolor = '#666666'  # shade
 
     def __init__(self, parent):
-        ttk.Frame.__init__(self, parent)
-        self.init_ttk_style()
         self.parent = parent
-        self.parent.title('Tuxedo Backlight Ctrl  v' + backlight.VERSION)
-        self.parent.iconphoto(parent._w, tk.PhotoImage(file=self.ICONPATH))
-        self.parent.resizable(width=False, height=False)
-        self.parent.grid(widthInc=8, heightInc=8, baseHeight=5, baseWidth=40)
-        self.parent.grid_columnconfigure(0, weight=1, pad=2)
-        self.parent.grid_rowconfigure(0, weight=1, pad=2)
+        self.init_tk_frame()
+        self.init_ttk_style()
 
         self.regions = (
             'color_left',
             'color_center',
             'color_right'
         )
-        if backlight.color_extra:
-        	self.regions = self.regions + ('color_extra',)
-
-        self.bg_frame = ttk.Frame(self.parent)
-        self.bg_frame.grid(sticky=tk.NSEW, column=0, row=0)
-        self.bg_frame.grid_columnconfigure(0, weight=1, minsize=150, pad=10)
-        self.bg_frame.grid_columnconfigure(1, weight=2, minsize=150, pad=10)
-        self.bg_frame.grid_rowconfigure(0, weight=0, pad=10)
-        self.bg_frame.grid_rowconfigure(1, weight=0, pad=10)
-        self.bg_frame.grid_rowconfigure(2, weight=0, pad=10)
-        self.bg_frame.grid_rowconfigure(6, weight=0, pad=0)
-
         for region in enumerate(self.regions):
             self.bg_frame.grid_rowconfigure(region[0] + 2, weight=0, pad=10)
 
+        if backlight.color_extra:
+            self.regions = self.regions + ('color_extra',)
+
         self.labels = {
             'mode': ttk.Label(self.bg_frame, text='Backlight mode: '),
             'color': ttk.Label(self.bg_frame, text='Backlight color: '),
@@ -55,7 +40,7 @@ def __init__(self, parent):
             'color_extra': ttk.Label(self.bg_frame, text='Color extra: ')
         }
 
-        if backlight.state == 1 and not backlight.mode == None:
+        if backlight.state == 1 and not backlight.mode is None:
             initial_mode = backlight.mode.capitalize()
         else:
             initial_mode = 'Select...'
@@ -68,7 +53,8 @@ def __init__(self, parent):
             'color_right': tk.StringVar(self, value=backlight.color_right.capitalize())
         }
         if backlight.color_extra:
-        	self.values['color_extra'] = tk.StringVar(self, value=backlight.color_extra.capitalize())
+            color_extra = tk.StringVar(self, value=backlight.color_extra.capitalize())
+            self.values['color_extra'] = color_extra
 
         def set_single_color(color):
             if not color == 'Select...':
@@ -124,7 +110,7 @@ def set_single_color(color):
         def cmd():
             self.on_color_mode_switch(self.values['color_mode'].get())
 
-        self.widgets['color_mode']['options']=(
+        self.widgets['color_mode']['options'] = (
             ttk.Radiobutton(
                 self.widgets['color_mode']['frame'],
                 variable=self.values['color_mode'],
@@ -154,7 +140,7 @@ def cmd():
         self.widgets['color_left']['menu'].config(**menuconfig)
         self.widgets['color_center']['menu'].config(**menuconfig)
         self.widgets['color_right']['menu'].config(**menuconfig)
-        
+
         if backlight.color_extra:
             self.widgets['color_extra']['menu'].config(**menuconfig)
 
@@ -167,6 +153,24 @@ def cmd():
         else:
             self.backlight_off()
 
+    def init_tk_frame(self):
+        ttk.Frame.__init__(self, self.parent)
+        self.parent.title('Tuxedo Backlight Ctrl  v' + backlight.VERSION)
+        self.parent.iconphoto(self.parent._w, tk.PhotoImage(file=self.ICONPATH))
+        self.parent.resizable(width=False, height=False)
+        self.parent.grid(widthInc=8, heightInc=8, baseHeight=5, baseWidth=40)
+        self.parent.grid_columnconfigure(0, weight=1, pad=2)
+        self.parent.grid_rowconfigure(0, weight=1, pad=2)
+
+        self.bg_frame = ttk.Frame(self.parent)
+        self.bg_frame.grid(sticky=tk.NSEW, column=0, row=0)
+        self.bg_frame.grid_columnconfigure(0, weight=1, minsize=150, pad=10)
+        self.bg_frame.grid_columnconfigure(1, weight=2, minsize=150, pad=10)
+        self.bg_frame.grid_rowconfigure(0, weight=0, pad=10)
+        self.bg_frame.grid_rowconfigure(1, weight=0, pad=10)
+        self.bg_frame.grid_rowconfigure(2, weight=0, pad=10)
+        self.bg_frame.grid_rowconfigure(6, weight=0, pad=0)
+
     def init_ttk_style(self):
         ttk_style = ttk.Style()
         ttk_style.theme_use('clam')