Skip to content

Add pickle warning message to PackedPose class docstring. #519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add pickle warning message to PackedPose class docstring. #519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/src/python/PyRosetta/src/pyrosetta/distributed/packed_pose/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ class PackedPose:
for serialization as text.

It should be noted that all pickled representations are *highly* compressible.

**The pickle module is not secure.** Learn more `here <https://docs.python.org/3/library/pickle.html>`_. For the purposes of the PackedPose object, the serialized object only exists in memory (not as a file) so there is no security risk unless the object is sent to a user over a network (e.g., socket, queue, shared cache, etc.).
"""

__slots__ = ("scores", "pickled_pose")
Expand Down