pylint is now happy

Author: Commandcracker

display_server_interactions/linux.py

@@ -1,6 +1,10 @@
 #!/usr/bin/python3
 # -*- coding: utf-8 -*-
 
+"""
+All X11 specific DSI functions
+"""
+
 # built-in modules
 from typing import Optional
 import logging
@@ -32,6 +36,8 @@
 
 # Setup Xlib Structures
 
+# pylint: disable=too-few-public-methods
+
 
 class Display(Structure):
     """
@@ -168,6 +174,7 @@ class XErrorEvent(Structure):
     """
 
     def __repr__(self) -> str:
+        # pylint: disable-next=line-too-long
         return f"XErrorEvent(type={self.type}, serial={self.serial}, error_code={self.error_code}, request_code={self.request_code}, minor_code={self.minor_code})"
 
     _fields_ = [
@@ -187,6 +194,9 @@ def __repr__(self) -> str:
 
 @ctypes.CFUNCTYPE(c_int, POINTER(Display), POINTER(XErrorEvent))
 def error_handler(_, event):
+    """
+    A C function that handles X11 errors.
+    """
     logger.error("%s", event.contents)
     return 0
 
@@ -294,6 +304,10 @@ class KeyMasks:
 
 
 class Xlib:
+    """
+    A class that provides access to Xlib functions.
+    """
+
     def __init__(self):
         # load libX11.so.6
         x11 = ctypes.util.find_library("X11")
@@ -374,7 +388,7 @@ def __getattribute__(self, __name: str):
         return self.xlib.__getattribute__(__name)
 
 
-def get_window_property(xlib: Xlib, window_xid: int, property: str, type: _SimpleCData):
+def get_window_property(xlib: Xlib, window_xid: int, property_name: str, return_type: _SimpleCData):
     """
     https://tronche.com/gui/x/xlib/window-information/XGetWindowProperty.html
     """
@@ -388,7 +402,7 @@ def get_window_property(xlib: Xlib, window_xid: int, property: str, type: _Simpl
         xlib.display,
         window_xid,
         xlib.XInternAtom(
-            xlib.display, c_char_p(property.encode('utf-8')),
+            xlib.display, c_char_p(property_name.encode('utf-8')),
             False
         ),
         0,
@@ -405,7 +419,7 @@ def get_window_property(xlib: Xlib, window_xid: int, property: str, type: _Simpl
     if prop_return:
         data = cast(
             prop_return,
-            POINTER(type)
+            POINTER(return_type)
         ).contents.value
     else:
         data = None
@@ -417,6 +431,10 @@ def get_window_property(xlib: Xlib, window_xid: int, property: str, type: _Simpl
 
 
 class Window(WindowBase):
+    """
+    An class for interacting with a window on X11.
+    """
+
     def __init__(self, xid: int, xlib: Xlib) -> None:
         self.xid = xid
         self.xlib = xlib
@@ -481,7 +499,7 @@ def get_image(self, geometry: Optional[Box] = None) -> Image:
 
         return data
 
-    def send_chr(self, chr: chr) -> None:
+    def send_chr(self, character: chr) -> None:
         """Send a character to the window
 
         Args:
@@ -492,10 +510,10 @@ def send_chr(self, chr: chr) -> None:
         key = XEvent(type=EventTypes.KeyPress).xkey  # KeyPress
         key.keycode = self.xlib.XKeysymToKeycode(
             self.xlib.display,
-            self.xlib.XStringToKeysym(c_char_p(chr.encode('utf-8')))
+            self.xlib.XStringToKeysym(c_char_p(character.encode('utf-8')))
         )  # https://github.com/python-xlib/python-xlib/blob/master/Xlib/keysymdef/latin1.py
         key.window = key.root = self.xid
-        key.state = KeyMasks.ShiftMask if chr.isupper() else 0
+        key.state = KeyMasks.ShiftMask if character.isupper() else 0
 
         self.xlib.XSendEvent(
             self.xlib.display,  # Display *display
@@ -508,14 +526,14 @@ def send_chr(self, chr: chr) -> None:
         # flush display or events will run delayed cus thai'r only called on the next update
         self.xlib.XFlush(self.xlib.display)
 
-    def send_str(self, str: str) -> None:
+    def send_str(self, string: str) -> None:
         """Send a string to the window
 
         Args:
             str (str): The string to send
         """
-        for chr in str:
-            self.send_chr(chr)
+        for character in string:
+            self.send_chr(character)
 
     def warp_pointer(self, x: int, y: int, geometry: Optional[Box] = None) -> None:
         if geometry is None:
@@ -538,10 +556,12 @@ def warp_pointer(self, x: int, y: int, geometry: Optional[Box] = None) -> None:
         self.xlib.XFlush(self.xlib.display)
 
     def send_mouse_click(self, x: int, y: int, button: MouseButtons = MouseButtons.LEFT) -> None:
+        # pylint: disable=line-too-long
         """
         Send a mouse click to the window at the given coordinates without moving the pointer.
         Some applications may not respond to the click so it is recommended to also move the pointer with `warp_pointer`.
         """
+        # pylint: enable=line-too-long
         event = XEvent(type=EventTypes.ButtonPress).xbutton
         event.window = event.root = self.xid
         event.button = button
@@ -622,20 +642,20 @@ def get_all_windows(xlib: Xlib) -> list:
     Get all window XIDs. By recursively getting all connected windows.
     """
     final = get_connected_xids(xlib, xlib.root_window)
-    next = final.copy()
+    next_window = final.copy()
 
     run = True
     while run:
         run = False
         next_temp = []
-        for xid in next:
+        for xid in next_window:
             xids = get_connected_xids(xlib, xid)
             if len(xids) > 0:
                 run = True
             next_temp += xids
 
-        next = next_temp
-        final += next
+        next_window = next_temp
+        final += next_window
 
     final_windows = []
 
@@ -646,6 +666,10 @@ def get_all_windows(xlib: Xlib) -> list:
 
 
 class DSI(DSIBase):
+    """
+    Main DSI class
+    """
+
     def __init__(self):
         self.xlib = Xlib()
 

display_server_interactions/util.py

@@ -1,17 +1,27 @@
 #!/usr/bin/python3
 # -*- coding: utf-8 -*-
 
+"""
+This module provides a function to detect the current Linux display server.
+"""
+
 from os import getenv
 from enum import Enum
 
 
 class LinuxDisplayServer(Enum):
+    """
+    An enumeration of Linux display servers.
+    """
     WAYLAND = "wayland"
     X11 = "x11"
     UNKNOWN = "Unknown"
 
 
 def detect_linux_display_server() -> LinuxDisplayServer:
+    """
+    Detects the current Linux display server.
+    """
     xdg_session_type = getenv("XDG_SESSION_TYPE")
     if xdg_session_type == "wayland":
         return LinuxDisplayServer.WAYLAND

display_server_interactions/window.py

@@ -1,14 +1,24 @@
 #!/usr/bin/python3
 # -*- coding: utf-8 -*-
 
+"""
+This module provides a class for interacting with windows
+"""
+
+# built-in modules
 from abc import ABCMeta, abstractmethod
 from typing import Optional
+
+# local modules
 from .image import Image
 from .buttons import MouseButtons
 from .box import Box
 
 
 class WindowBase(metaclass=ABCMeta):
+    """
+    An abstract base class that defines the interface for interacting with a window.
+    """
     @property
     @abstractmethod
     def name(self) -> str:
@@ -42,19 +52,21 @@ def geometry(self) -> Box:
 
     @abstractmethod
     def get_image(self, geometry: Optional[Box] = None) -> Image:
+        # pylint: disable=line-too-long
         """
         Returns an Image of the window.
         With the geometry parameter you can specify a sub-region of the window that will be captured.
         """
+        # pylint: enable=line-too-long
 
     @abstractmethod
-    def send_chr(self, chr: chr) -> None:
+    def send_chr(self, character: chr) -> None:
         """
         send the keystroke of the given character to the window.
         """
 
     @abstractmethod
-    def send_str(self, str: str) -> None:
+    def send_str(self, string: str) -> None:
         """
         Send keystrokes equivalent to the string you pass to the window.
         """
@@ -75,7 +87,9 @@ def send_mouse_click(self, x: int, y: int, button: MouseButtons = MouseButtons.L
         """
 
     def __repr__(self) -> str:
+        # pylint: disable=line-too-long
         name = self.name
         if name:
             return f'Window(name="{self.name}", pid={self.pid}, active={self.active}, geometry={self.geometry})'
         return f'Window(pid={self.pid}, active={self.active}, geometry={self.geometry})'
+        # pylint: enable=line-too-long