add docs for pickle

HISTORY.rst

@@ -7,6 +7,7 @@ v0.3.0 (TBC)
 ............
 * immutable models via ``config.allow_mutation = False``, associated cleanup and performance improvement #44
 * immutable helper methods ``construct()`` and ``copy()`` #53
+* allow pickling of models #53
 * ``setattr`` is removed as ``__setattr__`` is now intelligent #44
 * ``raise_exception`` removed, Models now always raise exceptions #44
 * instance method validators removed TODO

docs/examples/ex_pickle.py

@@ -0,0 +1,20 @@
+import pickle
+from pydantic import BaseModel
+
+
+class FooBarModel(BaseModel):
+    a: str
+    b: int
+
+
+m = FooBarModel(a='hello', b=123)
+print(m)
+# > FooBarModel a='hello' b=123
+
+data = pickle.dumps(m)
+print(data)
+# > b'\x80\x03c...'
+
+m2 = pickle.loads(data)
+print(m2)
+# > FooBarModel a='hello' b=123

docs/index.rst

@@ -231,6 +231,13 @@ is duplicated.
 
 .. literalinclude:: examples/copy_values.py
 
+Pickle
+......
+
+Using the same plumbing as ``copy()`` pydantic models support efficient pickling and unpicking.
+
+.. literalinclude:: examples/ex_pickle.py
+
 .. include:: ../HISTORY.rst
 
 

docs/spelling_wordlist.txt

@@ -5,6 +5,8 @@ config
 doesn
 dicts
 django
+faux
+Faux
 ints
 jsonmodels
 pydantic