Skip to content

Commit 402881b

Browse files
authored
Add warning message on pickle usage #390 (#2426)
* add warning in the pickle data node documentation * More accurate message * Update taipy/core/data/pickle.py * formatting
1 parent 23fc0fb commit 402881b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

taipy/core/data/pickle.py

+14
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ class PickleDataNode(DataNode, _FileDataNodeMixin):
3131
data node.
3232
- *default_data*: The default data of the data node. It is used at the data node instantiation
3333
to write the data to the Pickle file.
34+
35+
??? warning "To use with pickle-able data only"
36+
PickleDataNode should be used only for "pickle-able" data.
37+
38+
Everything that's build up (recursively) from basic python types (dicts, lists,
39+
primitives, objects, object references, even circular) can usually be pickled by default.
40+
41+
Things that are usually not pickle-able are, for example, sockets, file(handler)s,
42+
database connections, custom data structure using in-memory references to Python IDs,
43+
and so on.
44+
45+
Please refer to the
46+
[pickle documentation](https://docs.python.org/3/library/pickle.html) for more information.
47+
3448
"""
3549

3650
__STORAGE_TYPE = "pickle"

0 commit comments

Comments
 (0)