new: Display region_prices in linode types output (#533)

Author: yec-akamai

linodecli/overrides.py

@@ -4,6 +4,10 @@
 large changes to the OpenAPI spec.
 """
 
+from rich.align import Align
+from rich.console import Console
+from rich.table import Table
+
 from linodecli.output import OutputMode
 
 OUTPUT_OVERRIDES = {}
@@ -37,3 +41,92 @@ def handle_domains_zone_file(operation, output_handler, json_data) -> bool:
     """
     print("\n".join(json_data["zone_file"]))
     return False
+
+
+@output_override("linodes", "types", OutputMode.table)
+def handle_types_region_prices_list(
+    operation, output_handler, json_data
+) -> bool:
+    """
+    Override the output of 'linode-cli linodes types' to display regional pricing.
+    """
+    return linode_types_with_region_prices(operation, output_handler, json_data)
+
+
+def linode_types_with_region_prices(
+    operation, output_handler, json_data
+) -> bool:
+    # pylint: disable=unused-argument
+    """
+    Parse and reformat linode types output with region prices.
+    """
+    if len(json_data["data"]) < 1:
+        return True
+
+    output = Table()
+
+    # To ensure the order of the headers and make sure we have region_prices as the last column
+    headers = sorted(
+        json_data["data"][0].keys() - ["addons", "price", "region_prices"],
+        key=len,
+    )
+    headers += ["price.hourly", "price.monthly", "region_prices"]
+
+    for header in headers:
+        output.add_column(header, justify="center")
+
+    for linode in json_data["data"]:
+        row = []
+        for h in headers:
+            if h == "region_prices":
+                sub_table = format_region_prices(linode[h])
+                row.append(sub_table)
+
+            elif h in ("price.hourly", "price.monthly"):
+                price = format_prices(h, linode)
+                row.append(Align(price, align="left"))
+
+            else:
+                row.append(Align(str(linode[h]), align="left"))
+
+        output.add_row(*row)
+
+    console = Console()
+    console.print(output)
+
+    print(
+        "See our [Pricing Page](https://www.linode.com/pricing/) for Region-specific pricing, "
+        + "which applies after migration is complete."
+    )
+
+    return False
+
+
+def format_prices(prices, data: dict[str, any]) -> any:
+    """
+    Format nested price entry.
+    """
+    price_headers = prices.split(".")
+
+    return str(data[price_headers[0]][price_headers[1]])
+
+
+def format_region_prices(data: dict[str, any]) -> any:
+    """
+    Format nested region price entry into a sub-table.
+    """
+    subheaders = ["id", "hourly", "monthly"]
+
+    sub_table = Table()
+
+    for header in subheaders:
+        sub_table.add_column(header, justify="center")
+
+    for region_price in data:
+        region_price_row = (
+            Align(str(region_price[header]), align="left")
+            for header in subheaders
+        )
+        sub_table.add_row(*region_price_row)
+
+    return sub_table

tests/unit/test_overrides.py

@@ -56,3 +56,59 @@ def patch_func(*a):
             )
 
         assert stdout_buf.getvalue() != "line 1\nline 2\n"
+
+    def test_types_region_prices_list(
+        self, mock_cli, list_operation_for_overrides_test
+    ):
+        response_json = {
+            "data": [
+                {
+                    "addons": {
+                        "backups": {
+                            "price": {"hourly": 0.008, "monthly": 5},
+                            "region_prices": [
+                                {
+                                    "hourly": 0.0096,
+                                    "id": "us-east",
+                                    "monthly": 6,
+                                }
+                            ],
+                        }
+                    },
+                    "class": "standard",
+                    "disk": 81920,
+                    "gpus": 0,
+                    "id": "g6-standard-2",
+                    "label": "Linode 4GB",
+                    "memory": 4096,
+                    "network_out": 1000,
+                    "price": {"hourly": 0.03, "monthly": 20},
+                    "region_prices": [
+                        {"hourly": 0.036, "id": "us-east", "monthly": 24}
+                    ],
+                    "successor": None,
+                    "transfer": 4000,
+                    "vcpus": 2,
+                }
+            ],
+            "page": 1,
+            "pages": 1,
+            "results": 1,
+        }
+
+        override_signature = ("linodes", "types", OutputMode.table)
+
+        list_operation_for_overrides_test.command = "linodes"
+        list_operation_for_overrides_test.action = "types"
+        mock_cli.output_handler.mode = OutputMode.table
+
+        stdout_buf = io.StringIO()
+
+        with contextlib.redirect_stdout(stdout_buf):
+            list_operation_for_overrides_test.process_response_json(
+                response_json, mock_cli.output_handler
+            )
+
+        rows = stdout_buf.getvalue().split("\n")
+        # assert that the overridden table has the new columns
+        assert len(rows[1].split(rows[1][0])) == 15