Clean up logging

.gitignore

@@ -184,3 +184,4 @@ cython_debug/
 build_info.*
 doc/source/api/_autosummary
 test_run/
+**/dt_download/worker/**

examples/basic/00_file_operations_client.py

@@ -43,10 +43,11 @@
 import typer
 from typing_extensions import Annotated
 
-from ansys.hps.data_transfer.client import Client, DataTransferApi
+from ansys.hps.data_transfer.client import Client, DataTransferApi, get_log_level
 from ansys.hps.data_transfer.client.authenticate import authenticate
 from ansys.hps.data_transfer.client.models.msg import SrcDst, StoragePath
 
+
 log = logging.getLogger(__name__)
 
 ####################################
@@ -56,11 +57,6 @@ def file_operations(api: DataTransferApi, local_path: str, remote_path: Optional
     if not remote_path:
         remote_path = Path(local_path).parent.name
 
-    log.info("Query storages ...")
-    storages = api.storages()
-    storage_names = [f"{storage['name']}({storage['type']})" for storage in storages]
-    log.info(f"Available storages: {storage_names}")
-
     log.info("Creating a directory ...")
     base_dir = "basic-example"
     mkdir_op = api.mkdir([StoragePath(path=f"{base_dir}")])
@@ -73,12 +69,10 @@ def file_operations(api: DataTransferApi, local_path: str, remote_path: Optional
 
     op = api.copy([SrcDst(src=src, dst=dst) for src, dst in zip(srcs, dsts)])
     op = api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
 
     log.info("Listing files ...")
     op = api.list([StoragePath(path=base_dir)])
     op = api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
     log.info(f"Files in {base_dir}: {op[0].result}")
 
     log.info("Getting metadata ...")
@@ -90,7 +84,6 @@ def file_operations(api: DataTransferApi, local_path: str, remote_path: Optional
     log.info("Removing files ...")
     op = api.rmdir([StoragePath(path=base_dir)])
     op = api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
 
 ####################################
 # Define the main function
@@ -99,16 +92,15 @@ def main(
     local_path: Annotated[str, typer.Option(help="Path to the files or directory to transfer. Supports wildcards.")],
     remote_path: Annotated[str, typer.Option(help="Optional path to the remote directory to transfer files to.")] = None,
     debug: Annotated[bool, typer.Option(help="Enable debug logging.")] = False,
+    verbosity: Annotated[int, typer.Option(help="Increase verbosity")] = 1,
     url: Annotated[str, typer.Option(help="HPS URL to connect to.")] = "https://localhost:8443/hps",
     username: Annotated[str, typer.Option(help="Username to authenticate with.")] = "repadmin",
     password: Annotated[
         str, typer.Option(prompt=True, hide_input=True, help="Password to authenticate with.")
     ] = "repadmin",
 ):
+    logging.basicConfig(format="%(levelname)8s > %(message)s", level=get_log_level(verbosity, debug))
 
-    logging.basicConfig(
-        format="[%(asctime)s | %(levelname)s] %(message)s", level=logging.DEBUG if debug else logging.INFO
-    )
 
     dt_url = f"{url}/dt/api/v1"
     auth_url = f"{url}/auth/realms/rep"
@@ -121,8 +113,9 @@ def main(
     client = Client(clean=True)
 
     client.binary_config.update(
-        verbosity=3,
-        debug=False,
+        verbosity=verbosity,
+        debug=debug,
+        log=debug,
         insecure=True,
         token=token,
         data_transfer_url=dt_url,

examples/basic/01_async_data_transfer_client.py

@@ -44,24 +44,23 @@
 import typer
 from typing_extensions import Annotated
 
-from ansys.hps.data_transfer.client import AsyncClient, AsyncDataTransferApi
+from ansys.hps.data_transfer.client import AsyncClient, AsyncDataTransferApi, get_log_level
 from ansys.hps.data_transfer.client.authenticate import authenticate
 from ansys.hps.data_transfer.client.models.msg import SrcDst, StoragePath
 
-log = logging.getLogger(__name__)
-logger = logging.getLogger()
-logging.basicConfig(format="%(asctime)s %(levelname)8s > %(message)s", level=logging.DEBUG)
-
-
 async def main(
     debug: Annotated[bool, typer.Option(help="Enable debug logging")] = False,
+    verbosity: Annotated[int, typer.Option(help="Increase verbosity")] = 1,
     url: Annotated[str, typer.Option(help="HPS URL to connect to")] = "https://localhost:8443/hps",
     username: Annotated[str, typer.Option(help="Username to authenticate with")] = "repadmin",
     password: Annotated[
         str, typer.Option(prompt=True, hide_input=True, help="Password to authenticate with")
     ] = "repadmin",
 ):
 
+    log = logging.getLogger()
+    logging.basicConfig(format="%(levelname)8s > %(message)s", level=get_log_level(verbosity, debug))
+
     dt_url = f"{url}/dt/api/v1"
     auth_url = f"{url}/auth/realms/rep"
     token = authenticate(username=username, password=password, verify=False, url=auth_url)
@@ -75,7 +74,7 @@ async def main(
     client = AsyncClient(clean=True)
 
     client.binary_config.update(
-        verbosity=3,
+        verbosity=verbosity,
         debug=debug,
         insecure=True,
         token=token,
@@ -113,20 +112,17 @@ async def main(
 
     op = await api.copy([SrcDst(src=src, dst=dst) for src, dst in zip(srcs, dsts)])
     op = await api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
 
     files = glob.glob(os.path.join(os.path.dirname(__file__), "*.txt"))
     srcs = [StoragePath(path=file, remote="local") for file in files]
     dsts = [StoragePath(path=f"{os.path.basename(file)}") for file in files]
 
     op = await api.copy([SrcDst(src=src, dst=dst) for src, dst in zip(srcs, dsts)])
     op = await api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
 
     log.info("Listing files ...")
     op = await api.list([StoragePath(path=base_dir)])
     op = await api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
     log.info(f"Files in {base_dir}: {op[0].result}")
 
     log.info("Getting metadata ...")
@@ -138,7 +134,6 @@ async def main(
     log.info("Removing files ...")
     op = await api.rmdir([StoragePath(path=base_dir)])
     op = await api.wait_for([op.id])
-    log.info(f"Operation {op[0].state}")
 
     await client.stop()
 

examples/permissions/set_permissions_example.py

@@ -44,7 +44,7 @@
 import typer
 from typing_extensions import Annotated
 
-from ansys.hps.data_transfer.client import Client, DataTransferApi
+from ansys.hps.data_transfer.client import Client, DataTransferApi, get_log_level
 from ansys.hps.data_transfer.client.authenticate import authenticate
 from ansys.hps.data_transfer.client.models.msg import SrcDst, StoragePath
 from ansys.hps.data_transfer.client.models.permissions import (
@@ -235,15 +235,14 @@ def permissions(api: DataTransferApi, url: str):
 # ========================
 def main(
     debug: Annotated[bool, typer.Option(help="Enable debug logging")] = False,
+    verbosity: Annotated[int, typer.Option(help="Increase verbosity")] = 1,
     url: Annotated[str, typer.Option(help="HPS URL to connect to")] = "https://localhost:8443/hps",
     username: Annotated[str, typer.Option(help="Username to authenticate with")] = "repadmin",
     password: Annotated[
         str, typer.Option(prompt=True, hide_input=True, help="Password to authenticate with")
     ] = "repadmin",
 ):
-    logging.basicConfig(
-        format="[%(asctime)s | %(levelname)s] %(message)s", level=logging.DEBUG if debug else logging.INFO
-    )
+    logging.basicConfig(format="%(levelname)8s > %(message)s", level=get_log_level(verbosity, debug))
 
     dt_url = f"{url}/dt/api/v1"
     auth_url = f"{url}/auth/realms/rep"
@@ -256,8 +255,8 @@ def main(
     client = Client(clean=True)
 
     client.binary_config.update(
-        verbosity=3,
-        debug=False,
+        verbosity=verbosity,
+        debug=debug,
         insecure=True,
         token=token,
         data_transfer_url=dt_url,

examples/startup/data_transfer_runner.py

@@ -40,12 +40,13 @@
 import typer
 from typing_extensions import Annotated
 
-from ansys.hps.data_transfer.client import Client, DataTransferApi
+from ansys.hps.data_transfer.client import Client, DataTransferApi, get_log_level
 from ansys.hps.data_transfer.client.authenticate import authenticate
 
 
 def main(
     debug: Annotated[bool, typer.Option(help="Enable debug logging")] = False,
+    verbosity: Annotated[int, typer.Option(help="Increase verbosity")] = 1,
     url: Annotated[str, typer.Option(help="HPS URL to connect to")] = "https://localhost:8443/hps",
     username: Annotated[str, typer.Option(help="Username to authenticate with")] = "repadmin",
     password: Annotated[
@@ -55,34 +56,43 @@ def main(
 
     auth_url = f"{url}/auth/realms/rep"
     log = logging.getLogger()
-    logging.basicConfig(format="%(levelname)8s > %(message)s", level=logging.DEBUG)
+    logging.basicConfig(format="%(levelname)8s > %(message)s", level=get_log_level(verbosity, debug))
 
     user_token = authenticate(username=username, password=password, verify=False, url=auth_url)
     user_token = user_token.get("access_token", None)
     assert user_token is not None
 
     client = Client()
     client.binary_config.update(
-        verbosity=3,
-        debug=debug,
         insecure=True,
         token=user_token,
+        verbosity=verbosity,
     )
+    if debug:
+        client.binary_config.update(verbosity=3, debug=True)
 
-    client.binary_config.debug = True
     client.start()
     api = DataTransferApi(client)
     s = api.status(wait=True)
-    log.info("Status: %s" % s)
 
+    log.info("--- Worker info ---")
+    log.info(f"Ready: {s.ready}")
+    log.info(f"Build info:")
+    for k, v in s.build_info.__dict__.items():
+        log.info(f"  {k}: {v}")
+    log.info(f"Features:")
+    for k, v in s.features.__dict__.items():
+        log.info(f"  {k}: {v}")
     log.info("Available storage:")
     for d in api.storages():
-        log.info(f"- {json.dumps(d, indent=4)}")
+        log.info(f"  name={d['name']} type={d['type']} priority={d['priority']}")
 
-    for i in range(10):
+    log.info("--- Idling for a while ---")
+    for i in range(5):
         log.info("Idling for a while...")
         time.sleep(2)
 
+    log.info("--- Stopping ---")
     client.stop()