cmem-cmemc 24.3.3__py3-none-any.whl → 25.1.0__py3-none-any.whl

cmem_cmemc/commands/scheduler.py

@@ -3,7 +3,7 @@
 from typing import Any
 
 import click
-from click import Argument
+from click import Argument, ClickException, UsageError
 from cmem.cmempy.config import get_cmem_base_uri
 from cmem.cmempy.workflow.workflow import get_workflow_editor_uri
 from cmem.cmempy.workspace.search import list_items
@@ -68,7 +68,7 @@ def open_command(app: ApplicationContext, scheduler_ids: tuple[str, ...], workfl
     all_scheduler_ids = [s["projectId"] + ":" + s["id"] for s in schedulers]
     for scheduler_id in scheduler_ids:
         if scheduler_id not in all_scheduler_ids:
-            raise ValueError(f"Scheduler '{scheduler_id}' not found.")
+            raise ClickException(f"Scheduler '{scheduler_id}' not found.")
     for scheduler_id in scheduler_ids:
         for _ in schedulers:
             current_id = _["projectId"] + ":" + _["id"]
@@ -158,7 +158,7 @@ def disable_command(app: ApplicationContext, scheduler_ids: list[str], all_: boo
     them one after the other.
     """
     if not scheduler_ids and not all_:
-        raise ValueError(
+        raise UsageError(
             "Either specify at least one scheduler ID or use "
             "the --all option to disable all scheduler."
         )
@@ -201,7 +201,7 @@ def enable_command(app: ApplicationContext, scheduler_ids: list[str], all_: bool
     them one after the other.
     """
     if not scheduler_ids and not all_:
-        raise ValueError(
+        raise UsageError(
             "Either specify at least one scheduler ID or use "
             "the --all option to enable all scheduler."
         )

cmem_cmemc/commands/store.py

@@ -96,7 +96,7 @@ def showcase_command(app: ApplicationContext, scale: int, create: bool, delete:
     graphs).
     """
     if not delete and not create:
-        raise ValueError("Either use the --create or the --delete flag.")
+        raise UsageError("Either use the --create or the --delete flag.")
     if delete:
         raise NotImplementedError(
             "This feature is not implemented yet. " "Please delete the graphs manually."
@@ -145,7 +145,7 @@ def export_command(
             " Please use the --replace option instead."
         )
     if Path(backup_file).exists() and replace is not True:
-        raise ValueError(
+        raise UsageError(
             f"Export file {backup_file} already exists and --replace option is not used."
         )
     with get_zip() as request:

cmem_cmemc/commands/user.py

@@ -4,6 +4,7 @@ import sys
 from getpass import getpass
 
 import click
+from click import ClickException
 from cmem.cmempy.config import get_keycloak_base_uri, get_keycloak_realm_id
 from cmem.cmempy.keycloak.group import list_groups
 from cmem.cmempy.keycloak.user import (
@@ -139,7 +140,7 @@ def delete_command(app: ApplicationContext, username: str) -> None:
     app.echo_info(f"Deleting user {username} ... ", nl=False)
     users = get_user_by_username(username)
     if not users:
-        raise ValueError(NO_USER_ERROR.format(username))
+        raise ClickException(NO_USER_ERROR.format(username))
 
     delete_user(users[0]["id"])
     app.echo_success("deleted")
@@ -160,7 +161,7 @@ def create_command(app: ApplicationContext, username: str) -> None:
     app.echo_info(f"Creating user {username} ... ", nl=False)
     users = get_user_by_username(username)
     if users:
-        raise ValueError(EXISTING_USER_ERROR.format(username))
+        raise ClickException(EXISTING_USER_ERROR.format(username))
 
     create_user(username=username)
     app.echo_success("done")
@@ -207,21 +208,21 @@ def update_command(  # noqa: PLR0913
     """
     options = (first_name, last_name, email, assign_group, unassign_group)
     if all(_ is None or _ == () for _ in options):
-        raise ValueError(
+        raise click.UsageError(
             "This commands needs to be used with at least one option "
             "(e.g. --email). See the command help for a list of options."
         )
     app.echo_info(f"Updating user {username} ... ", nl=False)
     users = get_user_by_username(username)
     if not users:
-        raise ValueError(NO_USER_ERROR.format(username))
+        raise ClickException(NO_USER_ERROR.format(username))
     user_id = users[0]["id"]
     all_groups = {group["name"]: group["id"] for group in list_groups()}
     invalid_groups = [group for group in assign_group if group not in all_groups]
     existing_user_groups = {group["name"] for group in user_groups(user_id)}
 
     if invalid_groups:
-        raise ValueError(
+        raise ClickException(
             NO_GROUP_ERROR.format(
                 ", ".join(invalid_groups), ", ".join(all_groups.keys() - set(existing_user_groups))
             )
@@ -231,7 +232,7 @@ def update_command(  # noqa: PLR0913
         group for group in unassign_group if group not in existing_user_groups
     ]
     if invalid_unassign_groups:
-        raise ValueError(
+        raise ClickException(
             INVALID_UNASSIGN_GROUP_ERROR.format(
                 ", ".join(invalid_unassign_groups), ", ".join(existing_user_groups)
             )
@@ -286,7 +287,7 @@ def password_command(
     app.echo_info(f"Changing password for account {username} ... ", nl=False)
     users = get_user_by_username(username)
     if not users:
-        raise ValueError(NO_USER_ERROR.format(username))
+        raise ClickException(NO_USER_ERROR.format(username))
     if not value and not request_change:
         app.echo_info("\nNew password: ", nl=False)
         value = getpass(prompt="")
@@ -299,7 +300,7 @@ def password_command(
     if value:
         reset_password(user_id=users[0]["id"], value=value, temporary=temporary)
     if request_change and not users[0].get("email", None):
-        raise ValueError(NO_EMAIL_ERROR.format(username))
+        raise ClickException(NO_EMAIL_ERROR.format(username))
     if request_change:
         request_password_change(users[0]["id"])
     app.echo_success("done")
@@ -330,7 +331,7 @@ def open_command(app: ApplicationContext, usernames: str) -> None:
         user_name_id_map = {u["username"]: u["id"] for u in users}
         for _ in usernames:
             if _ not in user_name_id_map:
-                raise ValueError(NO_USER_ERROR.format(_))
+                raise ClickException(NO_USER_ERROR.format(_))
             user_id = user_name_id_map[_]
             open_user_uri = f"{open_user_base_uri}/{user_id}/settings"
 

cmem_cmemc/commands/validation.py

@@ -330,10 +330,10 @@ def _wait_for_process_completion(
         progress.stop()
         progress.__exit__(None, None, None)
     if state.status == validation.STATUS_CANCELLED:
-        raise ServerError("Process was cancelled.")
+        raise ServerError(app, "Process was cancelled.")
     if state.status == validation.STATUS_ERROR:
         error_message = state.data.get("error", "")
-        raise ServerError(f"Process ended with error: {error_message}")
+        raise ServerError(app, f"Process ended with error: {error_message}")
     return state.status
 
 

cmem_cmemc/commands/variable.py

@@ -34,7 +34,7 @@ def _get_variables_filtered(
     filter_types = VARIABLES_FILTER_TYPES + VARIABLES_FILTER_TYPES_HIDDEN
     # check for correct filter names (filter ids is used internally only)
     if filter_name not in filter_types:
-        raise ValueError(
+        raise UsageError(
             f"{filter_name} is an unknown filter name. " f"Use one of {VARIABLES_FILTER_TYPES}."
         )
     # filter by ID list

cmem_cmemc/commands/vocabulary.py

@@ -6,6 +6,7 @@ from re import match
 from urllib.parse import urlparse
 
 import click
+from click import ClickException
 from cmem.cmempy.config import get_cmem_base_uri
 from cmem.cmempy.dp.proxy import graph as graph_api
 from cmem.cmempy.dp.titles import resolve
@@ -104,7 +105,7 @@ def _validate_namespace(app: ApplicationContext, namespace: tuple[str | None, st
     """User input validation for the namespace."""
     prefix, uri = namespace
     if prefix is None or uri is None:
-        raise ValueError("No namespace given.")
+        raise ClickException("No namespace given.")
 
     if uri[-1] not in ("/", "#"):
         app.echo_warning(
@@ -114,10 +115,10 @@ def _validate_namespace(app: ApplicationContext, namespace: tuple[str | None, st
     parsed_url = urlparse(uri)
     app.echo_debug(str(parsed_url))
     if parsed_url.scheme not in ("http", "https", "urn"):
-        raise ValueError(f"Namespace IRI '{uri}' is not a https(s) URL or an URN.")
+        raise ClickException(f"Namespace IRI '{uri}' is not a https(s) URL or an URN.")
     prefix_expression = r"^[a-z][a-z0-9]*$"
     if not match(prefix_expression, prefix):
-        raise ValueError(
+        raise ClickException(
             "Prefix string does not match this regular" f" expression: {prefix_expression}"
         )
 
@@ -167,14 +168,14 @@ def _get_vocabulary_metadata_from_file(
     try:
         graph = Graph().parse(file, format="ttl")
     except BadSyntax as error:
-        raise ValueError("File {file} could not be parsed as turtle.") from error
+        raise ClickException("File {file} could not be parsed as turtle.") from error
 
     ontology_iris = graph.query(GET_ONTOLOGY_IRI_QUERY)
     if len(ontology_iris) == 0:
-        raise ValueError("There is no owl:Ontology resource described " "in the turtle file.")
+        raise ClickException("There is no owl:Ontology resource described " "in the turtle file.")
     if len(ontology_iris) > 1:
         ontology_iris_str = [str(iri[0]) for iri in ontology_iris]  # type: ignore[index]
-        raise ValueError(
+        raise ClickException(
             "There are more than one owl:Ontology resources described "
             f"in the turtle file: {ontology_iris_str}"
         )
@@ -182,7 +183,7 @@ def _get_vocabulary_metadata_from_file(
     metadata["iri"] = iri
     vann_data = graph.query(GET_PREFIX_DECLARATION.format(iri))
     if not vann_data and not namespace_given:
-        raise ValueError(
+        raise ClickException(
             "There is no namespace defined "
             f"for the ontology '{iri}'.\n"
             "Please add a prefix and namespace to the sources"
@@ -191,13 +192,13 @@ def _get_vocabulary_metadata_from_file(
             "https://vocab.org/vann/ for more information."
         )
     if vann_data and namespace_given:
-        raise ValueError(
+        raise ClickException(
             "There is already a namespace defined "
             f"in the file for the ontology '{iri}'.\n"
             "You can not use the --namespace option with this file."
         )
     if len(vann_data) > 1:
-        raise ValueError(
+        raise ClickException(
             "There is more than one vann namespace defined " f"for the ontology: {iri}"
         )
     if not namespace_given:
@@ -378,7 +379,7 @@ def import_command(
         if replace:
             success_message = "replaced"
         else:
-            raise ValueError(f"Proposed graph {iri} does already exist.")
+            raise ClickException(f"Proposed graph {iri} does already exist.")
     app.echo_info(f"Import {file} as vocabulary to {iri} ... ", nl=False)
     # upload graph
     _buffer.seek(0)

cmem_cmemc/commands/workflow.py

@@ -7,7 +7,7 @@ from datetime import datetime, timezone
 
 import click
 import timeago
-from click import UsageError
+from click import ClickException, UsageError
 from cmem.cmempy.workflow import get_workflows
 from cmem.cmempy.workflow.workflow import (
     execute_workflow_io,
@@ -99,12 +99,12 @@ def _get_workflows_filtered_by_io_feature(workflows: list[dict], feature: str) -
 
     Raises:
     ------
-        ValueError
+        UsageError
 
     """
     possible_io_filter_values = ("input-only", "output-only", "input-output", "any")
     if feature not in possible_io_filter_values:
-        raise ValueError(
+        raise UsageError(
             f"{feature} is an unknown filter value. " f"Use one of {possible_io_filter_values}."
         )
     filtered_workflows_ids = []
@@ -141,11 +141,11 @@ def _get_workflows_filtered(workflows: list, filter_name: str, filter_value: str
 
     Raises:
     ------
-        ValueError
+        UsageError
 
     """
     if filter_name not in WORKFLOW_FILTER_TYPES:
-        raise ValueError(
+        raise UsageError(
             f"{filter_name} is an unknown filter name. " f"Use one of {WORKFLOW_FILTER_TYPES}."
         )
     # filter by regex on the label
@@ -167,30 +167,30 @@ def _get_workflows_filtered(workflows: list, filter_name: str, filter_value: str
 def _io_check_request(info: dict, input_file: str, output_file: str, output_mimetype: str) -> None:
     """Check the requested io execution
 
-    Raise ValueError in multiple cases.
+    Raise UsageError in multiple cases.
     """
     if len(info["variableInputs"]) == 0 and input_file:
-        raise ValueError(
+        raise UsageError(
             "You are trying to send data to a workflow without a variable "
             "input. Please remove the '-i' parameter."
         )
     if len(info["variableOutputs"]) == 0 and output_file:
-        raise ValueError(
+        raise UsageError(
             "You are trying to retrieve data to a workflow without a variable "
             "output. Please remove the '-o' parameter."
         )
     if len(info["variableInputs"]) == 1 and not input_file:
-        raise ValueError(
+        raise UsageError(
             "This workflow has a defined input so you need to use the '-i' "
             "parameter to send data to it."
         )
     if len(info["variableOutputs"]) == 1 and not output_file:
-        raise ValueError(
+        raise UsageError(
             "This workflow has a defined output so you need to use the '-o' "
             "parameter to retrieve data from it."
         )
     if output_mimetype in STDOUT_UNSUPPORTED_MIME_TYPES and output_file == "-":
-        raise ValueError(
+        raise UsageError(
             f"Trying to output an {STDOUT_UNSUPPORTED_MIME_TYPES[output_mimetype]} "
             "file to stdout will fail.\n"
             "Please output to a regular file instead "
@@ -205,7 +205,7 @@ def _io_get_info(project_id: str, workflow_id: str) -> dict[str, str]:
         info: dict[str, str] = _
         if info["id"] == workflow_id and info["projectId"] == project_id:
             return info
-    raise ValueError(
+    raise ClickException(
         "The given workflow does not exist or is not suitable to be executed "
         "with this command.\n"
         "An io workflow needs exactly one variable input and/or one variable "
@@ -229,12 +229,12 @@ def _io_process_response(response: Response, app: ApplicationContext, output_fil
 def _io_guess_output(output_file: str) -> str:
     """Guess the mime type of output file name."""
     if output_file == "-":
-        raise ValueError("Output mime-type not guessable, please use the --output-mimetype option.")
+        raise UsageError("Output mime-type not guessable, please use the --output-mimetype option.")
     file_extension = Path(output_file).suffix
     if file_extension in VALID_EXTENSIONS:
         return f"application/x-plugin-{FILE_EXTENSIONS_TO_PLUGIN_ID[file_extension]}"
     valid_extensions = ", ".join(VALID_EXTENSIONS)
-    raise ValueError(
+    raise UsageError(
         f"Files with the extension {file_extension} can not be generated. "
         f"Try one of {valid_extensions}"
     )
@@ -243,12 +243,12 @@ def _io_guess_output(output_file: str) -> str:
 def _io_guess_input(input_file: str) -> str:
     """Guess the mime type of input file name."""
     if input_file == "-":
-        raise ValueError("Input mime-type not guessable, please use the --output-mimetype option.")
+        raise UsageError("Input mime-type not guessable, please use the --output-mimetype option.")
     file_extension = Path(input_file).suffix
     if file_extension in VALID_EXTENSIONS:
         return f"application/x-plugin-{FILE_EXTENSIONS_TO_PLUGIN_ID[file_extension]}"
     valid_extensions = ", ".join(VALID_EXTENSIONS)
-    raise ValueError(
+    raise UsageError(
         f"Files with the extension {file_extension} can not be processed. "
         f"Try one of {valid_extensions}"
     )
@@ -335,7 +335,7 @@ def _workflow_echo_status(app: ApplicationContext, status: dict) -> None:
         if status_name in ("Running", "Canceling", "Waiting"):
             app.echo_warning(message)
             return
-        raise ValueError(
+        raise ClickException(
             f"statusName is {status_name}, expecting one of: " "Running, Canceling or Waiting."
         )
     # not running can be Idle or Finished
@@ -390,7 +390,7 @@ def execute_command(  # noqa: PLR0913
     a workflow, the next workflow is not started.
     """
     if workflow_ids == () and not all_:
-        raise ValueError(
+        raise UsageError(
             "Either specify at least one workflow or use the"
             " --all option to execute all workflows."
         )