Add type defininitions for dicts, more...

1. ImagePolicyAction: Add type definitions for dicts 2. ImageStage, ImageValidate, ImageUpgrade: Add clarifying comments
CiscoDevNet · Jan 18, 2024 · 71cd2fc · 71cd2fc
1 parent cd329e0
commit 71cd2fc
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/plugins/module_utils/image_mgmt/image_policy_action.py b/plugins/module_utils/image_mgmt/image_policy_action.py
@@ -106,7 +106,7 @@ def build_payload(self):
         self.switch_issu_details.refresh()
         for serial_number in self.serial_numbers:
             self.switch_issu_details.filter = serial_number
-            payload = {}
+            payload: Dict[str, Any] = {}
             payload["policyName"] = self.policy_name
             payload["hostName"] = self.switch_issu_details.device_name
             payload["ipAddr"] = self.switch_issu_details.ip_address
@@ -238,7 +238,7 @@ def _attach_policy(self):
         self.properties["response"] = response
 
         for payload in self.payloads:
-            diff = {}
+            diff: Dict[str, Any] = {}
             diff["action"] = self.action
             diff["ip_address"] = payload["ipAddr"]
             diff["logical_name"] = payload["hostName"]
@@ -281,7 +281,7 @@ def _detach_policy(self):
 
         for serial_number in self.serial_numbers:
             self.switch_issu_details.filter = serial_number
-            diff = {}
+            diff:Dict[str, Any] = {}
             diff["action"] = self.action
             diff["ip_address"] = self.switch_issu_details.ip_address
             diff["logical_name"] = self.switch_issu_details.device_name

diff --git a/plugins/module_utils/image_mgmt/image_stage.py b/plugins/module_utils/image_mgmt/image_stage.py
@@ -239,6 +239,7 @@ def commit(self):
             diff["logical_name"] = self.issu_detail.device_name
             diff["policy"] = self.issu_detail.policy
             diff["serial_number"] = serial_number
+            # See image_upgrade_common.py for the definition of self.diff
             self.diff = copy.deepcopy(diff)
 
     def _wait_for_current_actions_to_complete(self):

diff --git a/plugins/module_utils/image_mgmt/image_upgrade.py b/plugins/module_utils/image_mgmt/image_upgrade.py
@@ -488,6 +488,7 @@ def commit(self) -> None:
 
             self.response = copy.deepcopy(response)
             self.response_data = response_data
+            # See image_upgrade_common.py for the definition of self.diff
             self.diff = copy.deepcopy(self.payload)
 
         self._wait_for_image_upgrade_to_complete()

diff --git a/plugins/module_utils/image_mgmt/image_validate.py b/plugins/module_utils/image_mgmt/image_validate.py
@@ -209,6 +209,7 @@ def commit(self) -> None:
             diff["logical_name"] = self.issu_detail.device_name
             diff["policy"] = self.issu_detail.policy
             diff["serial_number"] = serial_number
+            # See image_upgrade_common.py for the definition of self.diff
             self.diff = copy.deepcopy(diff)
 
     def _wait_for_current_actions_to_complete(self) -> None: