fix linting

Author: haydencarroll-NS1

examples/usage_alerts.py

@@ -31,11 +31,10 @@
 client = NS1(config=c)
 
 
-
 # Usage Alerts API Examples
 def usage_alerts_example():
     print("\n=== Usage Alerts Examples ===\n")
-    
+
     # List all usage alerts
     print("Listing usage alerts:")
     try:
@@ -45,7 +44,7 @@ def usage_alerts_example():
             print(f"  {i+1}. {alert.get('name')} (id: {alert.get('id')})")
     except Exception as e:
         print(f"Error listing alerts: {e}")
-    
+
     # Create a usage alert
     print("\nCreating a usage alert:")
     try:
@@ -62,7 +61,7 @@ def usage_alerts_example():
     except Exception as e:
         print(f"Error creating alert: {e}")
         return
-    
+
     # Update the alert
     print("\nUpdating the alert threshold to 90%:")
     try:
@@ -74,15 +73,15 @@ def usage_alerts_example():
         print(f"New threshold: {updated['data']['alert_at_percent']}%")
     except Exception as e:
         print(f"Error updating alert: {e}")
-    
+
     # Get alert details
     print("\nGetting alert details:")
     try:
         details = client.alerting().usage.get(alert_id)
         print(f"Alert details: {json.dumps(details, indent=2)}")
     except Exception as e:
         print(f"Error getting alert: {e}")
-    
+
     # Delete the alert
     print("\nDeleting the alert:")
     try:
@@ -92,11 +91,10 @@ def usage_alerts_example():
         print(f"Error deleting alert: {e}")
 
 
-
 # Test validation failures
 def test_validation():
     print("\n=== Validation Tests ===\n")
-    
+
     # Test invalid subtype
     print("Testing invalid subtype:")
     try:
@@ -107,7 +105,7 @@ def test_validation():
         )
     except ValueError as e:
         print(f"Validation error (expected): {e}")
-    
+
     # Test threshold too low
     print("\nTesting threshold too low (0):")
     try:
@@ -118,7 +116,7 @@ def test_validation():
         )
     except ValueError as e:
         print(f"Validation error (expected): {e}")
-    
+
     # Test threshold too high
     print("\nTesting threshold too high (101):")
     try:
@@ -131,13 +129,12 @@ def test_validation():
         print(f"Validation error (expected): {e}")
 
 
-
 if __name__ == '__main__':
     print("Usage Alerts API Examples")
     print("-" * 30)
     print("Note: To run against the actual API, set the NS1_APIKEY environment variable")
     print("Otherwise, this will run against a mock API endpoint")
-    
+
     # Run examples
     usage_alerts_example()
     test_validation()

ns1/alerting/usage_alerts.py

@@ -11,7 +11,8 @@ def _validate(name: str, subtype: str, alert_at_percent: int) -> None:
         raise ValueError("name required")
     if subtype not in USAGE_SUBTYPES:
         raise ValueError("invalid subtype")
-    if not isinstance(alert_at_percent, int) or not (1 <= alert_at_percent <= 100):
+    if not isinstance(alert_at_percent, int) or not (
+            1 <= alert_at_percent <= 100):
         raise ValueError("data.alert_at_percent must be int in 1..100")
 
 
@@ -21,6 +22,7 @@ class UsageAlertsAPI:
     Server rules: type='account'; data.alert_at_percent in 1..100;
     PATCH must not include type/subtype; zone_names/notifier_list_ids may be [].
     """
+
     def __init__(self, client) -> None:
         self._c = client
 
@@ -53,7 +55,8 @@ def patch(self, alert_id: str, *,
         if name is not None:
             patch["name"] = name
         if alert_at_percent is not None:
-            if not isinstance(alert_at_percent, int) or not (1 <= alert_at_percent <= 100):
+            if not isinstance(alert_at_percent, int) or not (
+                    1 <= alert_at_percent <= 100):
                 raise ValueError("data.alert_at_percent must be int in 1..100")
             patch["data"] = {"alert_at_percent": int(alert_at_percent)}
         if notifier_list_ids is not None:

tests/unit/test_usage_alerts.py

@@ -11,7 +11,6 @@
     import mock
 
 
-
 @pytest.fixture
 def usage_alerts_client(config):
     config.loadFromDict(
@@ -31,7 +30,6 @@ def usage_alerts_client(config):
     return client
 
 
-
 def test_create_usage_alert(usage_alerts_client):
     """Test creating a usage alert"""
     client = usage_alerts_client
@@ -49,7 +47,7 @@ def test_create_usage_alert(usage_alerts_client):
         "created_at": 1597937213,
         "updated_at": 1597937213
     }
-    
+
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
         alert = client.alerting().usage.create(
@@ -58,7 +56,7 @@ def test_create_usage_alert(usage_alerts_client):
             alert_at_percent=85,
             notifier_list_ids=["n1"]
         )
-    
+
     # Verify _post was called with correct arguments
     expected_body = {
         "name": "Test Alert",
@@ -68,8 +66,9 @@ def test_create_usage_alert(usage_alerts_client):
         "notifier_list_ids": ["n1"],
         "zone_names": []
     }
-    client._post.assert_called_once_with("/alerting/v1/alerts", json=expected_body)
-    
+    client._post.assert_called_once_with(
+        "/alerting/v1/alerts", json=expected_body)
+
     # Verify result
     assert alert["id"] == "a1b2c3"
     assert alert["name"] == "Test Alert"
@@ -78,12 +77,11 @@ def test_create_usage_alert(usage_alerts_client):
     assert alert["data"]["alert_at_percent"] == 85
 
 
-
 def test_get_usage_alert(usage_alerts_client):
     """Test retrieving a usage alert"""
     client = usage_alerts_client
     alert_id = "a1b2c3"
-    
+
     # Create a mock for the _get method
     client._get = mock.MagicMock()
     client._get.return_value = {
@@ -95,26 +93,25 @@ def test_get_usage_alert(usage_alerts_client):
         "notifier_list_ids": ["n1"],
         "zone_names": []
     }
-    
+
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
         alert = client.alerting().usage.get(alert_id)
-    
+
     # Verify _get was called with correct URL
     client._get.assert_called_once_with(f"/alerting/v1/alerts/{alert_id}")
-    
+
     # Verify result
     assert alert["id"] == alert_id
     assert alert["name"] == "Test Alert"
     assert alert["data"]["alert_at_percent"] == 85
 
 
-
 def test_patch_usage_alert(usage_alerts_client):
     """Test patching a usage alert - verify type/subtype are not sent"""
     client = usage_alerts_client
     alert_id = "a1b2c3"
-    
+
     # Create a mock for the _patch method
     client._patch = mock.MagicMock()
     client._patch.return_value = {
@@ -126,55 +123,54 @@ def test_patch_usage_alert(usage_alerts_client):
         "notifier_list_ids": ["n1"],
         "zone_names": []
     }
-    
+
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
         alert = client.alerting().usage.patch(
             alert_id,
             name="Updated Alert",
             alert_at_percent=90
         )
-    
+
     # Verify _patch was called with correct arguments
     expected_body = {
         "name": "Updated Alert",
         "data": {"alert_at_percent": 90}
     }
-    client._patch.assert_called_once_with(f"/alerting/v1/alerts/{alert_id}", json=expected_body)
-    
+    client._patch.assert_called_once_with(
+        f"/alerting/v1/alerts/{alert_id}", json=expected_body)
+
     # Verify type/subtype are not in the arguments
     call_args = client._patch.call_args[1]["json"]
     assert "type" not in call_args
     assert "subtype" not in call_args
-    
+
     # Verify result
     assert alert["id"] == alert_id
     assert alert["name"] == "Updated Alert"
     assert alert["data"]["alert_at_percent"] == 90
 
 
-
 def test_delete_usage_alert(usage_alerts_client):
     """Test deleting a usage alert"""
     client = usage_alerts_client
     alert_id = "a1b2c3"
-    
+
     # Create a mock for the _delete method
     client._delete = mock.MagicMock()
-    
+
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
         client.alerting().usage.delete(alert_id)
-    
+
     # Verify _delete was called with correct URL
     client._delete.assert_called_once_with(f"/alerting/v1/alerts/{alert_id}")
 
 
-
 def test_list_usage_alerts(usage_alerts_client):
     """Test listing usage alerts with pagination params"""
     client = usage_alerts_client
-    
+
     # Create a mock for the _get method
     client._get = mock.MagicMock()
     client._get.return_value = {
@@ -191,21 +187,22 @@ def test_list_usage_alerts(usage_alerts_client):
             }
         ]
     }
-    
+
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
         response = client.alerting().usage.list(
             limit=1,
             order_descending=True
         )
-    
+
     # Verify _get was called with correct URL and params
     expected_params = {
         "limit": 1,
         "order_descending": "true"
     }
-    client._get.assert_called_once_with("/alerting/v1/alerts", params=expected_params)
-    
+    client._get.assert_called_once_with(
+        "/alerting/v1/alerts", params=expected_params)
+
     # Verify result
     assert "results" in response
     assert "next" in response
@@ -215,11 +212,10 @@ def test_list_usage_alerts(usage_alerts_client):
     assert response["results"][0]["id"] == "a1"
 
 
-
 def test_validation_threshold_bounds(usage_alerts_client):
     """Test validation of alert_at_percent bounds"""
     client = usage_alerts_client
-    
+
     # Test below minimum
     with pytest.raises(ValueError) as excinfo:
         client.alerting().usage.create(
@@ -228,7 +224,7 @@ def test_validation_threshold_bounds(usage_alerts_client):
             alert_at_percent=0
         )
     assert "alert_at_percent must be int in 1..100" in str(excinfo.value)
-    
+
     # Test above maximum
     with pytest.raises(ValueError) as excinfo:
         client.alerting().usage.create(
@@ -237,7 +233,7 @@ def test_validation_threshold_bounds(usage_alerts_client):
             alert_at_percent=101
         )
     assert "alert_at_percent must be int in 1..100" in str(excinfo.value)
-    
+
     # Test same validation in patch
     with pytest.raises(ValueError) as excinfo:
         client.alerting().usage.patch(
@@ -247,19 +243,18 @@ def test_validation_threshold_bounds(usage_alerts_client):
     assert "alert_at_percent must be int in 1..100" in str(excinfo.value)
 
 
-
 def test_validation_subtype():
     """Test validation of subtype values"""
     from ns1.alerting import USAGE_SUBTYPES
     from ns1.alerting.usage_alerts import _validate
-    
+
     # Valid subtypes should pass validation
     for subtype in USAGE_SUBTYPES:
         try:
             _validate("Test Alert", subtype, 85)
         except ValueError:
             pytest.fail(f"Valid subtype '{subtype}' was rejected")
-    
+
     # Invalid subtype should fail validation
     with pytest.raises(ValueError) as excinfo:
         _validate("Test Alert", "invalid_subtype", 85)