[gentoo-commits] proj/g-sorcery:master commit in: g_sorcery/

[Jauhien Piatlicki]

commit:     4adf87ffbc61204a90f309517351c872dc37aa44
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Thu Aug  1 12:39:12 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Thu Aug  1 12:39:12 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=4adf87ff

g_sorcery/serialization: Docstrings added

---
 g_sorcery/serialization.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/g_sorcery/serialization.py b/g_sorcery/serialization.py
index 28e29e5..e051596 100644
--- a/g_sorcery/serialization.py
+++ b/g_sorcery/serialization.py
@@ -16,7 +16,14 @@ import importlib
 
 
 class JSONSerializer(json.JSONEncoder):
+    """
+    Custom JSON encoder.
 
+    Each serializable class should have a method serialize
+    that returns JSON serializable value. If class addfitionally
+    has a classmethod deserialize that it can be deserialized
+    and additional metainformation is added to the resulting JSON.
+    """
     def default(self, obj):
         if hasattr(obj, "serialize"):
             if hasattr(obj, "deserialize"):
@@ -32,6 +39,13 @@ class JSONSerializer(json.JSONEncoder):
 
 
 def deserializeHook(json_object):
+    """
+    Custom JSON decoder.
+
+    Each class that can be deserialized should have classmethod deserialize
+    that takes value (previously returned by serialize method) and transforms
+    it into class instance.
+    """
     if "python_class" in json_object:
         module = importlib.import_module(json_object["python_module"])
         cls = getattr(module, json_object["python_class"])