pihole6api 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

pihole6api/conn.py

@@ -2,6 +2,8 @@ import requests
 import urllib3
 from urllib.parse import urljoin
 import warnings
+import time
+import json
 
 # Suppress InsecureRequestWarning
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
@@ -25,22 +27,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."""

pihole6api/ftl_info.py

@@ -62,14 +62,30 @@ class PiHole6FtlInfo:
         """Retrieve Pi-hole version details."""
         return self.connection.get("info/version")
 
-    def get_dnsmasq_logs(self):
-        """Retrieve DNS log content."""
-        return self.connection.get("logs/dnsmasq")
+    def get_dnsmasq_logs(self, next_id=None):
+        """
+        Retrieve DNS log content from the embedded DNS resolver (dnsmasq).
+
+        :param next_id: Optional ID to fetch only new log lines since the last request.
+        """
+        params = {"nextID": next_id} if next_id is not None else {}
+        return self.connection.get("logs/dnsmasq", params=params)
+
 
-    def get_ftl_logs(self):
-        """Retrieve FTL log content."""
-        return self.connection.get("logs/ftl")
+    def get_ftl_logs(self, next_id=None):
+        """
+        Retrieve FTL log content.
+        
+        :param next_id: Optional ID to fetch only new log lines since the last request.
+        """
+        params = {"nextID": next_id} if next_id is not None else {}
+        return self.connection.get("logs/ftl", params=params)
 
-    def get_webserver_logs(self):
-        """Retrieve webserver log content."""
-        return self.connection.get("logs/webserver")
+    def get_webserver_logs(self, next_id=None):
+        """
+        Retrieve webserver log content.
+        
+        :param next_id: Optional ID to fetch only new log lines since the last request.
+        """
+        params = {"nextID": next_id} if next_id is not None else {}
+        return self.connection.get("logs/webserver", params=params)

pihole6api/list_management.py

@@ -52,7 +52,7 @@ class PiHole6ListManagement:
         """
         encoded_address = urllib.parse.quote(address, safe="")
         params = {"type": list_type}
-        return self.connection.get(f"lists/{encoded_address}")
+        return self.connection.get(f"lists/{encoded_address}", params=params)
 
     def update_list(self, address, list_type=None, comment=None, groups=None, enabled=True):
         """
@@ -85,10 +85,21 @@ class PiHole6ListManagement:
         params = {"type": list_type}
         return self.connection.delete(f"lists/{encoded_address}", params=params)
 
-    def search_list(self, domain):
+    def search_list(self, domain, num=None, partial=False, debug=False):
         """
         Search for a domain in Pi-hole's lists.
 
         :param domain: Domain to search for.
+        :param num: Maximum number of results to be returned (optional).
+        :param partial: Boolean flag to enable partial matching (optional).
+        :param debug: Boolean flag to add debug information to the response (optional).
         """
-        return self.connection.get(f"search/{domain}")
+        params = {
+            "partial": str(partial).lower(),
+            "debug": str(debug).lower(),
+        }
+        if num is not None:
+            params["n"] = num
+
+        return self.connection.get(f"search/{domain}", params=params)
+

pihole6api/network_info.py

@@ -3,9 +3,20 @@ class PiHole6NetworkInfo:
         """Handles Pi-hole network information API endpoints."""
         self.connection = connection
 
-    def get_devices(self):
-        """Get information about devices on the local network."""
-        return self.connection.get("network/devices")
+    def get_devices(self, max_devices=None, max_addresses=None):
+        """
+        Get information about devices on the local network.
+
+        :param max_devices: Optional maximum number of devices to show.
+        :param max_addresses: Optional maximum number of addresses to show.
+        """
+        params = {}
+        if max_devices is not None:
+            params["max_devices"] = max_devices
+        if max_addresses is not None:
+            params["max_addresses"] = max_addresses
+
+        return self.connection.get("network/devices", params=params)
 
     def delete_device(self, device_id):
         """
@@ -15,14 +26,26 @@ class PiHole6NetworkInfo:
         """
         return self.connection.delete(f"network/devices/{device_id}")
 
-    def get_gateway(self):
-        """Get information about the gateway of the Pi-hole."""
-        return self.connection.get("network/gateway")
+    def get_gateway(self, detailed=False):
+        """
+        Get information about the gateway of the Pi-hole.
 
-    def get_interfaces(self):
-        """Get information about network interfaces of the Pi-hole."""
-        return self.connection.get("network/interfaces")
+        :param detailed: Boolean flag to request detailed interface/routing information (default: False).
+        """
+        return self.connection.get("network/gateway", params={"detailed": detailed})
 
-    def get_routes(self):
-        """Get information about network routes of the Pi-hole."""
-        return self.connection.get("network/routes")
+    def get_interfaces(self, detailed=False):
+        """
+        Get information about network interfaces of the Pi-hole.
+        
+        :param detailed: Boolean flag to request detailed interface/routing information (default: False).
+        """
+        return self.connection.get("network/interfaces", params={"detailed": detailed})
+
+    def get_routes(self, detailed=False):
+        """
+        Get information about network routes of the Pi-hole.
+        
+        :param detailed: Boolean flag to request detailed interface/routing information (default: False).
+        """
+        return self.connection.get("network/routes", params={"detailed": detailed})

{pihole6api-0.1.2.dist-info → pihole6api-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pihole6api
-Version: 0.1.2
+Version: 0.1.4
 Summary: Python API Client for Pi-hole 6
 Author-email: Shane Barbetta <shane@barbetta.me>
 License: MIT
@@ -30,7 +30,7 @@ This package provides a simple, modular SDK for the PiHole 6 REST API.
 ## Features
 
 * Automatically handles authentication and renewal
-* Gracefully error management
+* Graceful error management
 * Logically organized modules
 * Easily maintained
 
@@ -130,7 +130,6 @@ client.actions.restart_dns()
 | `dhcp`              | Manage DHCP leases |
 | `network_info`      | View network devices, interfaces, routes |
 | `actions`           | Flush logs, restart services |
-| `padd`              | Fetch summarized data for PADD |
 
 ## License
 

{pihole6api-0.1.2.dist-info → pihole6api-0.1.4.dist-info}/RECORD

@@ -3,17 +3,17 @@ pihole6api/actions.py,sha256=8CBkr8nYfT8yfdCO6F9M9nompaYcFdsaYGiEa1eVDCw,693
 pihole6api/client.py,sha256=HYdRh3CSZJ0srbkpjIVnLo-iy1avqKDUne5ji2Aq394,2013
 pihole6api/client_management.py,sha256=opPYGrjuW6SiwuxuvoOxnqjpmflU2znKHsqFbGSS3Gg,2439
 pihole6api/config.py,sha256=NdBHOudz147oIs5YVR3U4WLvqk3hU3HlZHnshy1NK4g,4680
-pihole6api/conn.py,sha256=ArXgFtb3QG2HeBeDvhEuZ7jcBDR6fW8QorlCF46Y3MM,4840
+pihole6api/conn.py,sha256=60Q9paDCD6Bwmdg_G9mOUr86Hzj9G-dhMwL7F3NvLB8,5837
 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
-pihole6api/ftl_info.py,sha256=e9W9vwkF8nHzjVlHpIMe-55qhhQngMj0swMlp2QNvPg,2540
+pihole6api/ftl_info.py,sha256=FINHFotI1sQgkL0OPaNqW-rk4h1ua6QHnRh5gFXXRIE,3210
 pihole6api/group_management.py,sha256=MGHwegw-b9U9PIA-IBzqT-a1kYkpXyjfSXJJJjkyTxc,2225
-pihole6api/list_management.py,sha256=B98FdgsIZhfRJHRxtRmwWsRPJ4rGlhvN-9gFEGdbb-c,3396
+pihole6api/list_management.py,sha256=52cCe3lEAvHYkyBOYdxkOn7C2I39fBUNsMpNC_rGiCI,3876
 pihole6api/metrics.py,sha256=czNyx9tUf2yZi_HnUpqykrtW51c042Rxq3zFl2_GjLY,7379
-pihole6api/network_info.py,sha256=u5NIteFoI-yav05eE6v81-9gs3MeZVBlNCSBS5gzCT8,1006
-pihole6api-0.1.2.dist-info/LICENSE,sha256=hpO6J6J9O1VZxZeHQTxKMTmuobaHbApiZxp279I4xNU,1062
-pihole6api-0.1.2.dist-info/METADATA,sha256=0kZSJq4RYKkx6fHMae0Tohtbwm7QVORbYnZ15GJdgPw,3837
-pihole6api-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pihole6api-0.1.2.dist-info/top_level.txt,sha256=Qrh46lxEC54rBR8T53em-tuZLWbmi1SDwL1rOhsgrME,11
-pihole6api-0.1.2.dist-info/RECORD,,
+pihole6api/network_info.py,sha256=E1qQ7DsCb7qplt0oQIyKhUY12ExNF6bv6thm9rbNqwY,1953
+pihole6api-0.1.4.dist-info/LICENSE,sha256=hpO6J6J9O1VZxZeHQTxKMTmuobaHbApiZxp279I4xNU,1062
+pihole6api-0.1.4.dist-info/METADATA,sha256=F7_jh48dzzmrzazbdrvsBhh4_zdN6BhDhJasq7KH1lM,3778
+pihole6api-0.1.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pihole6api-0.1.4.dist-info/top_level.txt,sha256=Qrh46lxEC54rBR8T53em-tuZLWbmi1SDwL1rOhsgrME,11
+pihole6api-0.1.4.dist-info/RECORD,,