aboutsummaryrefslogtreecommitdiff
path: root/devel/py-tblib/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'devel/py-tblib/pkg-descr')
-rw-r--r--devel/py-tblib/pkg-descr21
1 files changed, 16 insertions, 5 deletions
diff --git a/devel/py-tblib/pkg-descr b/devel/py-tblib/pkg-descr
index b2b23b7c681f..5d6a1ca95ad9 100644
--- a/devel/py-tblib/pkg-descr
+++ b/devel/py-tblib/pkg-descr
@@ -1,5 +1,16 @@
-Pickle tracebacks and raise exceptions with pickled tracebacks in
-different processes. This allows better error handling when running
-code over multiple processes (imagine multiprocessing, billiard,
-futures, celery etc).
-Parse traceback strings and raise with the parsed tracebacks.
+Serialization library for Exceptions and Tracebacks.
+
+It allows you to:
+- Pickle tracebacks and raise exceptions with pickled tracebacks in different
+ processes. This allows better error handling when running code over multiple
+ processes (imagine multiprocessing, billiard, futures, celery etc).
+- Create traceback objects from strings (the from_string method). No pickling is
+ used.
+- Serialize tracebacks to/from plain dicts (the from_dict and to_dict methods).
+ No pickling is used.
+- Raise the tracebacks created from the aforementioned sources.
+- Pickle an Exception together with its traceback and exception chain (raise ...
+ from ...) (Python 3 only)
+
+Again, note that using the pickle support is completely optional. You are solely
+responsible for security problems should you decide to use the pickle support.