owlmixin 1.0.0b6

Parsing mixin which converts ``data class instance``, ``dict object``, ``json string`` and ``yaml string`` each other.

Parsing mixin which converts data class instance, dict object, json string and yaml string each other.

Motivation

Have you ever wanted to write robust code in Python? This library will make such your wishes come true.

Define your data class which is extend OwlMixin, you can use some useful methods which help your codes robust. See following Example and API sections.

Example

You don’t need to use typing necessarily, but I recommend to use this to make your codes more robust. See PEP 484 – Type Hints.

from typing import Text, Optional
from owlmixin import OwlMixin

class Food(OwlMixin):
    def __init__(self, id, name, color=None):
        self.id = id  # type: Text
        self.name = name  # type: Text
        self.color = color  # type: Optional[Text]

class Human(OwlMixin):
    def __init__(self, id, name, favorite):
        self.id = id  # type: Text
        self.name = name  # type: Text
        self.favorite = Food.from_dict2list(favorite)  # type: TList[Food]

jiro = Human.from_dict({
    "id": 10,
    "name": "jiro",
    "favorite": [
        {"id": 1, "name": "apple"},
        {"id": 2, "name": "orange", "color": "white"}
    ]
})

>>> jiro.id
10
>>> jiro.name
'jiro'
>>> print(jiro.favorite[0].to_pretty_json())
{
    "color": null,
    "id": 1,
    "name": "apple"
}
>>> print(jiro.to_dict())
{'favorite': [{'color': None, 'id': 1, 'name': 'apple'}, {'color': 'white', 'id': 2, 'name': 'orange'}], 'id': 10, 'name': 'jiro'}
>>> print(jiro.to_dict(ignore_none=True))
{'favorite': [{'id': 1, 'name': 'apple'}, {'color': 'white', 'id': 2, 'name': 'orange'}], 'id': 10, 'name': 'jiro'}

API

From instance to another

• to_dict

  • instance => dict

  • TDict[instance] => dict

• to_dicts

  • TList[instance] => List[dict]

• to_json

  • instance => json string

• to_pretty_json

  • instance => json string (has indent and line break)

• to_yaml

  • instance => yaml string

From something to instance

• from_dict [1] [2]

  • dict => instance

• from_optional_dict [1] [2]

  • Optional[dict] => Optional[instance]

• from_dicts [1] [2]

  • dict => TList[instance]

• from_optional_dicts [1] [2]

  • Optional[dict] => Optional[instance]

• from_dicts_by_key [1] [2]

  • dict => TDict[instance]

• from_optional_dicts_by_key [1] [2]

  • Optional[dict] => Optional[instance]

• from_json [1] [2]

  • json string => instance

• from_json_url [1] [2]

  • url (which returns json) => instance

• from_yaml [1] [2]

  • yaml string or file => instance

• from_csv [1] [2] [3]

  • csv file => TList[instance]

[1] (1,2,3,4,5,6,7,8,9,10)

Keys are transformed to snake case in order to compliant PEP8. (set force_snake_case=False if you don’t want to do it.)

[2] (1,2,3,4,5,6,7,8,9,10)

Key self is transformed to _self in order to avoid duplicate.

[3]

You can specify any encodings

Installation

pip install owlmixin