Logging improvements

cwmscli/__main__.py

@@ -12,7 +12,7 @@
 from cwmscli.utils.ssl_errors import is_cert_verify_error, ssl_help_text
 
 
-@click.group()
+@click.group(context_settings=dict(help_option_names=["-h", "--help"]))
 def cli():
     pass
 

cwmscli/commands/commands_cwms.py

@@ -5,7 +5,7 @@
 from cwmscli import requirements as reqs
 from cwmscli.callbacks import csv_to_list
 from cwmscli.commands import csv2cwms
-from cwmscli.utils import api_key_loc_option, common_api_options
+from cwmscli.utils import api_key_loc_option, common_api_options, to_uppercase
 from cwmscli.utils.deps import requires
 
 
@@ -251,6 +251,3 @@ def list_cmd(**kwargs):
     from cwmscli.commands.blob import list_cmd
 
     list_cmd(**kwargs)
-
-
-# endregion

cwmscli/utils/__init__.py

@@ -1,3 +1,5 @@
+import logging
+
 import click
 
 
@@ -7,6 +9,16 @@ def to_uppercase(ctx, param, value):
     return value.upper()
 
 
+def _set_log_level(ctx, param, value):
+    if value is None:
+        return
+    level = getattr(logging, value.upper(), None)
+    if level is None:
+        raise click.BadParameter(f"Invalid log level: {value}")
+    logging.getLogger().setLevel(level)
+    return value
+
+
 office_option = click.option(
     "-o",
     "--office",
@@ -47,6 +59,18 @@ def to_uppercase(ctx, param, value):
     type=str,
     help="file storing Api Key. One of api-key or api-key-loc are required",
 )
+log_level_option = click.option(
+    "--log-level",
+    type=click.Choice(
+        ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], case_sensitive=False
+    ),
+    default="INFO",
+    envvar="LOG_LEVEL",
+    callback=_set_log_level,
+    expose_value=False,  # Callback will set the log level of all methods
+    is_eager=True,  # Run before other commands (to cover any logging statements)
+    help="Set logging verbosity (overrides default INFO).",
+)
 
 
 def get_api_key(api_key: str, api_key_loc: str) -> str:
@@ -62,6 +86,7 @@ def get_api_key(api_key: str, api_key_loc: str) -> str:
 
 
 def common_api_options(f):
+    f = log_level_option(f)
     f = office_option(f)
     f = api_root_option(f)
     f = api_key_option(f)

cwmscli/utils/io.py

@@ -0,0 +1,16 @@
+import logging
+import os
+from pathlib import Path
+
+
+def write_to_file(file_path: str, data: str, create_dir: bool = False) -> None:
+    """Writes data to a file at the specified path."""
+    if not file_path:
+        raise ValueError("You must specify a file path to write data to.")
+    if not data:
+        raise ValueError("No data provided to write to file.")
+    if create_dir:
+        Path(os.path.dirname(file_path)).mkdir(parents=True, exist_ok=True)
+    with open(file_path, "w") as file:
+        file.write(data)
+    logging.info(f"Data written to file: {file_path}")