Add inspect utils + tests

Author: mythz

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-    "python.pythonPath": "C:\\Python39\\python.exe"
+    "python.pythonPath": "c:\\src\\servicestack-python\\venv\\Scripts\\python.exe"
 }

servicestack/clients.py

@@ -196,26 +196,6 @@ def register_deserializer(cls: Type, deserializer: Callable[[Any], Any]):
 }
 
 
-def is_optional(cls: Type): return f"{cls}".startswith("typing.Optional")
-
-
-def is_list(cls: Type):
-    return cls == typing.List or cls == list or get_origin(cls) == list
-
-
-def is_dict(cls: Type):
-    return cls == typing.Dict or cls == dict or get_origin(cls) == dict
-
-
-def generic_arg(cls: Type): return generic_args(cls)[0]
-
-
-def generic_args(cls: Type):
-    if not hasattr(cls, '__args__'):
-        raise TypeError(f"{cls} is not a Generic Type")
-    return cls.__args__
-
-
 def _resolve_forwardref(cls: Type, orig: Type = None):
     type_name = cls.__forward_arg__
     if orig is not None and orig.__name__ == type_name:

servicestack/utils.py

@@ -1,7 +1,33 @@
 import base64
 import json
+import numbers
+import os
+import pathlib
+import platform
+import dataclasses
+import typing
 from datetime import datetime, timezone, timedelta
-from typing import Optional
+from typing import Optional, List, Dict, Any, Type, get_origin, Union, get_args
+from dataclasses import dataclass, field, asdict
+from functools import reduce
+
+
+def is_optional(cls: Type): return get_origin(cls) is Union and type(None) in get_args(cls)
+
+
+def is_list(cls: Type): return cls == typing.List or cls == list or get_origin(cls) == list
+
+
+def is_dict(cls: Type): return cls == typing.Dict or cls == dict or get_origin(cls) == dict
+
+
+def generic_args(cls: Type):
+    if not hasattr(cls, '__args__'):
+        raise TypeError(f"{cls} is not a Generic Type")
+    return cls.__args__
+
+
+def generic_arg(cls: Type): return generic_args(cls)[0]
 
 
 def index_of(target: str, needle: str):
@@ -220,3 +246,148 @@ def inspect_jwt(jwt: str):
     body = _decode_base64url_payload(left_part(right_part(jwt, '.'), '.'))
     exp = int(body['exp'])
     return head, body, datetime.fromtimestamp(exp, timezone.utc)
+
+
+# inspect utils
+def _asdict(obj):
+    if isinstance(obj, dict):
+        return obj
+    elif dataclasses.is_dataclass(obj):
+        return asdict(obj)
+    elif hasattr(obj, '__dict__'):
+        return obj.__dict__
+    else:
+        return obj
+
+
+def _asdicts(obj):
+    t = type(obj)
+    if is_list(t):
+        to = []
+        for o in obj:
+            to.append(_asdicts(o))
+        return to
+    elif is_dict(t):
+        to = {}
+        for k in obj:
+            to[k] = _asdicts(obj[k])
+        return to
+    else:
+        return _asdict(obj)
+
+
+def _allkeys(obj):
+    keys = []
+    for o in obj:
+        for key in o:
+            if not key in keys:
+                keys.append(key)
+    return keys
+
+
+def inspect_vars(objs):
+    if not isinstance(objs, dict):
+        raise TypeError('objs must be a dictionary')
+
+    to = _asdicts(objs)
+
+    inspect_vars_path = os.environ.get('INSPECT_VARS')
+    if inspect_vars_path is None:
+        return
+    if platform.system() == 'Windows':
+        inspect_vars_path = inspect_vars_path.replace("/", "\\")
+    else:
+        inspect_vars_path = inspect_vars_path.replace("\\", "/")
+
+    pathlib.Path(os.path.dirname(inspect_vars_path)).mkdir(parents=True, exist_ok=True)
+
+    with open(inspect_vars_path, 'w') as outfile:
+        json.dump(to, outfile)
+
+
+def dump(obj):
+    print(_asdicts(obj))
+    return json.dumps(_asdicts(obj), indent=4).replace('"', '').replace(': null', ':')
+
+
+def printdump(obj):
+    print(dump(obj))
+
+
+def _align_left(s: str, length: int, pad: str = ' '):
+    if length < 0:
+        return ""
+    alen = length + 1 - len(s)
+    if alen <= 0:
+        return s
+    return pad + s + (pad * (length + 1 - len(s)))
+
+
+def _align_center(s: str, length: int, pad: str = ' '):
+    if length < 0:
+        return ""
+    nlen = len(s)
+    half = (length // 2 - nlen // 2)
+    odds = abs((nlen % 2) - (length % 2))
+    return (pad * (half + 1)) + s + (pad * (half + 1 + odds))
+
+
+def _align_right(s: str, length: int, pad: str = ' '):
+    if length < 0:
+        return ""
+    alen = length + 1 - len(s)
+    if alen <= 0:
+        return s
+    return (pad * (length + 1 - len(s))) + s + pad
+
+
+def _align_auto(obj: Any, length: int, pad: str = ' '):
+    s = f"{obj}"
+    if len(s) <= length:
+        if isinstance(obj, numbers.Number):
+            return _align_right(s, length, pad)
+        return _align_left(s, length, pad)
+    return s
+
+
+def dumptable(objs, headers=None):
+    if not is_list(type(objs)):
+        raise TypeError('objs must be a list')
+    map_rows = _asdicts(objs)
+    if headers is None:
+        headers = _allkeys(map_rows)
+    col_sizes: Dict[str, int] = {}
+
+    for k in headers:
+        max = len(k)
+        for row in map_rows:
+            if k in row:
+                col = row[k]
+                val_size = len(f"{col}")
+                if val_size > max:
+                    max = val_size
+            col_sizes[k] = max
+
+    # sum + ' padding ' + |
+    row_width = reduce(lambda x, y: x + y, col_sizes.values(), 0) + \
+                (len(col_sizes) * 2) + \
+                (len(col_sizes) + 1)
+    sb: List[str] = [f"+{'-' * (row_width - 2)}+"]
+    head = "|"
+    for k in headers:
+        head += _align_center(k, col_sizes[k]) + "|"
+    sb.append(head)
+    sb.append(f"|{'-' * (row_width - 2)}|")
+
+    for row in map_rows:
+        to = "|"
+        for k in headers:
+            to += '' + _align_auto(row[k], col_sizes[k]) + "|"
+        sb.append(to)
+
+    sb.append(f"+{'-' * (row_width - 2)}+")
+    return '\n'.join(sb)
+
+
+def printdumptable(obj, headers=None):
+    print(dumptable(obj, headers))

tests/config.py

@@ -5,6 +5,7 @@
 TEST_URL = "http://test.servicestack.net"
 TECHSTACKS_URL = "https://techstacks.io"
 
+
 def create_test_client():
     return JsonServiceClient(TEST_URL)
 
@@ -15,4 +16,3 @@ def create_techstacks_client():
 
 def clear_session(client: JsonServiceClient):
     client.post(Authenticate(provider="logout"))
-

tests/dtos.py

@@ -1,8 +1,8 @@
 """ Options:
-Date: 2021-07-11 06:31:33
+Date: 2021-07-11 10:30:38
 Version: 5.111
 Tip: To override a DTO option, remove "//" prefix before updating
-BaseUrl: https://localhost:5001
+BaseUrl: https://test.servicestack.net
 
 #GlobalNamespace:
 #MakePropertiesOptional: False
@@ -166,9 +166,9 @@ class NestedClass:
 
 
 class EnumType(str, Enum):
-    VALUE1 = 'VALUE1'
-    VALUE2 = 'VALUE2'
-    VALUE3 = 'VALUE3'
+    VALUE1 = 'Value1'
+    VALUE2 = 'Value2'
+    VALUE3 = 'Value3'
 
 
 # @Flags()
@@ -200,12 +200,12 @@ class EnumAsInt(Enum):
 
 
 class EnumStyle(str, Enum):
-    LOWER = 'LOWER'
+    LOWER = 'lower'
     UPPER = 'UPPER'
-    PASCAL_CASE = 'PASCAL_CASE'
-    CAMEL_CASE = 'CAMEL_CASE'
-    CAMEL_U_P_P_E_R = 'CAMEL_U_P_P_E_R'
-    PASCAL_U_P_P_E_R = 'PASCAL_U_P_P_E_R'
+    PASCAL_CASE = 'PascalCase'
+    CAMEL_CASE = 'camelCase'
+    CAMEL_U_P_P_E_R = 'camelUPPER'
+    PASCAL_U_P_P_E_R = 'PascalUPPER'
 
 
 class EnumStyleMembers(str, Enum):
@@ -286,13 +286,13 @@ class EmptyClass:
 
 
 class DayOfWeek(str, Enum):
-    SUNDAY = 'SUNDAY'
-    MONDAY = 'MONDAY'
-    TUESDAY = 'TUESDAY'
-    WEDNESDAY = 'WEDNESDAY'
-    THURSDAY = 'THURSDAY'
-    FRIDAY = 'FRIDAY'
-    SATURDAY = 'SATURDAY'
+    SUNDAY = 'Sunday'
+    MONDAY = 'Monday'
+    TUESDAY = 'Tuesday'
+    WEDNESDAY = 'Wednesday'
+    THURSDAY = 'Thursday'
+    FRIDAY = 'Friday'
+    SATURDAY = 'Saturday'
 
 
 class ScopeType(Enum):
@@ -349,8 +349,8 @@ class QueryDbTenant(Generic[From, Into], QueryDb2[From, Into]):
 
 
 class LivingStatus(str, Enum):
-    ALIVE = 'ALIVE'
-    DEAD = 'DEAD'
+    ALIVE = 'Alive'
+    DEAD = 'Dead'
 
 
 @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@@ -589,9 +589,9 @@ class InnerType:
 
 
 class InnerEnum(str, Enum):
-    FOO = 'FOO'
-    BAR = 'BAR'
-    BAZ = 'BAZ'
+    FOO = 'Foo'
+    BAR = 'Bar'
+    BAZ = 'Baz'
 
 
 @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@@ -1198,7 +1198,6 @@ class DeclarativeCollectiveValidationTest(IReturn[EmptyResponse]):
     site: Optional[str] = None
 
     declarative_validations: Optional[List[DeclarativeChildValidation]] = None
-
     fluent_validations: Optional[List[FluentChildValidation]] = None
 
 
@@ -1210,7 +1209,6 @@ class DeclarativeSingleValidationTest(IReturn[EmptyResponse]):
     site: Optional[str] = None
 
     declarative_single_validation: Optional[DeclarativeSingleValidation] = None
-
     fluent_single_validation: Optional[FluentSingleValidation] = None