Skip to content

Commit

Permalink
Add warning message on pickle usage #390 (#2426)
Browse files Browse the repository at this point in the history
* add warning in the pickle data node documentation

* More accurate message

* Update taipy/core/data/pickle.py

* formatting
  • Loading branch information
jrobinAV authored Jan 24, 2025
1 parent 23fc0fb commit 402881b
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions taipy/core/data/pickle.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ class PickleDataNode(DataNode, _FileDataNodeMixin):
data node.
- *default_data*: The default data of the data node. It is used at the data node instantiation
to write the data to the Pickle file.
??? warning "To use with pickle-able data only"
PickleDataNode should be used only for "pickle-able" data.
Everything that's build up (recursively) from basic python types (dicts, lists,
primitives, objects, object references, even circular) can usually be pickled by default.
Things that are usually not pickle-able are, for example, sockets, file(handler)s,
database connections, custom data structure using in-memory references to Python IDs,
and so on.
Please refer to the
[pickle documentation](https://docs.python.org/3/library/pickle.html) for more information.
"""

__STORAGE_TYPE = "pickle"
Expand Down

0 comments on commit 402881b

Please sign in to comment.