Standardized way of registering custom JSON serializers/deserializers.
Project description
JSON Handler Registry
Standardized way of registering custom JSON serializers/deserializers.
Package json
lacks standard approach to registering custom JSON handlers.
Project json-handler-registry
has been created to solve that issue.
Usage:
Registering your own handlers:
from typing import Optional
from json_handler_registry.registry import JsonHandlerRegistry
from json_handler_registry.encoder import IJsonEncoder, EncodingResult
from json_handler_registry.decoder import IJsonDecoder
# Enable registry:
JsonHandlerRegistry.enable()
# Implement your custom class encoder:
class MyJsonEncoder(IJsonEncoder):
def encodeObject(self, obj: object) -> Optional[EncodingResult]:
"""Convert object to a JSON serializable data.
Or return ``None`` instead.
"""
pass # TODO: Actual implementation goes here!
# Implement your custom class decoder:
class MyJsonDecoder(IJsonDecoder):
def decodeDict(self, dct: dict) -> Optional[object]:
"""Convert dictionary to your type instance.
Or return ``None`` instead.
"""
pass # TODO: Actual implementation goes here!
def decodeStr(self, valueStr: str) -> Optional[object]:
"""Convert string value to your type instance.
Or return ``None`` instead.
"""
pass # TODO: Actual implementation goes here!
# Register your serializer and deserializer:
JsonHandlerRegistry.registerEncoder(MyJsonEncoder())
JsonHandlerRegistry.registerDecoder(MyJsonDecoder())
Serialization & deserialization:
# Using `tunit` package as an example:
import json
from tunit.config import TUnitConfig
from tunit.unit import Seconds
TUnitConfig.registerJsonHandler() # Enables registry and registers handlers.
# JSON serialization:
messageDto = {"delay": Seconds(10)}
messageJson = json.dumps(messageDto)
print(messageJson) # Prints: '{"delay": "10s"}'
# JSON deserialization:
messageJson = '{"delay": "10s"}'
messageDto = json.loads(messageJson)
print(messageDto) # Prints: {'delay': Seconds(10)}
Changelog:
- Version: 1.2.0
- Guard to prevent registry from being easily overridden when enabled.
- Version: 1.1.0
- Registry accepts both type and instance of encoder/decoder.
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for json-handler-registry-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f28a2bc7be35626809d3f9fe776b8ebc0a6565c92dbdccc31d99669f4e93051 |
|
MD5 | a7a3821abfa52d3e53cbe7532baf1d45 |
|
BLAKE2b-256 | 2469def2fe6debf3792d21861ac43fd2b57e0d30846f35c37b90fa2cf46b5f5f |