Migrate client-side utility functions to a separate module (#563)

* Migrated client-side only functions to murfey.util.client
* Added logic to 'read_config()' to look for a file under 'MURFEY_CLIENT_CONFIGURATION' first before defaulting to looking for 'MURFEY_CLIENT_CONFIG_HOME' and then the default home
* Added unit tests for most of the migrated functions

Author: tieneupin

src/murfey/client/__init__.py

@@ -2,8 +2,6 @@
 
 import argparse
 import configparser
-
-# import json
 import logging
 import os
 import platform
@@ -12,57 +10,26 @@
 import time
 import webbrowser
 from datetime import datetime
-from functools import partial
 from pathlib import Path
 from queue import Queue
 from typing import List, Literal
 from urllib.parse import ParseResult, urlparse
 
 import requests
-
-# from multiprocessing import Process, Queue
 from rich.prompt import Confirm
 
-import murfey.client.rsync
 import murfey.client.update
 import murfey.client.watchdir
 import murfey.client.websocket
 from murfey.client.customlogging import CustomHandler, DirectableRichHandler
 from murfey.client.instance_environment import MurfeyInstanceEnvironment
 from murfey.client.tui.app import MurfeyTUI
 from murfey.client.tui.status_bar import StatusBar
-from murfey.util import _get_visit_list
-
-# from asyncio import Queue
-
-
-# from rich.prompt import Prompt
-
+from murfey.util.client import _get_visit_list, authorised_requests, read_config
 
 log = logging.getLogger("murfey.client")
 
-
-def read_config() -> configparser.ConfigParser:
-    config = configparser.ConfigParser()
-    try:
-        mcch = os.environ.get("MURFEY_CLIENT_CONFIG_HOME")
-        murfey_client_config_home = Path(mcch) if mcch else Path.home()
-        with open(murfey_client_config_home / ".murfey") as configfile:
-            config.read_file(configfile)
-    except FileNotFoundError:
-        log.warning(
-            f"Murfey client configuration file {murfey_client_config_home / '.murfey'} not found"
-        )
-    if "Murfey" not in config:
-        config["Murfey"] = {}
-    return config
-
-
-token = read_config()["Murfey"].get("token", "")
-
-requests.get = partial(requests.get, headers={"Authorization": f"Bearer {token}"})
-requests.post = partial(requests.post, headers={"Authorization": f"Bearer {token}"})
-requests.delete = partial(requests.delete, headers={"Authorization": f"Bearer {token}"})
+requests.get, requests.post, requests.put, requests.delete = authorised_requests()
 
 
 def write_config(config: configparser.ConfigParser):

src/murfey/client/analyser.py

@@ -22,7 +22,7 @@
 from murfey.client.instance_environment import MurfeyInstanceEnvironment
 from murfey.client.rsync import RSyncerUpdate, TransferResult
 from murfey.client.tui.forms import FormDependency
-from murfey.util import Observer, get_machine_config_client
+from murfey.util.client import Observer, get_machine_config_client
 from murfey.util.mdoc import get_block
 from murfey.util.models import PreprocessingParametersTomo, ProcessingParametersSPA
 

src/murfey/client/contexts/clem.py

@@ -14,7 +14,7 @@
 
 from murfey.client.context import Context
 from murfey.client.instance_environment import MurfeyInstanceEnvironment
-from murfey.util import capture_post, get_machine_config_client
+from murfey.util.client import capture_post, get_machine_config_client
 
 # Create logger object
 logger = logging.getLogger("murfey.client.contexts.clem")

src/murfey/client/contexts/fib.py

@@ -10,7 +10,7 @@
 
 from murfey.client.context import Context
 from murfey.client.instance_environment import MurfeyInstanceEnvironment
-from murfey.util import authorised_requests
+from murfey.util.client import authorised_requests
 
 logger = logging.getLogger("murfey.client.contexts.fib")
 

src/murfey/client/contexts/spa.py

@@ -15,7 +15,7 @@
     MurfeyID,
     MurfeyInstanceEnvironment,
 )
-from murfey.util import (
+from murfey.util.client import (
     authorised_requests,
     capture_get,
     capture_post,

src/murfey/client/contexts/spa_metadata.py

@@ -8,7 +8,11 @@
 from murfey.client.context import Context
 from murfey.client.contexts.spa import _file_transferred_to, _get_source
 from murfey.client.instance_environment import MurfeyInstanceEnvironment, SampleInfo
-from murfey.util import authorised_requests, capture_post, get_machine_config_client
+from murfey.util.client import (
+    authorised_requests,
+    capture_post,
+    get_machine_config_client,
+)
 from murfey.util.spa_metadata import (
     FoilHoleInfo,
     get_grid_square_atlas_positions,

src/murfey/client/contexts/tomo.py

@@ -17,7 +17,11 @@
     MurfeyID,
     MurfeyInstanceEnvironment,
 )
-from murfey.util import authorised_requests, capture_post, get_machine_config_client
+from murfey.util.client import (
+    authorised_requests,
+    capture_post,
+    get_machine_config_client,
+)
 from murfey.util.mdoc import get_block, get_global_data, get_num_blocks
 from murfey.util.tomo import midpoint
 

src/murfey/client/multigrid_control.py

@@ -20,7 +20,8 @@
 from murfey.client.rsync import RSyncer, RSyncerUpdate, TransferResult
 from murfey.client.tui.screens import determine_default_destination
 from murfey.client.watchdir import DirWatcher
-from murfey.util import capture_post, get_machine_config_client, posix_path
+from murfey.util import posix_path
+from murfey.util.client import capture_post, get_machine_config_client
 
 log = logging.getLogger("murfey.client.mutligrid_control")
 

src/murfey/client/rsync.py

@@ -19,7 +19,7 @@
 from urllib.parse import ParseResult
 
 from murfey.client.tui.status_bar import StatusBar
-from murfey.util import Observer
+from murfey.util.client import Observer
 
 logger = logging.getLogger("murfey.client.rsync")
 

src/murfey/client/tui/app.py

@@ -33,10 +33,10 @@
 from murfey.client.tui.status_bar import StatusBar
 from murfey.client.watchdir import DirWatcher
 from murfey.client.watchdir_multigrid import MultigridDirWatcher
-from murfey.util import (
+from murfey.util import posix_path
+from murfey.util.client import (
     capture_post,
     get_machine_config_client,
-    posix_path,
     read_config,
     set_default_acquisition_output,
 )