lots of optimization changes + folder structure + better logs

Author: wrecks-code

.gitignore

@@ -153,5 +153,6 @@ cython_debug/
 
 output/
 .vscode/
-mmt/
 config.ini
+MultiMonitorToolConfig.ini
+MultiMonitorToolScommaOutput.tmp

smct/config.py

@@ -1,130 +1,80 @@
 import configparser
 import os
-
 import requests
-
 from smct import paths, ui
-from smct.logger import log
+from smct.logger import log, INFO, ERROR
 
-# config.ini structure
 ENCODING = "utf-8"
-
-_SETTINGS_SECTION = "Settings"
-
-_MONITOR_NAME_KEY = "monitor_name"
-_MONITOR_SERIAL_KEY = "monitor_serial"
-_MMT_PATH_KEY = "multimonitortool_executable"
-_START_WITH_WINDOWS_KEY = "start_with_windows"
-_FIRST_START_KEY = "first_start"
-
+_SECTION_SETTINGS = "Settings"
+KEY_MONITOR_NAME = "monitor_name"
+KEY_MONITOR_SERIAL = "monitor_serial"
+KEY_MMT_PATH = "multimonitortool_executable"
+KEY_START_WITH_WINDOWS = "start_with_windows"
+KEY_FIRST_START = "first_start"
+
+_DEFAULT_CONFIG = {
+    KEY_MONITOR_NAME: "Example Monitor",
+    KEY_MONITOR_SERIAL: "12345",
+    KEY_MMT_PATH: "C:/MultiMonitorTool.exe",
+    KEY_START_WITH_WINDOWS: "no",
+    KEY_FIRST_START: "yes",
+}
 _configparser = configparser.ConfigParser()
 
 
 def _check_for_missing_files():
-    if not os.path.exists(paths.CONFIG_PATH):
-        _create_default_config_file()
-        log(f"Creating {paths.CONFIG_FILE_NAME}")
-
-    if not os.path.exists(paths.ASSETS_DIR_PATH):
-        os.mkdir(paths.ASSETS_DIR_PATH)
-        log(f"Creating {paths.ASSETS_DIR_NAME} folder")
-
-    # Check for Icons
-    if not os.path.exists(paths.ASSETS_ICO_PATH):
-        log(f"Downloading {paths.ASSETS_BASE_URL}{paths.ASSETS_ICO_NAME}")
-        download_assets_file(paths.ASSETS_ICO_NAME)
-        # sys.exit(1)
-    if not os.path.exists(paths.ASSETS_ICON_ENABLED_PATH):
-        log(f"Downloading {paths.ASSETS_BASE_URL}{paths.ASSETS_ICON_ENABLED_NAME}")
-        download_assets_file(paths.ASSETS_ICON_ENABLED_NAME)
-        # sys.exit(1)
-    if not os.path.exists(paths.ASSETS_ICON_DISABLED_PATH):
-        log(f"Downloading {paths.ASSETS_BASE_URL}{paths.ASSETS_ICON_DISABLED_NAME}")
-        download_assets_file(paths.ASSETS_ICON_DISABLED_NAME)
-        # sys.exit(1)
-
-    # Check for temp folder
-    if not os.path.exists(paths.MMT_DIR_PATH):
-        os.makedirs(paths.MMT_DIR_PATH)
-        log(f"Creating {paths.MMT_DIR_NAME} folder")
+    paths_actions = {
+        paths.CONFIG_PATH: _create_default_config_file,
+        paths.ASSETS_DIR_PATH: lambda: os.mkdir(paths.ASSETS_DIR_PATH),
+        paths.ASSETS_ICO_PATH: lambda: download_assets_file(paths.ASSETS_ICO_NAME),
+        paths.ASSETS_ICON_ENABLED_PATH: lambda: download_assets_file(
+            paths.ASSETS_ICON_ENABLED_NAME
+        ),
+        paths.ASSETS_ICON_DISABLED_PATH: lambda: download_assets_file(
+            paths.ASSETS_ICON_DISABLED_NAME
+        ),
+    }
+    for path, action in paths_actions.items():
+        if not os.path.exists(path):
+            action()
+            log(INFO, f"Creating or downloading {os.path.basename(path)}")
 
 
 def download_assets_file(image_name):
-    image_url = paths.ASSETS_BASE_URL + image_name
+    image_url = os.path.join(paths.ASSETS_BASE_URL, image_name)
     response = requests.get(image_url, stream=True, timeout=5)
-
     if response.status_code == 200:
-        filename = response.url.split("/")[-1]
-
-        with open(os.path.join(paths.ASSETS_DIR_PATH, filename), "wb") as f:
+        with open(os.path.join(paths.ASSETS_DIR_PATH, image_name), "wb") as f:
             for chunk in response.iter_content(1024):
                 f.write(chunk)
     else:
-        log(f"Error occurred while downloading {image_name}: {response.status_code}")
+        log(
+            ERROR,
+            f"Error occurred while downloading {image_name}: {response.status_code}",
+        )
 
 
 def init_config():
     _check_for_missing_files()
-
-    if get_first_start_value():
+    if get_value(KEY_FIRST_START):
         ui.init_root_window()
-        set_first_start_value(False)
-
-
-def get_mmt_path_value():
-    _read_from_config()
-    return _configparser.get(_SETTINGS_SECTION, _MMT_PATH_KEY)
-
-
-def set_mmt_path_value(_value):
-    log(f"Config.ini - Setting mmt_path to {_value}")
-    _configparser[_SETTINGS_SECTION][_MMT_PATH_KEY] = _value
-    _write_to_config()
-
-
-def get_monitor_name_value():
-    _read_from_config()
-    return _configparser.get(_SETTINGS_SECTION, _MONITOR_NAME_KEY)
-
+        set_value(KEY_FIRST_START, False)
 
-def set_monitor_name_value(_value):
-    log(f"Config.ini - Setting monitor_name to {_value}")
-    _configparser[_SETTINGS_SECTION][_MONITOR_NAME_KEY] = _value
-    _write_to_config()
 
-
-def get_monitor_serial_value():
+def get_value(key):
     _read_from_config()
-    return _configparser.get(_SETTINGS_SECTION, _MONITOR_SERIAL_KEY)
-
+    value = _configparser.get(_SECTION_SETTINGS, key)
+    return value.lower() == "yes" if value.lower() in ["yes", "no"] else value
 
-def set_monitor_serial_value(_value):
-    log(f"Config.ini - Setting monitor_serial to {_value}")
-    _configparser[_SETTINGS_SECTION][_MONITOR_SERIAL_KEY] = _value
-    _write_to_config()
-
-
-def get_start_with_windows_value():
-    _read_from_config()
-    return _configparser.getboolean(_SETTINGS_SECTION, _START_WITH_WINDOWS_KEY)
-
-
-def set_start_with_windows_value(_value):
-    value_str = "yes" if _value else "no"
-    log(f"Config.ini - Setting start_with_windows to {value_str}")
-    _configparser[_SETTINGS_SECTION][_START_WITH_WINDOWS_KEY] = value_str
-    _write_to_config()
-
-
-def get_first_start_value():
-    _read_from_config()
-    return _configparser.getboolean(_SETTINGS_SECTION, _FIRST_START_KEY)
 
+def set_value(key, value):
+    if isinstance(value, bool):
+        value_str = "yes" if value else "no"
+    else:
+        value_str = str(value)
 
-def set_first_start_value(_value):
-    value_str = "yes" if _value else "no"
-    log(f"Config.ini - Setting first_start to {value_str}")
-    _configparser[_SETTINGS_SECTION][_FIRST_START_KEY] = value_str
+    log(INFO, f"{paths.CONFIG_FILE_NAME} - Setting {key} to {value_str}")
+    _configparser[_SECTION_SETTINGS][key] = value_str
     _write_to_config()
 
 
@@ -138,11 +88,5 @@ def _write_to_config():
 
 
 def _create_default_config_file():
-    _configparser[_SETTINGS_SECTION] = {
-        _MONITOR_NAME_KEY: "Example Monitor",
-        _MONITOR_SERIAL_KEY: "12345",
-        _MMT_PATH_KEY: "C:/MultiMonitorTool.exe",
-        _START_WITH_WINDOWS_KEY: "no",
-        _FIRST_START_KEY: "yes",
-    }
+    _configparser[_SECTION_SETTINGS] = _DEFAULT_CONFIG
     _write_to_config()

smct/logger.py

@@ -3,15 +3,20 @@
 from smct.paths import LOG_PATH
 
 ENCODING = "utf-8"
+INFO = "info"
+ERROR = "error"
 
 LOG = None
 STARTUP = True
 
 LOG_LINE_LIMIT = 300
 
 
-def log(text):
-    LOG.info(text)
+def log(log_type, text):
+    if log_type == ERROR:
+        LOG.error(text)
+    elif log_type == INFO:
+        LOG.info(text)
 
 
 def clear_log_if_needed():

smct/multimonitortool.py

@@ -1,7 +1,8 @@
 import subprocess
+import os
 import pandas as pd
 from smct import config, paths
-from smct.logger import log
+from smct.logger import log, INFO, ERROR
 
 MMT_CSV_MONITOR_NAME = "Monitor Name"
 MMT_CSV_SERIAL_NUMBER = "Monitor Serial Number"
@@ -17,22 +18,24 @@ def get_monitor_selection_list():
         lambda row: f"{row[MMT_CSV_NAME][-1]} | {row[MMT_CSV_MONITOR_NAME]} | {row[MMT_CSV_SERIAL_NUMBER]}",
         axis=1,
     )
-    monitor_df["display_string"].apply(lambda x: log(f"Monitor detected: {x}"))
+    monitor_df["display_string"].apply(lambda x: log(INFO, f"Monitor detected: {x}"))
     return sorted(monitor_df["display_string"].tolist())
 
 
 def _get_monitor_df():
     _run_mmt_command("/scomma", paths.MMT_CSV_PATH)
-    return pd.read_csv(paths.MMT_CSV_PATH)
+    _return_df = pd.read_csv(paths.MMT_CSV_PATH)
+    os.remove(paths.MMT_CSV_PATH)
+    return _return_df
 
 
 def _run_mmt_command(command, destination):
-    command_line = [config.get_mmt_path_value(), command, destination]
+    command_line = [config.get_value(config.KEY_MMT_PATH), command, destination]
     try:
         subprocess.run(command_line, check=True)
-        log(f"{' '.join(command_line)}")
+        log(INFO, f"{paths.MMT_EXE_NAME} {command} {os.path.basename(destination)}")
     except subprocess.CalledProcessError as error:
-        log(f"{' '.join(command_line)} failed: {error}")
+        log(ERROR, f"{paths.MMT_EXE_NAME} {command} failed: {error}")
 
 
 def save_mmt_config():
@@ -43,44 +46,21 @@ def enable_monitor():
     _run_mmt_command("/LoadConfig", paths.MMT_CONFIG_PATH)
 
 
-def disable_monitor():
-    if selected_monitor_id := get_selected_monitor_id():
-        _run_mmt_command("/disable", selected_monitor_id)
+def disable_monitor(monitor_id):
+    _run_mmt_command("/disable", str(monitor_id))
 
 
-def enable_all_disabled_monitors():
-    disabled_monitor_ids = _get_all_disabled_monitor_ids()
-    log("enable_all_disabled_monitors()")
-    for _monitor_id in disabled_monitor_ids:
-        _run_mmt_command("/enable", _monitor_id)
-
-
-def get_selected_monitor_id():
-    condition = (
-        _get_monitor_df()[MMT_CSV_MONITOR_NAME] == config.get_monitor_name_value()
+# returns if selected monitor is enabled AND its id
+def get_state_and_id_of_monitor():
+    df = _get_monitor_df()
+    id_condition = (
+        df[MMT_CSV_MONITOR_NAME] == config.get_value(config.KEY_MONITOR_NAME)
     ) & (
-        _get_monitor_df()[MMT_CSV_SERIAL_NUMBER].astype(str)
-        == config.get_monitor_serial_value()
+        df[MMT_CSV_SERIAL_NUMBER].astype(str)
+        == config.get_value(config.KEY_MONITOR_SERIAL)
     )
-    filtered_df = _get_monitor_df().loc[condition]
-    if not filtered_df.empty:
-        return filtered_df.iloc[0][MMT_CSV_NAME][-1]
-
-
-def _get_all_disabled_monitor_ids():
-    monitor_df = _get_monitor_df()
+    state_condition = id_condition & (df[MMT_CSV_ACTIVE].str.lower() == MMT_CSV_YES)
     return (
-        monitor_df[monitor_df[MMT_CSV_ACTIVE].str.lower() == MMT_CSV_NO][MMT_CSV_NAME]
-        .apply(lambda x: x[-1])
-        .tolist()
-    )
-
-
-def is_selected_monitor_enabled():
-    df = _get_monitor_df()
-    condition = (
-        (df[MMT_CSV_MONITOR_NAME] == config.get_monitor_name_value())
-        & (df[MMT_CSV_SERIAL_NUMBER].astype(str) == config.get_monitor_serial_value())
-        & (df[MMT_CSV_ACTIVE].str.lower() == MMT_CSV_YES)
+        len(df.loc[state_condition]) == 1,
+        df.loc[id_condition].iloc[0][MMT_CSV_NAME][-1],
     )
-    return condition.any()

smct/paths.py

@@ -22,10 +22,10 @@ def strip_package_name_from_path(path):
 CONFIG_FILE_NAME = "config.ini"
 LOG_FILE_NAME = "smct.log"
 ASSETS_DIR_NAME = "assets"
-MMT_DIR_NAME = "mmt"
 
-MMT_CSV_NAME = "MultiMonitorToolOutput.csv"
-MMT_CONFIG_NAME = "MultiMonitorToolConfig"
+MMT_EXE_NAME = "MultiMonitorTool.exe"
+MMT_CSV_NAME = "MultiMonitorToolScommaOutput.tmp"
+MMT_CONFIG_NAME = "MultiMonitorToolConfig.ini"
 
 ASSETS_ICON_ENABLED_NAME = "tray_monitor_enabled.png"
 ASSETS_ICON_DISABLED_NAME = "tray_monitor_disabled.png"
@@ -40,10 +40,9 @@ def strip_package_name_from_path(path):
 CONFIG_PATH = os.path.join(BASE_PATH, CONFIG_FILE_NAME)
 LOG_PATH = os.path.join(BASE_PATH, LOG_FILE_NAME)
 ASSETS_DIR_PATH = os.path.join(BASE_PATH, ASSETS_DIR_NAME)
-MMT_DIR_PATH = os.path.join(BASE_PATH, MMT_DIR_NAME)
 
-MMT_CSV_PATH = os.path.join(MMT_DIR_PATH, MMT_CSV_NAME)
-MMT_CONFIG_PATH = os.path.join(MMT_DIR_PATH, MMT_CONFIG_NAME)
+MMT_CSV_PATH = os.path.join(BASE_PATH, MMT_CSV_NAME)
+MMT_CONFIG_PATH = os.path.join(BASE_PATH, MMT_CONFIG_NAME)
 
 ASSETS_ICON_ENABLED_PATH = os.path.join(ASSETS_DIR_PATH, ASSETS_ICON_ENABLED_NAME)
 ASSETS_ICON_DISABLED_PATH = os.path.join(ASSETS_DIR_PATH, ASSETS_ICON_DISABLED_NAME)