Add --limit to clob per the blob PR

Author: krowvin

cwmscli/commands/clob.py

@@ -53,9 +53,15 @@ def list_clobs(
     sort_by: Optional[Sequence[str]] = None,
     ascending: bool = True,
     limit: Optional[int] = None,
+    page_size: Optional[int] = None,
 ) -> pd.DataFrame:
     logging.info(f"Listing clobs for office: {office!r}...")
-    result = cwms.get_clobs(office_id=office, clob_id_like=clob_id_like)
+    fetch_page_size = page_size if page_size is not None else limit
+    result = cwms.get_clobs(
+        office_id=office,
+        clob_id_like=clob_id_like,
+        page_size=fetch_page_size,
+    )
 
     # Accept either a DataFrame or a JSON/dict-like response
     if isinstance(result, pd.DataFrame):
@@ -289,6 +295,7 @@ def list_cmd(
     sort_by: list[str],
     desc: bool,
     limit: int,
+    page_size: int,
     to_csv: str,
     office: str,
     api_root: str,
@@ -305,6 +312,7 @@ def list_cmd(
             sort_by=sort_by,
             ascending=not desc,
             limit=limit,
+            page_size=page_size,
         )
     except Exception:
         log_scoped_read_hint(

cwmscli/commands/commands_cwms.py

@@ -555,6 +555,12 @@ def update_cmd(**kwargs):
     help="Sort descending instead of ascending.",
 )
 @click.option("--limit", type=int, default=None, help="Max rows to show.")
+@click.option(
+    "--page-size",
+    type=int,
+    default=None,
+    help="Max rows to request from the clob endpoint. Defaults to --limit when set.",
+)
 @click.option(
     "--to-csv",
     type=click.Path(dir_okay=False, writable=True, path_type=str),

docs/cli/clob.rst

@@ -31,6 +31,8 @@ Quick reference
 - ``clob download`` writes the returned clob text to disk.
 - ``clob list`` and ``clob download`` send an API key if one is configured,
   unless ``--anonymous`` is used.
+- ``clob list --limit`` caps displayed rows, and sets the clob endpoint
+  request page size unless ``--page-size`` is provided to override the fetch size.
 - ``clob upload --overwrite`` replaces an existing clob.
 - ``clob update`` supports partial updates and ``--ignore-nulls`` behavior.
 
@@ -88,6 +90,28 @@ Examples:
    # Anonymous list
    cwms-cli clob list --office SWT --api-root http://localhost:8082/cwms-data --anonymous
 
+List pagination
+---------------
+
+``cwms-cli clob list`` can cap the local output and also control how many rows
+the CDA clob endpoint returns for the request.
+
+- ``--limit`` caps how many rows cwms-cli prints or writes.
+- When ``--limit`` is set, cwms-cli also uses that value as the clob endpoint
+  request ``page_size``.
+- Use ``--page-size`` to override the request size explicitly, especially if
+  you want to fetch more rows than you plan to display.
+
+Examples:
+
+.. code-block:: bash
+
+   # Fetch and show up to 250 rows
+   cwms-cli clob list --office SWT --limit 250
+
+   # Fetch 500 rows from CDA but only show the first 50 locally
+   cwms-cli clob list --office SWT --limit 50 --page-size 500
+
 .. _clob-overwrite-flag:
 
 Overwrite behavior

tests/commands/test_clob.py

@@ -207,7 +207,8 @@ def init_session(api_root, api_key):
             return None
 
         @staticmethod
-        def get_clobs(office_id, clob_id_like):
+        def get_clobs(office_id, clob_id_like, page_size=None):
+            calls.append(("get_clobs", office_id, clob_id_like, page_size))
             return pd.DataFrame([{"id": "TEST_CLOB", "description": "x"}])
 
     monkeypatch.setitem(sys.modules, "cwms", FakeCwms)
@@ -219,13 +220,86 @@ def get_clobs(office_id, clob_id_like):
         sort_by=[],
         desc=False,
         limit=None,
+        page_size=None,
         to_csv=None,
         office="SWT",
         api_root="https://example.test/",
         api_key="apikey 123",
     )
 
-    assert calls == [("init_session", "https://example.test/", "apikey 123")]
+    assert calls == [
+        ("init_session", "https://example.test/", "apikey 123"),
+        ("get_clobs", "SWT", "TEST_.*", None),
+    ]
+
+
+def test_list_cmd_uses_limit_as_fetch_page_size(monkeypatch):
+    calls = []
+
+    class FakeCwms:
+        @staticmethod
+        def init_session(api_root, api_key):
+            return None
+
+        @staticmethod
+        def get_clobs(office_id, clob_id_like, page_size=None):
+            calls.append((office_id, clob_id_like, page_size))
+            return pd.DataFrame(
+                [
+                    {"id": "A", "description": "x"},
+                    {"id": "B", "description": "y"},
+                ]
+            )
+
+    monkeypatch.setitem(sys.modules, "cwms", FakeCwms)
+    monkeypatch.setattr("cwmscli.commands.clob.cwms", FakeCwms)
+
+    list_cmd(
+        clob_id_like="TEST_.*",
+        columns=[],
+        sort_by=[],
+        desc=False,
+        limit=25,
+        page_size=None,
+        to_csv=None,
+        office="SWT",
+        api_root="https://example.test/",
+        api_key="apikey 123",
+    )
+
+    assert calls == [("SWT", "TEST_.*", 25)]
+
+
+def test_list_cmd_page_size_overrides_limit_for_fetch(monkeypatch):
+    calls = []
+
+    class FakeCwms:
+        @staticmethod
+        def init_session(api_root, api_key):
+            return None
+
+        @staticmethod
+        def get_clobs(office_id, clob_id_like, page_size=None):
+            calls.append((office_id, clob_id_like, page_size))
+            return pd.DataFrame([{"id": "A", "description": "x"}])
+
+    monkeypatch.setitem(sys.modules, "cwms", FakeCwms)
+    monkeypatch.setattr("cwmscli.commands.clob.cwms", FakeCwms)
+
+    list_cmd(
+        clob_id_like="TEST_.*",
+        columns=[],
+        sort_by=[],
+        desc=False,
+        limit=25,
+        page_size=200,
+        to_csv=None,
+        office="SWT",
+        api_root="https://example.test/",
+        api_key="apikey 123",
+    )
+
+    assert calls == [("SWT", "TEST_.*", 200)]
 
 
 def test_list_cmd_anonymous_skips_api_key(monkeypatch):
@@ -238,7 +312,8 @@ def init_session(api_root, api_key):
             return None
 
         @staticmethod
-        def get_clobs(office_id, clob_id_like):
+        def get_clobs(office_id, clob_id_like, page_size=None):
+            calls.append(("get_clobs", office_id, clob_id_like, page_size))
             return pd.DataFrame([{"id": "TEST_CLOB", "description": "x"}])
 
     monkeypatch.setitem(sys.modules, "cwms", FakeCwms)
@@ -250,14 +325,18 @@ def get_clobs(office_id, clob_id_like):
         sort_by=[],
         desc=False,
         limit=None,
+        page_size=None,
         to_csv=None,
         office="SWT",
         api_root="https://example.test/",
         api_key="apikey 123",
         anonymous=True,
     )
 
-    assert calls == [("init_session", "https://example.test/", None)]
+    assert calls == [
+        ("init_session", "https://example.test/", None),
+        ("get_clobs", "SWT", "TEST_.*", None),
+    ]
 
 
 def test_delete_cmd_uses_query_override_for_special_char_ids(monkeypatch):