aboutsummaryrefslogtreecommitdiffstats
path: root/fatcat_scholar/api_entities.py
blob: 0664718c62278a24263862ed9db0ed18eefbb418 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import collections
import json
from typing import Any, Optional

from fatcat_openapi_client import ApiClient

_global_serde_api_client = ApiClient()


def entity_to_dict(entity: Any, api_client: Optional[ApiClient] = 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 = _global_serde_api_client
    return api_client.sanitize_for_serialization(entity)


def entity_from_json(
    json_str: str, entity_type: Any, api_client: Optional[ApiClient] = None
) -> Any:
    """
    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 = _global_serde_api_client
    thing = collections.namedtuple("thing", ["data"])
    thing.data = json_str
    return api_client.deserialize(thing, entity_type)


def entity_from_dict(
    obj: dict, entity_type: Any, api_client: Optional[ApiClient] = None
) -> Any:
    json_str = json.dumps(obj)
    return entity_from_json(json_str, entity_type, api_client=api_client)