From 1230d1edcf09fa825985c204b115241141332a91 Mon Sep 17 00:00:00 2001 From: Brian Potchik Date: Thu, 9 Feb 2023 13:13:34 -0500 Subject: Update documentation to warn about creating databases in the context of analysis callbacks. --- python/binaryview.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'python/binaryview.py') diff --git a/python/binaryview.py b/python/binaryview.py index 013cf984..8005630b 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -3317,6 +3317,8 @@ class BinaryView: :return: True on success, False on failure :rtype: bool + .. warning:: The calling thread must not hold a lock on the BinaryView instance as this action is run on the main thread which requires the lock. + :Example: >>> settings = SaveSettings() >>> bv.create_database(f"{bv.file.filename}.bndb", None, settings) @@ -6300,6 +6302,7 @@ class BinaryView: The callee of this function is not responsible for maintaining the lifetime of the returned AnalysisCompletionEvent object. + .. note:: The lock held by the callback thread on the BinaryView instance ensures that other BinaryView actions can be safely performed in the callback thread. .. warning:: The built-in python console automatically updates analysis after every command is run, which means this call back may not behave as expected if entered interactively. :param callback callback: A function to be called with no parameters when analysis has completed. -- cgit v1.3.1