refactor: apply ruff formatting and linting to python files and update pyproject.toml

Author: rtuszik

pyproject.toml

@@ -5,3 +5,60 @@ description = "Build interactive, portable cheatsheets from YAML."
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = ["jinja2>=3.1.6", "python-dotenv>=1.1.1", "ruamel-yaml>=0.18.14"]
+
+[dependency-groups]
+dev = ["bandit>=1.8.6", "ruff>=0.14.0", "ty>=0.0.1a22", "vulture>=2.14"]
+
+
+[tool.ruff]
+indent-width = 4
+line-length = 120
+
+
+[tool.ruff.lint]
+# select = ["ALL"]
+ignore = [
+    "ANN",     # flake8-annotations
+    "COM",     # flake8-commas
+    "C90",     # mccabe complexity
+    "DJ",      # django
+    "EXE",     # flake8-executable
+    "BLE",     # blind except
+    "PTH",     # flake8-pathlib
+    "T10",     # debugger
+    "TID",     # flake8-tidy-imports
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D106",
+    "D107",
+    "D101",
+    "D107",    # missing docstring in public module
+    "D102",    # missing docstring in public class
+    "D104",    # missing docstring in public package
+    "D213",
+    "D203",
+    "D400",
+    "D415",
+    "G004",
+    "PLR2004",
+    "E501",    # line too long
+    "TRY",
+    "SIM105",  # faster without contextlib
+]
+
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
+
+docstring-code-format = false

src/generate_cheatsheet.py

@@ -7,7 +7,7 @@
 from logger import get_logger
 from pathlib import Path
 
-yaml_safe = YAML(typ='safe')
+yaml_safe = YAML(typ="safe")
 yaml_rw = YAML()
 yaml_rw.indent(mapping=2, sequence=4, offset=2)
 yaml_rw.preserve_quotes = True
@@ -18,7 +18,7 @@
 BASE_DIR = Path(__file__).parent
 PROJECT_ROOT = BASE_DIR.parent
 
-OUTPUT_DIR = Path(os.getenv('CHEATSHEET_OUTPUT_DIR') or PROJECT_ROOT / "output")
+OUTPUT_DIR = Path(os.getenv("CHEATSHEET_OUTPUT_DIR") or PROJECT_ROOT / "output")
 TEMPLATES_DIR = BASE_DIR / "templates"
 LAYOUTS_DIR = BASE_DIR / "layouts"
 CHEATSHEETS_DIR = PROJECT_ROOT / "cheatsheets"
@@ -30,7 +30,7 @@
 
 def load_yaml(file_path: Path) -> dict | None:
     try:
-        with open(file_path, "r", encoding='utf-8') as file:
+        with open(file_path, "r", encoding="utf-8") as file:
             return yaml_safe.load(file)
     except FileNotFoundError:
         logging.error(f"Error: YAML file '{file_path}' not found.")
@@ -43,54 +43,50 @@ def load_yaml(file_path: Path) -> dict | None:
 def load_layout():
     keyboard_layouts = load_yaml(LAYOUTS_DIR / "keyboard_layouts.yaml")
     system_mappings = load_yaml(LAYOUTS_DIR / "system_mappings.yaml")
-    
+
     if keyboard_layouts is None or system_mappings is None:
         logging.error("Failed to load configuration files.")
         return None, None
-    
+
     return keyboard_layouts, system_mappings
 
+
 def replace_shortcut_names(shortcut, system_mappings):
-    arrow_key_mappings = {
-        "Up": "↑",
-        "Down": "↓",
-        "Left": "←",
-        "Right": "→"
-    }
+    arrow_key_mappings = {"Up": "↑", "Down": "↓", "Left": "←", "Right": "→"}
     try:
         processed_parts = []
         i = 0
         while i < len(shortcut):
-            if shortcut[i] == '+':
-                if i + 1 < len(shortcut) and shortcut[i + 1] == '+':
-                    processed_parts.append('+')
+            if shortcut[i] == "+":
+                if i + 1 < len(shortcut) and shortcut[i + 1] == "+":
+                    processed_parts.append("+")
                     i += 2
                 else:
-                    processed_parts.append('<sep>')
+                    processed_parts.append("<sep>")
                     i += 1
             else:
-                current_part = ''
-                while i < len(shortcut) and shortcut[i] != '+':
+                current_part = ""
+                while i < len(shortcut) and shortcut[i] != "+":
                     current_part += shortcut[i]
                     i += 1
                 if current_part.strip():
                     part = current_part.strip()
                     part = system_mappings.get(part.lower(), part)
-                    if part in ['⌘', '⌥', '⌃', '⇧']:
+                    if part in ["⌘", "⌥", "⌃", "⇧"]:
                         part = f'<span class="modifier-symbol">{part}</span>'
 
                     part = arrow_key_mappings.get(part, part)
                     processed_parts.append(part)
 
-
-        return ''.join(processed_parts)
+        return "".join(processed_parts)
     except Exception as e:
-         logging.error(f"Error replacing shortcut names: {e}")
-         return shortcut
+        logging.error(f"Error replacing shortcut names: {e}")
+        return shortcut
+
 
 def normalize_shortcuts(data, system_mappings):
     normalized = {}
-    allow_text = data.get('AllowText', False)
+    allow_text = data.get("AllowText", False)
     try:
         for section, shortcuts in data.get("shortcuts", {}).items():
             normalized[section] = {}
@@ -112,17 +108,16 @@ def get_layout_info(data):
         "system": layout.get("system", "Darwin"),
     }
 
+
 def generate_html(data, keyboard_layouts, system_mappings):
     template_path = "cheatsheets/cheatsheet-template.html"
     layout_info = get_layout_info(data)
-    data["shortcuts"] = normalize_shortcuts(
-        data, system_mappings.get(layout_info["system"], {})
-    )
+    data["shortcuts"] = normalize_shortcuts(data, system_mappings.get(layout_info["system"], {}))
     data["layout"] = layout_info
     data["keyboard_layout"] = keyboard_layouts.get(layout_info["keyboard"], {}).get("layout")
     data["render_keys"] = data.get("RenderKeys", True)
     data["allow_text"] = data.get("AllowText", False)
-    
+
     return render_template(template_path, data)
 
 
@@ -141,15 +136,17 @@ def validate_and_lint(yaml_file):
 
     return True
 
+
 def write_html_content(html_output, html_content):
     try:
-        with open(html_output, "w", encoding='utf-8') as file:
+        with open(html_output, "w", encoding="utf-8") as file:
             file.write(html_content)
     except IOError as e:
         logging.error(f"Error writing to output file: {e}")
         return False
     return True
 
+
 def main(yaml_file):
     if not validate_and_lint(yaml_file):
         return None, None
@@ -199,7 +196,7 @@ def generate_index(cheatsheets):
 
     if cheatsheets:
         OUTPUT_DIR.mkdir(exist_ok=True, parents=True)
-        
+
         html_content = generate_index(cheatsheets)
         if html_content:
             index_output = os.path.join(OUTPUT_DIR, "index.html")

src/logger.py

@@ -11,6 +11,7 @@
 
 _logger: Optional[logging.Logger] = None
 
+
 def setup_logging(
     log_file: str = os.getenv("LOG_FILE", DEFAULT_LOG_FILE),
 ) -> logging.Logger:
@@ -20,7 +21,7 @@ def setup_logging(
 
     logger = logging.getLogger("app")
     logger.setLevel(logging.DEBUG)
-    
+
     formatter = logging.Formatter(DEFAULT_FORMAT)
 
     logger.handlers.clear()
@@ -32,10 +33,7 @@ def setup_logging(
 
     try:
         file_handler = RotatingFileHandler(
-            log_file,
-            maxBytes=DEFAULT_MAX_BYTES,
-            backupCount=DEFAULT_BACKUP_COUNT,
-            encoding='utf-8'
+            log_file, maxBytes=DEFAULT_MAX_BYTES, backupCount=DEFAULT_BACKUP_COUNT, encoding="utf-8"
         )
         file_handler.setLevel(logging.DEBUG)
         file_handler.setFormatter(formatter)
@@ -48,9 +46,9 @@ def setup_logging(
     _logger = logger
     return logger
 
+
 def get_logger() -> logging.Logger:
     global _logger
     if _logger is None:
         _logger = setup_logging()
     return _logger
-

src/template_renderer.py

@@ -4,21 +4,19 @@
 
 logging = get_logger()
 
+
 def render_template(template_path, data):
     try:
         templates_dir = Path(__file__).parent / "templates"
-        
-        env = Environment(
-            loader=FileSystemLoader(str(templates_dir))
-        )
-        
+
+        env = Environment(loader=FileSystemLoader(str(templates_dir)))
+
         template = env.get_template(str(template_path))
         return template.render(**data)
-        
+
     except FileNotFoundError:
         logging.error(f"Error: Template file '{template_path}' not found.")
         return None
     except Exception as e:
         logging.error(f"Error reading template file: {e}")
         return None
-