Model Serialization / JSON

All choo models can be (un)serialized to/from a JSON-encodable format.

In Python

from models import Stop, Location, Serializable
# Create a Stop
stop = Stop(city='Essen', name='Hauptbahnhof')

# serialization
serialized = stop.serialize()

# unserialize
stop = Stop.unserialize(serialized)
stop = Location.serialize(serialized)  # same result
stop = Serializable.serialize(serialized)  # same result

# this will fail because Stop is not a submodel of Ride
stop = Ride.serialize(serialized)

How it works

Caution

Some models have a additional attributes in their dictionary representation. See the Model Reference for more information.

The Type of the Model and all of its public attributes that are not dynamic and not None are put into a dictionary. All values are serialized.

datetime values are respresented as a string in YYYY-MM-DD HH:II:SS format.

timedelta values are respresented as a the total number of seconds as int.

{
    "type": "Stop",
    "id": 20009289,
    "source": "vrr",
    "lat": 51.451137,
    "lon": 7.012941,
    "country": "de",
    "city": "Essen",
    "name": "Hauptbahnhof"
}