Rearranged lines in 'run()' in logical blocks; added comments to describe purpose of code blocks

Author: tieneupin

src/murfey/client/__init__.py

@@ -11,6 +11,7 @@
 import webbrowser
 from datetime import datetime
 from pathlib import Path
+from pprint import pprint
 from queue import Queue
 from typing import List, Literal
 from urllib.parse import ParseResult, urlparse
@@ -91,6 +92,7 @@ def _check_for_updates(
 
 
 def run():
+    # Load client config and server information
     config = read_config()
     instrument_name = config["Murfey"]["instrument_name"]
     try:
@@ -109,6 +111,7 @@ def run():
     else:
         known_server = config["Murfey"].get("server")
 
+    # Set up argument parser with dynamic defaults based on client config
     parser = argparse.ArgumentParser(description="Start the Murfey client")
     parser.add_argument(
         "--server",
@@ -194,23 +197,23 @@ def run():
         default=False,
         help="Do not trigger processing for any data directories currently on disk (you may have started processing for them in a previous murfey run)",
     )
-
     args = parser.parse_args()
 
+    # Logic to exit early based on parsed args
     if not args.server:
         exit("Murfey server not set. Please run with --server host:port")
     if not args.server.startswith(("http://", "https://")):
         if "://" in args.server:
             exit("Unknown server protocol. Only http:// and https:// are allowed")
         args.server = f"http://{args.server}"
-
     if args.remove_files:
         remove_prompt = Confirm.ask(
             f"Are you sure you want to remove files from {args.source or Path('.').absolute()}?"
         )
         if not remove_prompt:
             exit("Exiting")
 
+    # If a new server URL is provided, save info to config file
     murfey_url = urlparse(args.server, allow_fragments=False)
     if args.server != known_server:
         # New server specified. Verify that it is real
@@ -232,8 +235,7 @@ def run():
     if args.no_transfer:
         log.info("No files will be transferred as --no-transfer flag was specified")
 
-    from pprint import pprint
-
+    # Check ISPyB (if set up) for ongoing visits
     ongoing_visits = []
     if args.visit:
         ongoing_visits = [args.visit]
@@ -250,35 +252,38 @@ def run():
 
     _enable_webbrowser_in_cygwin()
 
+    # Set up additional log handlers
     log.setLevel(logging.DEBUG)
     log_queue = Queue()
     input_queue = Queue()
 
-    # rich_handler = DirectableRichHandler(log_queue, enable_link_path=False)
+    # Rich-based console handler
     rich_handler = DirectableRichHandler(enable_link_path=False)
     rich_handler.setLevel(logging.DEBUG if args.debug else logging.INFO)
 
+    # Set up websocket app and handler
     client_id = requests.get(f"{murfey_url.geturl()}/new_client_id/").json()
     ws = murfey.client.websocket.WSApp(
         server=args.server,
         id=client_id["new_id"],
     )
+    ws_handler = CustomHandler(ws.send)
 
+    # Add additional handlers and set logging levels
     logging.getLogger().addHandler(rich_handler)
-    handler = CustomHandler(ws.send)
-    logging.getLogger().addHandler(handler)
+    logging.getLogger().addHandler(ws_handler)
     logging.getLogger("murfey").setLevel(logging.INFO)
     logging.getLogger("websocket").setLevel(logging.WARNING)
 
     log.info("Starting Websocket connection")
 
-    status_bar = StatusBar()
-
+    # Load machine data for subsequent sections
     machine_data = requests.get(
         f"{murfey_url.geturl()}/instruments/{instrument_name}/machine"
     ).json()
     gain_ref: Path | None = None
 
+    # Set up Murfey environment instance and map it to websocket app
     instance_environment = MurfeyInstanceEnvironment(
         url=murfey_url,
         client_id=ws.id,
@@ -295,9 +300,10 @@ def run():
             else ""
         ),
     )
-
     ws.environment = instance_environment
 
+    # Set up and run Murfey TUI app
+    status_bar = StatusBar()
     rich_handler.redirect = True
     app = MurfeyTUI(
         environment=instance_environment,