Base class for all authentication back-ends.
Its purpose is to provide an easy interface to authenticate a user against the WhintPy API.
Any authentication method is characterized by two parameters: its name and its identifier. The name is specific to each authentication backend. but the identifier is specific to each authentication instance.
Initialize the authentication method.
method_iddef __init__(self, method_id: str | None=None, *args, **kwargs):
"""Initialize the authentication method.
:param method_id: (str | None) Identifier of the authentication method
:param args: (dict) Credentials for a subclass of BaseAuthentication.
:param kwargs: (dict) Keywords for a subclass of BaseAuthentication.
:raises: TypeError: Invalid given ``method_id``
"""
self._available = True
self.__method_id = None
if method_id is not None:
if isinstance(method_id, str) is False:
raise TypeError(f"BaseAuthentication method_id must be a string. Got '{type(method_id).__name__}' instead.")
if len(method_id) > 0:
self.__method_id = method_id
Return True if authentication is available.
def get_available(self) -> bool:
"""Return True if authentication is available."""
return self._available
Return the name of the authentication method.
Must be overridden by subclasses.
@staticmethod
def name() -> str:
"""Return the name of the authentication method.
Must be overridden by subclasses.
:return: (str) The name of the authentication method.
"""
return BaseAuthentication._get_default_name(BaseAuthentication)
Return the id of the authentication method or None.
def get_method_id(self) -> str | None:
"""Return the id of the authentication method or None.
:return: (str | None) The id of the method if set, None otherwise.
"""
return self.__method_id
The authentication base method, must be overridden.
Must be overridden by subclasses.
def authenticate(self, *args, **kwargs) -> tuple[bool, str]:
"""The authentication base method, must be overridden.
Must be overridden by subclasses.
:param args: (any) the arguments of the credentials depends on the method
:param kwargs: (dict) the arguments of the credentials depends on the method
:return: (bool) True if the authentication is successful, False otherwise
"""
raise NotImplementedError("{:s} does not implement 'authenticate' method.".format(self.__class__.__name__))
Return the arguments of the authentication method.
Must be overridden by subclasses.
def get_args(self) -> list:
"""Return the arguments of the authentication method.
Must be overridden by subclasses.
:return: (list) The arguments of the method
"""
raise NotImplementedError("{:s} does not implement 'get_args' method.".format(self.__class__.__name__))
Return a default name for the given authentication method.
@staticmethod
def _get_default_name(obj: object) -> str:
"""Return a default name for the given authentication method.
:param obj: (class) The authentication method to use.
:return: (str) The default name of the authentication method.
:raises: TypeError: Invalid given parameter.
"""
if inspect.isclass(obj) is False:
raise TypeError("Invalid parameter to define a default name. Expected a 'class'.")
return obj.__name__.replace('Authentication', '').lower()