cwms-cli 0.3.4__tar.gz → 0.3.6__tar.gz

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cwms-cli
-Version: 0.3.4
+Version: 0.3.6
 Summary: Command line utilities for Corps Water Management Systems (CWMS) python scripts. This is a collection of shared scripts across the enterprise Water Management Enterprise System (WMES) teams.
 License: LICENSE
 License-File: LICENSE

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/__main__.py

@@ -4,12 +4,18 @@ import sys
 from typing import Optional
 
 import click
+from click.core import ParameterSource
 
 from cwmscli.commands import commands_cwms
 from cwmscli.load import __main__ as load
 from cwmscli.usgs import usgs_group
 from cwmscli.utils.click_help import add_version_to_help_tree
-from cwmscli.utils.logging import LoggingConfig, setup_logging
+from cwmscli.utils.logging import (
+    LoggingConfig,
+    apply_logging_policies,
+    current_environment,
+    setup_logging,
+)
 from cwmscli.utils.ssl_errors import is_cert_verify_error, ssl_help_text
 from cwmscli.utils.version import get_cwms_cli_version
 
@@ -40,8 +46,29 @@ from cwmscli.utils.version import get_cwms_cli_version
     ),
     default="INFO",
 )
-def cli(log_file: Optional[str], no_color: bool, log_level: str) -> None:
+@click.option(
+    "-q",
+    "--quiet",
+    is_flag=True,
+    default=False,
+    help="Suppress routine output; warnings and errors still print.",
+)
+@click.pass_context
+def cli(
+    ctx: click.Context,
+    log_file: Optional[str],
+    no_color: bool,
+    log_level: str,
+    quiet: bool,
+) -> None:
     level = getattr(logging, log_level.upper(), logging.INFO)
+    level = apply_logging_policies(
+        level,
+        quiet=quiet,
+        environment=current_environment(),
+        explicit_log_level=ctx.get_parameter_source("log_level")
+        == ParameterSource.COMMANDLINE,
+    )
 
     # Disable colors if stdout isn't a TTY (piped/redirected)
     tty = sys.stdout.isatty()

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/load/location/location.py

@@ -10,6 +10,7 @@ from cwmscli.load.root import (
     validate_cda_targets,
 )
 from cwmscli.utils.deps import requires
+from cwmscli.utils.links import CDA_REGEXP_GUIDE_URL
 
 
 @load_group.group(
@@ -22,14 +23,21 @@ def location(ctx):
 
 @location.command(
     "ids-all",
-    help="Copy ALL locations from a source CDA to a target CDA.",
+    help=(
+        "Copy locations from a source CDA catalog to a target CDA. "
+        "The --like and --location-kind-like filters use CDA regex semantics. "
+        f"Regex guide: {CDA_REGEXP_GUIDE_URL}"
+    ),
 )
 @shared_source_target_options
 @click.option(
     "--like",
     default=None,
     type=str,
-    help="LIKE filter for location name (e.g. 'Turbine*').",
+    help=(
+        "Regular expression passed directly to the source CDA catalog. "
+        "Examples: '^Black Butte$' for an exact match, '^Black Butte.*' for a prefix match. "
+    ),
 )
 @click.option(
     "--location-kind-like",
@@ -37,13 +45,13 @@ def location(ctx):
     default=["ALL"],
     multiple=True,
     help=(
-        "Filter by LOCATION_KIND using LIKE; may be passed multiple times.\n\n"
+        "Filter by LOCATION_KIND using CDA regex semantics; may be passed multiple times.\n\n"
         "Default is to pull all Location kinds.\n\n"
         "Common kinds: SITE, EMBANKMENT, OVERFLOW, TURBINE, STREAM, PROJECT, "
         "STREAMGAGE, BASIN, OUTLET, LOCK, GATE.\n\n"
         "Examples:\n"
         "  --location-kind-like PROJECT --location-kind-like STREAM\n"
-        "  --location-kind-like '(SITE|STREAM)'   # Posix regex"
+        "  --location-kind-like '(SITE|STREAM)'"
     ),
 )
 @requires(reqs.cwms)

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/load/location/location_ids.py

@@ -1,8 +1,14 @@
+import logging
+import re
 from typing import Iterable, Optional
 
 import click
 import cwms
 
+from cwmscli.utils.links import CDA_REGEXP_GUIDE_URL
+
+logger = logging.getLogger(__name__)
+
 
 def load_locations(
     source_cda: str,
@@ -15,50 +21,65 @@ def load_locations(
     location_kind_like: Optional[Iterable[str]] = "ALL",
 ):
     if verbose:
-        click.echo(
+        logger.info(
             f"[load locations] source={source_cda} ({source_office}) -> target={target_cda}"
         )
-        click.echo(
+        logger.info(
             f"  like={like or '-'}  kinds={list(location_kind_like) or '-'}  dry_run={dry_run}"
         )
+        if like or (
+            location_kind_like
+            and list(location_kind_like) != ["ALL"]
+            and list(location_kind_like) != []
+        ):
+            logger.info("  CDA regex guide: %s", CDA_REGEXP_GUIDE_URL)
 
     cwms.init_session(api_root=source_cda, api_key=None)
 
     cat_kwargs = {"office_id": source_office}
     if like:
         cat_kwargs["like"] = like
-    kinds = list(location_kind_like) if location_kind_like else [None]
+    kinds = list(location_kind_like) if location_kind_like else ["ALL"]
+    if "ALL" in kinds:
+        kinds = ["ALL"]
 
     locations = []
 
-    if "ALL" in kinds:
+    if kinds == ["ALL"] and not like:
         locations = cwms.get_locations(office_id=source_office).json
     else:
-        locations = []
+        seen_location_ids = set()
         for kind in kinds:
             cat_kwargs_k = dict(cat_kwargs)
             if kind != "ALL":
                 cat_kwargs_k["location_kind_like"] = kind
 
             if verbose >= 2:
-                click.echo(f"  > catalog query: {cat_kwargs_k}")
+                logger.debug("  > catalog query: %s", cat_kwargs_k)
 
             resp = cwms.get_locations_catalog(**cat_kwargs_k)
             if resp.df.empty:
                 continue
 
-            loc_ids = resp.df["name"].tolist()
-            locations_resp = cwms.get_locations(
-                office_id=source_office, location_ids=loc_ids
-            )
-            locations.extend(locations_resp.json or [])
+            for location_id in resp.df["name"].tolist():
+                if location_id in seen_location_ids:
+                    continue
+                seen_location_ids.add(location_id)
+                if verbose >= 2:
+                    logger.debug("  > location fetch: %s", location_id)
+                detail_resp = cwms.get_locations(
+                    office_id=source_office,
+                    location_ids=rf"^{re.escape(location_id)}$",
+                )
+                if detail_resp and detail_resp.json:
+                    locations.extend(detail_resp.json)
 
     if verbose:
-        click.echo(f"Fetched {len(locations)} locations from source")
+        logger.info("Fetched %s locations from source", len(locations))
 
     if dry_run:
         for loc in locations:
-            click.echo(
+            logger.info(
                 f"[dry-run] would store Location(name={loc['name']}) to {target_cda} ({source_office})"
             )
         return
@@ -72,7 +93,7 @@ def load_locations(
             if loc["active"] is True:
                 result = cwms.store_location(data=loc, fail_if_exists=False)
                 if verbose:
-                    click.echo(result)
+                    logger.info("%s", result)
         except Exception as e:
             errors += 1
             click.echo(f"Error storing location {loc}: \n\t{e}", err=True)
@@ -80,4 +101,4 @@ def load_locations(
     if errors:
         raise click.ClickException(f"Completed with {errors} error(s).")
     if verbose:
-        click.echo("Done.")
+        logger.info("Done.")

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/load/location/location_ids_bygroup.py

@@ -1,17 +1,20 @@
 # cwmscli/load/location_group.py
+import logging
 import re
 from typing import Optional
 
 import click
 import cwms
 
+logger = logging.getLogger(__name__)
+
 
 def exact_or_regex(ids: list[str]) -> str:
     if not ids:
         return r"^$"
     if len(ids) == 1:
         return rf"^{re.escape(ids[0])}$"
-    return r"^(?:" + "|".join(re.escape(x) for x in ids) + r")$"
+    return r"^(" + "|".join(re.escape(x) for x in ids) + r")$"
 
 
 def copy_from_group(
@@ -31,10 +34,10 @@ def copy_from_group(
     category_office_id = category_office_id or source_office
 
     if verbose:
-        click.echo(
+        logger.info(
             f"[load location group] source={source_cda} ({source_office}) -> target={target_cda})"
         )
-        click.echo(
+        logger.info(
             f"  group={group_id}  category={category_id}  "
             f"group_office={group_office_id}  category_office={category_office_id} "
             f"filter_office={filter_office}  dry_run={dry_run}"
@@ -51,11 +54,11 @@ def copy_from_group(
             category_office_id=category_office_id,
         )
         if verbose:
-            click.echo(f"Fetched Location Group '{group_id}' from source:")
+            logger.info("Fetched Location Group '%s' from source:", group_id)
             if hasattr(grp, "df"):
-                click.echo(grp.df)
+                logger.info("%s", grp.df)
             else:
-                click.echo(grp.json)
+                logger.info("%s", grp.json)
     except Exception as e:
         raise click.ClickException(
             f"Failed to read location group '{group_id}' in category '{category_id}': {e}"
@@ -63,7 +66,7 @@ def copy_from_group(
 
     df = getattr(grp, "df", None)
     if df is None or df.empty:
-        click.echo("No members found in the specified location group.")
+        logger.info("No members found in the specified location group.")
         return
 
     if filter_office and "office-id" in df.columns:
@@ -71,9 +74,9 @@ def copy_from_group(
 
     member_ids = sorted(df["location-id"].dropna().unique().tolist())
     if verbose:
-        click.echo(f"Group members found: {len(member_ids)}")
+        logger.info("Group members found: %s", len(member_ids))
     if not member_ids:
-        click.echo("No valid location IDs to copy.")
+        logger.info("No valid location IDs to copy.")
         return
 
     try:
@@ -85,7 +88,7 @@ def copy_from_group(
             pattern = exact_or_regex(batch)
             resp = cwms.get_locations(office_id=source_office, location_ids=pattern)
             if verbose and getattr(resp, "df", None) is not None:
-                click.echo(f"Fetched {len(resp.df)} matching Locations in batch")
+                logger.info("Fetched %s matching Locations in batch", len(resp.df))
             if resp and resp.json:
                 locations.extend(resp.json)
 
@@ -93,12 +96,12 @@ def copy_from_group(
         raise click.ClickException(f"Failed to fetch locations from source: {e}")
 
     if verbose:
-        click.echo(f"Fetched {len(locations)} Location objects from source")
+        logger.info("Fetched %s Location objects from source", len(locations))
 
     if dry_run:
         for loc in locations:
-            click.echo(
-                f"[dry-run] would store Location(name={loc.name}) to {target_cda} ({source_office})"
+            logger.info(
+                f"[dry-run] would store Location(name={loc['name']}) to {target_cda} ({source_office})"
             )
         return
 
@@ -111,16 +114,18 @@ def copy_from_group(
     for loc in locations:
         try:
             if verbose:
-                click.echo(f"Store: {loc['name']}")
+                logger.info("Store: %s", loc["name"])
             cwms.store_location(data=loc, fail_if_exists=False)
             if verbose:
-                click.echo("\tStored successfully.")
+                logger.info("\tStored successfully.")
         except Exception as e:
             errors += 1
             click.echo(f"Error storing location {loc}: \n\t{e}", err=True)
 
-    click.echo(
-        f"Successfully stored {len(locations) - errors} / {len(locations)} locations."
+    logger.info(
+        "Successfully stored %s / %s locations.",
+        len(locations) - errors,
+        len(locations),
     )
 
     if errors:

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/load/root.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import functools
+import logging
 from dataclasses import dataclass
 from typing import Optional
 from urllib.parse import urlparse
@@ -10,6 +11,8 @@ import click
 from cwmscli import requirements as reqs
 from cwmscli.utils.deps import requires
 
+logger = logging.getLogger(__name__)
+
 CONTEXT = dict(
     help_option_names=["-h", "--help"],
     max_content_width=160,
@@ -56,16 +59,14 @@ def validate_cda_targets(func):
                 "Type cwms-cli load --help for arg options."
             )
         elif same_root and not same_office:
-            click.secho(
+            logger.warning(
                 "Warning: source and target use the same CDA root URL but different offices. "
                 "This is allowed, but double-check intent.",
-                fg="yellow",
             )
 
-        click.secho(
+        logger.info(
             f"Source: {source_cda} (office={source_office or '-'})\n"
             f"Target: {target_cda} (office={source_office or '-'})",
-            fg="green" if not same_root else "yellow",
         )
         return func(*args, **kwargs)
 

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/load/timeseries/timeseries.py

@@ -9,6 +9,7 @@ from cwmscli.load.root import (
     validate_cda_targets,
 )
 from cwmscli.utils.deps import requires
+from cwmscli.utils.links import CDA_REGEXP_GUIDE_URL
 
 
 @load_group.group(
@@ -21,7 +22,10 @@ def timeseries(ctx):
 
 @timeseries.command(
     "ids-all",
-    help="Copy ALL timeseries IDs for locations in a target CDA from a source CDA.",
+    help=(
+        "Copy ALL timeseries IDs for locations in a target CDA from a source CDA. "
+        f"Regex guide for --timeseries-id-regex: {CDA_REGEXP_GUIDE_URL}"
+    ),
 )
 @shared_source_target_options
 @click.option(
@@ -29,7 +33,7 @@ def timeseries(ctx):
     "timeseries_id_regex",
     default=None,
     type=str,
-    help="regex filter for timeseries ID (e.g. 'LocID.*').",
+    help="Regex filter for timeseries ID (e.g. '^LocID.*').",
 )
 @requires(reqs.cwms)
 @validate_cda_targets

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/load/timeseries/timeseries_ids.py

@@ -1,10 +1,13 @@
 # cwmscli/load/timeseries_ids.py
+import logging
 from turtle import pd
 from typing import Optional
 
 import click
 import pandas as pd
 
+logger = logging.getLogger(__name__)
+
 
 def load_timeseries_ids(
     source_cda: str,
@@ -18,7 +21,7 @@ def load_timeseries_ids(
     import cwms
 
     if verbose:
-        click.echo(
+        logger.info(
             f"Loading timeseries IDs from source CDA '{source_cda}' (office '{source_office}') "
             f"to target CDA '{target_cda}'."
         )
@@ -38,13 +41,13 @@ def load_timeseries_ids(
     ts_lo_ids = pd.merge(ts_ids, locs, how="inner", on=["location-id", "office-id"])
 
     if verbose:
-        click.echo(f"Found {len(ts_lo_ids)} timeseries IDs to copy.")
+        logger.info("Found %s timeseries IDs to copy.", len(ts_lo_ids))
 
     errors = 0
     for i, row in ts_lo_ids.iterrows():
         ts_id = row["time-series-id"]
         if dry_run:
-            click.echo(
+            logger.info(
                 f"[dry-run] would store Timeseries ID(name={ts_id}) to {target_cda} ({source_office})"
             )
             continue
@@ -60,7 +63,7 @@ def load_timeseries_ids(
                 data=t_id_json, fail_if_exists=False
             )
             if verbose:
-                click.echo(result)
+                logger.info("%s", result)
         except Exception as e:
             errors += 1
             click.echo(f"Error storing location {ts_id}: \n\t{e}", err=True)
@@ -68,4 +71,4 @@ def load_timeseries_ids(
     if errors:
         raise click.ClickException(f"Completed with {errors} error(s).")
     if verbose:
-        click.echo("Timeseries ID copy operation completed.")
+        logger.info("Timeseries ID copy operation completed.")

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/usgs/__init__.py

@@ -46,7 +46,7 @@ def getusgs_timeseries(office, days_back, api_root, api_key, api_key_loc, backfi
     from cwmscli.usgs.getusgs_cda import getusgs_cda
 
     if backfill is not None:
-        backfill_list = backfill.replace(" ", "").split(",")
+        backfill_list = [item.strip() for item in backfill.split(",") if item.strip()]
     else:
         backfill_list = None
 
@@ -78,7 +78,9 @@ def getusgs_ratings(office, days_back, api_root, api_key, api_key_loc, rating_su
     from cwmscli.usgs.getUSGS_ratings_cda import getusgs_rating_cda
 
     if rating_subset is not None:
-        rating_list = rating_subset.replace(" ", "").split(",")
+        rating_list = [
+            item.strip() for item in rating_subset.split(",") if item.strip()
+        ]
     else:
         rating_list = None
 
@@ -158,7 +160,9 @@ def getusgs_measurements(
         if "group" in backfill:
             backfill_group = True
         elif type(backfill) == str:
-            backfill_list = backfill.replace(" ", "").split(",")
+            backfill_list = [
+                item.strip() for item in backfill.split(",") if item.strip()
+            ]
     api_key = get_api_key(api_key, api_key_loc)
     getusgs_measurement_cda(
         api_root=api_root,

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/utils/__init__.py

@@ -2,9 +2,11 @@ import logging as py_logging
 from typing import Optional
 
 import click
+from click.core import ParameterSource
 
 from cwmscli.utils import colors
 from cwmscli.utils.click_help import DOCS_BASE_URL
+from cwmscli.utils.logging import apply_logging_policies, current_environment
 
 
 def to_uppercase(ctx, param, value):
@@ -19,6 +21,14 @@ def _set_log_level(ctx, param, value):
     level = getattr(py_logging, value.upper(), None)
     if level is None:
         raise click.BadParameter(f"Invalid log level: {value}")
+    quiet = bool(ctx.find_root().params.get("quiet", False))
+    level = apply_logging_policies(
+        level,
+        quiet=quiet,
+        environment=current_environment(),
+        explicit_log_level=ctx.get_parameter_source(param.name)
+        == ParameterSource.COMMANDLINE,
+    )
     py_logging.getLogger().setLevel(level)
     return value
 

cwms_cli-0.3.6/cwmscli/utils/links.py

@@ -0,0 +1 @@
+CDA_REGEXP_GUIDE_URL = "https://cwms-cli.readthedocs.io/en/latest/cli/cda_regex.html"

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/cwmscli/utils/logging/__init__.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import logging
+import os
 import sys
 from dataclasses import dataclass
 from typing import Optional
@@ -18,6 +19,32 @@ class LoggingConfig:
     color: bool = True
 
 
+PRODUCTION_ENV_ALIASES = frozenset({"prod", "production"})
+
+
+def apply_logging_policies(
+    level: int,
+    *,
+    quiet: bool,
+    environment: Optional[str],
+    explicit_log_level: bool = False,
+) -> int:
+    effective_level = level
+    normalized_env = (environment or "").strip().lower()
+
+    if normalized_env in PRODUCTION_ENV_ALIASES and not explicit_log_level:
+        effective_level = max(effective_level, logging.WARNING)
+
+    if quiet:
+        effective_level = max(effective_level, logging.WARNING)
+
+    return effective_level
+
+
+def current_environment() -> Optional[str]:
+    return os.getenv("ENVIRONMENT")
+
+
 class ColorLevelFormatter(logging.Formatter):
     def __init__(self, fmt: str, datefmt: str, enable_color: bool) -> None:
         super().__init__(fmt=fmt, datefmt=datefmt)

{cwms_cli-0.3.4 → cwms_cli-0.3.6}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "cwms-cli"
 repository = "https://github.com/HydrologicEngineeringCenter/cwms-cli"
 
-version = "0.3.4"
+version = "0.3.6"
 
 
 packages = [