chore: Typing & linting

Author: C0rn3j

scc/controller.py

@@ -5,7 +5,6 @@
 from scc.constants import HapticPos
 
 if TYPE_CHECKING:
-	from scc.controller import HapticData
 	from scc.mapper import Mapper
 import logging
 import time
@@ -32,8 +31,9 @@ def __init__(self) -> None:
 
 
 	def get_type(self) -> None:
-		"""
-		This method has to return type identifier - short string without spaces
+		"""Has to return type identifier
+
+		Returns a short string without spaces
 		that describes type of controller which should be unique for each
 		driver.
 		String is used by UI to assign icons and, along with ID,
@@ -45,16 +45,15 @@ def get_type(self) -> None:
 
 
 	def get_id(self):
-		"""
-		Returns identifier that has to be unique at least until daemon
-		is restarted, ideally derived from HW device serial number.
+		"""Returns identifier that has to be unique at least until daemon is restarted.
+
+		Ideally derived from HW device serial number.
 		"""
 		return self._id
 
 
 	def get_gui_config_file(self) -> None:
-		"""
-		Returns file name of json file that GUI can use to load more data about
+		"""Returns file name of json file that GUI can use to load more data about
 		controller (background image, button images, available buttons and
 		axes, etc...) File name may be absolute path or just name of file in
 		/usr/share/scc
@@ -71,63 +70,61 @@ def set_mapper(self, mapper: Mapper):
 
 
 	def get_mapper(self):
-		""" Returns mapper set for controller """
+		"""Returns mapper set for controller"""
 		return self.mapper
 
 
 	def apply_config(self, config) -> None:
-		"""
-		Called from daemon to apply controller configuration stored
-		in config file.
+		"""Called from daemon to apply controller configuration stored in config file.
 
 		Does nothing by default.
 		"""
 		pass
 
 
 	def set_led_level(self, level) -> None:
-		"""
-		Configures LED intensity, if supported.
+		"""Configures LED intensity, if supported.
+
 		'level' goes from 0.0 to 100.0
 		"""
 		pass
 
 
 	def set_gyro_enabled(self, enabled) -> None:
-		""" Enables or disables gyroscope, if supported """
+		"""Enables or disables gyroscope, if supported"""
 		pass
 
 
 	def get_gyro_enabled(self) -> bool:
-		""" Returns True if gyroscope is enabled """
+		"""Returns True if gyroscope is enabled"""
 		return False
 
 
 	def feedback(self, data) -> None:
-		"""
-		Generates feedback effect, if supported.
+		"""Generates feedback effect, if supported.
+
 		'data' is HapticData instance.
 		"""
 		pass
 
 
 	def turnoff(self) -> None:
-		""" Turns off controller, if supported """
+		"""Turns off controller, if supported"""
 		pass
 
 
 	def disconnected(self) -> None:
-		""" Called from daemon after controller is disconnected """
+		"""Called from daemon after controller is disconnected"""
 		pass
 
 
 class HapticData:
 	""" Simple container to hold haptic feedback settings """
 
 	def __init__(self, position, amplitude=512, frequency=4, period=1024, count=1):
-		"""
-		'frequency' is used only when emulating touchpad and describes how many
-		pixels should mouse travell between two feedback ticks.
+		"""'frequency' is used only when emulating touchpad
+
+		and describes how many pixels should mouse travel between two feedback ticks.
 		"""
 		data = tuple([ int(x) for x in (position, amplitude, period, count) ])
 		if data[0] not in (HapticPos.LEFT, HapticPos.RIGHT, HapticPos.BOTH):
@@ -143,19 +140,19 @@ def __init__(self, position, amplitude=512, frequency=4, period=1024, count=1):
 		self.frequency = frequency		# used internally
 
 
-	def with_position(self, position):
-		""" Creates copy of HapticData with position value changed """
+	def with_position(self, position) -> HapticData:
+		"""Creates copy of HapticData with position value changed"""
 		trash, amplitude, period, count = self.data
 		return HapticData(position, amplitude, self.frequency, period, count)
 
 
-	def get_position(self):
+	def get_position(self) -> HapticPos:
 		return HapticPos(self.data[0])
 
 	def get_amplitude(self):
 		return self.data[1]
 
-	def get_frequency(self):
+	def get_frequency(self) -> float:
 		return float(self.frequency) / 1000.0
 
 	def get_period(self):
@@ -164,11 +161,8 @@ def get_period(self):
 	def get_count(self):
 		return self.data[3]
 
-	def __mul__(self, by) -> 'HapticData':
-		"""
-		Allows multiplying HapticData by scalar to get same values
-		with increased amplitude.
-		"""
+	def __mul__(self, by) -> HapticData:
+		"""Allows multiplying HapticData by scalar to get same values with increased amplitude."""
 		position, amplitude, period, count = self.data
 		amplitude = min(amplitude * by, 0x8000)
 		return HapticData(position, amplitude, self.frequency, period, count)

scc/parser.py

@@ -61,8 +61,9 @@ class Token(NamedTuple):
 	CONSTS = build_action_constants()
 
 
-	def __init__(self, string:str = ""):
+	def __init__(self, string:str = "") -> None:
 		self.restart(string)
+		self.tokens: list[ActionParser.Token] | None
 
 
 	def from_json_data(self, data: dict, key: str | None = None):

scc/paths.py

@@ -11,6 +11,7 @@
 import os
 import sys
 
+
 def get_config_path() -> str:
 	"""Return configuration directory.
 

scc/poller.py

@@ -19,35 +19,35 @@ class Poller:
 	POLLOUT = select.POLLOUT
 	POLLPRI = select.POLLPRI
 
-	def __init__(self):
+	def __init__(self) -> None:
 		self._events = {}
 		self._callbacks = {}
 		self._pool_in = ()
 		self._pool_out = ()
 		self._pool_pri = ()
 
 
-	def register(self, fd, events, callback):
+	def register(self, fd, events, callback) -> None:
 		if fd < 0:
 			raise ValueError("Invalid file descriptor")
 		self._events[fd] = events
 		self._callbacks[fd] = callback
 		self._generate_lists()
 
 
-	def unregister(self, fd):
+	def unregister(self, fd) -> None:
 		if fd in self._events: del self._events[fd]
 		if fd in self._callbacks: del self._callbacks[fd]
 		self._generate_lists()
 
 
-	def _generate_lists(self):
+	def _generate_lists(self) -> None:
 		self._pool_in = [ fd for fd, events in self._events.items() if events & Poller.POLLIN ]
 		self._pool_out = [ fd for fd, events in self._events.items() if events & Poller.POLLOUT ]
 		self._pool_pri = [ fd for fd, events in self._events.items() if events & Poller.POLLPRI ]
 
 
-	def poll(self, timeout=0.01):
+	def poll(self, timeout=0.01) -> None:
 		inn, out, pri = select.select( self._pool_in, self._pool_out, self._pool_pri, timeout )
 
 		for fd in inn:

scc/profile.py

@@ -2,6 +2,8 @@
 
 Handles mapping profile stored in json file
 """
+from __future__ import annotations
+
 import json
 import logging
 
@@ -36,33 +38,33 @@ class Profile:
 	RPAD_AXES  = { X : "rpad_x", Y : "rpad_y" }
 	TRIGGERS   = [ LEFT, RIGHT ]
 
-	def __init__(self, parser):
+	def __init__(self, parser) -> None:
 		self.parser = parser
 		self.clear()
-		self.filename = None
+		self.filename: str | None = None
 		# UI-only values
-		self.is_template = False
-		self.description = ""
+		self.is_template: bool = False
+		self.description: str = ""
 
 
-	def save(self, filename):
-		""" Saves profile into file. Returns self """
+	def save(self, filename: str) -> Profile:
+		"""Saves profile into file. Returns self"""
 		with open(filename, "w") as fileobj:
 			self.save_fileobj(fileobj)
 		return self
 
 
-	def save_fileobj(self, fileobj):
-		""" Saves profile into file-like object. Returns self """
+	def save_fileobj(self, fileobj) -> Profile:
+		"""Saves profile into file-like object. Returns self"""
 		data = {
 			"_"				: (self.description if "\n" not in self.description
 								else self.description.strip("\n").split("\n")),
-			'buttons'		: {},
-			'stick'			: self.stick,
-			'rstick'		: self.rstick,
-			'gyro'			: self.gyro,
-			'trigger_left'	: self.triggers[Profile.LEFT],
-			'trigger_right'	: self.triggers[Profile.RIGHT],
+			"buttons"		: {},
+			"stick"			: self.stick,
+			"rstick"		: self.rstick,
+			"gyro"			: self.gyro,
+			"trigger_left"	: self.triggers[Profile.LEFT],
+			"trigger_right"	: self.triggers[Profile.RIGHT],
 			"pad_left"		: self.pads[Profile.LEFT],
 			"pad_right"		: self.pads[Profile.RIGHT],
 			"cpad"			: self.pads[Profile.CPAD],
@@ -82,17 +84,17 @@ def save_fileobj(self, fileobj):
 		return self
 
 
-	def load(self, filename):
-		""" Loads profile from file. Returns self """
-		with open(filename, "r") as fileobj:
+	def load(self, filename: str) -> Profile:
+		"""Loads profile from file. Returns self"""
+		with open(filename) as fileobj:
 			self.load_fileobj(fileobj)
 		self.filename = filename
 		return self
 
 
-	def load_fileobj(self, fileobj):
-		"""
-		Loads profile from file-like object.
+	def load_fileobj(self, fileobj) -> Profile:
+		"""Loads profile from file-like object.
+
 		Filename attribute is not set, what may cause some trouble if used in GUI.
 
 		Returns self.
@@ -101,7 +103,8 @@ def load_fileobj(self, fileobj):
 		# Version
 		try:
 			version = float(data["version"])
-		except:
+		except Exception:
+			logging.exception("Failed to load file-like object")
 			version = 0
 
 		# Settings - Description
@@ -182,8 +185,8 @@ def load_fileobj(self, fileobj):
 		return self
 
 
-	def clear(self):
-		""" Clears all actions and adds default menu action on center button """
+	def clear(self) -> None:
+		"""Clears all actions and adds default menu action on center button"""
 		self.buttons = { x : NoAction() for x in SCButtons }
 		self.buttons[SCButtons.C] = HoldModifier(
 			MenuAction("Default.menu"),
@@ -204,8 +207,8 @@ def clear(self):
 
 
 	def get_all_actions(self):
-		"""
-		Returns generator with every action defined in this profile,
+		"""Returns generator with every action defined in this profile,
+
 		including actions in menus.
 		Recursively walks into macros, dpads and everything else that can have
 		nested actions, so both parent and all child actions are yielded.
@@ -223,10 +226,7 @@ def get_all_actions(self):
 
 
 	def get_actions(self):
-		"""
-		As get_all_actions, but returns only root actions, without children,
-		and ignores menus.
-		"""
+		"""As get_all_actions, but returns only root actions, without children, and ignores menus."""
 		for dct in (self.buttons, self.triggers, self.pads):
 			for k in dct:
 				yield dct[k]
@@ -235,15 +235,13 @@ def get_actions(self):
 
 
 	def get_filename(self):
-		"""
-		Returns filename of last loaded file or None.
-		"""
+		"""Returns filename of last loaded file or None."""
 		return self.filename
 
 
-	def compress(self):
-		"""
-		Calls compress on every action to throw out some redundant stuff.
+	def compress(self) -> None:
+		"""Calls compress on every action to throw out some redundant stuff.
+
 		Note that calling save() after compress() will cause data loss.
 		"""
 		for dct in (self.buttons, self.triggers, self.pads):
@@ -257,7 +255,7 @@ def compress(self):
 
 
 	def _convert(self, from_version):
-		""" Performs conversion from older profile version """
+		"""Performs conversion from older profile version"""
 		if from_version < 1:
 			from scc.modifiers import ModeModifier
 			# Add 'display Default.menu if center button is held' for old profiles