fake-bpy-module 20241111__py3-none-any.whl → 20241112__py3-none-any.whl

bpy/types/__init__.pyi

@@ -80869,11 +80869,7 @@ The function should return {'FINISHED'}
 
 , the latter
 meaning that operator execution was aborted without making any changes, and
-saving an undo entry isn't neccesary. If an error is detected after some changes
-have already been made, use the {'FINISHED'}
-
- return code, or the behavior
-of undo will be confusing for the user.
+that no undo step will created (see next example for more info about undo).
 
 [NOTE]
 Operator subclasses must be registered before accessing them from blender.
@@ -80881,6 +80877,52 @@ Operator subclasses must be registered before accessing them from blender.
 ```../examples/bpy.types.Operator.py```
 
 
+--------------------
+
+Any operator modifying Blender data should enable the 'UNDO'
+
+ option.
+This will make Blender automatically create an undo step when the operator
+finishes its execute
+
+ (or invoke
+
+, see below) functions, and returns
+{'FINISHED'}
+
+.
+
+Otherwise, no undo step will be created, which will at best corrupt the
+undo stack and confuse the user (since modifications done by the operator
+may either not be undoable, or be undone together with other edits done
+before). In many cases, this can even lead to data corruption and crashes.
+
+Note that when an operator returns {'CANCELLED'}
+
+, no undo step will be
+created. This means that if an error occurs *after* modifying some data
+already, it is better to return {'FINISHED'}
+
+, unless it is possible to
+fully undo the changes before returning.
+
+[NOTE]
+Most examples in this page do not do any edit to Blender data, which is
+why it is safe to keep the default bl_options
+
+ value for these operators.
+
+[NOTE]
+In some complex cases, the automatic undo step created on operator exit may
+not be enough. For example, if the operator does mode switching, or calls
+other operators that should create an extra undo step, etc.
+Such manual undo push is possible using the bpy.ops.ed.undo_push
+function. Be careful though, this is considered an advanced feature and
+requires some understanding of the actual undo system in Blender code.
+
+```../examples/bpy.types.Operator.1.py```
+
+
 --------------------
 
 Operator.invoke is used to initialize the operator from the context
@@ -80899,7 +80941,7 @@ to typical class properties because blender registers them with the
 operator, to use as arguments when called, saved for operator undo/redo and
 automatically added into the user interface.
 
-```../examples/bpy.types.Operator.1.py```
+```../examples/bpy.types.Operator.2.py```
 
 
 --------------------
@@ -80918,14 +80960,14 @@ user confirms.
 The Operator.poll function is optional, used to check if the operator
 can run.
 
-```../examples/bpy.types.Operator.2.py```
+```../examples/bpy.types.Operator.3.py```
 
 
 --------------------
 
 This operator uses its Operator.invoke function to call a popup.
 
-```../examples/bpy.types.Operator.3.py```
+```../examples/bpy.types.Operator.4.py```
 
 
 --------------------
@@ -80937,7 +80979,7 @@ Operator.draw function.
 This works like the Panel and Menu draw functions, its used
 for dialogs and file selectors.
 
-```../examples/bpy.types.Operator.4.py```
+```../examples/bpy.types.Operator.5.py```
 
 
 --------------------
@@ -80968,7 +81010,7 @@ Notice __init__()
 For other operator types they are not useful but for modal operators they will
 be called before the Operator.invoke and after the operator finishes.
 
-```../examples/bpy.types.Operator.5.py```
+```../examples/bpy.types.Operator.6.py```
 
 
 --------------------
@@ -80976,7 +81018,7 @@ be called before the Operator.invoke and after the operator finishes.
 You may want to have an operator prompt the user to select an item
 from a search field, this can be done using bpy.types.Operator.invoke_search_popup.
 
-```../examples/bpy.types.Operator.6.py```
+```../examples/bpy.types.Operator.7.py```
 
 
 --------------------

bpy/typing/__init__.pyi

@@ -2425,7 +2425,7 @@ type OperatorReturnItems = typing.Literal[
 ]
 type OperatorTypeFlagItems = typing.Literal[
     "REGISTER",  # Register.Display in the info window and support the redo toolbar panel.
-    "UNDO",  # Undo.Push an undo event (needed for operator redo).
+    "UNDO",  # Undo.Push an undo event when the operator returns `FINISHED` (needed for operator redo, mandatory if the operator modifies Blender data).
     "UNDO_GROUPED",  # Grouped Undo.Push a single undo event for repeated instances of this operator.
     "BLOCKING",  # Blocking.Block anything else from using the cursor.
     "MACRO",  # Macro.Use to check if an operator is a macro.

{fake_bpy_module-20241111.dist-info → fake_bpy_module-20241112.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fake-bpy-module
-Version: 20241111
+Version: 20241112
 Summary: Collection of the fake Blender Python API module for the code completion.
 Author: nutti
 Author-email: nutti.metro@gmail.com

{fake_bpy_module-20241111.dist-info → fake_bpy_module-20241112.dist-info}/RECORD

@@ -275,8 +275,8 @@ bpy/ops/workspace/__init__.pyi,sha256=4qG0-HkVfaGfdBe9QvBCKUox03nb1ZfeV1fz-0b3KJ
 bpy/ops/world/__init__.pyi,sha256=ytaDhwJ-K4SbWylChL1za6lvMNM2-RX1S0BR7892Afg,946
 bpy/path/__init__.pyi,sha256=b_M-IUy-VEWMDZJH0bP9P-HHcLLcQo59S1dARRQrP9E,5064
 bpy/props/__init__.pyi,sha256=3sLdRLi978cZRz7xJRc1MachtPUAo0Ddl9RejShVb-g,30492
-bpy/types/__init__.pyi,sha256=h6_UDxF03GU0IBVgJqrbyjionngISc2X-kfUXGMZFr8,5361632
-bpy/typing/__init__.pyi,sha256=cQWf5y7fGG52KM_nXbabxyJ3ZnodweLz91nB4tvqBTU,138751
+bpy/types/__init__.pyi,sha256=VKXJJCdWYVCeiECjupa60j8zlGHZTARRtGAXx2iDrHs,5362946
+bpy/typing/__init__.pyi,sha256=gsUFQbZl7Gutj4Syr6Pqk3uZfsSsTa-vqvr2Mvq3AeY,138837
 bpy/utils/__init__.pyi,sha256=XXoE6J8aW13NQ-2FvnFORXyNVUFfO8hSno-xfgJ6ZNI,13078
 bpy/utils/previews/__init__.pyi,sha256=XEThA7jxMWet1sPTJ3mmngM6LdAdKiIVSZOKbCsbvzw,2217
 bpy/utils/units/__init__.pyi,sha256=-NsCsGdfcIsC2lnZwzUrQFe1CXdnSjA80MCWSSxwbbk,2578
@@ -358,7 +358,7 @@ rna_prop_ui/__init__.pyi,sha256=lShhkbbeJ_ANi2dy4J4HIkyp1HZrMqCfhcf8QpAQsj0,1281
 rna_prop_ui/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rna_xml/__init__.pyi,sha256=idYsAZj-_egBKMA2pQl2P9IoNhZxXIkBSALFuq-ylO8,577
 rna_xml/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fake_bpy_module-20241111.dist-info/METADATA,sha256=X_XhFDfWSDklTud-bQVJWhA8VziaNUdDsfCi3BvW27g,7289
-fake_bpy_module-20241111.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-fake_bpy_module-20241111.dist-info/top_level.txt,sha256=SZm3DVRKif7dFSjYKiIIg3_7uqjIwRAwOnCIcT4hRNM,500
-fake_bpy_module-20241111.dist-info/RECORD,,
+fake_bpy_module-20241112.dist-info/METADATA,sha256=czNsJMLUgw8tpPOhnq-k08cHQibI-5OEOK7odun4I88,7289
+fake_bpy_module-20241112.dist-info/WHEEL,sha256=a7TGlA-5DaHMRrarXjVbQagU3Man_dCnGIWMJr5kRWo,91
+fake_bpy_module-20241112.dist-info/top_level.txt,sha256=SZm3DVRKif7dFSjYKiIIg3_7uqjIwRAwOnCIcT4hRNM,500
+fake_bpy_module-20241112.dist-info/RECORD,,

{fake_bpy_module-20241111.dist-info → fake_bpy_module-20241112.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (75.4.0)
 Root-Is-Purelib: true
 Tag: py3-none-any