Skip to content

Hive.cookbook.features

Features

Bases: ApiManager

Class that handles all the XAutomata features APIs

Source code in hive/cookbook/features.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class Features(ApiManager):
    """Class that handles all the XAutomata features APIs"""

    def features(self, warm_start: bool = False, kwargs: dict = None, **params
        ) -> list:
        """Get Api Features Settings

        Args:
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            user-agent (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['user-agent']
        params.get('user-agent')
        if not self._silence_warning:
            warning_wrong_parameters(self.features.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/features/', warm_start=
            warm_start, params=params, **kwargs)
        return response

features(warm_start=False, kwargs=None, **params)

Get Api Features Settings

Parameters:

Name Type Description Default
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

 False
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
user-agent string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/features.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def features(self, warm_start: bool = False, kwargs: dict = None, **params
    ) -> list:
    """Get Api Features Settings

    Args:
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        user-agent (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['user-agent']
    params.get('user-agent')
    if not self._silence_warning:
        warning_wrong_parameters(self.features.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/features/', warm_start=
        warm_start, params=params, **kwargs)
    return response