test-gui

Test and Debug GUI

This skill helps in testing and debugging gwexpy.gui.

Instructions

1. Run Automated Tests:

   • Run tests specifically marked for GUI (usually requiring pytest-qt).
   • Command: pytest -m gui or pytest tests/gui/. (Adjust based on actual markers/folders).
   • Check scripts/run_gui_tests.sh if it exists and run it.

2. Debug Crashes:

   • If the GUI crashes (e.g. segmentation fault), look for logs or run with gdb if necessary/possible.
   • Check typical PyQt issues: Thread safety (updating UI from background thread), signal/slot mismatches, object lifecycle (Python garbage collecting C++ objects).

3. Interactive Debugging:

   • Since this is an agent, "interactive" means adding print debugging or logging to the code and running it to capture output.
   • Focus on gwexpy/gui/main_window.py or relevant widget files.

Best Practices

• Avoid Binding Conflicts: Use qtpy for imports in test files (e.g. from qtpy import QtWidgets).
• Environment Variables: If multiple top-level bindings are installed, enforce consistency:
  • export QT_API=pyqt5
  • export PYTEST_QT_API=pyqt5
• Handling Blocking Windows (plt.show):

  • When testing code that calls plt.show() or app.exec_(), use QTimer to close it automatically.

  • Example:

    from qtpy.QtCore import QTimer
    # ... inside test ...
    # Close active window after 100ms
    QTimer.singleShot(100, plt.close)
    # Or for raw Qt widgets:
    # QTimer.singleShot(100, widget.close)
    
    # Then call the blocking function
    plt.show()