mgr/rbd_support: use NamedTuple to define ImageSpecT

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/src/pybind/mgr/rbd_support/mirror_snapshot_schedule.py b/src/pybind/mgr/rbd_support/mirror_snapshot_schedule.py
index 1b8266b8821dc03e27fe3cc8a753989d07bd7806..7921ffdc13aec6685ae2d769ef628ad022ccca0c 100644 (file)
--- a/src/pybind/mgr/rbd_support/mirror_snapshot_schedule.py
+++ b/src/pybind/mgr/rbd_support/mirror_snapshot_schedule.py
@@ -7,7 +7,7 @@ import traceback
 
 from datetime import datetime
 from threading import Condition, Lock, Thread
-from typing import Any, Dict, List, Optional, Sequence, Set, Tuple
+from typing import Any, Dict, List, NamedTuple, Optional, Sequence, Set, Tuple
 
 from .common import get_rbd_pools
 from .schedule import LevelSpec, Interval, StartTime, Schedule, Schedules
@@ -145,7 +145,11 @@ class Watchers:
             self.unregister(pool_id, namespace)
 
 
-ImageSpecT = Tuple[str, str, str]
+class ImageSpec(NamedTuple):
+    pool_id: str
+    namespace: str
+    image_id: str
+
 
 class CreateSnapshotRequests:
 
@@ -156,9 +160,9 @@ class CreateSnapshotRequests:
         self.handler = handler
         self.rados = handler.module.rados
         self.log = handler.log
-        self.pending: Set[ImageSpecT] = set()
-        self.queue: List[ImageSpecT] = []
-        self.ioctxs: Dict[Tuple[str, str], Tuple[rados.Ioctx, Set[ImageSpecT]]] = {}
+        self.pending: Set[ImageSpec] = set()
+        self.queue: List[ImageSpec] = []
+        self.ioctxs: Dict[Tuple[str, str], Tuple[rados.Ioctx, Set[ImageSpec]]] = {}
 
     def __del__(self) -> None:
         self.wait_for_pending()
@@ -169,7 +173,7 @@ class CreateSnapshotRequests:
                 self.condition.wait()
 
     def add(self, pool_id: str, namespace: str, image_id: str) -> None:
-        image_spec = (pool_id, namespace, image_id)
+        image_spec = ImageSpec(pool_id, namespace, image_id)
 
         self.log.debug("CreateSnapshotRequests.add: {}/{}/{}".format(
             pool_id, namespace, image_id))
@@ -192,7 +196,7 @@ class CreateSnapshotRequests:
 
         self.open_image(image_spec)
 
-    def open_image(self, image_spec: ImageSpecT) -> None:
+    def open_image(self, image_spec: ImageSpec) -> None:
         pool_id, namespace, image_id = image_spec
 
         self.log.debug("CreateSnapshotRequests.open_image: {}/{}/{}".format(
@@ -212,7 +216,7 @@ class CreateSnapshotRequests:
             self.finish(image_spec)
 
     def handle_open_image(self,
-                          image_spec: ImageSpecT,
+                          image_spec: ImageSpec,
                           comp: rados.Completion,
                           image: rbd.Image) -> None:
         pool_id, namespace, image_id = image_spec
@@ -230,7 +234,7 @@ class CreateSnapshotRequests:
 
         self.get_mirror_mode(image_spec, image)
 
-    def get_mirror_mode(self, image_spec: ImageSpecT, image: rbd.Image) -> None:
+    def get_mirror_mode(self, image_spec: ImageSpec, image: rbd.Image) -> None:
         pool_id, namespace, image_id = image_spec
 
         self.log.debug("CreateSnapshotRequests.get_mirror_mode: {}/{}/{}".format(
@@ -248,7 +252,7 @@ class CreateSnapshotRequests:
             self.close_image(image_spec, image)
 
     def handle_get_mirror_mode(self,
-                               image_spec: ImageSpecT,
+                               image_spec: ImageSpec,
                                image: rbd.Image,
                                comp: rados.Completion,
                                mode: str) -> None:
@@ -275,7 +279,7 @@ class CreateSnapshotRequests:
 
         self.get_mirror_info(image_spec, image)
 
-    def get_mirror_info(self, image_spec: ImageSpecT, image: rbd.Image) -> None:
+    def get_mirror_info(self, image_spec: ImageSpec, image: rbd.Image) -> None:
         pool_id, namespace, image_id = image_spec
 
         self.log.debug("CreateSnapshotRequests.get_mirror_info: {}/{}/{}".format(
@@ -293,7 +297,7 @@ class CreateSnapshotRequests:
             self.close_image(image_spec, image)
 
     def handle_get_mirror_info(self,
-                               image_spec: ImageSpecT,
+                               image_spec: ImageSpec,
                                image: rbd.Image,
                                comp: rados.Completion,
                                info: str) -> None:
@@ -312,7 +316,7 @@ class CreateSnapshotRequests:
 
         self.create_snapshot(image_spec, image)
 
-    def create_snapshot(self, image_spec: ImageSpecT, image: rbd.Image) -> None:
+    def create_snapshot(self, image_spec: ImageSpec, image: rbd.Image) -> None:
         pool_id, namespace, image_id = image_spec
 
         self.log.debug(
@@ -332,7 +336,7 @@ class CreateSnapshotRequests:
 
 
     def handle_create_snapshot(self,
-                               image_spec: ImageSpecT,
+                               image_spec: ImageSpec,
                                image: rbd.Image,
                                comp: rados.Completion,
                                snap_id: str) -> None:
@@ -349,7 +353,7 @@ class CreateSnapshotRequests:
 
         self.close_image(image_spec, image)
 
-    def close_image(self, image_spec: ImageSpecT, image: rbd.Image) -> None:
+    def close_image(self, image_spec: ImageSpec, image: rbd.Image) -> None:
         pool_id, namespace, image_id = image_spec
 
         self.log.debug(
@@ -368,7 +372,7 @@ class CreateSnapshotRequests:
             self.finish(image_spec)
 
     def handle_close_image(self,
-                           image_spec: ImageSpecT,
+                           image_spec: ImageSpec,
                            comp: rados.Completion) -> None:
         pool_id, namespace, image_id = image_spec
 
@@ -383,7 +387,7 @@ class CreateSnapshotRequests:
 
         self.finish(image_spec)
 
-    def finish(self, image_spec: ImageSpecT) -> None:
+    def finish(self, image_spec: ImageSpec) -> None:
         pool_id, namespace, image_id = image_spec
 
         self.log.debug("CreateSnapshotRequests.finish: {}/{}/{}".format(
@@ -399,7 +403,7 @@ class CreateSnapshotRequests:
 
         self.open_image(image_spec)
 
-    def get_ioctx(self, image_spec: ImageSpecT) -> rados.Ioctx:
+    def get_ioctx(self, image_spec: ImageSpec) -> rados.Ioctx:
         pool_id, namespace, image_id = image_spec
         nspec = (pool_id, namespace)
 
@@ -415,7 +419,7 @@ class CreateSnapshotRequests:
 
         return ioctx
 
-    def put_ioctx(self, image_spec: ImageSpecT) -> None:
+    def put_ioctx(self, image_spec: ImageSpec) -> None:
         pool_id, namespace, image_id = image_spec
         nspec = (pool_id, namespace)
 
@@ -471,7 +475,7 @@ class MirrorSnapshotScheduleHandler:
 
     def init_schedule_queue(self) -> None:
         # schedule_time => image_spec
-        self.queue: Dict[str, List[ImageSpecT]] = {}
+        self.queue: Dict[str, List[ImageSpec]] = {}
         # pool_id => {namespace => image_id}
         self.images: Dict[str, Dict[str, Dict[str, str]]] = {}
         self.watchers = Watchers(self)
@@ -626,11 +630,11 @@ class MirrorSnapshotScheduleHandler:
             self.queue[schedule_time] = []
         self.log.debug("schedule image {}/{}/{} at {}".format(
             pool_id, namespace, image_id, schedule_time))
-        image_spec = (pool_id, namespace, image_id)
+        image_spec = ImageSpec(pool_id, namespace, image_id)
         if image_spec not in self.queue[schedule_time]:
-            self.queue[schedule_time].append((pool_id, namespace, image_id))
+            self.queue[schedule_time].append(image_spec)
 
-    def dequeue(self) -> Tuple[Optional[Tuple[str, str, str]], float]:
+    def dequeue(self) -> Tuple[Optional[ImageSpec], float]:
         if not self.queue:
             return None, 1000.0
 
@@ -650,9 +654,10 @@ class MirrorSnapshotScheduleHandler:
 
     def remove_from_queue(self, pool_id: str, namespace: str, image_id: str) -> None:
         empty_slots = []
+        image_spec = ImageSpec(pool_id, namespace, image_id)
         for schedule_time, images in self.queue.items():
-            if (pool_id, namespace, image_id) in images:
-                images.remove((pool_id, namespace, image_id))
+            if image_spec in images:
+                images.remove(image_spec)
                 if not images:
                     empty_slots.append(schedule_time)
         for schedule_time in empty_slots: