Python cleanup (#60)

Author: simonkurtz-MSFT

shared/python/apimrequests.py

@@ -25,7 +25,7 @@ class ApimRequests:
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, url: str, apimSubscriptionKey: str | None = None):
+    def __init__(self, url: str, apimSubscriptionKey: str | None = None) -> None:
         """
         Initialize the ApimRequests object.
 
@@ -43,6 +43,10 @@ def __init__(self, url: str, apimSubscriptionKey: str | None = None):
 
         self._headers['Accept'] = 'application/json'
 
+    # ------------------------------
+    #    PROPERTIES
+    # ------------------------------
+
     @property
     def headers(self) -> dict[str, str]:
         """
@@ -177,7 +181,7 @@ def _multiRequest(self, method: HTTP_VERB, path: str, runs: int, headers: list[a
 
         return api_runs
 
-    def _print_response(self, response):
+    def _print_response(self, response) -> None:
         """
         Print the response headers and body with appropriate formatting.
         """
@@ -194,7 +198,7 @@ def _print_response(self, response):
         else:
             utils.print_val("Response body", response.text, True)
 
-    def _print_response_code(self, response):
+    def _print_response_code(self, response) -> None:
         """
         Print the response status code with color formatting.
         """
@@ -213,7 +217,7 @@ def _print_response_code(self, response):
     #    PUBLIC METHODS
     # ------------------------------
 
-    def singleGet(self, path: str, headers = None, msg: str | None = None, printResponse = True) -> Any:
+    def singleGet(self, path: str, headers = None, msg: str | None = None, printResponse: bool = True) -> Any:
         """
         Make a GET request to the Azure API Management service.
 
@@ -228,7 +232,7 @@ def singleGet(self, path: str, headers = None, msg: str | None = None, printResp
 
         return self._request(method = HTTP_VERB.GET, path = path, headers = headers, msg = msg, printResponse = printResponse)
 
-    def singlePost(self, path: str, *, headers = None, data = None, msg: str | None = None, printResponse = True) -> Any:
+    def singlePost(self, path: str, *, headers = None, data = None, msg: str | None = None, printResponse: bool = True) -> Any:
         """
         Make a POST request to the Azure API Management service.
 
@@ -244,7 +248,7 @@ def singlePost(self, path: str, *, headers = None, data = None, msg: str | None
 
         return self._request(method = HTTP_VERB.POST, path = path, headers = headers, data = data, msg = msg, printResponse = printResponse)
 
-    def multiGet(self, path: str, runs: int, headers = None, data = None, msg: str | None = None, printResponse = True, sleepMs: int | None = None) -> list[dict[str, Any]]:
+    def multiGet(self, path: str, runs: int, headers = None, data = None, msg: str | None = None, printResponse: bool = True, sleepMs: int | None = None) -> list[dict[str, Any]]:
         """
         Make multiple GET requests to the Azure API Management service.
 

shared/python/apimtesting.py

@@ -1,14 +1,38 @@
 """
-Rudimentary test "framework" to offload validations from the Jupyter notebooks. 
+Rudimentary test framework to offload validations from the Jupyter notebooks. 
 """
 
+
+# ------------------------------
+#    CLASSES
+# ------------------------------
+
 class ApimTesting:
-    def __init__(self, test_suite_name: str = 'APIM Tests'):
+    """
+    A simple test framework for validating APIM deployments and configurations.
+    """
+
+    # ------------------------------
+    #    CONSTRUCTOR
+    # ------------------------------
+
+    def __init__(self, test_suite_name: str = 'APIM Tests') -> None:
+        """
+        Initialize the ApimTesting instance.
+
+        Args:
+            test_suite_name (str, optional): The name of the test suite. Defaults to 'APIM Tests'.
+        """
         self.test_suite_name = test_suite_name
         self.tests_passed = 0
         self.tests_failed = 0
         self.total_tests = 0
         self.errors = []
+
+        
+    # ------------------------------
+    #    PUBLIC METHODS
+    # ------------------------------
 
     def verify(self, value: any, expected: any) -> bool:
         """
@@ -19,22 +43,23 @@ def verify(self, value: any, expected: any) -> bool:
             expected: The expected value to match
             
         Returns:
-            True, if the assertion passes; otherwise, false.
+            bool: True, if the assertion passes; otherwise, False.
         """
-
         try:
             self.total_tests += 1
             assert value == expected, f'Value [{value}] does not match expected [{expected}]'
             self.tests_passed += 1
             print(f"✅ Test {self.total_tests}: PASS")
+
             return True
         except AssertionError as e:
             self.tests_failed += 1
             self.errors.append(f'{str(e)}')
             print(f"❌ Test {self.total_tests}: FAIL - {str(e)}")
+
             return False
 
-    def print_summary(self):
+    def print_summary(self) -> None:
         """
         Print a summary of the test results with visual flair and comprehensive details.
         

shared/python/apimtypes.py

@@ -10,7 +10,7 @@
 
 
 # ------------------------------
-#    CONSTANTS
+#    PRIVATE METHODS
 # ------------------------------
 
 def _get_project_root() -> Path:
@@ -204,7 +204,7 @@ class APIOperation:
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, name: str, displayName: str, urlTemplate: str, method: HTTP_VERB, description: str, policyXml: Optional[str] = None, templateParameters: Optional[List[dict[str, Any]]] = None):
+    def __init__(self, name: str, displayName: str, urlTemplate: str, method: HTTP_VERB, description: str, policyXml: Optional[str] = None, templateParameters: Optional[List[dict[str, Any]]] = None) -> None:
         # Validate that method is a valid HTTP_VERB
         if not isinstance(method, HTTP_VERB):
             try:
@@ -241,6 +241,7 @@ class GET_APIOperation(APIOperation):
     """
     Represents a simple GET operation within a parent API.
     """
+
     # ------------------------------
     #    CONSTRUCTOR
     # ------------------------------
@@ -254,11 +255,12 @@ class GET_APIOperation2(APIOperation):
     """
     Represents a GET operation within a parent API.
     """
+
     # ------------------------------
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, name: str, displayName: str, urlTemplate: str, description: str, policyXml: Optional[str] = None, templateParameters: Optional[List[dict[str, Any]]] = None):
+    def __init__(self, name: str, displayName: str, urlTemplate: str, description: str, policyXml: Optional[str] = None, templateParameters: Optional[List[dict[str, Any]]] = None) -> None:
         super().__init__(name, displayName, urlTemplate, HTTP_VERB.GET, description, policyXml, templateParameters)
 
 
@@ -267,11 +269,12 @@ class POST_APIOperation(APIOperation):
     """
     Represents a simple POST operation within a parent API.
     """
+
     # ------------------------------
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, description: str, policyXml: Optional[str] = None, templateParameters: Optional[List[dict[str, Any]]] = None):
+    def __init__(self, description: str, policyXml: Optional[str] = None, templateParameters: Optional[List[dict[str, Any]]] = None) -> None:
         super().__init__('POST', 'POST', '/', HTTP_VERB.POST, description, policyXml, templateParameters)
 
 
@@ -289,7 +292,7 @@ class NamedValue:
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, name: str, value: str, isSecret: bool = False):
+    def __init__(self, name: str, value: str, isSecret: bool = False) -> None:
         self.name = name
         self.value = value
         self.isSecret = isSecret
@@ -307,6 +310,7 @@ def to_dict(self) -> dict:
         }
 
         return nv_dict
+
 
 @dataclass
 class PolicyFragment:
@@ -322,7 +326,7 @@ class PolicyFragment:
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, name: str, policyXml: str, description: str = ''):
+    def __init__(self, name: str, policyXml: str, description: str = '') -> None:
         self.name = name
         self.policyXml = policyXml
         self.description = description
@@ -362,7 +366,7 @@ class Product:
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, name: str, displayName: str, description: str, state: str = 'published', subscriptionRequired: bool = True, approvalRequired: bool = False, policyXml: Optional[str] = None):
+    def __init__(self, name: str, displayName: str, description: str, state: str = 'published', subscriptionRequired: bool = True, approvalRequired: bool = False, policyXml: Optional[str] = None) -> None:
         self.name = name
         self.displayName = displayName
         self.description = description
@@ -391,6 +395,7 @@ def __init__(self, name: str, displayName: str, description: str, state: str = '
 </policies>"""
         else:
             self.policyXml = policyXml
+
     # ------------------------------
     #    PUBLIC METHODS
     # ------------------------------
@@ -408,4 +413,4 @@ def to_dict(self) -> dict:
         if self.policyXml is not None:
             product_dict["policyXml"] = self.policyXml
 
-        return product_dict
+        return product_dict

shared/python/authfactory.py

@@ -18,20 +18,33 @@ class JwtPayload:
     https://datatracker.ietf.org/doc/html/rfc7519
     """
 
+    # ------------------------------
+    #    CONSTANTS
+    # ------------------------------
+
     DEFAULT_LIFETIME_SECONDS = 3600 * 24  # Default lifetime of 24 hours
 
+
+    # ------------------------------
+    #    CONSTRUCTOR
+    # ------------------------------
+
     def __init__(self, subject: str, name: str, issued_at: int | None = None, expires: int | None = None, roles: dict[str] | None = None) -> None:
         self.sub = subject
         self.name = name        
         self.iat = issued_at if issued_at is not None else int(time.time())
         self.exp = expires if expires is not None else self.iat + self.DEFAULT_LIFETIME_SECONDS
         self.roles = roles if roles is not None else []
 
+
+    # ------------------------------
+    #    PUBLIC METHODS
+    # ------------------------------
+
     def to_dict(self) -> dict[str, Any]:
         """
         Convert the payload to a dictionary for encoding.
         """
-
         pl: dict[str, Any] = {
             "sub": self.sub,
             "name": self.name,
@@ -44,13 +57,18 @@ def to_dict(self) -> dict[str, Any]:
 
         return pl
 
+
 class SymmetricJwtToken:
     """
     Represents a JSON Web Token using a symmetric signing algorithm (HS256) for APIM testing.
     This is a simple implementation for demonstration purposes as it uses a shared secret key
     for the token creation and verification. This is not production-ready code.
     """
 
+    # ------------------------------
+    #    CONSTRUCTOR
+    # ------------------------------
+
     def __init__(self, key: str, payload: JwtPayload) -> None:
         """
         Initialize the SymmetricJwtToken with a signing key and payload.
@@ -62,6 +80,11 @@ def __init__(self, key: str, payload: JwtPayload) -> None:
         self.key = key
         self.payload = payload
 
+
+    # ------------------------------
+    #    PUBLIC METHODS
+    # ------------------------------
+
     def encode(self) -> str:
         """
         Encode the JWT token using the provided key and payload.
@@ -73,12 +96,17 @@ def encode(self) -> str:
             The key parameter used for signing must be a regular ASCII string, NOT a base64-encoded string. If you have a base64-encoded key, decode it to its ASCII form before using it here. Passing a base64-encoded string directly will result in signature validation errors in APIM or other JWT consumers.
         """
         return jwt.encode(self.payload.to_dict(), self.key, algorithm = "HS256")
+
 
 class AuthFactory:
     """
     Factory class for creating authentication tokens or objects.
     """
 
+    # ------------------------------
+    #    PUBLIC METHODS
+    # ------------------------------
+
     @staticmethod
     def create_symmetric_jwt_token_for_user(user: User, jwt_key: str) -> str:
         if not user:

shared/python/charts.py

@@ -22,27 +22,44 @@ class BarChart(object):
     Class for creating bar charts with colored bars based on backend indexes.
     """
 
-    def __init__(self, title: str, x_label: str, y_label: str, api_results: list[dict], fig_text: str = None):
+    # ------------------------------
+    #    CONSTRUCTOR
+    # ------------------------------
+
+    def __init__(self, title: str, x_label: str, y_label: str, api_results: list[dict], fig_text: str = None) -> None:
         """
         Initialize the BarChart with API results.
 
         Args:
+            title (str): The title of the chart.
+            x_label (str): The label for the x-axis.
+            y_label (str): The label for the y-axis.
             api_results (list[dict]): List of API result dictionaries.
+            fig_text (str, optional): Additional figure text to display. Defaults to None.
         """
-        
         self.title = title
         self.x_label = x_label
         self.y_label = y_label
         self.api_results = api_results
         self.fig_text = fig_text
 
-    def plot(self):
+
+    # ------------------------------
+    #    PUBLIC METHODS
+    # ------------------------------
+
+    def plot(self) -> None:
         """
         Plot the bar chart based on the provided API results.
         """
         self._plot_barchart(self.api_results)
 
-    def _plot_barchart(self, api_results: list[dict]):
+
+    # ------------------------------
+    #    PRIVATE METHODS
+    # ------------------------------
+
+    def _plot_barchart(self, api_results: list[dict]) -> None:
         """
         Internal method to plot the bar chart.