griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix: PyDocs: bpy.ops document behavior on error reports

Browse Source 
When submitting #135854 I've assumed that `RuntimeError` is
connected particularly to `{'CANCELLED'}` return status. Turned
out error is raised regardless of what return status is and it's
only based on the presence of error reports during operator
execution. Submitting a clarification for this.

Pull Request: https://projects.blender.org/blender/blender/pulls/138558
This commit is contained in:
Andrej730
2025-05-08 06:58:34 +02:00
committed by Pratik Borhade
parent 63cdb7eae4
commit 670fc012e5
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/python_api/examples/bpy.ops.py
View File

@@ -16,7 +16,9 @@ saving an undo history entry.
If operator was cancelled but there wasn't any reports from it with ``{'ERROR'}`` type,
it will just return ``{'CANCELLED'}`` without raising any exceptions.
If it had error reports, then it will raise a ``RuntimeError`` including all report messages.
However, if there are error reports, a ``RuntimeError`` will be raised
after the operator finishes execution, including all error report messages,
regardless of the return status (even if it was ``{'FINISHED'}``).
Calling an operator in the wrong context will raise a ``RuntimeError``,
there is a poll() method to avoid this problem.