Refactor move crystal.browser.MainWindow to its own submodule

Author: davidfstr

src/crystal/browser/__init__.py

@@ -31,7 +31,7 @@
 from typing import Any, BinaryIO, TextIO, cast, Never, ParamSpec, TypeVar, TYPE_CHECKING, override
 
 if TYPE_CHECKING:
-    from crystal.browser import MainWindow
+    from crystal.browser.main_window import MainWindow
     from crystal.model import Project
     from crystal.progress.interface import OpenProjectProgressListener
     from crystal.shell import Shell
@@ -1039,7 +1039,7 @@ async def _did_launch(
 
                 # Create main window (unless in headless mode)
                 if not parsed_args.headless:
-                    from crystal.browser import MainWindow
+                    from crystal.browser.main_window import MainWindow
                     # NOTE: Can raise CancelOpenProject
                     window = MainWindow(project, progress_listener)
     except CancelOpenProject:
@@ -1107,7 +1107,7 @@ async def _prompt_for_project(
     Raises:
     * SystemExit -- if the user quits rather than providing a project
     """
-    from crystal.browser import MainWindow
+    from crystal.browser.main_window import MainWindow
     from crystal.progress.interface import CancelOpenProject
     from crystal.ui.dialog import BetterMessageDialog
     from crystal.util.wx_bind import bind

src/crystal/browser/main_window.py

@@ -37,7 +37,7 @@
 )
 
 if TYPE_CHECKING:
-    from crystal.browser import MainWindow
+    from crystal.browser.main_window import MainWindow
 
 
 _R = TypeVar('_R')

src/crystal/main.py

@@ -270,7 +270,7 @@ recommended unless you are writing tests intended to directly test the UI.
 After creating or opening a project, you'll get an `mw`
 (`crystal.tests.util.windows.MainWindow`) object which can be interacted with
 to manipulate the UI in the main window. (This is not the same as the
-`crystal.browser.MainWindow` object that is available on the Crystal CLI.)
+`crystal.browser.main_window.MainWindow` object that is available on the Crystal CLI.)
 
 Read the source of `MainWindow` or look at how other tests interact with it
 to determine what actions are possible.

src/crystal/shell.py

@@ -1,6 +1,6 @@
 from collections.abc import Iterator
 from contextlib import contextmanager
-from crystal.browser import MainWindow as RealMainWindow
+from crystal.browser.main_window import MainWindow as RealMainWindow
 from crystal.model import Project, Resource, RootResource
 # TODO: Extract shared utilities to own module
 from crystal.tests.aspects.test_untitled_projects import (
@@ -516,7 +516,7 @@ def spy_execute(self, command: str, *args, **kwargs):
 
         # Run the save operation
         with patch.object(DatabaseCursor, 'execute', spy_execute), \
-                patch('crystal.browser.ShowModal', mocked_show_modal(
+                patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                     'cr-save-error-dialog', wx.ID_OK)):
             await save_as_with_ui(rmw, save_path)
 

src/crystal/tests/README.md

@@ -1,7 +1,7 @@
 from collections.abc import AsyncIterator, Callable, Iterator
 from contextlib import asynccontextmanager, contextmanager
 from crystal.app_preferences import app_prefs
-from crystal.browser import MainWindow as RealMainWindow
+from crystal.browser.main_window import MainWindow as RealMainWindow
 from crystal.browser.tasktree import TaskTreeNode
 from crystal.model import (
     Project, ProjectReadOnlyError, Resource, ResourceGroup, RootResource,
@@ -330,7 +330,7 @@ async def test_when_dirty_untitled_project_closed_then_prompts_to_save() -> None
                 assert mw.main_window.OSXIsModified()
 
             # Close the project, expect a prompt to save, and save to the specified path
-            with patch('crystal.browser.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_YES)), \
+            with patch('crystal.browser.main_window.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_YES)), \
                     file_dialog_returning(save_path):
                 await mw.close()
                 assert os.path.exists(save_path)
@@ -341,7 +341,7 @@ async def test_when_clean_untitled_project_closed_then_does_not_prompt_to_save()
         assert not project.is_dirty
 
         # Close project. Ensure no prompt to save.
-        with patch('crystal.browser.ShowModal') as mock_show_modal:
+        with patch('crystal.browser.main_window.ShowModal') as mock_show_modal:
             await mw.close()
             mock_show_modal.assert_not_called()
 
@@ -407,7 +407,7 @@ def _ensure_logout_vetoed_and_return_yes(dialog: wx.Dialog) -> int:
                 return wx.ID_YES
 
             # Start logout. Expect a prompt to save. Save.
-            with patch('crystal.browser.ShowModal', mocked_show_modal(
+            with patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                         'cr-save-changes-dialog',
                         _ensure_logout_vetoed_and_return_yes)), \
                     file_dialog_returning(save_path):
@@ -435,7 +435,7 @@ async def test_given_os_logout_with_dirty_untitled_project_and_prompts_to_save_w
         assert project.is_dirty
 
         # Start logout. Expect a prompt to save. Cancel.
-        with patch('crystal.browser.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_CANCEL)):
+        with patch('crystal.browser.main_window.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_CANCEL)):
             logout_event = _simulate_os_logout()
 
             # Verify the logout was vetoed
@@ -446,7 +446,7 @@ async def test_given_os_logout_with_dirty_untitled_project_and_prompts_to_save_w
             assert project.is_untitled
 
         # Now close the project without saving
-        with patch('crystal.browser.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_NO)):
+        with patch('crystal.browser.main_window.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_NO)):
             await mw.close()
 
 
@@ -460,7 +460,7 @@ async def test_given_os_logout_with_dirty_untitled_project_and_prompts_to_save_w
         assert project.is_dirty
 
         # Start logout. Expect a prompt to save. Do not save.
-        with patch('crystal.browser.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_NO)):
+        with patch('crystal.browser.main_window.ShowModal', mocked_show_modal('cr-save-changes-dialog', wx.ID_NO)):
             _simulate_os_logout()
 
             # Ensure project was closed
@@ -476,7 +476,7 @@ async def test_when_close_untitled_prompt_and_user_does_not_save_then_project_mo
 
         with patch('crystal.filesystem.LocalFilesystem.send2trash', wraps=send2trash.send2trash) as send2trash_spy, \
                 patch(
-                    'crystal.browser.ShowModal',
+                    'crystal.browser.main_window.ShowModal',
                     mocked_show_modal('cr-save-changes-dialog', wx.ID_NO)):
             await mw.close()
 
@@ -820,7 +820,7 @@ def spy_execute(self, command: str, *args, **kwargs):
 
         # Run the save operation
         with patch.object(DatabaseCursor, 'execute', spy_execute), \
-                patch('crystal.browser.ShowModal', mocked_show_modal(
+                patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                     'cr-save-error-dialog', wx.ID_OK)):
             await save_as_with_ui(rmw, save_path)
 
@@ -857,7 +857,7 @@ def raise_disk_full_error() -> Never:
 
             # Run the save operation
             with _file_object_write_mocked_to(raise_disk_full_error), \
-                    patch('crystal.browser.ShowModal', mocked_show_modal(
+                    patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                         'cr-save-error-dialog', wx.ID_OK)):
                 await save_as_with_ui(rmw, save_path)
 
@@ -904,7 +904,7 @@ def raise_destination_filesystem_gone_error() -> Never:
 
                     # Run the save operation
                     with _file_object_write_mocked_to(raise_destination_filesystem_gone_error), \
-                            patch('crystal.browser.ShowModal', mocked_show_modal(
+                            patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                                 'cr-save-error-dialog', wx.ID_OK)):
                         await save_as_with_ui(rmw, save_path)
 
@@ -981,7 +981,7 @@ async def test_when_save_as_project_and_old_project_fails_to_close_then_handles_
             # Patch the scheduler join timeout to 0 to force immediate timeout
             with patch.object(Project, '_SCHEDULER_JOIN_TIMEOUT', 0):
                 # Mock error dialog to acknowledge the timeout error
-                with patch('crystal.browser.ShowModal', mocked_show_modal(
+                with patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                         'cr-save-error-dialog', wx.ID_OK)):
                     await save_as_with_ui(rmw, save_path)
 
@@ -1029,7 +1029,7 @@ def raise_database_corruption_error(*args, **kwargs):
 
             # Run the save operation
             with patch('sqlite3.connect', side_effect=raise_database_corruption_error), \
-                    patch('crystal.browser.ShowModal', mocked_show_modal(
+                    patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                         'cr-save-error-dialog', wx.ID_OK)):
                 await save_as_with_ui(rmw, save_path)
 
@@ -1071,7 +1071,7 @@ def fake_reopen(self):
                     f.truncate(size // 2)
             return original_reopen(self)
         with patch.object(Project, '_reopen', fake_reopen), \
-                patch('crystal.browser.ShowModal', mocked_show_modal(
+                patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                     'cr-save-error-dialog', wx.ID_OK)) as show_modal_method:
             await save_as_with_ui(rmw, save_path)
             assert 1 == show_modal_method.call_count, \
@@ -1119,7 +1119,7 @@ def fake_reopen(self):
                 return original_reopen(self)
 
             with patch.object(Project, '_reopen', fake_reopen), \
-                    patch('crystal.browser.ShowModal', mocked_show_modal(
+                    patch('crystal.browser.main_window.ShowModal', mocked_show_modal(
                         'cr-save-error-dialog', wx.ID_OK)) as show_modal_method:
                 await save_as_with_ui(rmw, save_path)
                 assert 1 == show_modal_method.call_count, \
@@ -1506,7 +1506,7 @@ def SaveAsProgressDialogSpy(*args, **kwargs) -> SaveAsProgressDialog:  # wraps r
         return instance
 
     try:
-        with patch('crystal.browser.SaveAsProgressDialog', SaveAsProgressDialogSpy):
+        with patch('crystal.browser.main_window.SaveAsProgressDialog', SaveAsProgressDialogSpy):
             async with wait_for_save_as_to_complete(project):
                 # 1. Tell caller to start a Save As operation
                 # 2. Yield a placeholder for spies that will be updated when the dialog is created
@@ -1537,7 +1537,7 @@ def SaveAsProgressDialogSpy(*args, **kwargs):  # wraps real constructor
     try:
         old_project_dirpath = project.path  # capture
         assert os.path.exists(old_project_dirpath)
-        with patch('crystal.browser.SaveAsProgressDialog', SaveAsProgressDialogSpy):
+        with patch('crystal.browser.main_window.SaveAsProgressDialog', SaveAsProgressDialogSpy):
             async with wait_for_save_as_to_complete(project):
                 yield
 

src/crystal/tests/aspects/test_readonly_mode.py

@@ -418,7 +418,7 @@ def test_when_launched_with_shell_and_project_filepath_then_shell_starts_with_op
 
             # Verify window variable is set to a real MainWindow object
             result = py_eval_literal(crystal, 'repr(window)')
-            assertIn('<crystal.browser.MainWindow object at 0x', result)
+            assertIn('<crystal.browser.main_window.MainWindow object at 0x', result)
 
             # Verify the project path is correct
             result = py_eval_literal(crystal, 'project.path')

src/crystal/tests/aspects/test_untitled_projects.py

@@ -6,7 +6,7 @@
 """
 
 from contextlib import redirect_stderr
-from crystal.browser import MainWindow as RealMainWindow
+from crystal.browser.main_window import MainWindow as RealMainWindow
 from crystal.model import Project
 from crystal.tests.util.asserts import (
     assertEqual, assertIn, assertNotEqual, assertNotIn, assertRegex

src/crystal/tests/cli/test_cli.py

@@ -126,12 +126,12 @@ def test_can_launch_with_shell(subtests: SubtestsContext) -> None:
                 r'^<crystal\.model\.project\.Project object at 0x[0-9a-f]+>\n$',
                 py_eval(crystal, 'project'))
             assert re.fullmatch(
-                r'^<crystal\.browser\.MainWindow object at 0x[0-9a-f]+>\n$',
+                r'^<crystal\.browser\.main_window\.MainWindow object at 0x[0-9a-f]+>\n$',
                 py_eval(crystal, 'window'))
 
         with subtests.test(msg='and {project, window} can be used with help()'):
             assertIn('Help on Project in module crystal.model.project object:', py_eval(crystal, 'help(project)'))
-            assertIn('Help on MainWindow in module crystal.browser object:', py_eval(crystal, 'help(window)'))
+            assertIn('Help on MainWindow in module crystal.browser.main_window object:', py_eval(crystal, 'help(window)'))
 
 
 def test_can_use_pythonstartup_file() -> None: