style(gui): Apply strict vertical compaction and add type hints

This commit is contained in:
2026-05-13 16:51:19 -04:00
parent 8d0599a9cb
commit 8cbd232db0
6 changed files with 54 additions and 47 deletions
+18 -18
View File
@@ -1,26 +1,26 @@
# Implementation Plan: GUI 2.py Cleanup & Structural Awareness
## Phase 1: `gui_2.py` Structural Analysis & Init Cleanup
- [ ] Task: Audit `gui_2.py` state variables and `__init__` declarations to identify redundancies or disorganization.
- [ ] Task: Refactor `gui_2.py`'s `__init__` method to group related state variables and improve clarity.
- [ ] Task: Verify GUI initialization functionality and ensure no regressions using manual/test hooks.
- [ ] Task: Conductor - User Manual Verification 'Phase 1: `gui_2.py` Structural Analysis & Init Cleanup' (Protocol in workflow.md)
- [x] Task: Audit `gui_2.py` state variables and `__init__` declarations to identify redundancies or disorganization.
- [x] Task: Refactor `gui_2.py`'s `__init__` method to group related state variables and improve clarity.
- [x] Task: Verify GUI initialization functionality and ensure no regressions using manual/test hooks.
- [x] Task: Conductor - User Manual Verification 'Phase 1: `gui_2.py` Structural Analysis & Init Cleanup' (Protocol in workflow.md)
## Phase 2: Type Hints & Layout Refactoring in `gui_2.py`
- [ ] Task: Inject and validate Python type hints across `gui_2.py` methods and properties.
- [ ] Task: Refactor complex layout and rendering logic blocks within `gui_2.py` for better readability.
## Phase 2: Study & Document Codebase Conventions
- [x] Task: Study recent changes to `gui_2.py` (via git diffs and current file state) to identify established conventions for type hints, layout logic, and ImGui scoping.
- [x] Task: Synthesize learnings to update `conductor/code_styleguides/python.md` with specific, explicit coding conventions.
- [x] Task: Update `conductor/product-guidelines.md` with high-level structural and maintenance strategies derived from the codebase study.
- [x] Task: Conductor - User Manual Verification 'Phase 2: Study & Document Codebase Conventions' (Protocol in workflow.md)
## Phase 3: Apply Conventions & Finalize `gui_2.py` Nitpicks
- [~] Task: Audit `gui_2.py` against the newly documented conventions to identify remaining structural nitpicks.
- [ ] Task: Apply formatting, type hint corrections, and layout refactoring to bring the rest of `gui_2.py` into alignment.
- [ ] Task: Run automated test suite to ensure structural changes haven't broken the rendering pipeline.
- [ ] Task: Conductor - User Manual Verification 'Phase 2: Type Hints & Layout Refactoring in `gui_2.py`' (Protocol in workflow.md)
- [ ] Task: Conductor - User Manual Verification 'Phase 3: Apply Conventions & Finalize `gui_2.py` Nitpicks' (Protocol in workflow.md)
## Phase 3: MCP Tool Enhancements
- [ ] Task: Investigate existing MCP tools (e.g., `py_get_skeleton`, `py_get_code_outline`) for AST parsing logic.
- [ ] Task: Enhance AST parsing logic to better extract type annotations from Python source files.
## Phase 4: MCP Tool Enhancements for Structural Awareness
- [ ] Task: Investigate existing Python MCP tool scripts (e.g., `py_get_skeleton`, `py_get_code_outline` implementations) for AST parsing logic.
- [ ] Task: Enhance AST parsing logic to better extract and expose type annotations from Python source files.
- [ ] Task: Modify structural extraction tools to recognize and highlight common ImGui/Dear PyGui patterns.
- [ ] Task: Write/update tests for MCP tools to verify accurate annotation and pattern parsing.
- [ ] Task: Conductor - User Manual Verification 'Phase 3: MCP Tool Enhancements' (Protocol in workflow.md)
## Phase 4: Documentation & Guidelines Update
- [ ] Task: Synthesize learnings from Phase 1 & 2 to define best practices for Python maintenance in this codebase.
- [ ] Task: Update `conductor/product-guidelines.md` with high-level structural and maintenance strategies.
- [ ] Task: Update `conductor/code_styleguides/python.md` with explicit coding conventions (e.g., 1-space indentation, ImGui patterns) derived from the cleanup.
- [ ] Task: Conductor - User Manual Verification 'Phase 4: Documentation & Guidelines Update' (Protocol in workflow.md)
- [ ] Task: Conductor - User Manual Verification 'Phase 4: MCP Tool Enhancements for Structural Awareness' (Protocol in workflow.md)
+12 -16
View File
@@ -1,32 +1,28 @@
# Specification: GUI 2.py Cleanup & Structural Awareness
## Overview
This track focuses on a comprehensive cleanup of `src/gui_2.py`, deriving best practices for maintaining the Python codebase, and updating the relevant guidelines. It also includes enhancing the MCP tools to better understand Python structural conventions such as annotations.
This track focuses on studying recent manual cleanups performed on `src/gui_2.py` to derive best practices for maintaining the Python codebase. It aims to document these extracted conventions, apply them to remaining nitpicks, and significantly enhance the MCP tools' structural awareness of annotations and Python/ImGui conventions.
## Functional Requirements
1. **`gui_2.py` Cleanup**:
- Reorganize the `__init__` method and object state.
- Improve type hints and annotations throughout the file.
- Refactor layout and rendering logic for better readability.
- Improve general code structure and maintainability.
2. **Guidelines Update**:
- Analyze the cleanup process to derive best practices.
- Update `conductor/product-guidelines.md` with high-level maintenance strategies.
- Update `conductor/code_styleguides/python.md` with specific coding conventions discovered during the cleanup.
1. **Study & Documentation**:
- Study the recent changes made to `gui_2.py` to identify conventions regarding type hints, state organization, and ImGui rendering patterns.
- Update `conductor/product-guidelines.md` with high-level maintenance strategies derived from the study.
- Update `conductor/code_styleguides/python.md` with explicit coding conventions discovered (e.g., annotation formatting, class layout).
2. **`gui_2.py` Cleanup (Nitpicks)**:
- Apply the formalized conventions to any remaining unorganized sections of `gui_2.py` (e.g., finishing `__init__` refactoring or scattered state).
3. **MCP Tools Enhancements**:
- Improve parsing of Python type annotations.
- Enhance the extraction of class and method outlines.
- Add support for recognizing specific ImGui/Dear PyGui patterns to improve structural awareness.
- Enhance AST parsing logic (e.g., in Python outline/skeleton extraction) to properly parse and expose type annotations.
- Modify structural tools to recognize common ImGui/Dear PyGui patterns for better structural awareness and token efficiency.
## Non-Functional Requirements
- Ensure changes do not break existing functionality or introduce regressions.
- Maintain the "1-space indentation" rule as strictly defined in the Python code styleguide.
- All refactoring should aim to reduce token consumption when analyzing the file with AI.
- All refactoring should aim to reduce token consumption when analyzing files with AI.
## Acceptance Criteria
- `gui_2.py` is successfully refactored, specifically focusing on `__init__` declarations and type hints.
- Both `conductor/product-guidelines.md` and `conductor/code_styleguides/python.md` are updated with the newly derived insights.
- MCP tools (e.g., `py_get_skeleton`, `py_get_code_outline`) exhibit improved awareness of annotations and GUI patterns.
- `gui_2.py` is successfully refactored according to the formalized conventions.
- MCP tools exhibit improved awareness of annotations and GUI patterns.
- Automated tests pass and manual GUI verification confirms no regressions.
## Out of Scope