add --page-size option to devices cmds (#383)

* add --page-size option to devices cmds

* add default to help

Author: timabrmsn

CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 The intended audience of this file is for py42 consumers -- as such, changes that don't affect
 how a consumer would use the library (e.g. adding unit tests, updating documentation, etc) are not captured here.
 
+## 1.14.5 - 2022-08-01
+
+### Added
+
+- `code42 devices list` and `code42 devices list-backup-sets` now accept a `--page-size <int>` option to enable manually configuring optimal page size.
+
 ## 1.14.4 - 2022-07-21
 
 ### Changed

src/code42cli/__version__.py

@@ -1 +1 @@
-__version__ = "1.14.4"
+__version__ = "1.14.5"

src/code42cli/cmds/devices.py

@@ -243,6 +243,14 @@ def _get_device_info(sdk, device_guid):
     help="Limit devices to only those in the organization you specify. "
     "Note that child organizations will be included.",
 )
+page_size_option = click.option(
+    "--page-size",
+    required=False,
+    type=int,
+    default=100,
+    help="Number of devices to retrieve per API call. "
+    "Lower this value if you are getting timeouts when retrieving devices with backup info. Default: 100",
+)
 
 include_usernames_option = click.option(
     "--include-usernames",
@@ -323,6 +331,7 @@ def _get_device_info(sdk, device_guid):
     help="Include devices only when 'creationDate' field is greater than the provided value. "
     "Argument format options are the same as --last-connected-before.",
 )
+@page_size_option
 @format_option
 @sdk_options()
 def list_devices(
@@ -340,6 +349,7 @@ def list_devices(
     last_connected_before,
     created_after,
     created_before,
+    page_size,
     format,
 ):
     """Get information about many devices."""
@@ -359,11 +369,12 @@ def list_devices(
         "userUid",
     ]
     df = _get_device_dataframe(
-        state.sdk,
-        columns,
-        active,
-        org_uid,
-        (include_backup_usage or include_total_storage),
+        sdk=state.sdk,
+        columns=columns,
+        page_size=page_size,
+        active=active,
+        org_uid=org_uid,
+        include_backup_usage=(include_backup_usage or include_total_storage),
     )
     if exclude_most_recently_connected:
         most_recent = (
@@ -429,13 +440,13 @@ def _get_all_active_hold_memberships(sdk):
 
 
 def _get_device_dataframe(
-    sdk, columns, active=None, org_uid=None, include_backup_usage=False
+    sdk, columns, page_size, active=None, org_uid=None, include_backup_usage=False
 ):
     devices_generator = sdk.devices.get_all(
         active=active,
         include_backup_usage=include_backup_usage,
         org_uid=org_uid,
-        page_size=100,
+        page_size=page_size,
     )
     devices_list = []
     if include_backup_usage:
@@ -514,6 +525,7 @@ def _break_backup_usage_into_total_storage(backup_usage):
 @inactive_option
 @org_uid_option
 @include_usernames_option
+@page_size_option
 @format_option
 @sdk_options()
 def list_backup_sets(
@@ -522,6 +534,7 @@ def list_backup_sets(
     inactive,
     org_uid,
     include_usernames,
+    page_size,
     format,
 ):
     """Get information about many devices and their backup sets."""

tests/cmds/test_devices.py

@@ -690,7 +690,7 @@ def test_get_device_dataframe_returns_correct_columns(
         "osVersion",
         "userUid",
     ]
-    result = _get_device_dataframe(cli_state.sdk, columns)
+    result = _get_device_dataframe(cli_state.sdk, columns, page_size=100)
     assert "computerId" in result.columns
     assert "guid" in result.columns
     assert "name" in result.columns
@@ -710,7 +710,9 @@ def test_get_device_dataframe_returns_correct_columns(
 def test_device_dataframe_return_includes_backupusage_when_flag_passed(
     cli_state, get_all_devices_success
 ):
-    result = _get_device_dataframe(cli_state.sdk, columns=[], include_backup_usage=True)
+    result = _get_device_dataframe(
+        cli_state.sdk, columns=[], page_size=100, include_backup_usage=True
+    )
     assert "backupUsage" in result.columns
 
 
@@ -738,6 +740,24 @@ def test_add_legal_hold_membership_to_device_dataframe_adds_legal_hold_columns_t
     assert "legalHoldName" in result.columns
 
 
+def test_list_without_page_size_option_defaults_to_100_results_per_page(
+    cli_state, runner
+):
+    runner.invoke(cli, ["devices", "list"], obj=cli_state)
+    cli_state.sdk.devices.get_all.assert_called_once_with(
+        active=None, include_backup_usage=False, org_uid=None, page_size=100
+    )
+
+
+def test_list_with_page_size_option_sets_expected_page_size_in_request(
+    cli_state, runner
+):
+    runner.invoke(cli, ["devices", "list", "--page-size", "1000"], obj=cli_state)
+    cli_state.sdk.devices.get_all.assert_called_once_with(
+        active=None, include_backup_usage=False, org_uid=None, page_size=1000
+    )
+
+
 def test_list_include_legal_hold_membership_pops_legal_hold_if_device_deactivated(
     cli_state, get_all_matter_success, get_all_custodian_success
 ):