# Copyright (c) 2022, IRIS-HEP
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from typing import Optional
import rich
import typer
from servicex import servicex_client
from servicex._version import __version__
from servicex.app.cli_options import (
backend_cli_option,
config_file_option,
cache_dir_option,
)
from servicex.app.datasets import datasets_app
from servicex.app.transforms import transforms_app
from servicex.app.cache import cache_app
from servicex.app.codegen import codegen_app
from servicex.app.init import init_app
app = typer.Typer(no_args_is_help=True)
app.add_typer(transforms_app)
app.add_typer(cache_app)
app.add_typer(codegen_app)
app.add_typer(datasets_app)
app.add_typer(init_app)
spec_file_arg = typer.Argument(..., help="Spec file to submit to serviceX")
ignore_cache_opt = typer.Option(
None, "--ignore-cache", help="Ignore local cache and always submit to ServiceX"
)
hide_results_opt = typer.Option(
False,
"--hide-results",
help="Exclude printing results to the console",
)
[docs]
def show_version(show: bool):
"""Display the installed version and quit."""
if show:
rich.print(f"ServiceX {__version__}")
raise typer.Exit()
def _display_results(out_dict):
"""Display the delivery results using rich styling."""
from rich import get_console
console = get_console()
console.print("\n[bold green]✓ ServiceX Delivery Complete![/bold green]\n")
table = rich.table.Table(
title="Delivered Files", show_header=True, header_style="bold magenta"
)
table.add_column("Sample", style="cyan", no_wrap=True)
table.add_column("File Count", justify="right", style="green")
table.add_column("Files", style="dim")
total_files = 0
for sample_name, files in out_dict.items():
if isinstance(files, servicex_client.GuardList) and files.valid():
file_list = list(files)
file_count = len(file_list)
total_files += file_count
# Show first few files with ellipsis if many
if file_count <= 3:
files_display = "\n".join(str(f) for f in file_list)
else:
files_display = "\n".join(str(f) for f in file_list[:2])
files_display += f"\n... and {file_count - 2} more files"
table.add_row(sample_name, str(file_count), files_display)
else:
# Handle error case
table.add_row(
sample_name, "[red]Error[/red]", "[red]Failed to retrieve files[/red]"
)
console.print(table)
console.print(f"\n[bold blue]Total files delivered: {total_files}[/bold blue]\n")
version_opt = typer.Option(None, "--version", callback=show_version, is_eager=True)
[docs]
@app.callback()
def main_info(version: Optional[bool] = version_opt):
"""
ServiceX Client
"""
pass
[docs]
@app.command()
def deliver(
backend: Optional[str] = backend_cli_option,
config_path: Optional[str] = config_file_option,
spec_file: str = spec_file_arg,
ignore_cache: Optional[bool] = ignore_cache_opt,
hide_results: bool = hide_results_opt,
cache_dir: Optional[str] = cache_dir_option,
):
"""
Deliver a file to the ServiceX cache.
"""
print(f"Delivering {spec_file} to ServiceX cache")
results = servicex_client.deliver(
spec_file,
servicex_name=backend,
config_path=config_path,
ignore_local_cache=ignore_cache,
cache_dir=cache_dir,
)
if not hide_results:
_display_results(results)
if __name__ == "__main__":
app()