fix: event watch has reliable json output

Why:

 * event watch is dumping Dict rather than json
 * event watch is not honoring output formats

This change addreses the need by:

 * add callback mechanism for websocket calls
 * used usual formatter for every message
   Means event watch dumps 1 table per msg.
   Recommended to use --no-headers
 * Made formatting just dump one item when output
   is not actually a list.
 * Only print `event` messages

Author: maxandersen

homeassistant_cli/const.py

@@ -13,7 +13,7 @@
 
 DEFAULT_DATAOUTPUT = 'yaml'
 
-COLUMNS_DEFAULT = [('ALL', '*')]
+COLUMNS_DEFAULT = [('ALL', '$')]
 COLUMNS_ENTITIES = [
     ('ENTITY', 'entity_id'),
     ('DESCRIPTION', 'attributes.friendly_name'),

homeassistant_cli/helper.py

@@ -4,7 +4,7 @@
 import json
 import logging
 import shlex
-from typing import Any, Dict, Generator, List, Optional, Tuple, cast
+from typing import Any, Dict, Generator, List, Optional, Tuple, Union, cast
 
 from homeassistant_cli.config import Configuration
 import homeassistant_cli.const as const
@@ -47,7 +47,7 @@ def to_tuples(entry: str) -> List[Tuple[str, str]]:
 
 def raw_format_output(
     output: str,
-    data: List[Dict[str, Any]],
+    data: Union[Dict[str, Any], List[Dict[str, Any]]],
     yamlparser: YAML,
     columns: Optional[List] = None,
     no_headers: bool = False,
@@ -59,7 +59,7 @@ def raw_format_output(
         _LOGGING.debug("Output `auto` thus using %s", const.DEFAULT_DATAOUTPUT)
         output = const.DEFAULT_DATAOUTPUT
 
-    if sort_by:
+    if sort_by and isinstance(data, List):
         _sort_table(data, sort_by)
 
     if output == 'json':
@@ -79,17 +79,24 @@ def raw_format_output(
             columns = const.COLUMNS_DEFAULT
 
         fmt = [(v[0], parse(v[1] if len(v) > 1 else v[0])) for v in columns]
+
         result = []
+
         if no_headers:
             headers = []  # type: List[str]
         else:
             headers = [v[0] for v in fmt]
+
+        # in case data passed in is a single element
+        # we turn it into a single item list for better table output
+        if not isinstance(data, List):
+            data = [data]
+
         for item in data:
             row = []
             for fmtpair in fmt:
                 val = [match.value for match in fmtpair[1].find(item)]
                 row.append(", ".join(map(str, val)))
-
             result.append(row)
 
         res = tabulate(

homeassistant_cli/plugins/event.py

@@ -1,12 +1,13 @@
 """Event plugin for Home Assistant CLI (hass-cli)."""
 import json as json_
 import logging
+from typing import Dict
 
 import click
 import homeassistant_cli.autocompletion as autocompletion
 from homeassistant_cli.cli import pass_context
 from homeassistant_cli.config import Configuration
-from homeassistant_cli.helper import raw_format_output
+from homeassistant_cli.helper import format_output, raw_format_output
 import homeassistant_cli.remote as api
 
 _LOGGING = logging.getLogger(__name__)
@@ -63,7 +64,19 @@ def watch(ctx: Configuration, event_type):
     """
     frame = {'type': 'subscribe_events'}
 
+    cols = [('EVENT_TYPE', 'event_type'), ('DATA', '$.data')]
+
+    def _msghandler(msg: Dict) -> None:
+        if msg['type'] == 'event':
+            ctx.echo(
+                format_output(
+                    ctx,
+                    msg['event'],
+                    columns=ctx.columns if ctx.columns else cols,
+                )
+            )
+
     if event_type:
         frame['event_type'] = event_type
 
-    api.wsapi(ctx, frame, True)
+    api.wsapi(ctx, frame, _msghandler)

homeassistant_cli/remote.py

@@ -10,7 +10,7 @@
 import enum
 import json
 import logging
-from typing import Any, Dict, List, Optional, cast
+from typing import Any, Callable, Dict, List, Optional, cast
 import urllib.parse
 from urllib.parse import urlencode
 
@@ -88,9 +88,17 @@ def restapi(
 
 
 def wsapi(
-    ctx: Configuration, frame: Dict, wait: bool = False
+    ctx: Configuration,
+    frame: Dict,
+    callback: Optional[Callable[[Dict], Any]] = None,
 ) -> Optional[Dict]:
-    """Make a call to Home Assistant using WS API."""
+    """Make a call to Home Assistant using WS API.
+
+    if callback provided will keep listening and call
+    on every message.
+
+    If no callback return data returned.
+    """
     loop = asyncio.get_event_loop()
 
     async def fetcher() -> Optional[Dict]:
@@ -116,8 +124,8 @@ async def fetcher() -> Optional[Dict]:
                     elif msg.type == aiohttp.WSMsgType.TEXT:
                         mydata = json.loads(msg.data)  # type: Dict
 
-                        if wait:
-                            print(mydata)
+                        if callback:
+                            callback(mydata)
                         elif mydata['type'] == 'result':
                             return mydata
         return None