x/tobiko
Code Issues Proposed changes

Add typing hints to Heat client APIs

Browse Source 
Change-Id: I624fa3ad07e3d433e8b33b8fb4bf06e148c06bef
This commit is contained in:
Federico Ressi 2021-07-05 10:58:09 +02:00
parent ebe62cc404
commit 06038db65b
2 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tobiko/openstack/heat/__init__.py
View File

@ -17,12 +17,12 @@ from tobiko.openstack.heat import _client
from tobiko.openstack.heat import _template
from tobiko.openstack.heat import _stack
heat_client = _client.heat_client
default_heat_client = _client.default_heat_client
get_heat_client = _client.get_heat_client
heat_client = _client.heat_client
HeatClient = _client.HeatClient
HeatClientFixture = _client.HeatClientFixture
HeatClientType = _client.HeatClientType
heat_template = _template.heat_template
heat_template_file = _template.heat_template_file
@ -33,7 +33,6 @@ HeatStackFixture = _stack.HeatStackFixture
heat_stack_parameters = _stack.heat_stack_parameters
INIT_IN_PROGRESS = _stack.INIT_IN_PROGRESS
INIT_COMPLETE = _stack.INIT_COMPLETE
INIT_IN_PROGRESS = _stack.INIT_IN_PROGRESS
CREATE_IN_PROGRESS = _stack.CREATE_IN_PROGRESS
CREATE_COMPLETE = _stack.CREATE_COMPLETE
CREATE_FAILED = _stack.CREATE_FAILED

30
tobiko/openstack/heat/_client.py
View File

@ -13,34 +13,44 @@
# under the License.
from __future__ import absolute_import
from heatclient.v1 import client as heatclient
import typing
from heatclient.v1 import client as v1_client
import tobiko
from tobiko.openstack import _client
HeatClient = typing.Union[v1_client.Client]
class HeatClientFixture(_client.OpenstackClientFixture):
def init_client(self, session):
return heatclient.Client(session=session,
endpoint_type='public',
service_type='orchestration')
def init_client(self, session) -> HeatClient:
return v1_client.Client(session=session,
endpoint_type='public',
service_type='orchestration')
class HeatClientManager(_client.OpenstackClientManager):
def create_client(self, session):
def create_client(self, session) -> HeatClientFixture:
return HeatClientFixture(session=session)
CLIENTS = HeatClientManager()
def heat_client(obj=None):
HeatClientType = typing.Union[None,
HeatClient,
HeatClientFixture]
def heat_client(obj: HeatClientType = None) -> HeatClient:
if obj is None:
return default_heat_client()
if isinstance(obj, heatclient.Client):
if isinstance(obj, v1_client.Client):
return obj
fixture = tobiko.get_fixture(obj)
@ -51,12 +61,12 @@ def heat_client(obj=None):
raise TypeError(message)
def default_heat_client():
def default_heat_client() -> HeatClient:
return get_heat_client()
def get_heat_client(session=None, shared=True, init_client=None,
manager=None):
manager=None) -> HeatClient:
manager = manager or CLIENTS
fixture = manager.get_client(session=session, shared=shared,
init_client=init_client)