diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2024-01-04 18:16:28 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2024-01-04 18:16:28 -0500 |
| commit | 9d16a5c960bc941846a65e504b1065eb68dcb85a (patch) | |
| tree | c6be85162cc3e74bcbef766aa0d6eadb7090108c /python | |
| parent | e27a7226a23f0276360542a69570e58b0edc9747 (diff) | |
add warning for session_data being ephemeral to docs
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 8d72d94e..d2ef315f 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -2388,7 +2388,7 @@ class BinaryView: @staticmethod def set_default_session_data(name: str, value: str) -> None: """ - ``set_default_session_data`` saves a variable to the BinaryView. + ``set_default_session_data`` saves a variable to the BinaryView. Session data is ephemeral not saved to a database. Consider using :py:func:`store_metadata` if permanence is needed. :param str name: name of the variable to be saved :param str value: value of the variable to be saved @@ -2873,7 +2873,7 @@ class BinaryView: @property def session_data(self): # TODO add type hint - """Dictionary object where plugins can store arbitrary data associated with the view""" + """Dictionary object where plugins can store arbitrary data associated with the view. This data is ephemeral and not saved to a database. Consider using :py:func:`store_metadata` if permanence is needed.""" handle = ctypes.cast(self.handle, ctypes.c_void_p) if handle.value not in BinaryView._associated_data: obj = _BinaryViewAssociatedDataStore() |
