add htmldump apis

Author: mythz

servicestack/__init__.py

@@ -68,13 +68,16 @@
     'is_optional',
     'is_list',
     'is_dict',
+    'is_builtin',
     'generic_args',
     'generic_arg',
     'inspect_vars',
     'dump',
     'printdump',
-     'table',
+    'table',
     'printtable',
+    'htmldump',
+    'printhtmldump',
     'lowercase',
     'uppercase',
     'snakecase',
@@ -120,8 +123,8 @@
     qsvalue, resolve_httpmethod
 
 from .reflection import TypeConverters, to_json, from_json, all_keys, to_dict, convert, is_optional, \
-    is_list, is_dict, generic_args, generic_arg, inspect_vars, dump, printdump, table, \
-    printtable
+    is_list, is_dict, is_builtin, generic_args, generic_arg, inspect_vars, dump, printdump, table, \
+    printtable, htmldump, printhtmldump
 
 from .utils import \
     lowercase, uppercase, snakecase, camelcase, capitalcase, pascalcase, titlecase, clean_camelcase, \

servicestack/clients.py

@@ -310,7 +310,7 @@ def send_url(self, path: str, method: str = None, response_as: Type = None, body
 
         return self.send_request(info)
 
-    def send(self, request, method="POST", body: Any = None, args: Dict[str, Any] = None):
+    def send(self, request, method: Any = None, body: Any = None, args: Dict[str, Any] = None):
         if not isinstance(request, IReturn) and not isinstance(request, IReturnVoid):
             raise TypeError(f"'{nameof(request)}' does not implement IReturn or IReturnVoid")
 

servicestack/reflection.py

@@ -1,4 +1,5 @@
 import base64
+import collections
 import decimal
 import inspect
 import json
@@ -91,9 +92,16 @@ def identity(x: Any): return x
 _BUILT_IN_TYPES = {str, bool, int, float, decimal.Decimal, datetime, timedelta, bytes, bytearray, complex}
 
 
+def is_builtin(t: Type):
+    try:
+        return t in _BUILT_IN_TYPES or issubclass(t, Enum)
+    except Exception as e:  # throws if t is not hashable
+        return False
+
+
 def to_dict(obj: Any, key_case: Callable[[str], str] = identity, remove_empty: bool = True):
     t = type(obj)
-    if obj is None or t in _BUILT_IN_TYPES or issubclass(t, Enum):
+    if obj is None or is_builtin(t):
         return obj
     if is_list(t):
         to = []
@@ -157,7 +165,7 @@ def _json_encoder(obj: Any):
         return float(obj)
     if t in _JSON_TYPES:
         return obj
-    if t in _BUILT_IN_TYPES or (type(obj) == type and issubclass(obj, Enum)):
+    if is_builtin(t):
         return _str(obj)
     raise TypeError(f"Unsupported Type in JSON encoding: {t}")
 
@@ -363,7 +371,11 @@ def from_json(into: Type, json_str: str):
 # inspect utils
 def all_keys(obj):
     keys = []
+    if not isinstance(obj, collections.Iterable):
+        return keys
     for o in obj:
+        if is_builtin(type(o)):
+            continue
         for key in o:
             key = _str(key)
             if key is not None and key not in keys:
@@ -477,3 +489,54 @@ def table(objs, headers=None):
 
 def printtable(obj, headers=None):
     print(table(obj, headers))
+
+def htmllist(d: dict):
+    sb: List[str] = ["<table><tbody>"]
+    for k, v in d.items():
+        sb.append(f"<tr><th>{_str(k)}</th><td>{_str(v)}</td></tr>")
+    sb.append("</tbody></table>")
+    return ''.join(sb)
+
+def htmldump(objs, headers=None):
+    map_rows = to_dict(objs)
+    t = type(map_rows)
+    if is_builtin(t):
+        return _str(map_rows)
+    if is_dict(t):
+        return htmllist(map_rows)
+
+    if headers is None:
+        headers = all_keys(map_rows)
+
+    # print(headers, map_rows)
+
+    sb: List[str] = ["<table>"]
+    row = ["<thead><tr>"]
+    for k in headers:
+        row.append(f"<th>{k}</th>")
+    row.append("</tr></head>")
+    if len(row) > 2:
+        sb.append(''.join(row))
+    sb.append("<tbody>")
+
+    rows = []
+    for item in map_rows:
+        rows.append("<tr>")
+        if len(headers) > 0:
+            row = []
+            for k in headers:
+                val = item[k] if k in item else ""
+                row.append(f"<td>{val}</td>")
+            rows.append(''.join(row))
+        else:
+            rows.append(f"<td>{item}</td>")
+        rows.append("</tr>")
+
+    sb.append(''.join(rows))
+    sb.append("</tbody>")
+    sb.append("</table>")
+    return '\n'.join(sb)
+
+
+def printhtmldump(obj, headers=None):
+    print(htmldump(obj, headers))

tests/test_client_utils.py

@@ -2,10 +2,27 @@
 """
 
 import unittest
+import re
 from .dtos import *
 from servicestack import to_json, qsvalue, resolve_httpmethod
 
 
+@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
+@dataclass
+class GetLocationsResponse:
+    locations: Optional[List[str]] = None
+
+
+# @Route("/locations")
+@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
+@dataclass
+class GetLocations(IReturn[GetLocationsResponse], IGet):
+    pass
+
+
+def sanitize_html(s: str): return re.sub(r"\s", "", s)
+
+
 class ClientUtils(unittest.TestCase):
 
     def test_json_encode(self):
@@ -27,3 +44,20 @@ def test_does_resolve_IVerbs_from_request_DTO_interface_marker(self):
         self.assertEqual(resolve_httpmethod(SendGet()), "GET")
         self.assertEqual(resolve_httpmethod(SendPost()), "POST")
         self.assertEqual(resolve_httpmethod(SendPut()), "PUT")
+        self.assertEqual(resolve_httpmethod(GetLocations()), "GET")
+
+    def test_can_htmldump_different_types(self):
+        self.assertEqual(htmldump(1), "1")
+        self.assertEqual(htmldump("A"), "A")
+        self.assertEqual(htmldump({"A": 1, "B": 2}),
+                         "<table><tbody><tr><th>A</th><td>1</td></tr><tr><th>B</th><td>2</td></tr></tbody></table>")
+        self.assertEqual(sanitize_html(htmldump(["A", 1])),
+                         "<table><tbody><tr><td>A</td></tr><tr><td>1</td></tr></tbody></table>")
+        self.assertEqual(sanitize_html(htmldump([{"A": 1, "B": 2}, {"A": 3, "B": 4}])),
+                         "<table><thead><tr><th>A</th><th>B</th></tr></head><tbody><tr><td>1</td><td>2</td></tr><tr><td>3</td><td>4</td></tr></tbody></table>")
+
+    def test_can_send_GetLocations(self):
+        client = JsonServiceClient("https://covid-vac-watch.netcore.io")
+        response = client.send(GetLocations())
+        printdump(response)
+        printhtmldump(response.locations)

tests/test_inspect.py

@@ -49,4 +49,5 @@ def test_does_support_FindTechnologies(self):
         printtable(response.results)
         printtable(response.results, headers=['id', 'name', 'vendor_name', 'view_count', 'fav_count'])
         printtable(to_dict(response.results, key_case=titlecase))
+        printhtmldump(response.results)
         inspect_vars({"response": response})