rda-python-globus 1.0.13__tar.gz → 1.0.17__tar.gz

{rda_python_globus-1.0.13/src/rda_python_globus.egg-info → rda_python_globus-1.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_globus
-Version: 1.0.13
+Version: 1.0.17
 Summary: Tools for managing Globus transfers supporting the NSF NCAR Geoscience Data Exchange (GDEX) project.
 Author-email: Thomas Cram <tcram@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-globus

{rda_python_globus-1.0.13 → rda_python_globus-1.0.17}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rda_python_globus"
-version = "1.0.13"
+version = "1.0.17"
 authors = [
   { name="Thomas Cram", email="tcram@ucar.edu" },
 ]

{rda_python_globus-1.0.13 → rda_python_globus-1.0.17}/src/rda_python_globus/file_management.py

@@ -9,6 +9,7 @@ from .lib import (
     task_submission_options,
     path_options,
     endpoint_options,
+    namespace_options,
     transfer_client,
     process_json_stream,
 )
@@ -40,15 +41,17 @@ def add_batch_to_delete_data(batch, delete_data):
 )
 @endpoint_options
 @path_options
+@namespace_options
 @common_options
 def mkdir_command(
     endpoint: str,
     path: str,
+    namespace: str
 ) -> None:
     """
     Create a directory on a Globus endpoint. Directory path is relative to the endpoint host path.
     """
-    tc = transfer_client()
+    tc = transfer_client(namespace=namespace)
     try:
         res = tc.operation_mkdir(endpoint, path=path)
         click.echo(f"{res['message']}")
@@ -146,12 +149,14 @@ def mkdir_command(
     """),
 )
 @endpoint_options
+@namespace_options
 @common_options
 def rename_command(
     endpoint: str,
     old_path: str,
     new_path: str,
-    batch: t.TextIO
+    batch: t.TextIO,
+    namespace: str
 ) -> None:
     """
     Rename a file or directory on a Globus endpoint. Path is relative to the endpoint host path.
@@ -171,7 +176,7 @@ def rename_command(
             }
         ]
     
-    tc = transfer_client()
+    tc = transfer_client(namespace=namespace)
     for file in files:
         old_path = file["old_path"]
         new_path = file["new_path"]
@@ -262,6 +267,7 @@ def rename_command(
 )
 @endpoint_options
 @task_submission_options
+@namespace_options
 @common_options
 def delete_command(
     endpoint: str,
@@ -270,12 +276,13 @@ def delete_command(
     batch: t.TextIO,
     dry_run: bool,
     recursive: bool,
+    namespace: str,
 ) -> None:
     """
     Delete files and/or directories on a Globus endpoint. Directory
     path is relative to the endpoint host path.
     """
-    tc = transfer_client()
+    tc = transfer_client(namespace=namespace)
     delete_data = DeleteData(tc, endpoint, label=label, recursive=recursive)
 
     # If a batch file is provided, read the file and add to delete data

{rda_python_globus-1.0.13 → rda_python_globus-1.0.17}/src/rda_python_globus/lib/__init__.py

@@ -47,6 +47,17 @@ def path_options(f):
     )(f)
     return f
 
+def namespace_options(f):
+    f = click.option(
+        "--namespace",
+        "-ns",
+        type=str,
+        default="DEFAULT",
+        show_default=True,
+        help="Globus client namespace for the task or operation. Set to 'tacc' to view transfer tasks or operations to/from TACC.",
+    )(f)
+    return f
+
 def valid_uuid(uuid):
     regex = re.compile('^[a-f0-9]{8}-?[a-f0-9]{4}-?[a-f0-9]{4}-?[a-f0-9]{4}-?[a-f0-9]{12}\Z', re.I)
     match = regex.match(uuid)
@@ -226,6 +237,7 @@ __all__ = (
     "task_submission_options",
     "endpoint_options",
     "path_options",
+    "namespace_options",
     "validate_dsid",
     "valid_uuid",
     "validate_endpoint",

{rda_python_globus-1.0.13 → rda_python_globus-1.0.17}/src/rda_python_globus/task_management.py

@@ -7,6 +7,7 @@ from globus_sdk import GlobusAPIError, NetworkError
 
 from .lib import (
     common_options,
+    namespace_options,
     transfer_client,
     colon_formatted_print,
     print_table,
@@ -79,8 +80,9 @@ def _process_filterval(
     "task-id",
     type=click.UUID,
 )
+@namespace_options
 @common_options
-def get_task(task_id: uuid.UUID) -> None:
+def get_task(task_id: uuid.UUID, namespace: str) -> None:
     """ 
     Print information including status about a Globus task.  The task may
     be pending, completed, failed, or in progress.
@@ -88,7 +90,7 @@ def get_task(task_id: uuid.UUID) -> None:
     if not task_id:
         raise click.UsageError("TASK_ID is required.")
 
-    tc = transfer_client()
+    tc = transfer_client(namespace=namespace)
     try:
         task_info = tc.get_task(task_id)
     except (GlobusAPIError, NetworkError) as e:
@@ -159,6 +161,7 @@ def get_task(task_id: uuid.UUID) -> None:
     callback=_format_date_callback,
     help="Filter tasks completed after this date.",
 )
+@namespace_options
 @common_options
 def task_list(
     limit: int,
@@ -169,6 +172,7 @@ def task_list(
     filter_requested_after: Union[str, None],
     filter_completed_before: Union[str, None],
     filter_completed_after: Union[str, None],
+    namespace: str
 ) -> None:
     """ 
     List the most recent Globus tasks with optional filtering.
@@ -199,7 +203,7 @@ def task_list(
         ("Label", "label")
     ]
 
-    tc = transfer_client()
+    tc = transfer_client(namespace=namespace)
     try:
         tasks = tc.task_list(limit=limit, filter=filter_string, orderby="request_time DESC")
     except (GlobusAPIError, NetworkError) as e:
@@ -208,6 +212,55 @@ def task_list(
 
     print_table(tasks, fields)
 
+@click.command(
+    help="List events and show details about a Globus task, including faults and error messages.",
+)
+@click.argument(
+    "task-id",
+    type=click.UUID,
+)
+@click.option(
+    "--limit",
+    "-l",
+    type=int,
+    default=None,
+    show_default=True,
+    help="Limit the number of results returned.",
+)
+@click.option(
+    "--offset",
+    "-o",
+    type=int,
+    default=None,
+    help="Offset used in pagination.",
+)
+@click.option(
+    "--error-only",
+    "-e",
+    is_flag=True,
+    help="Only show events with error codes.",
+)
+@namespace_options
+@common_options
+def task_event_list(task_id: uuid.UUID, limit: int, offset: int, error_only: bool, namespace: str) -> None:
+    """ 
+    List the events associated with a Globus task.  This includes status
+    updates, error messages, and other information about the task's progress.
+    """
+    if not task_id:
+        raise click.UsageError("TASK_ID is required.")
+    
+    tc = transfer_client(namespace=namespace)
+    try:
+        if error_only:
+            filters = {"filter": "is_error:1"}
+        for event in tc.task_event_list(task_id, limit=limit, offset=offset, query_params=filters):
+            print(f"Event on Task({task_id}) at {event['time']}:\n{event['code']}\n{event['description']}\n{event['details']}\n")
+    except (GlobusAPIError, NetworkError) as e:
+        logger.error(f"Error: {e}")
+        click.echo("Failed to get task events.")
+        return
+
 @click.command(
     help="Cancel a Globus task.",
 )
@@ -215,8 +268,9 @@ def task_list(
     "task-id",
     type=click.UUID,
 )
+@namespace_options
 @common_options
-def cancel_task(task_id: uuid.UUID) -> None:
+def cancel_task(task_id: uuid.UUID, namespace: str) -> None:
     """
     Cancel a Globus task.  This includes a task that is currently 
     executing or queued for execution.
@@ -224,7 +278,7 @@ def cancel_task(task_id: uuid.UUID) -> None:
     if not task_id:
         raise click.UsageError("TASK_ID is required.")
     
-    tc = transfer_client()
+    tc = transfer_client(namespace=namespace)
     try:
         res = tc.cancel_task(task_id)
         click.echo(f"Task {task_id}\n{res['message']}")
@@ -236,4 +290,5 @@ def add_commands(group):
     """ Add task management commands to a click group. """
     group.add_command(get_task)
     group.add_command(task_list)
+    group.add_command(task_event_list)
     group.add_command(cancel_task)

{rda_python_globus-1.0.13 → rda_python_globus-1.0.17/src/rda_python_globus.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_globus
-Version: 1.0.13
+Version: 1.0.17
 Summary: Tools for managing Globus transfers supporting the NSF NCAR Geoscience Data Exchange (GDEX) project.
 Author-email: Thomas Cram <tcram@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-globus