centralcli 8.2.2__tar.gz → 8.2.4__tar.gz

{centralcli-8.2.2 → centralcli-8.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: centralcli
-Version: 8.2.2
+Version: 8.2.4
 Summary: A CLI for interacting with Aruba Central (Cloud Management Platform).  Facilitates bulk imports, exports, reporting.  A handy tool if you have devices managed by Aruba Central.
 License: MIT
 Keywords: cli,Aruba,Aruba Networks,Aruba Central,HPE,API,RESTFUL,REST

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/cache.py

@@ -2537,14 +2537,16 @@ class Cache:
         return await self.update_db(DB, data=list(updated_devs_by_serial.values()), truncate=True)
 
 
-    async def update_db(self, db: Table, data: List[Dict[str, Any]] | Dict[str, Any] = None, doc_ids: List[int] | int = None, truncate: bool = True) -> bool:
+    async def update_db(self, db: Table, data: List[Dict[str, Any]] | Dict[str, Any] = None, *, doc_ids: List[int] | int = None, dev_types: constants.GenericDeviceTypes | List[constants.GenericDeviceTypes] = None, truncate: bool = True,) -> bool:
         """Update Local Cache DB
 
         Args:
             db (Table): TinyDB Table object to be updated.
             data (List[Dict[str, Any]] | Dict[str, Any], optional): Data to be added to database. Defaults to None.
-            truncate (bool, optional): Existing DB data will be discarded, and all data in DB will be replaced with provided. Defaults to True.
             doc_ids (List[int] | int, optional): doc_ids to be deleted from the DB. Defaults to None.
+            dev_types (Literal["ap", "gw", "cx", "sw", "switch"] | List["ap", "gw" ...], optional): List of dev_types the data represents as current for those types.
+                This will result in any devices of the specified types that do not exist in the provided data being removed from cache. Defaults to None.
+            truncate (bool, optional): Existing DB data will be discarded, and all data in DB will be replaced with provided. Defaults to True.
 
         Returns:
             bool: _description_
@@ -2589,6 +2591,43 @@ class Cache:
         else:
             return await self.update_db(self.DevDB, doc_ids=data)
 
+    async def prep_filtered_devs_for_cache(self, raw_models: List[models.Device], dev_type: constants.GenericDeviceTypes | List[constants.GenericDeviceTypes] = None, site: str = None, group: str = None) -> List[dict]:
+        new_by_serial = {d.serial: d.model_dump() for d in raw_models}
+        filters = {
+            "dev_type": dev_type,
+            "site": site,
+            "group": group
+        }
+        filter_msg = ", ".join([f"{k}: {v if k != 'dev_type' else utils.unlistify(v)}" for k, v in filters.items() if v])
+
+        if dev_type:
+            switch_types = ["cx", "sw"] if "switch" in dev_type else []
+            cache_type = [*[t for t in dev_type if t != "switch"], *switch_types]
+        else:
+            cache_type = []
+
+        def include_device(dev: dict) -> bool:
+            criteria = []
+            if cache_type:
+                criteria += [dev["type"] in cache_type]
+            if site:
+                criteria += [dev["site"] == site]
+            if group:
+                criteria += [dev["group"] == group]
+
+            if all(criteria):
+                if dev["serial"] not in new_by_serial:
+                    return False
+
+            return True
+
+        cache_devices = {cd["serial"]: cd for cd in self.devices if include_device(cd)}
+
+        update_data = {**cache_devices, **new_by_serial}
+        log.info(f"Data prepared for device cache update.  Filters: {filter_msg}. Add/update {len(new_by_serial)} devices.  Devices in cache: Now: {len(self.devices)}, After Update: {len(update_data)}.")
+
+        return list(update_data.values())
+
     async def refresh_dev_db(
             self,
             dev_type: constants.GenericDeviceTypes | List[constants.GenericDeviceTypes] = None,  # TODO make consistent throughout using device_type in many places
@@ -2657,7 +2696,9 @@ class Cache:
             offset=offset,
             limit=limit,
         )
-        if isinstance(resp, CombinedResponse) and resp.ok:
+        if isinstance(resp, CombinedResponse) and resp.ok:  # Can be Response | List[Response] if get_all_devices aborted due to failures
+            # Any filters not in list below do not result in a cache update
+            filtered_resonse = True if any([label, serial, mac, model, stack_id, swarm_id, cluster_id, public_ip_address, status]) else False
             raw_data = await self.format_raw_devices_for_cache(resp)
             with console.status(f"preparing {len(resp)} records for cache update"):
                 _start_time = time.perf_counter()
@@ -2665,13 +2706,18 @@ class Cache:
                 raw_models = [*raw_models_by_type.aps, *raw_models_by_type.switches, *raw_models_by_type.gateways]
                 log.debug(f"prepared {len(resp)} records for dev cache update in {round(time.perf_counter() - _start_time, 2)}")
 
-            filtered_resonse = True if any([dev_type, group, site, label, serial, mac, model, stack_id, swarm_id, cluster_id, public_ip_address, status]) else False
+            if dev_type:
+                update_data = await self.prep_filtered_devs_for_cache(raw_models=raw_models, dev_type=dev_type, site=site, group=group)
+            else:
+                update_data = [dev.model_dump() for dev in raw_models]
+
             if resp.all_ok and not filtered_resonse:
-                self.updated.append(self.central.get_all_devices)
-                self.responses.dev = resp
-                _ = await self.update_db(self.DevDB, data=[dev.model_dump() for dev in raw_models], truncate=True)
+                if not dev_type:
+                    self.updated.append(self.central.get_all_devices)
+                    self.responses.dev = resp
+                _ = await self.update_db(self.DevDB, data=update_data, truncate=True)
             else:  # Response is filtered or incomplete due to partial failure merge with existing cache data (update)
-                _ = await self._add_update_devices([dev.model_dump() for dev in raw_models])
+                _ = await self._add_update_devices(update_data)
 
         return resp
 

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/cleaner.py

@@ -2069,14 +2069,7 @@ def get_swarm_firmware_details(data: List[Dict[str, Any]]) -> List[Dict[str, Any
     return simple_kv_formatter(data, key_order=key_order)
 
 def show_radios(data: List[Dict[str, str | int]]) -> List[Dict[str, str | int]]:
-    def by_name_blocks(name: str, exist_names=[]) -> str:
-        if name not in exist_names:
-            exist_names += [name]
-            return name
-        return ''
-
     key_order = ["name", "macaddr", "radio_name", "status", "channel", "radio_type", "spatial_stream", "mode", "tx_power", "utilization",]  # "band", "index"]
-    data = [{k: v if k != "name" else by_name_blocks(v) for k, v in inner.items()} for inner in data]
     data = simple_kv_formatter(data, key_order=key_order)
 
     return data

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/clibatch.py

@@ -378,7 +378,7 @@ def batch_add_sites(import_file: Path = None, data: dict = None, yes: bool = Fal
     address_fields = {"site_name": "bright_green", "name": "bright_green", "address": "bright_cyan", "city": "turquoise4", "state": "dark_olive_green3", "country": "magenta", "zipcode": "blue", "zip": "blue"}
     confirm_msg = utils.summarize_list(
         [
-            "|".join([f'[{address_fields[k]}]{v}[/]' for k, v in site.items() if v and k in address_fields]) for site in verified_sites.model_dump()
+            "|".join([f'[{address_fields[k]}]{v}[/]' for k, v in site.model_dump().items() if v and k in address_fields]) for site in list(verified_sites)
         ],
         max=7
     )
@@ -974,8 +974,12 @@ def add(
     caption, tablefmt = None, "action"
     if what == "sites":
         resp = batch_add_sites(import_file, yes=yes)
+        if resp.ok:
+            try:
+                resp.output = cleaner.sites(resp.output)
+            except Exception as e:
+                log.error(f"Error cleaning output of batch site addition {repr(e)}", caption=True, log=True)
         tablefmt = "rich"
-        # TODO should re-order columns so output is more consistent with show sites (i.e. site_name is not guaranteed to be first col in output of these calls)
     elif what == "groups":
         resp = batch_add_groups(import_file, yes=yes)
     elif what == "devices":
@@ -1004,7 +1008,7 @@ def add(
             "Use [cyan]cencli show cloud-auth upload mpsk[/] to see the status of the import."
         )
 
-    cli.display_results(resp, tablefmt=tablefmt, title=f"Batch Add {what}", caption=caption)
+    cli.display_results(resp, tablefmt=tablefmt, title=f"Batch Add {what.value}", caption=caption)
 
 
 # TODO archive and unarchive have the same block this is used by batch delete

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/clicommon.py

@@ -521,6 +521,7 @@ class CLICommon:
         reverse: bool = False,
         stash: bool = True,
         output_by_key: str | List[str] = "name",
+        group_by: str = None,
         set_width_cols: dict = None,
         full_cols: Union[List[str], str] = [],
         fold_cols: Union[List[str], str] = [],
@@ -555,6 +556,7 @@ class CLICommon:
             "account": None if config.account in ["central_info", "default"] else config.account,
             "config": config,
             "output_by_key": output_by_key,
+            "group_by": group_by,
             "set_width_cols": set_width_cols,
             "full_cols": full_cols,
             "fold_cols": fold_cols,
@@ -592,6 +594,7 @@ class CLICommon:
         reverse: bool = False,
         stash: bool = True,
         output_by_key: str | List[str] = "name",
+        group_by: str = None,
         exit_on_fail: bool = False,  # TODO make default True so failed calls return a failed return code to the shell.  Need to validate everywhere it needs to be set to False
         cache_update_pending: bool = False,
         set_width_cols: dict = None,
@@ -625,6 +628,8 @@ class CLICommon:
                 show last.  Default: True
             output_by_key: For json or yaml output, if any of the provided keys are foound in the List of dicts
                 the List will be converted to a Dict[value of provided key, original_inner_dict].  Defaults to name.
+            group_by: When provided output will be grouped by this key.  For outputs where multiple entries relate to a common device, and multiple devices exist in the output.
+                i.e. interfaces for a device when the output contains multiple devices.  Results in special formatting.  Defaults to None
             exit_on_fail: (bool, optional): If provided resp indicates a failure exit after display.  Defaults to False
             cache_update_pending: (bool, optional): If a cache update is to be performed if resp is success.
                 Results in a warning before exit if failure. Defaults to False
@@ -753,6 +758,7 @@ class CLICommon:
                         reverse=reverse,
                         stash=stash,
                         output_by_key=output_by_key,
+                        group_by=group_by,
                         set_width_cols=set_width_cols,
                         full_cols=full_cols,
                         fold_cols=fold_cols,
@@ -1509,7 +1515,7 @@ class CLICommon:
             cache_devs += [this_dev]
 
         not_found_devs: List[str] = [s for s, c in zip(serials_in, cache_devs) if c is None]
-        cache_found_devs: List[CacheDevice | CacheInvDevice] = [d for d in cache_devs if d]
+        cache_found_devs: List[CacheDevice | CacheInvDevice] = [d for d in cache_devs if d is not None]
         cache_mon_devs: List[CacheDevice] = [d for d in cache_found_devs if d.db.name == "devices"]
         cache_inv_devs: List[CacheInvDevice] = [d for d in cache_found_devs if d.db.name == "inventory"]
 
@@ -1616,6 +1622,96 @@ class CLICommon:
         if inv_doc_ids:
             self.central.request(self.cache.update_inv_db, inv_doc_ids, remove=True)
 
+# Header rows used by CAS
+#DEVICE NAME,SERIAL,MAC,GROUP,SITE,LABELS,LICENSE,ZONE,SWARM MODE,RF PROFILE,INSTALLATION TYPE,RADIO 0 MODE,RADIO 1 MODE,RADIO 2 MODE,DUAL 5GHZ MODE,SPLIT 5GHZ MODE,FLEX DUAL BAND,ANTENNA WIDTH,ALTITUDE,IP ADDRESS,SUBNET MASK,DEFAULT GATEWAY,DNS SERVER,DOMAIN NAME,TIMEZONE,AP1X USERNAME,AP1X PASSWORD
+
+    # def batch_update_aps(self, data: List[dict]) -> List[Response]:
+    #         data: List[CacheDevice] = [self.cache.get_dev_identifier(ap, dev_type="ap") for ap in data]
+
+    #         disable_radios = None if not disable_radios else [r.value for r in disable_radios]
+    #         enable_radios = None if not enable_radios else [r.value for r in enable_radios]
+    #         flex_dual_exclude = None if not flex_dual_exclude else flex_dual_exclude.value
+    #         antenna_width = None if not antenna_width else antenna_width.value
+
+    #         radio_24_disable = None if not enable_radios or "2.4" not in enable_radios else False
+    #         radio_5_disable = None if not enable_radios or "5" not in enable_radios else False
+    #         radio_6_disable = None if not enable_radios or "6" not in enable_radios else False
+    #         if disable_radios:
+    #             for radio, var in zip(["2.4", "5", "6"], [radio_24_disable, radio_5_disable, radio_6_disable]):
+    #                 if radio in disable_radios and var is not None:
+    #                     cli.exit(f"Invalid combination you tried to enable and disable the {radio}Ghz radio")
+    #                 # var = None if radio not in disable_radios else True  # doesn't work
+    #             radio_24_disable = None if "2.4" not in disable_radios else True
+    #             radio_5_disable = None if "5" not in disable_radios else True
+    #             radio_6_disable = None if "6" not in disable_radios else True
+
+
+    #         kwargs = {
+    #             "hostname": hostname,
+    #             "ip": ip,
+    #             "mask": mask,
+    #             "gateway": gateway,
+    #             "dns": dns,
+    #             "domain": domain,
+    #             "radio_24_disable": radio_24_disable,
+    #             "radio_5_disable": radio_5_disable,
+    #             "radio_6_disable": radio_6_disable,
+    #             "uplink_vlan": tagged_uplink_vlan,
+    #             "flex_dual_exclude": flex_dual_exclude,
+    #             "dynamic_ant_mode": antenna_width,
+    #         }
+    #         if ip and not all([mask, gateway, dns]):
+    #             cli.exit("[cyan]mask[/], [cyan]gateway[/], and [cyan]--dns[/] are required when [cyan]--ip[/] is provided.")
+    #         if len(data) > 1 and hostname or ip:
+    #             cli.exit("Setting hostname/ip on multiple APs doesn't make sesnse")
+
+    #         print(f"[bright_green]Updating[/]: {utils.summarize_list([ap.summary_text for ap in data], color=None, pad=10).lstrip()}")
+    #         print("\n[green italic]With the following per-ap-settings[/]:")
+    #         _ = [print(f"  {k}: {v}") for k, v in kwargs.items() if v is not None]
+    #         skip_flex = [ap for ap in data if ap.model not in flex_dual_models]
+    #         skip_width = [ap for ap in data if ap.model not in ["679"]]
+
+    #         warnings = []
+    #         if flex_dual_exclude is not None and skip_flex:
+    #             warnings += [f"[yellow]:information:[/]  Flexible dual radio [red]will be ignored[/] for {len(skip_flex)} AP, as the setting doesn't apply to those models."]
+    #         if antenna_width is not None and skip_width:
+    #             warnings += [f"[yellow]:information:[/]  Dynamic antenna width [red]will be ignored[/] for {len(skip_width)} AP, as the setting doesn't apply to those models."]
+    #         if warnings:
+    #             warn_text = '\n'.join(warnings)
+    #             print(f"\n{warn_text}")
+
+    #         # determine if any effective changes after skips for settings on invalid AP models
+    #         changes = 2
+    #         if not list(filter(None, list(kwargs.values())[0:-2])):
+    #             if not flex_dual_exclude or (flex_dual_exclude and not [ap for ap in data if ap not in skip_flex]):
+    #                 changes -= 1
+    #             if not antenna_width or (antenna_width and not [ap for ap in data if ap not in skip_width]):
+    #                 changes -= 1
+    #         if not changes:
+    #             cli.exit("No valid updates provided for the selected AP models... Nothing to do.")
+
+    #         self.confirm(yes)  # exits here if they abort
+    #         batch_resp = cli.central.batch_request(
+    #             [
+    #                 BatchRequest(
+    #                     cli.central.update_per_ap_settings,
+    #                     ap.serial,
+    #                     hostname=hostname,
+    #                     ip=ip,
+    #                     mask=mask,
+    #                     gateway=gateway,
+    #                     dns=dns,
+    #                     domain=domain,
+    #                     radio_24_disable=radio_24_disable,
+    #                     radio_5_disable=radio_5_disable,
+    #                     radio_6_disable=radio_6_disable,
+    #                     uplink_vlan=tagged_uplink_vlan,
+    #                     flex_dual_exclude=None if ap.model not in flex_dual_models else flex_dual_exclude,
+    #                     dynamic_ant_mode=None if ap.model != "679" else antenna_width,
+    #                 ) for ap in data
+    #             ]
+    #         )
+
     def help_default(self, default_txt: str) -> str:
         """Helper function that returns properly escaped default text, including rich color markup, for use in CLI help.
 

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/clishow.py

@@ -962,7 +962,11 @@ def parse_interface_responses(dev_type: GenericDeviceTypes, responses: List[Resp
     _passed = responses if not _failed else [r for r in responses if r.ok]
 
     if _failed:
-        log.warning(f"Incomplete output!! {len(_failed)} calls failed.  Devices: {utils.color([r.url.path.split("/")[-2:][0] for r in _failed])}. [cyan]cencli show logs --cencli[/] for details.", caption=True)
+        try:
+            log.warning(f"Incomplete output!! {len(_failed)} calls failed.  Devices: {utils.color([r.url.path.split('/')[-2:][0] for r in _failed])}. [cyan]cencli show logs --cencli[/] for details.", caption=True)
+        except Exception:
+            log.warning("Incomplete output, failures occured, see log")
+
 
     # output = [i for r in _passed for i in utils.listify(r.output)]
     output = [r.output for r in _passed]
@@ -1132,10 +1136,10 @@ def interfaces(
 
     caption = []
     if dev_type == "switch":
-        if "sw" in [d.type for d in devs]:
+        if "sw" in [d.type for d in devs] and resp.ok:
             dev_type = dev_type if len(batch_resp) > 1 else "sw"  # So single device cleaner gets specific dev_type
             caption = [render.rich_capture(":information:  Native VLAN for trunk ports not shown for aos-sw as not provided by the API", emoji=True)]
-        if "cx" in [d.type for d in devs]:
+        if "cx" in [d.type for d in devs] and resp.ok:
             caption = [render.rich_capture(":information:  L3 interfaces for CX switches will show as Access/VLAN 1 as the L3 details are not provided by the API", emoji=True)]
 
     if resp:
@@ -1161,6 +1165,7 @@ def interfaces(
         sort_by=sort_by,
         reverse=reverse,
         output_by_key=None,
+        group_by=None if len(batch_resp) <= 1 else "device",
         cleaner=cleaner.show_interfaces if len(batch_resp) == 1 else None,  # Multi device listing is ran through cleaner already
         verbosity=verbose,
         dev_type=dev_type,
@@ -3201,22 +3206,24 @@ def radios(
             resp = sorted(passed, key=lambda ap: ap.rl)[0]
             resp.output = [{"name": ap["name"], **rdict} for ap in combined for rdict in ap["radios"]]
         if failed:
-            cli.display_results(failed)
+            cli.display_results(failed, tablefmt="action")
     else:
         resp = cli.central.request(cli.cache.refresh_dev_db, dev_type="ap", **{**params, **default_params})
         if resp.ok:
             resp.output = [{"name": ap["name"], **rdict} for ap in resp.output for rdict in ap["radios"]]
 
     if resp.ok:
+        # We sort before sending data to renderer to keep groupings by AP name
         if sort_by and resp.output and sort_by in resp.output[0].keys():
             resp.output = list(sorted(resp.output, key=lambda ap: (ap["name"], ap[sort_by])))
         else:
             resp.output = list(sorted(resp.output, key=lambda ap: (ap["name"], ap["radio_name"])))
+
+        caption = _build_radio_caption(resp.output)
         if status:
             resp.output = list(filter(lambda radio: radio["status"] == status, resp.output))
-        caption = _build_radio_caption(resp.output)
 
-    cli.display_results(resp, tablefmt=tablefmt, title="Radio Details", reverse=reverse, outfile=outfile, pager=pager, caption=caption, cleaner=cleaner.show_radios)
+    cli.display_results(resp, tablefmt=tablefmt, title="Radio Details", reverse=reverse, outfile=outfile, pager=pager, caption=caption, group_by="name", cleaner=cleaner.show_radios)
 
 
 @app.command()

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/models.py

@@ -233,7 +233,7 @@ class ImportSites(RootModel):
 
     @staticmethod
     def _convert_site_key(_data: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
-        def auto_usa(data: Dict[str, str | int | float]) -> str:
+        def auto_usa(data: Dict[str, str | int | float]) -> str | None:
             _country = data.get("country", "")
             if _country.isdigit():  # Data from large customer had country as '1' for some sites
                 _country = ""
@@ -243,7 +243,7 @@ class ImportSites(RootModel):
             if _country.upper() in ["USA", "US"]:
                 return "United States"
 
-            return _country
+            return _country or None
 
         _data = [
             {

{centralcli-8.2.2 → centralcli-8.2.4}/centralcli/render.py

@@ -170,12 +170,12 @@ def do_pretty(key: str, value: str) -> str:
     value = "" if value is None else value  # testing error on cop
     return value if key != "status" else f'[b {color}]{value.title()}[/b {color}]'
 
-def _do_subtables(data: List[dict], tablefmt: str = "rich") -> List[dict]:
+def _do_subtables(data: List[dict], *, tablefmt: str = "rich") -> List[dict]:
     """Parse data and format any values that are dict, list, tuple
 
     Args:
         data (list): The data
-        tablefmt (str, optional): table format. Defaults to "rich".
+        tablefmt (str, optional): table format. Defaults to "rich"
 
     Returns:
         List[dict]: Original dict with any inner (dict/list/tuples)
@@ -250,11 +250,35 @@ def tabulate_output(outdata: List[dict]) -> tuple:
 
     return raw_data, table_data
 
+def build_rich_table_rows(data: List[Dict[str, Text | str]], table: Table, group_by: str) -> Table:
+    if not group_by:
+        [table.add_row(*list(in_dict.values())) for in_dict in data]
+        return table
+
+    if not isinstance(data, list) or group_by not in data[0]:
+        log.error(f"Error in render.do_group_by_table invalid type {type(data)} or {group_by} not found in header.")
+        [table.add_row(*list(in_dict.values())) for in_dict in data]
+        return table
+
+    field_idx = list(data[0].keys()).index(group_by)
+    this = "_start_"
+    for in_dict in data:
+        if in_dict[group_by] == this:
+            table.add_row(*[v if idx != field_idx else "" for idx, v in enumerate(in_dict.values())])  # only  show value for first entry in group
+        else:
+            this = in_dict[group_by]  # first entry in group
+            table.add_section()
+            table.add_row(*list(in_dict.values()))
+
+    return table
+
+
 def rich_output(
     outdata: List[dict],
     title: str = None,
     caption: str = None,
     account: str = None,
+    group_by: str = None,
     set_width_cols: dict = None,
     full_cols: Union[List[str], str] = [],
     fold_cols: Union[List[str], str] = [],
@@ -266,6 +290,7 @@ def rich_output(
         title (str, optional): Table Title. Defaults to None.
         caption (str, optional): Table Caption. Defaults to None.
         account (str, optional): The account (displayed in caption if not the default). Defaults to None.
+        group_by (str, optional): Group output by the value of the provided field.  Results in special formatting.  Defaults to None.
         set_width_cols (dict, optional): cols that need to be rendered with a specific width. Defaults to None.
         full_cols (Union[List[str], str], optional): cols that should not be truncated. Defaults to [].
         fold_cols (Union[List[str], str], optional): cols that can be folded (wrapped). Defaults to [].
@@ -324,7 +349,7 @@ def rich_output(
         formatted = _do_subtables(outdata)
         log.debug(f"render.rich_output.do_subtables took {time.perf_counter() - _start:.2f} to process {len(outdata)} records")
 
-        [table.add_row(*list(in_dict.values())) for in_dict in formatted]
+        table = build_rich_table_rows(formatted, table=table, group_by=group_by)
 
         if title:
             table.title = f'[italic cornflower_blue]{constants.what_to_pretty(title)}'
@@ -352,6 +377,32 @@ def rich_output(
 
     return outdata, outdata
 
+
+def format_data_by_key(data: List[Dict[str, Any]], output_by_key: str) -> Dict[str, Any]:
+    # -- modify keys potentially formatted with \n for narrower rich output to format appropriate for json/yaml
+    data = utils.listify(data)
+    if isinstance(data[0], dict) and all([isinstance(k, str) for k in list(data[0].keys())]):
+        data = [{k.replace(" ", "_").replace("\n", "_"): v for k, v in d.items()} for d in data]
+
+    # -- convert List[dict] --> Dict[dev_name: dict] for yaml/json outputs unless output_dict_by_key is specified, then use the provided key(s) rather than name
+    if output_by_key and data and isinstance(data[0], dict):
+        if len(output_by_key) == 1 and "+" in output_by_key[0]:
+            found_keys = [k for k in output_by_key[0].split("+") if k in data[0]]
+            if len(found_keys) == len(output_by_key[0].split("+")):
+                data: Dict[dict] = {
+                    f"{'-'.join([item[key] for key in found_keys])}": {k: v for k, v in item.items()} for item in data
+                }
+        else:
+            _output_key = [k for k in output_by_key if k in data[0]]
+            if _output_key:
+                _output_key = _output_key[0]
+                data: Dict[dict] = {
+                    item[_output_key]: {k: v for k, v in item.items() if k != _output_key}
+                    for item in data
+                }
+    return data
+
+
 def output(
     outdata: List[str] | List[Dict[str, Any]] | Dict[str, Any],
     tablefmt: TableFormat = "rich",  # "action" and "raw" are not sent through formatter, handled in clicommon.display_output
@@ -360,6 +411,7 @@ def output(
     account: str = None,
     config: Config = None,
     output_by_key: str | List[str] = "name",
+    group_by: str = None,
     set_width_cols: dict = None,
     full_cols: Union[List[str], str] = [],
     fold_cols: Union[List[str], str] = [],
@@ -368,6 +420,7 @@ def output(
     raw_data = outdata
     _lexer = table_data = None
 
+    # sanitize output for demos
     if config and config.sanitize and raw_data and all(isinstance(x, dict) for x in raw_data):
         outdata = [{k: d[k] if k not in REDACT else "--redacted--" for k in d} for d in raw_data]
 
@@ -376,27 +429,7 @@ def output(
         tablefmt = "simple"
 
     if tablefmt in ['json', 'yaml', 'yml']:
-        # -- modify keys potentially formatted with \n for narrower rich output to format appropriate for json/yaml
-        outdata = utils.listify(outdata)
-        if isinstance(outdata[0], dict) and all([isinstance(k, str) for k in list(outdata[0].keys())]):
-            outdata = [{k.replace(" ", "_").replace("\n", "_"): v for k, v in data.items()} for data in outdata]
-
-        # -- convert List[dict] --> Dict[dev_name: dict] for yaml/json outputs unless output_dict_by_key is specified, then use the provided key(s) rather than name
-        if output_by_key and outdata and isinstance(outdata[0], dict):
-            if len(output_by_key) == 1 and "+" in output_by_key[0]:
-                found_keys = [k for k in output_by_key[0].split("+") if k in outdata[0]]
-                if len(found_keys) == len(output_by_key[0].split("+")):
-                    outdata: Dict[dict] = {
-                        f"{'-'.join([item[key] for key in found_keys])}": {k: v for k, v in item.items()} for item in outdata
-                    }
-            else:
-                _output_key = [k for k in output_by_key if k in outdata[0]]
-                if _output_key:
-                    _output_key = _output_key[0]
-                    outdata: Dict[dict] = {
-                        item[_output_key]: {k: v for k, v in item.items() if k != _output_key}
-                        for item in outdata
-                    }
+        outdata = format_data_by_key(outdata, output_by_key)
 
     if tablefmt == "json":
         outdata = utils.unlistify(outdata)
@@ -445,8 +478,7 @@ def output(
         table_data = rich_capture(table_data)
 
     elif tablefmt == "rich":
-        raw_data, table_data = rich_output(outdata, title=title, caption=caption, account=account, set_width_cols=set_width_cols, full_cols=full_cols, fold_cols=fold_cols)
-        ...
+        raw_data, table_data = rich_output(outdata, title=title, caption=caption, account=account, set_width_cols=set_width_cols, full_cols=full_cols, fold_cols=fold_cols, group_by=group_by)
 
     elif tablefmt == "tabulate":
         raw_data, table_data = tabulate_output(outdata)

{centralcli-8.2.2 → centralcli-8.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "centralcli"
-version = "8.2.2"
+version = "8.2.4"
 description = "A CLI for interacting with Aruba Central (Cloud Management Platform).  Facilitates bulk imports, exports, reporting.  A handy tool if you have devices managed by Aruba Central."
 license = "MIT"
 authors = [{"name" = "Wade Wells (Pack3tL0ss)","email" = "cencli@consolepi.com"}]

centralcli-8.2.2/centralcli/cnxcli/__init__.py

@@ -1,25 +0,0 @@
-from centralcli import config, log, cnx_client, utils, cleaner
-from centralcli.typedefs import Method, StrOrURL
-from centralcli.constants import lib_to_api, STRIP_KEYS
-from centralcli.exceptions import CentralCliException
-from centralcli.response import RateLimit, BatchRequest, LoggedRequests, Spinner, Response
-from .pycentralv2.base import ArubaCentralNewBase
-
-__all__ = [
-    config,
-    log,
-    cnx_client,
-    Method,
-    StrOrURL,
-    lib_to_api,
-    STRIP_KEYS,
-    cleaner,
-    utils,
-    CentralCliException,
-    RateLimit,
-    BatchRequest,
-    LoggedRequests,
-    Spinner,
-    Response,
-    ArubaCentralNewBase
-]

centralcli-8.2.2/centralcli/cnxcli/api/__init__.py

@@ -1,12 +0,0 @@
-# from ...response import BatchRequest, Response, LoggedRequests, Spinner
-# from ... import utils
-# from ..pycentralv2.base import ArubaCentralNewBase
-
-# __all__ = [
-#     BatchRequest,
-#     Response,
-#     LoggedRequests,
-#     Spinner,
-#     ArubaCentralNewBase,
-#     utils
-# ]