Adds rich formatting of logs and updates the default logging styles.

Additionally, `matlab-proxy-app-list-servers` renders the output as a table, and now supports a `--quiet | -q` flag to only print links to running servers.

Author: prabhakk-mw

matlab_proxy/app.py

@@ -996,7 +996,7 @@ def configure_no_proxy_in_env():
         os.environ["no_proxy"] = ",".join(
             set(existing_no_proxy_env + no_proxy_whitelist)
         )
-    logger.info(f"Setting no_proxy to: {os.environ.get('no_proxy')}")
+    logger.debug(f"Setting no_proxy to: {os.environ.get('no_proxy')}")
 
 
 def create_and_start_app(config_name):
@@ -1053,12 +1053,12 @@ def print_version_and_exit():
 
 def main():
     """Starting point of the integration. Creates the web app and runs indefinitely."""
-    if util.parse_cli_args()["version"]:
+    if util.parse_main_cli_args()["version"]:
         print_version_and_exit()
 
     # The integration needs to be called with --config flag.
     # Parse the passed cli arguments.
-    desired_configuration_name = util.parse_cli_args()["config"]
+    desired_configuration_name = util.parse_main_cli_args()["config"]
 
     create_and_start_app(config_name=desired_configuration_name)
 

matlab_proxy/app_state.py

@@ -875,15 +875,8 @@ def create_logs_dir_for_MATLAB(self):
                     user_code_output_file
                 )
                 logger.info(
-                    util.prettify(
-                        boundary_filler="*",
-                        text_arr=[
-                            f"When MATLAB starts, you can see the output for your startup code at:",
-                            f"{self.matlab_session_files.get('startup_code_output_file', ' ')}",
-                        ],
-                    )
+                    f"The results of executing MWI_MATLAB_STARTUP_SCRIPT are stored at: {user_code_output_file} "
                 )
-
             return
 
     def create_server_info_file(self):
@@ -909,17 +902,17 @@ def create_server_info_file(self):
 
         # By default mwi_server_url usually points to 0.0.0.0 as the hostname, but this does not work well
         # on some browsers. Specifically on Safari (MacOS)
-        logger.info(
-            util.prettify(
-                boundary_filler="=",
-                text_arr=[
-                    f"Access MATLAB at:",
-                    self.settings["mwi_server_url"].replace("0.0.0.0", "localhost")
-                    + mwi_auth_token_str,
-                ],
-            )
+        server_url = (
+            self.settings["mwi_server_url"].replace("0.0.0.0", "localhost")
+            + mwi_auth_token_str
         )
 
+        mwi.logger.log_startup_info(
+            title=f"matlab-proxy-app running on {self.settings['app_port']}",
+            matlab_url=server_url,
+        )
+        logger.info(f"MATLAB Root: {self.settings['matlab_path']}")
+
     def clean_up_mwi_server_session(self):
         # Clean up mwi_server_session_files
         try:
@@ -1004,7 +997,7 @@ async def __setup_env_for_matlab(self) -> dict:
 
         # Set MW_CONNECTOR_CONTEXT_ROOT
         matlab_env["MW_CONNECTOR_CONTEXT_ROOT"] = self.settings.get("base_url", "/")
-        logger.info(
+        logger.debug(
             f"MW_CONNECTOR_CONTEXT_ROOT is set to: {matlab_env['MW_CONNECTOR_CONTEXT_ROOT']}"
         )
 
@@ -1316,6 +1309,8 @@ async def start_matlab(self, restart_matlab=False):
         # to MATLAB state by other functions/tasks until the lock is released, ensuring consistency. It's released early only in case of exceptions.
         await self.matlab_state_updater_lock.acquire()
         self.set_matlab_state("starting")
+        logger.info(f"Starting MATLAB...")
+
         # Clear MATLAB errors and logging
         self.error = None
         self.logs["matlab"].clear()
@@ -1535,7 +1530,7 @@ async def stop_matlab(self, force_quit=False):
                             except:
                                 pass
 
-        logger.info("Stopped (any running) MATLAB process.")
+        logger.debug("Stopped (any running) MATLAB process.")
 
         # Terminating Xvfb
         if system.is_posix():

matlab_proxy/settings.py

@@ -53,7 +53,7 @@ def get_process_startup_timeout():
             )
             return constants.DEFAULT_PROCESS_START_TIMEOUT
 
-    logger.info(
+    logger.debug(
         f"Using {constants.DEFAULT_PROCESS_START_TIMEOUT} seconds as the default timeout value"
     )
 
@@ -94,7 +94,7 @@ def get_matlab_executable_and_root_path():
 
     if matlab_executable_path:
         matlab_root_path = Path(matlab_executable_path).resolve().parent.parent
-        logger.info(f"Found MATLAB executable at: {matlab_executable_path}")
+        logger.debug(f"MATLAB root folder: {matlab_root_path}")
         matlab_root_path = mwi.validators.validate_matlab_root_path(
             matlab_root_path, is_custom_matlab_root=False
         )
@@ -698,7 +698,6 @@ def _get_matlab_cmd(matlab_executable_path, code_to_execute, nlm_conn_str):
         "-nosplash",
         *flag_to_hide_desktop,
         "-softwareopengl",
-        # " v=mvm ",
         *matlab_lic_mode,
         "-externalUI",
         profile_matlab_startup,

matlab_proxy/util/__init__.py

@@ -26,7 +26,7 @@
 interrupt_signal_caught = False
 
 
-def parse_cli_args():
+def parse_main_cli_args():
     """Parses CLI arguments passed to the main() function.
 
     Returns:
@@ -56,6 +56,28 @@ def parse_cli_args():
     return parsed_args
 
 
+def parse_list_cli_args():
+    """Parses CLI arguments passed to the matlab-proxy-app-list-servers entrypoint.
+
+    Returns:
+        dict: Containing the parsed arguments
+    """
+    # Parse the --config flag provided to the console script executable.
+    parsed_args = {}
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-q",
+        "--quiet",
+        help="Return the server list without any additional text.",
+        action="store_true",
+    )
+    args = parser.parse_args()
+
+    parsed_args["quiet"] = args.quiet
+
+    return parsed_args
+
+
 def prepare_site(app, runner):
     """Prepares to launch a TCPSite. If MWI_APP_PORT env variable is set,
     it will setup a site to launch on that port, else will launch on a random available port.
@@ -148,47 +170,6 @@ def catch_interrupt_signal(*args):
     return loop
 
 
-def prettify(boundary_filler=" ", text_arr=[]):
-    """Prettify array of strings with borders for stdout
-
-    Args:
-        boundary_filler (str, optional): Upper and lower border filler for text. Defaults to " ".
-        text_arr (list, optional):The text array to prettify. Each element will be added to a newline. Defaults to [].
-
-    Returns:
-        [str]: Prettified String
-    """
-
-    import sys
-
-    if not sys.stdout.isatty():
-        return (
-            "\n============================\n"
-            + "\n".join(text_arr)
-            + "\n============================\n"
-        )
-
-    size = os.get_terminal_size()
-    cols, _ = size.columns, size.lines
-
-    if any(len(text) > cols for text in text_arr):
-        result = ""
-        for text in text_arr:
-            result += text + "\n"
-        return result
-
-    upper = "\n" + "".ljust(cols, boundary_filler) + "\n" if len(text_arr) > 0 else ""
-    lower = "".ljust(cols, boundary_filler) if len(text_arr) > 0 else ""
-
-    content = ""
-    for text in text_arr:
-        content += text.center(cols) + "\n"
-
-    result = upper + content + lower
-
-    return result
-
-
 def get_child_processes(parent_process, max_attempts=10, sleep_interval=1):
     """Get list of child processes from a parent process.
 

matlab_proxy/util/list_servers.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2022 The MathWorks, Inc.
+# Copyright (c) 2020-2025 The MathWorks, Inc.
 # Script to print information about all running matlab-proxy servers for current user on current machine.
 
 import glob
@@ -7,6 +7,66 @@
 import matlab_proxy.settings as mwi_settings
 import matlab_proxy.util as mwi_util
 
+from datetime import datetime
+from rich.console import Console
+from rich.table import Table
+
+__NO_SERVERS_MSG = "No MATLAB-PROXY Servers are currently running."
+
+
+def _extract_version_and_session(title):
+    """Extracts session name and MATLAB version from the title."""
+    parts = title.split("-")
+    if len(parts) < 2:
+        return title.replace("MATLAB ", ""), ""
+    session_name = parts[0].strip()
+    matlab_version = parts[1].strip().replace("MATLAB ", "")
+    return matlab_version, session_name
+
+
+def _get_server_info(server):
+    """Helper function to parse info from server file."""
+    with open(server) as f:
+        # Assumes that the server file contains the address on the first line,
+        # the browser_title on the second line, and the timestamp is derived from the file's last modified time.
+        address = f.readline().strip()
+        browser_title = f.readline().strip()
+        matlab_version, session_name = _extract_version_and_session(browser_title)
+        timestamp = _get_timestamp(server)
+        return timestamp, matlab_version, session_name, address
+
+
+def _print_server_info_as_table(servers):
+    console = Console()
+    table = Table(
+        title="MATLAB Proxy Servers",
+        title_style="cyan",
+        title_justify="center",
+        caption="No servers found." if not servers else "",
+        caption_style="bold red",
+        show_header=True,
+        header_style="yellow",
+        show_lines=True,
+        show_edge=True,
+    )
+    table.add_column("Created On")
+    table.add_column("MATLAB\nVersion")
+    table.add_column("Session Name")
+    table.add_column("Server URL", overflow="fold")
+
+    # Build server information
+    for server in servers:
+        table.add_row(*_get_server_info(server))
+
+    console.print(table)
+
+
+def _get_timestamp(filename):
+    """Get the last modified timestamp of the file in a human-readable format."""
+    timestamp = os.path.getmtime(filename)
+    readable_time = datetime.fromtimestamp(timestamp).strftime("%d/%m/%y %H:%M:%S")
+    return readable_time
+
 
 def print_server_info():
     """Print information about all matlab-proxy servers (with version > 0.4.0) running on this machine"""
@@ -15,30 +75,15 @@ def print_server_info():
     # Look for files in port folders
     ports_folder = home_folder / "ports"
     search_string = str(ports_folder) + "/**/mwi_server.info"
+    servers = sorted(glob.glob(search_string), key=os.path.getmtime)
 
-    print_output = str(
-        mwi_util.prettify(
-            boundary_filler="-",
-            text_arr=["Your running servers are:"],
-        )
-    )
-    print_output += "\n"
-    search_results = sorted(glob.glob(search_string), key=os.path.getmtime)
-    if len(search_results) == 0:
-        print_output += "No MATLAB-PROXY Servers are currently running."
-    else:
-        server_number = 0
-        for server in search_results:
-            server_number += 1
+    args = mwi_util.parse_list_cli_args()
+
+    if args["quiet"]:
+        for server in servers:
             with open(server) as f:
                 server_info = f.readline().strip()
-                print_output += str(server_number) + ".  " + str(server_info) + "\n"
-
-    print_output += str(
-        mwi_util.prettify(
-            boundary_filler="-",
-            text_arr=["Thank you."],
-        )
-    )
-
-    return print_output
+                print(f"{server_info}", end="\n")
+    else:
+        _print_server_info_as_table(servers)
+    return

matlab_proxy/util/mwi/environment_variables.py

@@ -213,3 +213,13 @@ def get_env_name_use_cookie_cache():
     def should_use_cookie_cache():
         """Returns true if the cookie jar support is enabled."""
         return _is_env_set_to_true(Experimental.get_env_name_use_cookie_cache())
+
+    @staticmethod
+    def get_env_name_use_rich_logging():
+        """Set to True to enable rich logging to console."""
+        return "MWI_USE_RICH_LOGGING"
+
+    @staticmethod
+    def use_rich_logger():
+        """Returns true if the cookie jar support is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_use_rich_logging())