earthengine-api/python/ee/encodable.py
2013-05-22 15:03:30 -07:00

23 lines
596 B
Python

"""An interface implemented by serializable objects."""
# Using lowercase function naming to match the JavaScript names.
# pylint: disable-msg=g-bad-name
class Encodable(object):
"""An interface implemented by objects that can serialize themselves."""
def encode(self, encoder):
"""Encodes the object in a format compatible with Serializer.
Args:
encoder: A function that can be called to encode the components of
an object.
Returns:
The encoded form of the object.
"""
raise NotImplementedError('Encodable classes must implement encode().')