Confused about undictify

[shawalli]

Thanks for the information! I'll give that a try.

[Dobiasd]

Hi shawalli,

thanks for the feedback and sorry for the inconvenience.

In version 0.1.x it was:

my_thing = undictify.unpack_json(Thing, json_str)`

Now with version 0.2.x it is

my_thing = undictify.type_checked_apply(Thing, **json.loads(json_str))

I realized that unpacking JSON is just one specific use-case of a more general problem this library can solve, and I tried to reflect that.

Luckily the change needed on client side (see above) is quite small. And since the library has not yet reached version 1.x, I was hoping such a change would be acceptable. 🙂

If you still want a function named unpack_json, that you can use like my_thing = unpack_json(Thing, json_str) (and that has the optional convert_types flag), you can create it like this:

TypeT = TypeVar('TypeT')


def unpack_json(target_func: Callable[..., TypeT],
                object_repr: str, convert_types: bool = False) -> TypeT:
    if convert_types:
        return type_checked_apply_skip_convert(target_func,
                                               **json.loads(object_repr))
    return type_checked_apply_skip(target_func,
                                   **json.loads(object_repr))

I also just added it to examples/readme_examples.py.

However I'd like to encourage you to also try the new version, which is adding the @type_checked_call_skip decorator to your target class and unpacking you JSON like this:

my_thing = Thing(**json.loads(json_str))