Coverage for mlos_bench/mlos_bench/services/types/authenticator_type.py: 100%

1# 

2# Copyright (c) Microsoft Corporation. 

3# Licensed under the MIT License. 

4# 

5"""Protocol interface for authentication for the cloud services.""" 

6 

7from typing import Protocol, TypeVar, runtime_checkable 

8 

9T_co = TypeVar("T_co", covariant=True) 

10 

11 

12@runtime_checkable 

13class SupportsAuth(Protocol[T_co]): 

14 """Protocol interface for authentication for the cloud services.""" 

15 

16 def get_access_token(self) -> str: 

17 """ 

18 Get the access token for cloud services. 

19 

20 Returns 

21 ------- 

22 access_token : str 

23 Access token. 

24 """ 

25 

26 def get_auth_headers(self) -> dict: 

27 """ 

28 Get the authorization part of HTTP headers for REST API calls. 

29 

30 Returns 

31 ------- 

32 access_header : dict 

33 HTTP header containing the access token. 

34 """ 

35 

36 def get_credential(self) -> T_co: 

37 """ 

38 Get the credential object for cloud services. 

39 

40 Returns 

41 ------- 

42 credential : T 

43 Cloud-specific credential object. 

44 """