Lint

src/cosl/__init__.py

@@ -4,7 +4,7 @@
 """Utils for observability Juju charms."""
 
 from .cos_tool import CosTool
-from .grafana_dashboard import GrafanaDashboard, LZMABase64, DashboardPath40UID
+from .grafana_dashboard import DashboardPath40UID, GrafanaDashboard, LZMABase64
 from .juju_topology import JujuTopology
 from .mandatory_relation_pairs import MandatoryRelationPairs
 from .rules import AlertRules, RecordingRules

src/cosl/grafana_dashboard.py

@@ -10,7 +10,7 @@
 import logging
 import lzma
 import warnings
-from typing import Any, Dict, Tuple, Union, ClassVar
+from typing import Any, ClassVar, Dict, Tuple, Union
 
 logger = logging.getLogger(__name__)
 
@@ -66,6 +66,7 @@ def decompress(cls, compressed: str) -> str:
 
 
 class DashboardPath40UID:
+    """A helper class for dashboard UID of length 40, generated from charm name and dashboard path."""
 
     length: ClassVar[int] = 40
 
@@ -114,5 +115,3 @@ def is_valid(cls, uid: str) -> bool:
         except binascii.Error:
             return False
         return True
-
-

tests/test_grafana_dashboard.py

@@ -4,7 +4,7 @@
 import json
 import unittest
 
-from cosl import GrafanaDashboard, LZMABase64, DashboardPath40UID
+from cosl import DashboardPath40UID, GrafanaDashboard, LZMABase64
 
 
 class TestRoundTripEncDec(unittest.TestCase):
@@ -52,4 +52,8 @@ def test_validity(self):
         self.assertFalse(DashboardPath40UID.is_valid("non-hex string, crafted to be 40 chars!!"))
 
         self.assertTrue(DashboardPath40UID.is_valid("0" * 40))
-        self.assertTrue(DashboardPath40UID.is_valid(DashboardPath40UID.generate("some-charm", "dashboard.json")))
+        self.assertTrue(
+            DashboardPath40UID.is_valid(
+                DashboardPath40UID.generate("some-charm", "dashboard.json")
+            )
+        )