pybind/rados: add more type hintings

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

diff --git a/src/pybind/rados/rados.pyx b/src/pybind/rados/rados.pyx
index 348dbca04f4aa8fe24bfd979264e4b0b9d2fe9bf..d79fdb55ca24b00cf718512f355614676e0f00db 100644 (file)
--- a/src/pybind/rados/rados.pyx
+++ b/src/pybind/rados/rados.pyx
@@ -863,7 +863,7 @@ Rados object in state %s." % self.state)
         if ret != 0:
             raise make_ex(ret, "error calling conf_parse_env")
 
-    def conf_get(self, option: str):
+    def conf_get(self, option: str) -> Optional[str]:
         """
         Get the value of a configuration option
 
@@ -961,7 +961,7 @@ Rados object in state %s." % self.state)
             raise make_ex(ret, "error connecting to the cluster")
         self.state = "connected"
 
-    def get_instance_id(self):
+    def get_instance_id(self) -> int:
         """
         Get a global id for current instance
         """
@@ -970,7 +970,7 @@ Rados object in state %s." % self.state)
             ret = rados_get_instance_id(self.cluster)
         return ret;
 
-    def get_cluster_stats(self):
+    def get_cluster_stats(self) -> Dict[str, int]:
         """
         Read usage info about the cluster
 
@@ -1003,7 +1003,7 @@ Rados object in state %s." % self.state)
                 'kb_avail': stats.kb_avail,
                 'num_objects': stats.num_objects}
 
-    def pool_exists(self, pool_name: str):
+    def pool_exists(self, pool_name: str) -> bool:
         """
         Checks if a given pool exists.
 
@@ -1027,7 +1027,7 @@ Rados object in state %s." % self.state)
         else:
             raise make_ex(ret, "error looking up pool '%s'" % pool_name)
 
-    def pool_lookup(self, pool_name: str):
+    def pool_lookup(self, pool_name: str) -> int:
         """
         Returns a pool's ID based on its name.
 
@@ -1127,7 +1127,7 @@ Rados object in state %s." % self.state)
         if ret < 0:
             raise make_ex(ret, "error creating pool '%s'" % pool_name)
 
-    def get_pool_base_tier(self, pool_id: int):
+    def get_pool_base_tier(self, pool_id: int) -> int:
         """
         Get base pool
 
@@ -1166,7 +1166,7 @@ Rados object in state %s." % self.state)
         if ret < 0:
             raise make_ex(ret, "error deleting pool '%s'" % pool_name)
 
-    def get_inconsistent_pgs(self, pool_id: int):
+    def get_inconsistent_pgs(self, pool_id: int) -> List[str]:
         """
         List inconsistent placement groups in the given pool
 
@@ -1195,7 +1195,7 @@ Rados object in state %s." % self.state)
         finally:
             free(pgs)
 
-    def list_pools(self):
+    def list_pools(self) -> List[str]:
         """
         Gets a list of pool names.
 
@@ -1220,7 +1220,7 @@ Rados object in state %s." % self.state)
         finally:
             free(c_names)
 
-    def get_fsid(self):
+    def get_fsid(self) -> str:
         """
         Get the fsid of the cluster as a hexadecimal string.
 
@@ -1247,7 +1247,7 @@ Rados object in state %s." % self.state)
         finally:
             free(ret_buf)
 
-    def open_ioctx(self, ioctx_name: str):
+    def open_ioctx(self, ioctx_name: str) -> Ioctx:
         """
         Create an io context
 
@@ -1521,7 +1521,7 @@ Rados object in state %s." % self.state)
         finally:
             free(_cmd)
 
-    def wait_for_latest_osdmap(self):
+    def wait_for_latest_osdmap(self) -> int:
         self.require_state("connected")
         with nogil:
             ret = rados_wait_for_latest_osdmap(self.cluster)
@@ -1860,7 +1860,7 @@ cdef class Snap(object):
         return "rados.Snap(ioctx=%s,name=%s,snap_id=%d)" \
             % (str(self.ioctx), self.name, self.snap_id)
 
-    def get_timestamp(self):
+    def get_timestamp(self) -> float:
         """
         Find when a snapshot in the current pool occurred
 
@@ -1897,7 +1897,7 @@ cdef class Completion(object):
         self.onsafe = onsafe
         self.ioctx = ioctx
 
-    def is_safe(self):
+    def is_safe(self) -> bool:
         """
         Is an asynchronous operation safe?
 
@@ -1907,7 +1907,7 @@ cdef class Completion(object):
         """
         return self.is_complete()
 
-    def is_complete(self):
+    def is_complete(self) -> bool:
         """
         Has an asynchronous operation completed?
 
@@ -1954,7 +1954,7 @@ cdef class Completion(object):
             ret = rados_aio_wait_for_complete_and_cb(self.rados_comp)
         return ret
 
-    def get_return_value(self):
+    def get_return_value(self) -> int:
         """
         Get the return value of an asychronous operation
 
@@ -2312,7 +2312,7 @@ cdef class Watch(object):
             return
         self.error_callback(watch_id, error)
 
-    def get_id(self):
+    def get_id(self) -> int:
         return self.id
 
     def check(self):
@@ -2864,7 +2864,7 @@ cdef class Ioctx(object):
             rados_ioctx_locator_set_key(self.io, _loc_key)
         self.locator_key = loc_key
 
-    def get_locator_key(self):
+    def get_locator_key(self) -> str:
         """
         Get the locator_key of context
 
@@ -2909,7 +2909,7 @@ cdef class Ioctx(object):
             rados_ioctx_set_namespace(self.io, _nspace)
         self.nspace = nspace
 
-    def get_namespace(self):
+    def get_namespace(self) -> str:
         """
         Get the namespace of context
 
@@ -3144,7 +3144,7 @@ returned %d, but should return zero on success." % (self.name, ret))
             # itself and set ret_s to NULL, hence XDECREF).
             ref.Py_XDECREF(ret_s)
 
-    def get_stats(self):
+    def get_stats(self) -> Dict[str, int]:
         """
         Get pool usage statistics
 
@@ -3194,7 +3194,7 @@ returned %d, but should return zero on success." % (self.name, ret))
                 "num_wr": stats.num_wr,
                 "num_wr_kb": stats.num_wr_kb}
 
-    def remove_object(self, key: str):
+    def remove_object(self, key: str) -> bool:
         """
         Delete an object
 
@@ -3244,7 +3244,7 @@ returned %d, but should return zero on success." % (self.name, ret))
             raise make_ex(ret, "Ioctx.trunc(%s): failed to truncate %s" % (self.name, key))
         return ret
    
-    def cmpext(self, key: str, cmp_buf: bytes, offset: int = 0):
+    def cmpext(self, key: str, cmp_buf: bytes, offset: int = 0) -> int:
         '''
         Compare an on-disk object range with a buffer
         :param key: the name of the object
@@ -3396,7 +3396,7 @@ returned %d, but should return zero on success." % (self.name, ret))
                           (key, xattr_name))
         return True
 
-    def notify(self, obj: str, msg: str = '', timeout_ms: int = 5000):
+    def notify(self, obj: str, msg: str = '', timeout_ms: int = 5000) -> bool:
         """
         Send a rados notification to an object.
 
@@ -3506,7 +3506,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         self.require_ioctx_open()
         return ObjectIterator(self)
 
-    def list_snaps(self):
+    def list_snaps(self) -> SnapIterator:
         """
         Get SnapIterator on rados.Ioctx object.
 
@@ -3515,7 +3515,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         self.require_ioctx_open()
         return SnapIterator(self)
 
-    def get_pool_id(self):
+    def get_pool_id(self) -> int:
         """
         Get pool id
 
@@ -3525,7 +3525,7 @@ returned %d, but should return zero on success." % (self.name, ret))
             ret = rados_ioctx_get_id(self.io)
         return ret;
 
-    def get_pool_name(self):
+    def get_pool_name(self) -> str:
         """
         Get pool name
 
@@ -3588,7 +3588,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         if ret != 0:
             raise make_ex(ret, "Failed to remove snap %s" % snap_name)
 
-    def lookup_snap(self, snap_name: str):
+    def lookup_snap(self, snap_name: str) -> Snap:
         """
         Get the id of a pool snapshot
 
@@ -3721,7 +3721,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         if ret != 0:
             raise make_ex(ret, "Failed to rollback %s" % oid)
 
-    def get_last_version(self):
+    def get_last_version(self) -> int:
         """
         Return the version of the last object read or written to.
 
@@ -3735,14 +3735,14 @@ returned %d, but should return zero on success." % (self.name, ret))
             ret = rados_get_last_version(self.io)
         return int(ret)
 
-    def create_write_op(self):
+    def create_write_op(self) -> WriteOp:
         """
         create write operation object.
         need call release_write_op after use
         """
         return WriteOp().create()
 
-    def create_read_op(self):
+    def create_read_op(self) -> ReadOp:
         """
         create read operation object.
         need call release_read_op after use
@@ -3823,7 +3823,7 @@ returned %d, but should return zero on success." % (self.name, ret))
                              oncomplete: Optional[Callable[[Completion], None]] = None,
                              onsafe: Optional[Callable[[Completion], None]] = None,
                              mtime: int = 0,
-                             flags: int = LIBRADOS_OPERATION_NOFLAG):
+                             flags: int = LIBRADOS_OPERATION_NOFLAG) -> Completion:
         """
         execute the real write operation asynchronously
         :para write_op: write operation object
@@ -4170,7 +4170,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         if ret < 0:
             raise make_ex(ret, "error enabling application")
 
-    def application_list(self):
+    def application_list(self) -> List[str]:
         """
         Returns a list of enabled applications
 
@@ -4197,7 +4197,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         finally:
             free(apps)
 
-    def application_metadata_get(self, app_name: str, key: str):
+    def application_metadata_get(self, app_name: str, key: str) -> str:
         """
         Gets application metadata on an OSD pool for the given key
 
@@ -4284,7 +4284,7 @@ returned %d, but should return zero on success." % (self.name, ret))
         if ret < 0:
             raise make_ex(ret, "error removing application metadata")
 
-    def application_metadata_list(self, app_name: str):
+    def application_metadata_list(self, app_name: str) -> List[Tuple[str, str]]:
         """
         Returns a list of enabled applications
 
@@ -4322,7 +4322,7 @@ returned %d, but should return zero on success." % (self.name, ret))
             free(c_keys)
             free(c_vals)
 
-    def alignment(self):
+    def alignment(self) -> int:
         """
         Returns pool alignment