zcc-helper 3.4.dev3__tar.gz → 3.4.dev5__tar.gz

{zcc_helper-3.4.dev3/zcc_helper.egg-info → zcc_helper-3.4.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zcc_helper
-Version: 3.4.dev3
+Version: 3.4.dev5
 Summary: ZIMI ZCC helper module
 Author: Mark Hannon
 Author-email: mark.hannon@gmail.com

zcc_helper-3.4.dev5/zcc/__init__.py

@@ -0,0 +1,14 @@
+'''ZCC Support Library to support ZIMI based home network elements'''
+import logging
+import sys
+
+from .controller import ControlPoint
+from .description import ControlPointDescription
+from .discovery import ControlPointDiscoveryService
+from .errors import ( ControlPointError,
+                     ControlPointConnectionRefusedError,
+                     ControlPointCannotConnectError,
+                     ControlPointInvalidHostError,
+                     ControlPointTimeoutError)
+
+logging.basicConfig(stream=sys.stderr)

{zcc_helper-3.4.dev3 → zcc_helper-3.4.dev5}/zcc/__main__.py

@@ -100,9 +100,10 @@ async def main(args):
         return
 
     if options.test_connection and options.host and options.port:
-        await ControlPointDiscoveryService(
+        result = await ControlPointDiscoveryService(
             verbosity=options.verbosity
         ).validate_connection(host=options.host, port=options.port)
+        print(result)
         return
 
     if options.host and options.port:

{zcc_helper-3.4.dev3 → zcc_helper-3.4.dev5}/zcc/constants.py

@@ -9,4 +9,4 @@ APP_ID = "ZvWqWJQB"
 APP_TOKEN = "3422ecbb-cf6a-404c-b3dc-2023dd213535"
 
 NAME = "zcc_helper"
-VERSION = "3.4-dev3"
+VERSION = "3.4-dev5"

{zcc_helper-3.4.dev3 → zcc_helper-3.4.dev5}/zcc/discovery.py

@@ -13,23 +13,13 @@ from typing import Tuple
 from zcc.constants import LEVEL_BY_VERBOSITY
 from zcc.controller import ControlPoint
 from zcc.description import ControlPointDescription
-from zcc.errors import ControlPointError
+from zcc.errors import ( ControlPointError,
+                     ControlPointConnectionRefusedError,
+                     ControlPointCannotConnectError,
+                     ControlPointInvalidHostError,
+                     ControlPointTimeoutError)
 from zcc.protocol import ControlPointProtocol
 
-
-class ControlPointDiscoveryErrors(StrEnum):
-    """Discovery errors."""
-
-    ALREADY_CONFIGURED = "already_configured"
-    CANNOT_CONNECT = "cannot_connect"
-    CONNECTION_REFUSED = "connection_refused"
-    DISCOVERY_FAILURE = "discovery_failure"
-    INVALID_HOST = "invalid_host"
-    INVALID_PORT = "invalid_port"
-    TIMEOUT = "timeout"
-    UNKNOWN = "unknown"
-
-
 class ControlPointDiscoveryProtocol(asyncio.DatagramProtocol):
     """Listens for ZCC announcements on the defined UDP port."""
 
@@ -154,14 +144,12 @@ class ControlPointDiscoveryService:
 
     async def validate_connection(
         self, host: str, port: int
-    ) -> ControlPointDescription | dict[str, str]:
+    ) -> ControlPointDescription:
         """Validate ability to connect and close a connection.
 
-        Return a ControlPointDescription if OK or error dictionary if not.
+        Returns ControlPointDescription if OK.
         """
 
-        error = None
-
         try:
             socket.gethostbyname(host)
             s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@@ -169,25 +157,21 @@ class ControlPointDiscoveryService:
             try:
                 s.connect((host, port))
                 s.close()
-            except ConnectionRefusedError:
-                error = {"error": ControlPointDiscoveryErrors.CONNECTION_REFUSED}
-            except TimeoutError:
-                error = {"error": ControlPointDiscoveryErrors.TIMEOUT}
-            except socket.gaierror:
-                error = {"error": ControlPointDiscoveryErrors.CANNOT_CONNECT}
-        except socket.gaierror:
-            error = {"error": ControlPointDiscoveryErrors.INVALID_HOST}
-
-        if error:
-            self.logger.error(error)
-            return error
+            except ConnectionRefusedError as e:
+                raise ControlPointConnectionRefusedError() from e
+            except TimeoutError as e:
+                raise ControlPointTimeoutError() from e
+            except socket.gaierror as e:
+                raise ControlPointCannotConnectError() from e
+        except socket.gaierror as e:
+            raise ControlPointInvalidHostError() from e
 
         api = ControlPoint(ControlPointDescription(host=host, port=port))
 
         try:
             await api.connect(fast=True)
-        except ControlPointError:
-            return {"error": ControlPointDiscoveryErrors.CANNOT_CONNECT}
+        except ControlPointError as e:
+            raise ControlPointCannotConnectError() from e
 
         self.validation_result = ControlPointDescription(
             brand=api.brand,

zcc_helper-3.4.dev5/zcc/errors.py

@@ -0,0 +1,16 @@
+'''ControlPoint error class'''
+
+
+class ControlPointError(Exception):
+    '''Represents a ZCC controller error.'''
+
+class ControlPointCannotConnectError(ControlPointError):
+    '''Represents a connect connect error when connecting to zcc.'''
+    
+class ControlPointInvalidHostError(ControlPointError):
+    '''Represents an invalid host error when connecting to zcc.'''
+class ControlPointConnectionRefusedError(ControlPointError):
+    '''Represents a connection refused when connecting to zcc.'''
+
+class ControlPointTimeoutError(ControlPointError):
+    '''Represents a connection timeout when connecting to zcc.'''

{zcc_helper-3.4.dev3 → zcc_helper-3.4.dev5/zcc_helper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zcc_helper
-Version: 3.4.dev3
+Version: 3.4.dev5
 Summary: ZIMI ZCC helper module
 Author: Mark Hannon
 Author-email: mark.hannon@gmail.com

zcc_helper-3.4.dev3/zcc/__init__.py

@@ -1,10 +0,0 @@
-'''ZCC Support Library to support ZIMI based home network elements'''
-import logging
-import sys
-
-from .controller import ControlPoint
-from .description import ControlPointDescription
-from .discovery import ControlPointDiscoveryService, ControlPointDiscoveryErrors
-from .errors import ControlPointError
-
-logging.basicConfig(stream=sys.stderr)

zcc_helper-3.4.dev3/zcc/errors.py

@@ -1,5 +0,0 @@
-'''ControlPoint error class'''
-
-
-class ControlPointError(Exception):
-    '''Represents a ZCC controller error.'''