avro-object-furlan 0.9.1

Description:

avroobjectfurlan 0.9.1

AvroObject’s documentation!

Links

GitHub AvroObject
PyPi avro-object-furlan

Examples

Basic Serialization
Schema Serialization
Basic Deserialization
Schema Deserialization

AvroObject
class avro_object.AvroObject(data, schema=None)
Helper class for AVRO objects


Parameters


data (JSON as string*, Dict object, Filename/URL as string with JSON content, *Avro as bytes with binary serialized content) – (un)serialized data


schema (JSON as string*, Dict object, *Filename/URL as string with JSON content) – Avro schema




property data()


Returns
Native unserialized data


Return type
dict


property json()


Returns
JSON serialized data


Return type
str


property last_error()


Returns
Last error message


Return type
str


property ok()


Returns
Avro Object successfull creation


Return type
bool


property origin()


Returns
Source of data (str, file, URL, Avro binary)


Return type
str


property schema_origin()


Returns
Source of schema (str, file, URL)


Return type
str


to_avro()


Returns
AVRO bytes serialized data (when schema is informed)


Return type
bytes


to_json()


Returns
JSON serialized data


Return type
str


AvroTools
class avro_object.AvroTools()
Tools for AvroObject
classmethod add_fetch_method(method)
Add custom fetch method


Parameters
method – (str source) -> (bool Success, str JSON/Error, str origin name)


Returns
Success


Return type
bool


static create_schema(data: dict, name: str, namespace: str = 'namespace.test', doc: str = None)
Create schema from object (incomplete)


Parameters


data – source object


name – Name of schema


namespace – Namespace of schema


doc – Documentation




Returns
Schema


Return type
dict


classmethod fetch_json(source: str)
Load JSON string from various medium and returns as string


Parameters
source – string JSON, file name, URL, another registered source by add_fetch_method


Return type
tuple (bool Success, str JSON or error message, origin)


static fetch_json_file(source: str)
Try to parse json from file


Parameters
source – str with file name


Returns
(bool Success, str JSON or Error, origin)


static fetch_json_url(source: str)
Try to parse json from url


Parameters
source – str with URL


Returns
(bool Success, str JSON or Error, origin)


classmethod reset_fetch_methods()
Resets default fetch methods (File, URL and string)
Author
©2019, Guionardo Furlan
https://github.com/guionardo