add more type annotations

Author: slivingston

rerobots/api.py

@@ -18,7 +18,7 @@
 # only required for certain code paths that go beyond core routines.
 # e.g., get_snapshot_cam(dformat='array')
 
-from .types import Capability
+from .types import AccessRules, Capability
 
 
 class Error(Exception):
@@ -241,7 +241,11 @@ def get_wdeployment_info(self, wdeployment_id: str):
             raise Error(res.text)
         return payload
 
-    def get_access_rules(self, wdeployment_id=None, to_user=None):
+    def get_access_rules(
+        self,
+        wdeployment_id: str | None = None,
+        to_user: str | None = None,
+    ) -> AccessRules:
         """Get list of access control rules of workspace deployments."""
         params = dict()
         if to_user is not None:
@@ -292,7 +296,11 @@ def create_access_rule(
             raise Error('{} {}'.format(res.status_code, res.reason))
         return res.json()['rule_id']
 
-    def del_access_rule(self, wdeployment_id, rule_id) -> None:
+    def del_access_rule(
+        self,
+        wdeployment_id: str,
+        rule_id: int,
+    ) -> None:
         """Delete access control rule from workspace deployment."""
         res = requests.delete(
             self.__base_uri + '/deployment/{}/rule/{}'.format(wdeployment_id, rule_id),

rerobots/types.py

@@ -1,5 +1,18 @@
-from typing import Literal
+from typing import Literal, TypedDict
 
 
 Capability = Literal['CAP_NO_INSTANTIATE', 'CAP_INSTANTIATE']
 InstanceStatus = Literal['INIT', 'INIT_FAIL', 'READY', 'TERMINATING', 'TERMINATED']
+
+
+class AccessRule(TypedDict):
+    id: int
+    date_created: str
+    user: str
+    wdeployment_id: str
+    capability: Capability
+    param: int
+
+
+class AccessRules(TypedDict):
+    rules: list[AccessRule]