fix progress conflict with cli prompt (#507)

Author: iferencik

rapida/cli/__init__.py

@@ -53,7 +53,7 @@ def cli(ctx):
     progress = Progress(disable=False, console=None, transient=True)
 
     # 4. Spin up the progress display canvas
-    progress.start()
+    #progress.start()
 
     # 5. Inject it into Click's shared context object
     ctx.obj['progress'] = progress

rapida/cli/aclick.py

@@ -52,7 +52,11 @@ def list_commands(self, ctx):
 
     def add_command(self, cmd: click.Command, name: str = None) -> None:
         # Catch-all: forces help display if a subcommand is run empty
-        #cmd.no_args_is_help = True
+        has_required_params = any(param.required for param in cmd.params)
+        is_grp = isinstance(cmd, click.Group) or issubclass(cmd.__class__, self.__class__)
+        #print(cmd.name, has_required_params, is_grp, cmd.params)
+        # if not is_grp and has_required_params:
+        #     cmd.no_args_is_help = True
         # 2. Automatically inject --debug into every registered subcommand
         cmd.params.append(
             click.Option(

rapida/cli/auth.py

@@ -1,7 +1,7 @@
 import logging
 from rapida.az.surgeauth import SurgeTokenCredential
 import click
-from rapida.util.setup_logger import setup_logger
+
 
 
 logger = logging.getLogger(__name__)
@@ -18,7 +18,6 @@ def auth(cache_dir):
     """
     Authenticate with  UNDP account
     """
-    # setup_logger(name='rapida', level=logging.DEBUG if debug else logging.INFO)
 
     credential = SurgeTokenCredential(cache_dir=cache_dir)
     token, exp_ts = credential.get_token("https://storage.azure.com/.default",)

rapida/cli/connectivity.py

@@ -88,7 +88,8 @@ async def connectivity(ctx, bbox:tuple[float, float, float, float]=None, travel_
     ):
     logger.info(f'Running connectivity analysis ')
     progress = ctx.obj.get('progress')
-    return await run_connectivity_analysis(
-        bbox=bbox, dst_dir=dst_dir, travel_mode=travel_mode, time_intervals=time_intervals,
-        barriers_dataset=barriers_dataset, barriers_layer=barriers_layer, barriers_buffer=barriers_buffer, progress=progress
-    )
+    with progress:
+        return await run_connectivity_analysis(
+            bbox=bbox, dst_dir=dst_dir, travel_mode=travel_mode, time_intervals=time_intervals,
+            barriers_dataset=barriers_dataset, barriers_layer=barriers_layer, barriers_buffer=barriers_buffer, progress=progress
+        )

rapida/cli/create.py

@@ -3,7 +3,6 @@
 import click
 import sys
 from rapida.session import is_rapida_initialized
-from rapida.util.setup_logger import setup_logger
 from rapida.project.project import Project
 
 logger = logging.getLogger(__name__)

rapida/cli/delete.py

@@ -34,7 +34,6 @@ def delete(project: str, no_input: bool = False, ):
         rapida delete --project=<project folder path>: If you are not in a project folder
 
     """
-    #setup_logger(name='rapida', level=logging.DEBUG if debug else logging.INFO)
 
     if not is_rapida_initialized():
         return

rapida/cli/download.py

@@ -3,9 +3,7 @@
 import logging
 from rapida.az.fileshare import download_project
 from rich.progress import Progress
-
 from rapida.session import is_rapida_initialized
-from rapida.util.setup_logger import setup_logger
 from rapida.project.project import Project
 
 logger = logging.getLogger(__name__)
@@ -24,11 +22,8 @@
               is_flag=True,
               default=False,
               help="Whether to overwrite the project in case it already exists locally.")
-@click.option('--debug',
-              is_flag=True,
-              default=False,
-              help="Set log level to debug")
-def download(project_name=None, destination_folder=None, max_concurrency=None,force=None, debug: bool =False ):
+
+def download(project_name=None, destination_folder=None, max_concurrency=None,force=None):
     """
     Download a project from Azure File Share.
 
@@ -51,7 +46,6 @@ def download(project_name=None, destination_folder=None, max_concurrency=None,fo
     To use `-f/--force`, project data will be overwritten if it already exists in local storage.
 
     """
-    setup_logger(name='rapida', level=logging.DEBUG if debug else logging.INFO)
 
     if not is_rapida_initialized():
         return

rapida/cli/init.py

@@ -79,13 +79,13 @@ def setup_prompt(session: Session):
               default=False,
               help="Optional. If True, it will automatically answer yes to prompts. Default is False.")
 
-def init(no_input: bool = False, debug=False):
+def init(no_input: bool = False):
     """
     Initialize RAPIDA tool. This command will creates a config file under user home directory (~/.rapida/config.json) to setup RAPIDA tool.
 
     Use `--no-input` to disable prompting. Default is False.
     """
-    setup_logger(name='rapida', level=logging.DEBUG if debug else logging.INFO)
+
 
     click.echo("Welcome to rapida CLI tool!")
     with Session() as session:

rapida/cli/list.py

@@ -2,20 +2,16 @@
 import click
 from rapida.az.fileshare import list_projects
 from rapida.session import is_rapida_initialized
-from rapida.util.setup_logger import setup_logger
 
 
 logger = logging.getLogger(__name__)
 
 
 @click.command(short_help=f'list RAPIDA projects/folders located in default Azure file share')
-@click.option('--debug',
-              is_flag=True,
-              default=False,
-              help="Set log level to debug"
-              )
-def list_project(debug=False):
-    setup_logger(name='rapida', level=logging.DEBUG if debug else logging.INFO)
+
+
+def list_project():
+
 
     if not is_rapida_initialized():
         return

rapida/cli/ntl.py

@@ -114,35 +114,36 @@ def search():
 async def search_noaa(ctx, bbox:tuple[float, float, float, float]=None, nominal_date:datetime=None, satellites:list[str] = [], cmask:bool=None):
 
     progress = ctx.obj.get('progress')
-    table = Table(title=f"VIIRS satellites granules for the night of  {nominal_date.date()} covering {bbox}",
-                  title_style="bold yellow")
-    table.add_column("Position", justify="center", style="white")
-    table.add_column("Satellite", style="green", justify='center')
-    table.add_column("Timestamp (UTC)", style="cyan", justify='center')
-    # table.add_column("Scan Start Date and Time (UTC)", style="red", justify='center')
-    table.add_column("Bbox offset from SSP (km)", justify="center", style="white")
-    table.add_column("Elevation above bbox (degrees)", justify="center", style="white")
-    if cmask:
-        table.add_column("Cloud coverage in bbox (%)", justify="center", style="white")
-    table.add_column("Score (%)", justify="center", style="white")
-    table.add_column("BBOX intersection (%)", justify="center", style="white")
-
-    granules = await async_search_granules(
-        satellites=satellites, nominal_date=nominal_date, bbox=bbox,
-        cmask=cmask, progress=progress)
-    if granules:
-        for i, granule in enumerate(granules, start=1):
-            if cmask:
-                values = f'{i}', granule.sat, granule.timestamp, f'{granule.offset}', f'{granule.elevation:.2f}', f'{granule.cloud_cover}', f'{granule.rank}', f'{granule.pint}'
-            else:
-                values = f'{i}', granule.sat, granule.timestamp, f'{granule.offset}', f'{granule.elevation:.2f}', f'{granule.rank}', f'{granule.pint}'
-            table.add_row(*values)
-
-    if table.row_count == 0:
-        progress.console.print("[bold red]No granules found for this criteria.[/bold red]")
-    else:
-        progress.console.print(table)
-        progress.console.print(f"\n[dim]Note: Each granule represents {1025 / 12:.2f}s of instrument data.[/dim]")
+    with progress:
+        table = Table(title=f"VIIRS satellites granules for the night of  {nominal_date.date()} covering {bbox}",
+                      title_style="bold yellow")
+        table.add_column("Position", justify="center", style="white")
+        table.add_column("Satellite", style="green", justify='center')
+        table.add_column("Timestamp (UTC)", style="cyan", justify='center')
+        # table.add_column("Scan Start Date and Time (UTC)", style="red", justify='center')
+        table.add_column("Bbox offset from SSP (km)", justify="center", style="white")
+        table.add_column("Elevation above bbox (degrees)", justify="center", style="white")
+        if cmask:
+            table.add_column("Cloud coverage in bbox (%)", justify="center", style="white")
+        table.add_column("Score (%)", justify="center", style="white")
+        table.add_column("BBOX intersection (%)", justify="center", style="white")
+
+        granules = await async_search_granules(
+            satellites=satellites, nominal_date=nominal_date, bbox=bbox,
+            cmask=cmask, progress=progress)
+        if granules:
+            for i, granule in enumerate(granules, start=1):
+                if cmask:
+                    values = f'{i}', granule.sat, granule.timestamp, f'{granule.offset}', f'{granule.elevation:.2f}', f'{granule.cloud_cover}', f'{granule.rank}', f'{granule.pint}'
+                else:
+                    values = f'{i}', granule.sat, granule.timestamp, f'{granule.offset}', f'{granule.elevation:.2f}', f'{granule.rank}', f'{granule.pint}'
+                table.add_row(*values)
+
+        if table.row_count == 0:
+            progress.console.print("[bold red]No granules found for this criteria.[/bold red]")
+        else:
+            progress.console.print(table)
+            progress.console.print(f"\n[dim]Note: Each granule represents {1025 / 12:.2f}s of instrument data.[/dim]")
 
 
 @search.command(name='nasa', short_help=f'Search for available NTL science data from NASA source')
@@ -187,7 +188,6 @@ async def search_noaa(ctx, bbox:tuple[float, float, float, float]=None, nominal_
 def search_nasa(ctx, bbox:tuple[tuple[float, float, float, float]]=None, nominal_date:datetime=None, stream:str = None, processing_level:str=None, route:str=None):
 
     progress = ctx.obj.get('progress')
-
     urls = nasa_search(processing_level=processing_level, nominal_date=nominal_date,
                        bbox=bbox, stream=stream, route=route, progress=progress, push_to_cache=True)
 
@@ -259,28 +259,29 @@ async def download_nasa(ctx, timestamp:str = None, product:str=None, tile:str=No
     if tile and bbox:
         raise click.UsageError("Illegal usage: `--tile` and `--bbox` are mutually exclusive.")
 
-    downloaded_files = await download_from_nasa(timestamp=timestamp, product=product,
-                                                tile=tile, bbox=bbox, dst_dir=dst_dir,progress=progress)
+    with progress:
+        downloaded_files = await download_from_nasa(timestamp=timestamp, product=product,
+                                                    tile=tile, bbox=bbox, dst_dir=dst_dir,progress=progress)
 
 
 
-    if downloaded_files:
-        table = Table(title=f"Downloaded files for {product.upper()} {timestamp} ", title_style="bold yellow")
+        if downloaded_files:
+            table = Table(title=f"Downloaded files for {product.upper()} {timestamp} ", title_style="bold yellow")
 
-        table.add_column("Path", style="red", justify='center')
-        table.add_column("Timestamp", style="red", justify='center')
-        table.add_column("Tile", style="red", justify='center')
-        table.add_column("Size", style="green", justify='center')
-        for timestamp, files in downloaded_files.items():
-            for local_file_path in files:
-                _, file_name = os.path.split(local_file_path)
-                file_size = os.path.getsize(local_file_path)
-                m = NTL_FILENAME_PATTERN.match(file_name)
-                meta = m.groupdict()
-                tile = meta['tile']
-                table.add_row(local_file_path, timestamp, tile, f'{file_size}')
+            table.add_column("Path", style="red", justify='center')
+            table.add_column("Timestamp", style="red", justify='center')
+            table.add_column("Tile", style="red", justify='center')
+            table.add_column("Size", style="green", justify='center')
+            for timestamp, files in downloaded_files.items():
+                for local_file_path in files:
+                    _, file_name = os.path.split(local_file_path)
+                    file_size = os.path.getsize(local_file_path)
+                    m = NTL_FILENAME_PATTERN.match(file_name)
+                    meta = m.groupdict()
+                    tile = meta['tile']
+                    table.add_row(local_file_path, timestamp, tile, f'{file_size}')
 
-        progress.console.print(table)
+            progress.console.print(table)
 
 
 @download.command(name='noaa', short_help=f'Download operational NTL data from NOAA')
@@ -325,22 +326,23 @@ async def download_nasa(ctx, timestamp:str = None, product:str=None, tile:str=No
 @click.pass_context
 async def download_noaa(ctx, satellite:str=None, timestamp:str=None, products:Iterable[str]=None, source:str=None, dst_dir:str=None ):
     progress = ctx.obj.get('progress')
-    downloaded_files = await download_from_noaa(satellite=satellite,timestamp=timestamp,
-                           source=source, products=products,dest_dir=dst_dir, progress=progress)
+    with progress:
+        downloaded_files = await download_from_noaa(satellite=satellite,timestamp=timestamp,
+                               source=source, products=products,dest_dir=dst_dir, progress=progress)
 
-    if downloaded_files:
-        table = Table(title=f"VIIRS satellites images for the night of  {timestamp} ",
-                      title_style="bold yellow")
+        if downloaded_files:
+            table = Table(title=f"VIIRS satellites images for the night of  {timestamp} ",
+                          title_style="bold yellow")
 
-        table.add_column("Satellite", style="green", justify='center')
-        table.add_column("Timestamp (UTC)", style="cyan", justify='center')
-        table.add_column("Downloaded file", justify="left", style="red")
-        table.add_column("File size", justify="center", style="white")
+            table.add_column("Satellite", style="green", justify='center')
+            table.add_column("Timestamp (UTC)", style="cyan", justify='center')
+            table.add_column("Downloaded file", justify="left", style="red")
+            table.add_column("File size", justify="center", style="white")
 
-        for _, local_file_path, file_size in downloaded_files:
-            values = satellite, timestamp, f'{local_file_path}', f'{bytesto(file_size, "m"):.2f} MB'
-            table.add_row(*values)
-        progress.console.print(table)
+            for _, local_file_path, file_size in downloaded_files:
+                values = satellite, timestamp, f'{local_file_path}', f'{bytesto(file_size, "m"):.2f} MB'
+                table.add_row(*values)
+            progress.console.print(table)
 
 
 
@@ -391,28 +393,28 @@ async def download_noaa(ctx, satellite:str=None, timestamp:str=None, products:It
 async def bulk_download(ctx, bbox:tuple[float, float, float, float]=None, start_date:datetime=None, end_date:datetime=None,
                             products:str=None, dst_dir:str=None):
     progress = ctx.obj.get('progress')
+    with progress:
+        if start_date > end_date:
+            raise click.UsageError(f'--from {start_date} must be smaller or equal then --to {end_date}')
 
-    if start_date > end_date:
-        raise click.UsageError(f'--from {start_date} must be smaller or equal then --to {end_date}')
-
-    if 'nrt' in products[0].lower():
-        stream = OPERATIONAL
-        now = datetime.now()
-
-        start_days_difference = abs((now - start_date).days)
-        if start_days_difference > 7:
-            raise ValueError(f'Invalid start_date={start_date}.{stream} stream holds max 7 days of data. ')
-        end_days_difference = abs((now - end_date).days)
-        if end_days_difference > 7:
-            raise ValueError(f'Invalid start_date={end_date}.{stream} stream holds max 7 days of data. ')
-
-    else:
-        stream = ARCHIVE
-    downloaded_files = await bdownload(
-        bbox=bbox, start_date=start_date, end_date=end_date,
-        stream=stream, products=products,
-        dst_dir=dst_dir,progress=progress
-    )
+        if 'nrt' in products[0].lower():
+            stream = OPERATIONAL
+            now = datetime.now()
+
+            start_days_difference = abs((now - start_date).days)
+            if start_days_difference > 7:
+                raise ValueError(f'Invalid start_date={start_date}.{stream} stream holds max 7 days of data. ')
+            end_days_difference = abs((now - end_date).days)
+            if end_days_difference > 7:
+                raise ValueError(f'Invalid start_date={end_date}.{stream} stream holds max 7 days of data. ')
+
+        else:
+            stream = ARCHIVE
+        downloaded_files = await bdownload(
+            bbox=bbox, start_date=start_date, end_date=end_date,
+            stream=stream, products=products,
+            dst_dir=dst_dir,progress=progress
+        )
 
 
 
@@ -457,7 +459,8 @@ async def bulk_download(ctx, bbox:tuple[float, float, float, float]=None, start_
 async def fetch(ctx, bbox:tuple[float, float, float, float]=None, nominal_date:datetime=None, deliverable:str=None, dst_dir:str=None):
 
     progress = ctx.obj.get('progress')
-    return await fetch_ntl(bbox=bbox,nominal_date=nominal_date, deliverable=deliverable, progress=progress, dst_dir=dst_dir )
+    with progress:
+        return await fetch_ntl(bbox=bbox,nominal_date=nominal_date, deliverable=deliverable, progress=progress, dst_dir=dst_dir )
 
 
 @ntl.command(short_help=f'Execute crisis impact detection (48h Alerts / 72h Assessments)')
@@ -527,10 +530,11 @@ async def fetch(ctx, bbox:tuple[float, float, float, float]=None, nominal_date:d
 async def detect(ctx, bbox:tuple[float, float, float, float]=None, nominal_date:datetime=None, deliverable:str=None,
                  mask_clouds:bool=True, dst_dir:str=None, percentage_drop:int=None, display:bool=False):
     progress = ctx.obj.get('progress')
-    return await detect_outage(
-        bbox=bbox, nominal_date=nominal_date, deliverable=deliverable, dst_dir=dst_dir,
-        progress=progress, mask_clouds=mask_clouds, percentage_drop=percentage_drop, display=display
-    )
+    with progress:
+        return await detect_outage(
+            bbox=bbox, nominal_date=nominal_date, deliverable=deliverable, dst_dir=dst_dir,
+            progress=progress, mask_clouds=mask_clouds, percentage_drop=percentage_drop, display=display
+        )