typing: Add hints to api module

Most of this module should eventually be removed in favour of
SDK, but that is a job for another day.

Change-Id: I71cfb1f786a483a0715984dfb7dda451d4b33dac
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

openstackclient/api/api.py

@@ -13,6 +13,8 @@
 
 """Base API Library"""
 
+from typing import Any
+
 from keystoneauth1 import exceptions as ks_exceptions
 from keystoneauth1 import session as ks_session
 from osc_lib import exceptions
@@ -30,7 +32,9 @@ class KeystoneSession:
 
     """
 
-    def __init__(self, session=None, endpoint=None, **kwargs):
+    def __init__(
+        self, session: Any = None, endpoint: str | None = None, **kwargs: Any
+    ) -> None:
         """Base object that contains some common API objects and methods
 
         :param Session session:
@@ -46,7 +50,9 @@ def __init__(self, session=None, endpoint=None, **kwargs):
         self.session = session
         self.endpoint = endpoint
 
-    def _request(self, method, url, session=None, **kwargs):
+    def _request(
+        self, method: str, url: str, session: Any = None, **kwargs: Any
+    ) -> Any:
         """Perform call into session
 
         All API calls are funneled through this method to provide a common
@@ -82,8 +88,12 @@ class BaseAPI(KeystoneSession):
     """Base API"""
 
     def __init__(
-        self, session=None, service_type=None, endpoint=None, **kwargs
-    ):
+        self,
+        session: Any = None,
+        service_type: str | None = None,
+        endpoint: str | None = None,
+        **kwargs: Any,
+    ) -> None:
         """Base object that contains some common API objects and methods
 
         :param Session session:
@@ -101,7 +111,13 @@ def __init__(
 
     # The basic action methods all take a Session and return dict/lists
 
-    def create(self, url, session=None, method=None, **params):
+    def create(
+        self,
+        url: str,
+        session: Any = None,
+        method: str | None = None,
+        **params: Any,
+    ) -> Any:
         """Create a new resource
 
         :param string url:
@@ -121,7 +137,7 @@ def create(self, url, session=None, method=None, **params):
         except requests.JSONDecodeError:
             return ret
 
-    def delete(self, url, session=None, **params):
+    def delete(self, url: str, session: Any = None, **params: Any) -> Any:
         """Delete a resource
 
         :param string url:
@@ -132,7 +148,14 @@ def delete(self, url, session=None, **params):
 
         return self._request('DELETE', url, **params)
 
-    def list(self, path, session=None, body=None, detailed=False, **params):
+    def list(
+        self,
+        path: str,
+        session: Any = None,
+        body: Any = None,
+        detailed: bool = False,
+        **params: Any,
+    ) -> Any:
         """Return a list of resources
 
         GET ${ENDPOINT}/${PATH}?${PARAMS}
@@ -177,11 +200,11 @@ def list(self, path, session=None, body=None, detailed=False, **params):
 
     def find_attr(
         self,
-        path,
-        value=None,
-        attr=None,
-        resource=None,
-    ):
+        path: str,
+        value: str | None = None,
+        attr: str | None = None,
+        resource: str | None = None,
+    ) -> Any:
         """Find a resource via attribute or ID
 
         Most APIs return a list wrapped by a dict with the resource
@@ -211,15 +234,15 @@ def find_attr(
         if resource is None:
             resource = path
 
-        def getlist(kw):
+        def getlist(kw: dict[str, Any]) -> Any:
             """Do list call, unwrap resource dict if present"""
             ret = self.list(path, **kw)
             if isinstance(ret, dict) and resource in ret:
                 ret = ret[resource]
             return ret
 
         # Search by attribute
-        kwargs = {attr: value}
+        kwargs: dict[str, Any] = {attr: value}
         data = getlist(kwargs)
         if isinstance(data, dict):
             return data
@@ -241,7 +264,7 @@ def getlist(kw):
             msg % {'resource': resource, 'attr': attr, 'value': value}
         )
 
-    def find_bulk(self, path, **kwargs):
+    def find_bulk(self, path: str, **kwargs: Any) -> Any:
         """Bulk load and filter locally
 
         :param string path:
@@ -267,7 +290,7 @@ def find_bulk(self, path, **kwargs):
 
         return ret
 
-    def find_one(self, path, **kwargs):
+    def find_one(self, path: str, **kwargs: Any) -> Any:
         """Find a resource by name or ID
 
         :param string path:
@@ -286,12 +309,7 @@ def find_one(self, path, **kwargs):
             raise RuntimeError(msg)
         return bulk_list[0]
 
-    def find(
-        self,
-        path,
-        value=None,
-        attr=None,
-    ):
+    def find(self, path: str, value: str, attr: str) -> Any:
         """Find a single resource by name or ID
 
         :param string path:

openstackclient/api/compute_v2.py

@@ -17,6 +17,7 @@
 """
 
 import http
+from typing import Any
 
 from openstack import exceptions as sdk_exceptions
 from osc_lib import exceptions
@@ -25,7 +26,11 @@
 # security groups
 
 
-def create_security_group(compute_client, name=None, description=None):
+def create_security_group(
+    compute_client: Any,
+    name: str | None = None,
+    description: str | None = None,
+) -> Any:
     """Create a new security group
 
     https://docs.openstack.org/api-ref/compute/#create-security-group
@@ -46,7 +51,9 @@ def create_security_group(compute_client, name=None, description=None):
     return response.json()['security_group']
 
 
-def list_security_groups(compute_client, all_projects=None):
+def list_security_groups(
+    compute_client: Any, all_projects: bool | None = None
+) -> Any:
     """Get all security groups
 
     https://docs.openstack.org/api-ref/compute/#list-security-groups
@@ -63,7 +70,7 @@ def list_security_groups(compute_client, all_projects=None):
     return response.json()['security_groups']
 
 
-def find_security_group(compute_client, name_or_id):
+def find_security_group(compute_client: Any, name_or_id: str) -> Any:
     """Find the security group for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-security-group-details
@@ -101,8 +108,11 @@ def find_security_group(compute_client, name_or_id):
 
 
 def update_security_group(
-    compute_client, security_group_id, name=None, description=None
-):
+    compute_client: Any,
+    security_group_id: str,
+    name: str | None = None,
+    description: str | None = None,
+) -> Any:
     """Update an existing security group
 
     https://docs.openstack.org/api-ref/compute/#update-security-group
@@ -127,7 +137,9 @@ def update_security_group(
     return response.json()['security_group']
 
 
-def delete_security_group(compute_client, security_group_id=None):
+def delete_security_group(
+    compute_client: Any, security_group_id: str | None = None
+) -> None:
     """Delete a security group
 
     https://docs.openstack.org/api-ref/compute/#delete-security-group
@@ -146,14 +158,14 @@ def delete_security_group(compute_client, security_group_id=None):
 
 
 def create_security_group_rule(
-    compute_client,
-    security_group_id=None,
-    ip_protocol=None,
-    from_port=None,
-    to_port=None,
-    remote_ip=None,
-    remote_group=None,
-):
+    compute_client: Any,
+    security_group_id: str | None = None,
+    ip_protocol: str | None = None,
+    from_port: int | None = None,
+    to_port: int | None = None,
+    remote_ip: str | None = None,
+    remote_group: str | None = None,
+) -> Any:
     """Create a new security group rule
 
     https://docs.openstack.org/api-ref/compute/#create-security-group-rule
@@ -182,7 +194,9 @@ def create_security_group_rule(
     return response.json()['security_group_rule']
 
 
-def delete_security_group_rule(compute_client, security_group_rule_id=None):
+def delete_security_group_rule(
+    compute_client: Any, security_group_rule_id: str | None = None
+) -> None:
     """Delete a security group rule
 
     https://docs.openstack.org/api-ref/compute/#delete-security-group-rule
@@ -201,7 +215,12 @@ def delete_security_group_rule(compute_client, security_group_rule_id=None):
 # networks
 
 
-def create_network(compute_client, name, subnet, share_subnet=None):
+def create_network(
+    compute_client: Any,
+    name: str,
+    subnet: str,
+    share_subnet: bool | None = None,
+) -> Any:
     """Create a new network
 
     https://docs.openstack.org/api-ref/compute/#create-network
@@ -212,7 +231,7 @@ def create_network(compute_client, name, subnet, share_subnet=None):
     :param bool share_subnet: Shared subnet between projects
     :returns: A network object
     """
-    data = {
+    data: dict[str, Any] = {
         'label': name,
         'cidr': subnet,
     }
@@ -226,7 +245,7 @@ def create_network(compute_client, name, subnet, share_subnet=None):
     return response.json()['network']
 
 
-def list_networks(compute_client):
+def list_networks(compute_client: Any) -> Any:
     """Get all networks
 
     https://docs.openstack.org/api-ref/compute/#list-networks
@@ -239,7 +258,7 @@ def list_networks(compute_client):
     return response.json()['networks']
 
 
-def find_network(compute_client, name_or_id):
+def find_network(compute_client: Any, name_or_id: str) -> Any:
     """Find the network for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-network-details
@@ -276,7 +295,7 @@ def find_network(compute_client, name_or_id):
     return found
 
 
-def delete_network(compute_client, network_id):
+def delete_network(compute_client: Any, network_id: str) -> None:
     """Delete a network
 
     https://docs.openstack.org/api-ref/compute/#delete-network
@@ -294,7 +313,7 @@ def delete_network(compute_client, network_id):
 # floating ips
 
 
-def create_floating_ip(compute_client, network):
+def create_floating_ip(compute_client: Any, network: str) -> Any:
     """Create a new floating ip
 
     https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address
@@ -309,7 +328,7 @@ def create_floating_ip(compute_client, network):
     return response.json()['floating_ip']
 
 
-def list_floating_ips(compute_client):
+def list_floating_ips(compute_client: Any) -> Any:
     """Get all floating IPs
 
     https://docs.openstack.org/api-ref/compute/#list-floating-ip-addresses
@@ -321,7 +340,7 @@ def list_floating_ips(compute_client):
     return response.json()['floating_ips']
 
 
-def get_floating_ip(compute_client, floating_ip_id):
+def get_floating_ip(compute_client: Any, floating_ip_id: str) -> Any:
     """Get a floating IP
 
     https://docs.openstack.org/api-ref/compute/#show-floating-ip-address-details
@@ -336,7 +355,7 @@ def get_floating_ip(compute_client, floating_ip_id):
     return response.json()['floating_ip']
 
 
-def delete_floating_ip(compute_client, floating_ip_id):
+def delete_floating_ip(compute_client: Any, floating_ip_id: str) -> None:
     """Delete a floating IP
 
     https://docs.openstack.org/api-ref/compute/#delete-deallocate-floating-ip-address
@@ -353,7 +372,7 @@ def delete_floating_ip(compute_client, floating_ip_id):
 # floating ip pools
 
 
-def list_floating_ip_pools(compute_client):
+def list_floating_ip_pools(compute_client: Any) -> Any:
     """Get all floating IP pools
 
     https://docs.openstack.org/api-ref/compute/#list-floating-ip-pools