Collaboration diagram for src.lib.actions.api_querier.APIQuerier:

Public Member Functions
None	__init__ (self, Dict[str, Any] service, Variables variable, str scope, RuntimeData runtime_data, ActionLogger logger, int action_id, int error=84, int success=0, bool debug=False)

str	strip_descriptor (self, str node)

Dict[str, Any]	get_api_info (self, int api_id)

None	update_secrets (self, Dict[str, Any] api_info)

str	sanitize_parameter_value (self, str url_param)

str	get_variable_name (self, str var)

str	get_special_content (self, str var_name)

str	get_normal_content (self, str var_name)

str	check_special_vars (self, str var)

str	check_normal_vars (self, str var)

str	compile_url_parameters (self, Dict[str, Any] url_params)

Dict[str, Any]	process_extra_headers (self, str header)

Dict[str, Any]	process_headers (self, Dict[str, Any] header)

Dict[str, Any]	process_extra_body (self, str body)

Dict[str, Any]	process_body (self, Dict[str, Any] body)

str	get_method (self, List[str] method)

int	extract_response_code (self, Dict[str, Any] code)

None	check_response_code (self, Response response, int expected_response)

str	compile_url (self, str url_extra, Dict[str, Any] url_params)

str	replace_url_body_params (self, str url_extra, Union[Dict[str, Any], None] url_body_params)

Response	query (self)

Data Fields
int	error = error

str	scope = scope

bool	debug = debug

int	success = success

str	action_id = str(action_id)

ActionLogger	logger = logger

Variables	variable = variable

Dict[str, Any]	service = service

RuntimeData	runtime_data = runtime_data

Disp	disp

Secrets	secrets

Dict[str, Any]	api_info

Protected Member Functions
int	_log_fatal (self, str title, msg, int action_id, bool raise_item=False, object raise_func=ValueError)

Detailed Description

_summary_

Definition at line 22 of file api_querier.py.

Constructor & Destructor Documentation

◆ init()

None src.lib.actions.api_querier.APIQuerier.__init__	(		self,
		Dict[str, Any]	service,
		Variables	variable,
		str	scope,
		RuntimeData	runtime_data,
		ActionLogger	logger,
		int	action_id,
		int	error = 84,
		int	success = 0,
		bool	debug = False )

_summary_
    Class in charge of querying the data from the API

Args:
    service (Dict[str, Any]): _description_
    variable (Variables): _description_: The class variable in charge of tracking the variables for the runtime.
    scope (str): _description_: The scope of the trigger.
    runtime_data (RuntimeData): _description_
    logger (ActionLogger): _description_: The class logger in charge of logging the actions.
    action_id (int): _description_: The action ID to log.
    error (int, optional): _description_. Defaults to 84.
    success (int, optional): _description_. Defaults to 0.
    debug (bool, optional): _description_. Defaults to False.

Definition at line 26 of file api_querier.py.

Member Function Documentation

◆ _log_fatal()

int src.lib.actions.api_querier.APIQuerier._log_fatal	(		self,
		str	title,
			msg,
		int	action_id,
		bool	raise_item = False,
		object	raise_func = ValueError )

protected

_summary_
    A function that will log a provided fatal error.

Args:
    title (str): _description_: the title of the function
    msg (str): _description_: The message to log
    raise_item (bool, optional): _description_. Inform if the logger should raise or just return an error. Defaults to False.
    raise_func (object, optional): _description_. The function to raise if required. Defaults to ValueError.

Raises:
    ValueError: _description_: One of the possible errors to raise.

Returns:
    int: _description_: Will return self.error if raise_item is False

Definition at line 75 of file api_querier.py.

◆ check_normal_vars()

str src.lib.actions.api_querier.APIQuerier.check_normal_vars	(		self,
		str	var )

_summary_
    Check the normal variables

Args:
    var (str): _description_

Returns:
    str: _description_

Definition at line 330 of file api_querier.py.

◆ check_response_code()

None src.lib.actions.api_querier.APIQuerier.check_response_code	(		self,
		Response	response,
		int	expected_response )

_summary_
    Check the response code

Args:
    response (Response): _description_
    expected_response (int): _description_

Definition at line 646 of file api_querier.py.

◆ check_special_vars()

str src.lib.actions.api_querier.APIQuerier.check_special_vars	(		self,
		str	var )

_summary_
    Check the variables

Args:
    var (str): _description_

Returns:
    str: _description_

Definition at line 301 of file api_querier.py.

◆ compile_url()

str src.lib.actions.api_querier.APIQuerier.compile_url	(		self,
		str	url_extra,
		Dict[str, Any]	url_params )

_summary_
    Compile the URL

Args:
    url_extra (str): _description_
    url_params (Dict[str, Any]): _description_

Returns:
    str: _description_

Definition at line 674 of file api_querier.py.

◆ compile_url_parameters()

str src.lib.actions.api_querier.APIQuerier.compile_url_parameters	(		self,
		Dict[str, Any]	url_params )

_summary_
    Compile the URL parameters

Args:
    url_params (Dict[str, Any]): _description_

Returns:
    str: _description_

Definition at line 359 of file api_querier.py.

◆ extract_response_code()

int src.lib.actions.api_querier.APIQuerier.extract_response_code	(		self,
		Dict[str, Any]	code )

_summary_
    Extract the code code

Args:
    code (Dict[str, Any]): _description_

Returns:
    int: _description_

Definition at line 596 of file api_querier.py.

◆ get_api_info()

Dict[str, Any] src.lib.actions.api_querier.APIQuerier.get_api_info	(		self,
		int	api_id )

_summary_
    Get the API information

Args:
    api_id (int): _description_

Returns:
    Dict[str, Any]: _description_

Definition at line 119 of file api_querier.py.

◆ get_method()

str src.lib.actions.api_querier.APIQuerier.get_method	(		self,
		List[str]	method )

_summary_
    Get the method

Args:
    method (str): _description_

Returns:
    str: _description_

Definition at line 570 of file api_querier.py.

◆ get_normal_content()

str src.lib.actions.api_querier.APIQuerier.get_normal_content	(		self,
		str	var_name )

_summary_
    Get the content of a normal variable

Args:
    var_name (str): _description_

Returns:
    str: _description_

Definition at line 282 of file api_querier.py.

◆ get_special_content()

str src.lib.actions.api_querier.APIQuerier.get_special_content	(		self,
		str	var_name )

_summary_
    Get the content of a special variable

Args:
    var_name (str): _description_

Returns:
    str: _description_

Definition at line 256 of file api_querier.py.

◆ get_variable_name()

str src.lib.actions.api_querier.APIQuerier.get_variable_name	(		self,
		str	var )

_summary_
    Get the variable name

Args:
    var (str): _description_

Returns:
    str: _description_

Definition at line 234 of file api_querier.py.

◆ process_body()

Dict[str, Any] src.lib.actions.api_querier.APIQuerier.process_body	(		self,
		Dict[str, Any]	body )

_summary_
    Process the body

Args:
    body (Dict[str, Any]): _description_

Returns:
    Dict[str, Any]: _description_

Definition at line 521 of file api_querier.py.

◆ process_extra_body()

Dict[str, Any] src.lib.actions.api_querier.APIQuerier.process_extra_body	(		self,
		str	body )

_summary_
    Process the extra body

Args:
    body (str): _description_

Returns:
    Dict[str, Any]: _description_

Definition at line 491 of file api_querier.py.

◆ process_extra_headers()

Dict[str, Any] src.lib.actions.api_querier.APIQuerier.process_extra_headers	(		self,
		str	header )

_summary_
    Process the extra headers

Args:
    header (Dict[str, Any]): _description_

Returns:
    Dict[str, Any]: _description_

Definition at line 411 of file api_querier.py.

◆ process_headers()

Dict[str, Any] src.lib.actions.api_querier.APIQuerier.process_headers	(		self,
		Dict[str, Any]	header )

_summary_
    Process the header

Args:
    header (Dict[str, Any]): _description_

Returns:
    Dict[str, Any]: _description_

Definition at line 441 of file api_querier.py.

◆ query()

Response src.lib.actions.api_querier.APIQuerier.query ( self )

_summary_
    Query the API

Returns:
    Response: _description_

Definition at line 718 of file api_querier.py.

◆ replace_url_body_params()

str src.lib.actions.api_querier.APIQuerier.replace_url_body_params	(		self,
		str	url_extra,
		Union[Dict[str, Any], None]	url_body_params )

Replaces placeholders in the URL with values from the given dictionary.

Args:
    url_extra: The URL containing placeholders in the format {param}.
    url_body_params: A dictionary containing the parameters and their values.

Returns:
    The URL with the placeholders replaced by their corresponding values.

If url_body_params is None, the function returns url_extra unchanged.

Definition at line 696 of file api_querier.py.

◆ sanitize_parameter_value()

str src.lib.actions.api_querier.APIQuerier.sanitize_parameter_value	(		self,
		str	url_param )

_summary_
    Sanitize the parameter value

Args:
    url_param (str): _description_

Returns:
    str: _description_

Definition at line 216 of file api_querier.py.

◆ strip_descriptor()

str src.lib.actions.api_querier.APIQuerier.strip_descriptor	(		self,
		str	node )

_summary_
    A function that will strip the descriptor of the given node.

Args:
    descriptor (str): _description_: The descriptor to strip.

Returns:
    str: _description_: The stripped descriptor.

Definition at line 103 of file api_querier.py.

◆ update_secrets()

None src.lib.actions.api_querier.APIQuerier.update_secrets	(		self,
		Dict[str, Any]	api_info )

_summary_
    Update the secrets

Args:
    api_info (Dict[str, Any]): _description_

Definition at line 157 of file api_querier.py.

Field Documentation

◆ action_id

str src.lib.actions.api_querier.APIQuerier.action_id = str(action_id)

Definition at line 46 of file api_querier.py.

◆ api_info

src.lib.actions.api_querier.APIQuerier.api_info

Initial value:

=  self.get_api_info(
            self.service.get("ignore:id")
        )

Definition at line 68 of file api_querier.py.

◆ debug

bool src.lib.actions.api_querier.APIQuerier.debug = debug

Definition at line 44 of file api_querier.py.

◆ disp

Disp src.lib.actions.api_querier.APIQuerier.disp

Initial value:

=  Disp(
            TOML_CONF,
            SAVE_TO_FILE,
            FILE_NAME,
            FILE_DESCRIPTOR,
            debug=self.debug,
            logger=self.__class__.__name__
        )

Definition at line 52 of file api_querier.py.

◆ error

int src.lib.actions.api_querier.APIQuerier.error = error

Definition at line 42 of file api_querier.py.

◆ logger

ActionLogger src.lib.actions.api_querier.APIQuerier.logger = logger

Definition at line 47 of file api_querier.py.

◆ runtime_data

RuntimeData src.lib.actions.api_querier.APIQuerier.runtime_data = runtime_data

Definition at line 50 of file api_querier.py.

◆ scope

src.lib.actions.api_querier.APIQuerier.scope = scope

Definition at line 43 of file api_querier.py.

◆ secrets

Secrets src.lib.actions.api_querier.APIQuerier.secrets

Initial value:

=  Secrets(
            success=self.success,
            error=self.error,
            debug=self.debug
        )

Definition at line 62 of file api_querier.py.

◆ service

Dict[str, Any] src.lib.actions.api_querier.APIQuerier.service = service

Definition at line 49 of file api_querier.py.

◆ success

int src.lib.actions.api_querier.APIQuerier.success = success

Definition at line 45 of file api_querier.py.

◆ variable

Variables src.lib.actions.api_querier.APIQuerier.variable = variable

Definition at line 48 of file api_querier.py.

The documentation for this class was generated from the following file:

app/back/server/src/lib/actions/api_querier.py

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _log_fatal()

◆ check_normal_vars()

◆ check_response_code()

◆ check_special_vars()

◆ compile_url()

◆ compile_url_parameters()

◆ extract_response_code()

◆ get_api_info()

◆ get_method()

◆ get_normal_content()

◆ get_special_content()

◆ get_variable_name()

◆ process_body()

◆ process_extra_body()

◆ process_extra_headers()

◆ process_headers()

◆ query()

◆ replace_url_body_params()

◆ sanitize_parameter_value()

◆ strip_descriptor()

◆ update_secrets()

Field Documentation

◆ action_id

◆ api_info

◆ debug

◆ disp

◆ error

◆ logger

◆ runtime_data

◆ scope

◆ secrets

◆ service

◆ success

◆ variable

◆ init()