review updates

Author: pmajali

linode_api4/groups/monitor_service.py

@@ -10,7 +10,7 @@
 
 class MonitorGroup(Group):
     """
-    Encapsulates Monitor-related methods of the :any:`LinodeClient`.  
+    Encapsulates Monitor-related methods of the :any:`LinodeClient`.
 
     This group contains all features beneath the `/monitor` group in the API v4.
     """
@@ -36,12 +36,14 @@ def list_monitor_dashboards(self, *filters) -> list[MonitorDashboard]:
 
         return self.client._get_and_filter(MonitorDashboard, *filters)
 
-    def list_dashboards_by_service(self, service_type: str, *filters) -> list[MonitorDashboard]:
+    def list_dashboards_by_service(
+        self, service_type: str, *filters
+    ) -> list[MonitorDashboard]:
         """
         Returns a list of dashboards for a particular service.
-            
+
             dashboard_by_service = client.monitor_service.list_dashboards_by_service(service_type="dbaas")
-        
+
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-dashboards
@@ -67,7 +69,7 @@ def list_supported_services(self, *filters) -> list[MonitorService]:
         Returns a list of services supported by ACLP.
 
             supported_services = client.monitor_service.list_supported_services()
-        
+
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
@@ -82,22 +84,24 @@ def list_supported_services(self, *filters) -> list[MonitorService]:
 
         return self.client._get_and_filter(MonitorService, *filters)
 
-    def list_service_by_type(self, service_type: str, *filters) -> list[MonitorService]:
+    def list_service_by_type(
+        self, service_type: str, *filters
+    ) -> list[MonitorService]:
         """
         Lists monitor services by a given service_type
 
             service_details = client.monitor_service.list_service_by_type(service_type="dbaas")
-        
+
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
-        
+
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type
-        
+
         :param service_type: The service type to get details for.
         :type service_type: str
         :param filters: Any number of filters to apply to this query.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                         for more details on filtering.
-        
+
         :returns: Lists monitor services by a given service_type
         :rtype: PaginatedList of the Services
         """
@@ -107,8 +111,9 @@ def list_service_by_type(self, service_type: str, *filters) -> list[MonitorServi
             endpoint=f"/monitor/services/{service_type}",
         )
 
-
-    def list_metric_definitions(self, service_type: str, *filters) -> list[MonitorMetricsDefinition]:
+    def list_metric_definitions(
+        self, service_type: str, *filters
+    ) -> list[MonitorMetricsDefinition]:
         """
         Returns metrics for a specific service type.
 
@@ -132,15 +137,17 @@ def list_metric_definitions(self, service_type: str, *filters) -> list[MonitorMe
             endpoint=f"/monitor/services/{service_type}/metric-definitions",
         )
 
-    def create_token(self, service_type: str, entity_ids: list) -> MonitorServiceToken:
+    def create_token(
+        self, service_type: str, entity_ids: list
+    ) -> MonitorServiceToken:
         """
         Returns a JWE Token for a specific service type.
             token = client.monitor_service.create_token(service_type="dbaas", entity_ids=[1234])
 
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/post-get-token
-        
+
         :param service_type: The service type to create token for.
         :type service_type: str
         :param entity_ids: The list of entity IDs for which the token is valid.
@@ -161,4 +168,3 @@ def create_token(self, service_type: str, entity_ids: list) -> MonitorServiceTok
                 "Unexpected response when creating token!", json=result
             )
         return MonitorServiceToken(token=result["token"])
-        

linode_api4/objects/monitor_service.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass, field
-from typing import Any, Dict, List, Optional, Union
+from typing import List, Optional
 
 from linode_api4.objects import Base, JSONObject, Property, StrEnum
 
@@ -8,6 +8,7 @@ class AggregateFunction(StrEnum):
     """
     Enum for supported aggregate functions.
     """
+
     min = "min"
     max = "max"
     avg = "avg"
@@ -17,17 +18,21 @@ class AggregateFunction(StrEnum):
     increase = "increase"
     last = "last"
 
+
 class ChartType(StrEnum):
     """
     Enum for supported chart types.
     """
+
     line = "line"
     area = "area"
 
+
 class ServiceType(StrEnum):
     """
     Enum for supported service types.
     """
+
     dbaas = "dbaas"
     linode = "linode"
     lke = "lke"
@@ -37,19 +42,23 @@ class ServiceType(StrEnum):
     object_storage = "object_storage"
     aclb = "aclb"
 
+
 class MetricType(StrEnum):
     """
     Enum for supported metric type
     """
+
     gauge = "gauge"
     counter = "counter"
     histogram = "histogram"
     summary = "summary"
 
+
 class MetricUnit(StrEnum):
     """
     Enum for supported metric units.
     """
+
     COUNT = "count"
     PERCENT = "percent"
     BYTE = "byte"
@@ -66,18 +75,22 @@ class MetricUnit(StrEnum):
     OPS_PER_SECOND = "ops_per_second"
     IOPS = "iops"
 
+
 class DashboardType(StrEnum):
     """
     Enum for supported dashboard types.
     """
+
     standard = "standard"
     custom = "custom"
 
+
 @dataclass
 class DashboardWidget(JSONObject):
     """
     Represents a single widget in the widgets list.
     """
+
     metric: str = ""
     unit: MetricUnit = ""
     label: str = ""
@@ -86,21 +99,24 @@ class DashboardWidget(JSONObject):
     chart_type: ChartType = ""
     y_label: str = ""
     aggregate_function: AggregateFunction = ""
-    
+
+
 @dataclass
 class Dimension(JSONObject):
     """
     Represents a single dimension in the dimensions list.
     """
+
     dimension_label: Optional[str] = None
     label: Optional[str] = None
     values: Optional[List[str]] = None
-    
+
+
 @dataclass
 class MonitorMetricsDefinition(JSONObject):
     """
     Represents a single metric definition in the metrics definition list.
-    
+
     API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-information
     """
 
@@ -111,8 +127,10 @@ class MonitorMetricsDefinition(JSONObject):
     scrape_interval: int = 0
     is_alertable: bool = False
     dimensions: Optional[List[Dimension]] = None
-    available_aggregate_functions: List[AggregateFunction] = field(default_factory=list)
- 
+    available_aggregate_functions: List[AggregateFunction] = field(
+        default_factory=list
+    )
+
 
 class MonitorDashboard(Base):
     """
@@ -132,11 +150,12 @@ class MonitorDashboard(Base):
         "updated": Property(is_datetime=True),
     }
 
+
 class MonitorService(Base):
     """
     Represents a single service type.
     API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
-    
+
     """
 
     api_endpoint = "/monitor/services/{service_type}"
@@ -146,7 +165,8 @@ class MonitorService(Base):
         "label": Property(),
     }
 
-@dataclass    
+
+@dataclass
 class MonitorServiceToken(JSONObject):
     """
     A token for the requested service_type.
@@ -155,6 +175,3 @@ class MonitorServiceToken(JSONObject):
     """
 
     token: str = ""
-
-
-

test/unit/objects/monitor_service_test.py

@@ -87,13 +87,17 @@ def test_get_all_dashboards(self):
         self.assertEqual(dashboards[0].widgets[0].y_label, "cpu_usage")
 
     def test_specific_service_details(self):
-        data = self.client.monitor_service.list_service_by_type(service_type="dbaas")
+        data = self.client.monitor_service.list_service_by_type(
+            service_type="dbaas"
+        )
         self.assertEqual(data[0].label, "Databases")
         self.assertEqual(data[0].service_type, "dbaas")
 
     def test_metric_definitions(self):
 
-        metrics = self.client.monitor_service.list_metric_definitions(service_type="dbaas")
+        metrics = self.client.monitor_service.list_metric_definitions(
+            service_type="dbaas"
+        )
         self.assertEqual(
             metrics[0].available_aggregate_functions,
             ["max", "avg", "min", "sum"],
@@ -117,5 +121,3 @@ def test_create_token(self):
                 service_type="dbaas", entity_ids=[189690, 188020]
             )
             self.assertEqual(m.return_dct["token"], "abcdefhjigkfghh")
-
-