pihole6api 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

pihole6api/client.py

@@ -41,4 +41,8 @@ class PiHole6Client:
         :param full: Boolean flag to get the full dataset.
         :return: API response containing PADD summary.
         """
-        return self.connection.get("padd", params={"full": str(full).lower()})
+        return self.connection.get("padd", params={"full": str(full).lower()})
+    
+    def close_session(self):
+        """Close the Pi-hole session by calling the exit method in the connection."""
+        return self.connection.exit()

pihole6api/conn.py

@@ -2,6 +2,7 @@ import requests
 import urllib3
 from urllib.parse import urljoin
 import warnings
+import time
 
 # Suppress InsecureRequestWarning
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
@@ -25,22 +26,43 @@ class PiHole6Connection:
         self._authenticate()
 
     def _authenticate(self):
-        """Authenticate with the Pi-hole API and store session ID and CSRF token."""
+        """Authenticate with the Pi-hole API and store session ID and CSRF token.
+        
+        Retries up to three times (with a one-second pause between attempts)
+        before raising an exception.
+        """
         auth_url = urljoin(self.base_url, "auth")
         payload = {"password": self.password}
+        max_attempts = 3
+        last_exception = None
 
-        response = requests.post(auth_url, json=payload, verify=False)
-        
-        if response.status_code == 200:
-            data = response.json()
-            if "session" in data and data["session"]["valid"]:
-                self.session_id = data["session"]["sid"]
-                self.csrf_token = data["session"]["csrf"]
-                self.validity = data["session"]["validity"]
-            else:
-                raise Exception("Authentication failed: Invalid session response")
-        else:
-            raise Exception(f"Authentication failed: {response.json().get('error', {}).get('message', 'Unknown error')}")
+        for attempt in range(1, max_attempts + 1):
+            response = requests.post(auth_url, json=payload, verify=False)
+            try:
+                if response.status_code == 200:
+                    data = response.json()
+                    if "session" in data and data["session"]["valid"]:
+                        self.session_id = data["session"]["sid"]
+                        self.csrf_token = data["session"]["csrf"]
+                        self.validity = data["session"]["validity"]
+                        return  # Successful authentication
+                    else:
+                        last_exception = Exception("Authentication failed: Invalid session response")
+                else:
+                    # Try to extract an error message from the response
+                    try:
+                        error_msg = response.json().get("error", {}).get("message", "Unknown error")
+                    except (json.decoder.JSONDecodeError, ValueError):
+                        error_msg = f"HTTP {response.status_code}: {response.reason}"
+                    last_exception = Exception(f"Authentication failed: {error_msg}")
+            except Exception as e:
+                last_exception = e
+
+            if attempt < max_attempts:
+                time.sleep(1)  # Pause before retrying
+
+        # All attempts failed; raise the last captured exception.
+        raise last_exception
 
     def _get_headers(self):
         """Return headers including the authentication SID and CSRF token."""
@@ -124,4 +146,15 @@ class PiHole6Connection:
 
     def patch(self, endpoint, data=None):
         """Send a PATCH request."""
-        return self._do_call("PATCH", endpoint, data=data)
+        return self._do_call("PATCH", endpoint, data=data)
+    
+    def exit(self):
+        """Delete the current session."""
+        response = self.delete("auth")
+
+        # Clear stored session info
+        self.session_id = None
+        self.csrf_token = None
+        self.validity = None
+
+        return response

{pihole6api-0.1.1.dist-info → pihole6api-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pihole6api
-Version: 0.1.1
+Version: 0.1.3
 Summary: Python API Client for Pi-hole 6
 Author-email: Shane Barbetta <shane@barbetta.me>
 License: MIT
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.26.0
 
-# pihole6api
+# 🍓 pihole6api
 
 This package provides a simple, modular SDK for the PiHole 6 REST API.
 
@@ -55,7 +55,7 @@ pip install -e .
 ### Initialize the Client
 
 ```python
-from pihole6api.client import PiHole6Client
+from pihole6api import PiHole6Client
 client = PiHole6Client("https://your-pihole.local/", "your-password")
 ```
 

{pihole6api-0.1.1.dist-info → pihole6api-0.1.3.dist-info}/RECORD

@@ -1,9 +1,9 @@
 pihole6api/__init__.py,sha256=OKDAH2I6UjXcBmcj6rn5aNg5J60GCUBVFJ-_t83GiVQ,898
 pihole6api/actions.py,sha256=8CBkr8nYfT8yfdCO6F9M9nompaYcFdsaYGiEa1eVDCw,693
-pihole6api/client.py,sha256=IgUjiBUx_EFzQujgQZcX2h9dfDfI83aVeipUeStHWY0,1855
+pihole6api/client.py,sha256=HYdRh3CSZJ0srbkpjIVnLo-iy1avqKDUne5ji2Aq394,2013
 pihole6api/client_management.py,sha256=opPYGrjuW6SiwuxuvoOxnqjpmflU2znKHsqFbGSS3Gg,2439
 pihole6api/config.py,sha256=NdBHOudz147oIs5YVR3U4WLvqk3hU3HlZHnshy1NK4g,4680
-pihole6api/conn.py,sha256=sYjS8Gvk2GuA482eyvFknTKgeeesLnS5ylI9I4yUNRo,4581
+pihole6api/conn.py,sha256=qqC-PO6a2RR_dluhSeu_RMeo6TpA8_Xlg5CA2FTwG7Y,5825
 pihole6api/dhcp.py,sha256=1A3z-3q9x51-6MOC3JMl7yR_5pHmRxZtMWtPqzWxYm0,629
 pihole6api/dns_control.py,sha256=mxV3AIuGCsx0-1ibpMXor9QUGd_fDFfeaUENPhIK_TY,853
 pihole6api/domain_management.py,sha256=vxhQSG5F8EFDGqtiNkF0H_KOWFMerXaAuJZT0nMa8ec,3492
@@ -12,8 +12,8 @@ pihole6api/group_management.py,sha256=MGHwegw-b9U9PIA-IBzqT-a1kYkpXyjfSXJJJjkyTx
 pihole6api/list_management.py,sha256=B98FdgsIZhfRJHRxtRmwWsRPJ4rGlhvN-9gFEGdbb-c,3396
 pihole6api/metrics.py,sha256=czNyx9tUf2yZi_HnUpqykrtW51c042Rxq3zFl2_GjLY,7379
 pihole6api/network_info.py,sha256=u5NIteFoI-yav05eE6v81-9gs3MeZVBlNCSBS5gzCT8,1006
-pihole6api-0.1.1.dist-info/LICENSE,sha256=hpO6J6J9O1VZxZeHQTxKMTmuobaHbApiZxp279I4xNU,1062
-pihole6api-0.1.1.dist-info/METADATA,sha256=GzNFEKppAIpUn6xgmxZPoMhrmtRkMzNgFIOVhKqXkbo,3839
-pihole6api-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pihole6api-0.1.1.dist-info/top_level.txt,sha256=Qrh46lxEC54rBR8T53em-tuZLWbmi1SDwL1rOhsgrME,11
-pihole6api-0.1.1.dist-info/RECORD,,
+pihole6api-0.1.3.dist-info/LICENSE,sha256=hpO6J6J9O1VZxZeHQTxKMTmuobaHbApiZxp279I4xNU,1062
+pihole6api-0.1.3.dist-info/METADATA,sha256=JMgYTLowrNI52DPCEaVpBIqiD4NHBX9av86qJLQ8-wg,3837
+pihole6api-0.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pihole6api-0.1.3.dist-info/top_level.txt,sha256=Qrh46lxEC54rBR8T53em-tuZLWbmi1SDwL1rOhsgrME,11
+pihole6api-0.1.3.dist-info/RECORD,,