refactoring and typing

Author: savelkouls

paling/edge.py

@@ -2,7 +2,18 @@
 
 name = 'Edge'
 
-def run(path, options, start_urls):
+def run(path: str, options: dict, start_urls: list) -> None:
+    """
+    Run the specified web browser with the given options and start URLs.
+
+    Args:
+        path (str): The path to the web browser executable.
+        options (dict): A dictionary of options for the web browser.
+        start_urls (list): A list of URLs to open in the web browser.
+
+    Returns:
+        None
+    """
     if path != 'edge_legacy':
         if options['app_mode']:
             for url in start_urls:
@@ -16,13 +27,19 @@ def run(path, options, start_urls):
         cmd = 'start microsoft-edge:{}'.format(start_urls[0])
         sps.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr, stdin=sps.PIPE, shell=True)
 
-def find_path():
+def find_path() -> str | None:
     if sys.platform in ['win32', 'win64']:
         return _find_edge_win()
     else:
         return None
 
-def _find_edge_win():
+def _find_edge_win() -> str:
+    """
+    Finds the path of the Microsoft Edge browser executable on Windows.
+
+    Returns:
+        str: The path of the Microsoft Edge browser executable.
+    """
     import winreg as reg
     reg_path = r'SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\msedge.exe'
 
@@ -33,7 +50,7 @@ def _find_edge_win():
             reg_key.Close()
             if not os.path.isfile(edge_path):
                 continue
-        except WindowsError:
+        except FileNotFoundError:
             edge_path = 'edge_legacy'
         else:
             break

paling/electron.py

@@ -10,6 +10,17 @@
 name: str = 'Electron'
 
 def run(path: str, options: OptionsDictT, start_urls: List[str]) -> None:
+    """
+    Run the specified Electron application.
+
+    Args:
+        path (str): The path to the Electron application executable.
+        options (OptionsDictT): A dictionary containing options for the Electron application.
+        start_urls (List[str]): A list of URLs to open in the Electron application.
+
+    Raises:
+        TypeError: If the 'cmdline_args' option is not of type List[str].
+    """
     if not isinstance(options['cmdline_args'], list):
         raise TypeError("'cmdline_args' option must be of type List[str]")
     cmd = [path] + options['cmdline_args']
@@ -18,12 +29,18 @@ def run(path: str, options: OptionsDictT, start_urls: List[str]) -> None:
 
 
 def find_path() -> Optional[str]:
+    """
+    Finds the path to the Electron executable.
+
+    Returns:
+        Optional[str]: The path to the Electron executable if found, otherwise None.
+    """
     if sys.platform in ['win32', 'win64']:
         # It doesn't work well passing the .bat file to Popen, so we get the actual .exe
         bat_path = wch.which('electron')
         return os.path.join(bat_path, r'..\node_modules\electron\dist\electron.exe')
     elif sys.platform in ['darwin', 'linux']:
-        # This should work find...
+        # This should work fine...
         return wch.which('electron') # type: ignore # whichcraft doesn't currently have type hints
     else:
         return None