xautomata-hive 3.20.2__py3-none-any.whl → 3.21.0__py3-none-any.whl

hive/api.py

@@ -52,6 +52,7 @@ class ApiManager:
     _timeout_sleep_time = 120  # tempo di attesa tra un retry e quello successivo in caso di timeout
     _silence_warning = False  # da implementare
     num_items = None  # serve per quando si mette la count a True, di default vale 0
+    response = []  # variabile in cui mettere la risposta degli endpoing per poter accedere alla versione originale
 
     def __init__(self, root, user, password, ssl_verify: bool = True):
 
@@ -155,6 +156,8 @@ class ApiManager:
 
         url = f'{self.root}{path}'
 
+        self.response = []  # reset dell'attributo responce, cosi da non accodare risposte proveninenti da richieste diverse
+
         @warmstart(active=warm_start, args_ex=[2], verbose=False)
         @paginate(single_page=single_page, page_size=page_size, skip=_params_['skip'], limit=_params_['limit'], bulk=bulk)
         @timeout_retry(max_tries=self._timeout_retry, sleep_time=self._timeout_sleep_time)
@@ -166,7 +169,8 @@ class ApiManager:
             logger.debug(f'request params (skip and limit may differ from your setting due pagination): {_params}')
             logger.debug(f'request payload: {_payload}')
 
-            response = get_session(self._timeout, self._timeout_get_session_retry, self._timeout_get_session_backoff_factor).request(_mode, url=_url, json=_payload, params=_params, headers=_headers, verify=self._SSL_verify, **_kwargs)
+            response = get_session(self._timeout, self._timeout_get_session_retry, self._timeout_get_session_backoff_factor).request(_mode, url=_url, json=_payload, params=_params,
+                                                                                                                                     headers=_headers, verify=self._SSL_verify, **_kwargs)
             if response.status_code == 401: raise UnauthorizedException
             if response.status_code != 200 and response.status_code != 504:  # 504 non e' gestito dalle API per cui la responce non sarebbe json serializable
                 logger.error(response.json())
@@ -178,6 +182,8 @@ class ApiManager:
             logger.debug(f'responce: {response.json()}')
             logger.debug(f'header: {response.headers}')
 
+            self.response.append(response)  # sotto forma di lista perche se la risposta viene paginata questa viene spezzata su piu risposte
+
             return response.json()
 
         return run_request(mode, url, _headers_, _payload_, _params_, **kwargs)

hive/cookbook/webhooks.py

@@ -115,16 +115,19 @@ class Webhooks(ApiManager):
         return response
 
     def webhooks_create_webhook_type(self, webhook_type: str,
-        kwargs: dict = None) -> list:
+        single_page: bool = False, page_size: int = 50, kwargs: dict = None
+        ) -> list:
         """Post Webhook
 
         Args:
             webhook_type (str, required): webhook_type
+            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
+            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
             kwargs (dict, optional): additional parameters for execute. Default to None.
 
         Returns: list"""
         if kwargs is None:
             kwargs = dict()
         response = self.execute('POST', path=f'/webhooks/{webhook_type}',
-            **kwargs)
+            single_page=single_page, page_size=page_size, **kwargs)
         return response

hive/decorators.py

@@ -131,29 +131,55 @@ def timeout_retry(func=None, max_tries: int = 2, sleep_time: int = 60):
 
 
 def paginate(single_page: bool, page_size: int, skip: int, limit: int, bulk: bool):
+    """Questa funzione è un decorator che abilita la paginazione per una funzione.
+
+    Args:
+        single_page: se True, restituisce solo una singola "pagina" di risultati.
+        page_size: dimensione della pagina (numero massimo di elementi per chiamata).
+        skip: numero di elementi da saltare all'inizio.
+        limit: numero massimo di elementi da restituire.
+        bulk: se True, gestisce il payload in modalità "bulk", suddividendolo in chunk.
+    """
     def attributes(func):
+        # Questo è il decorator interno che avvolge la funzione passata (`func`).
         @functools.wraps(func)
         def behaviour(mode, url, headers, payload, params, **kwargs) -> list:
-            result = []
+            # `behaviour` è la funzione wrapper che implementa la logica di paginazione.
+            # Accetta i parametri della funzione originale (`func`) e aggiunge il supporto alla paginazione.
+            result = []  # Lista che conterrà i risultati aggregati.
 
             # se la chiamata è bulk, il payload deve essere un lista e qui viene divisa in chunk e viene chiamata un
             # chunk per volta, ogni chunk ha la dimensione del page_size
             if bulk and not single_page:  # se la bulk viene richiesta in single_page, ricade nell'uso normale
+                # Divide il payload in chunk della dimensione specificata da `page_size`.
                 c_payload = chunks(payload, page_size)
+                # Per ogni chunk:
                 for c in c_payload:
+                    # Chiama la funzione originale (`func`) con il chunk corrente.
                     result_partial = func(mode, url, headers, c, params, **kwargs)
+                    # Se il risultato non è una lista, lo converte in una lista.
                     if not isinstance(result_partial, list): result_partial = [result_partial]
+                    # Aggiunge i risultati parziali alla lista complessiva `result`.
                     result += result_partial
 
-            else:
-                size = page_size if not single_page else limit
-                params['skip'] = skip
-                params['limit'] = min(size, limit)
-                while True:
+            else:  # Se non è in modalità bulk o se è richiesto single_page:
+                size = page_size if not single_page else limit  # Determina la dimensione della pagina.
+                params['skip'] = skip  # Imposta il valore iniziale di `skip` nei parametri.
+                params['limit'] = min(size, limit)  # Imposta il limite massimo per la pagina corrente.
+                while True:  # Ciclo per iterare attraverso le pagine.
+                    # Chiama la funzione originale (`func`) con i parametri della pagina corrente.
                     result_partial = func(mode, url, headers, payload, params, **kwargs)
+                    # Se il risultato non è una lista, lo converte in una lista.
                     if not isinstance(result_partial, list): result_partial = [result_partial]
+                    # Aggiunge i risultati parziali alla lista complessiva `result`.
                     result += result_partial
+                    # Aggiorna il valore di `skip` per passare alla pagina successiva.
                     params['skip'] = params['skip'] + size
+                    # Interrompe il ciclo se:
+                    # - Non ci sono più risultati (`result_partial` è vuoto).
+                    # - Il numero di risultati è inferiore alla dimensione della pagina.
+                    # - Il numero totale di risultati supera il limite specificato.
+                    # - È richiesto il single_page.
                     if not result_partial or len(result_partial) < size or len(result) > limit or single_page: break
 
             # se count è True il result è una lista con dentro una tupla, in questa maniera viene trasmessa solo la tupla

hive/version.py

@@ -1 +1 @@
-version = '3.20.2'
+version = '3.21.0'

{xautomata_hive-3.20.2.dist-info → xautomata_hive-3.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xautomata-hive
-Version: 3.20.2
+Version: 3.21.0
 Home-page: https://github.com/sherlogic/xautomata-hive.git
 Author: Enrico Ferro - Andrea Jacassi
 Author-email: 

{xautomata_hive-3.20.2.dist-info → xautomata_hive-3.21.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 hive/__init__.py,sha256=UjH5QfSfRGu2FR5_StfVbEtL_fuGS2Z_iZXmf1nx4AE,68
-hive/api.py,sha256=hQrokucvtOoBErofaCz27BFVBCh4BejPTj6sYwYb5Ik,41633
-hive/decorators.py,sha256=Lb2mYj7UpFaCzJXGKyLj3SmTK74zKMZgnC7Ys2j1D7g,9975
+hive/api.py,sha256=tXYFzcAEyWGmdQ3PWLD8u1m_4tCe4IL-YVAn6SUbahc,42151
+hive/decorators.py,sha256=qvXBMfkzmJ3nHzpnX96thrTdZjWuw4WAqYaxsJCfRug,12110
 hive/exceptions.py,sha256=kTJSPMViU2ZhF_ENbL_i-skU3YEv_ViJH2PpUQ6ums8,136
 hive/infrastrucure_keys.py,sha256=UzgXex6tQsglowhKeb45e7vw4u7kh2wM0YscQPorodU,4095
 hive/tools.py,sha256=Oi_d6wphtAS4f1wOhFzdXZj8Au1nwZ-UrRvIJDBQLMo,1371
-hive/version.py,sha256=A6DNRNCQIzEvjIBXMgWYcvOSWQ0pSbph1yJNgYqBuQI,18
+hive/version.py,sha256=CzEEPnYnPo514ZDmU-I_H_Uu3B3rOyK4rzwGXkNMQy0,18
 hive/cookbook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hive/cookbook/acl_docs.py,sha256=0xr7Vb9121vhsiZjQaKvuAt4gKlXOO4aUJM472HeARw,786
 hive/cookbook/acl_overrides.py,sha256=l3xyJmGeQysP1M2Sa6kVhDn8n6ttCKUzJ0jTcPjyo78,9690
@@ -67,11 +67,11 @@ hive/cookbook/ts_service_value.py,sha256=CAxT58Ss4cdECAv8Uuxs3UdV-CCtdVGaur3AddN
 hive/cookbook/users.py,sha256=FGeHTuvcXkZN2oC-Zuj4qSsxDysLSPbg9EP0A2YbhmE,52551
 hive/cookbook/users_notifications.py,sha256=klrqR3awrwKHx6o0wpg2oLFdU0PWA2MSa41KtJQhNjw,8165
 hive/cookbook/virtual_domains.py,sha256=N3dp3pjkO-5jni3KBcCukRqcmVqAFYCDV6dgVXrHaFM,22826
-hive/cookbook/webhooks.py,sha256=xQp7gW4FQP6717d4MCOuQN2Py7nw7TFy4pl9RmkqMKs,6705
+hive/cookbook/webhooks.py,sha256=PYbA1nZqJ9p8qbKk8Ba5_WLXKgJMkXmRI1YFK70RPxQ,7047
 hive/cookbook/widget_groups.py,sha256=GY7mBh72HzI9RRMCwnmJ-fildtZ3w4BrPDUdNfNoVyk,16018
 hive/cookbook/widgets.py,sha256=nYAEwh17aMGam8EC13jUwSR_i9KuP4yYRt25F0J6Z4g,23497
-xautomata_hive-3.20.2.dist-info/LICENSE,sha256=CFT1oIPm4kciOjwep2r1LQnpATugddSy3D839fsmgFs,1065
-xautomata_hive-3.20.2.dist-info/METADATA,sha256=6xtRLnOJwglxObwqxoWqj1bq_NJfuSgVKwcsk9MMd9M,10747
-xautomata_hive-3.20.2.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-xautomata_hive-3.20.2.dist-info/top_level.txt,sha256=pLpVAuviHGk3pzaFXU-4GKttxGTGAbFoWK8JvUl1jHQ,5
-xautomata_hive-3.20.2.dist-info/RECORD,,
+xautomata_hive-3.21.0.dist-info/LICENSE,sha256=CFT1oIPm4kciOjwep2r1LQnpATugddSy3D839fsmgFs,1065
+xautomata_hive-3.21.0.dist-info/METADATA,sha256=5uc08Aguie_ZpaP5McMGIowt9KndfzIO4XjrtH2SWzM,10747
+xautomata_hive-3.21.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+xautomata_hive-3.21.0.dist-info/top_level.txt,sha256=pLpVAuviHGk3pzaFXU-4GKttxGTGAbFoWK8JvUl1jHQ,5
+xautomata_hive-3.21.0.dist-info/RECORD,,

{xautomata_hive-3.20.2.dist-info → xautomata_hive-3.21.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any