matching stub

1 files changed, 55 insertions, 0 deletions

diff --git a/fuzzycat/entities.py b/fuzzycat/entities.py
new file mode 100644
index 0000000..0b9ebc3
--- /dev/null
+++ b/fuzzycat/entities.py
@@ -0,0 +1,55 @@
+import collections
+import json
+
+import toml
+from fatcat_openapi_client import ApiClient
+
+
+def entity_to_dict(entity, api_client=None) -> dict:
+    """
+    Hack to take advantage of the code-generated serialization code.
+
+    Initializing/destroying ApiClient objects is surprisingly expensive
+    (because it involves a threadpool), so we allow passing an existing
+    instance. If you already have a full-on API connection `api`, you can
+    access the ApiClient object as `api.api_client`. This is such a speed-up
+    that this argument may become mandatory.
+    """
+    if not api_client:
+        api_client = ApiClient()
+    return api_client.sanitize_for_serialization(entity)
+
+
+def entity_from_json(json_str: str, entity_type, api_client=None):
+    """
+    Hack to take advantage of the code-generated deserialization code
+
+    See note on `entity_to_dict()` about api_client argument.
+    """
+    if not api_client:
+        api_client = ApiClient()
+    thing = collections.namedtuple('Thing', ['data'])
+    thing.data = json_str
+    return api_client.deserialize(thing, entity_type)
+
+
+def entity_from_dict(obj: dict, entity_type, api_client=None):
+    json_str = json.dumps(obj)
+    return entity_from_json(json_str, entity_type, api_client=api_client)
+
+
+def entity_to_toml(entity, api_client=None, pop_fields=None) -> str:
+    """
+    pop_fields parameter can be used to strip out some fields from the resulting
+    TOML. Eg, for fields which should not be edited, like the ident.
+    """
+    obj = entity_to_dict(entity, api_client=api_client)
+    pop_fields = pop_fields or []
+    for k in pop_fields:
+        obj.pop(k, None)
+    return toml.dumps(obj)
+
+
+def entity_from_toml(toml_str: str, entity_type, api_client=None):
+    obj = toml.loads(toml_str)
+    return entity_from_dict(obj, entity_type, api_client=api_client)