c97fc3ab427d2115f4fa5add5444cb708b01303b
[blender.git] / doc / python_api / rst / info_gotcha.rst
1 ********
2 Gotcha's
3 ********
4
5 This document attempts to help you work with the Blender API in areas that can be troublesome and avoid practices that are known to give instability.
6
7
8 Using Operators
9 ===============
10
11 Blender's operators are tools for users to access, that python can access them too is very useful nevertheless operators have limitations that can make them cumbersome to script.
12
13 Main limits are...
14
15 * Can't pass data such as objects, meshes or materials to operate on (operators use the context instead)
16
17 * The return value from calling an operator gives the success (if it finished or was canceled),
18   in some cases it would be more logical from an API perspective to return the result of the operation.
19
20 * Operators poll function can fail where an API function would raise an exception giving details on exactly why.
21
22
23 Why does an operator's poll fail?
24 ---------------------------------
25
26 When calling an operator gives an error like this:
27
28    >>> bpy.ops.action.clean(threshold=0.001)
29    RuntimeError: Operator bpy.ops.action.clean.poll() failed, context is incorrect
30
31 Which raises the question as to what the correct context might be?
32
33 Typically operators check for the active area type, a selection or active object they can operate on, but some operators are more picky about when they run.
34
35 In most cases you can figure out what context an operator needs simply be seeing how its used in Blender and thinking about what it does.
36
37
38 Unfortunately if you're still stuck - the only way to **really** know whats going on is to read the source code for the poll function and see what its checking.
39
40 For python operators its not so hard to find the source since its included with with Blender and the source file/line is included in the operator reference docs.
41
42 Downloading and searching the C code isn't so simple, especially if you're not familiar with the C language but by searching the operator name or description you should be able to find the poll function with no knowledge of C.
43
44 .. note::
45
46    Blender does have the functionality for poll functions to describe why they fail, but its currently not used much, if you're interested to help improve our API feel free to add calls to ``CTX_wm_operator_poll_msg_set`` where its not obvious why poll fails.
47
48       >>> bpy.ops.gpencil.draw()
49       RuntimeError: Operator bpy.ops.gpencil.draw.poll() Failed to find Grease Pencil data to draw into
50
51
52 The operator still doesn't work!
53 --------------------------------
54
55 Certain operators in Blender are only intended for use in a specific context, some operators for example are only called from the properties window where they check the current material, modifier or constraint.
56
57 Examples of this are:
58
59 * :mod:`bpy.ops.texture.slot_move`
60 * :mod:`bpy.ops.constraint.limitdistance_reset`
61 * :mod:`bpy.ops.object.modifier_copy`
62 * :mod:`bpy.ops.buttons.file_browse`
63
64 Another possibility is that you are the first person to attempt to use this operator in a script and some modifications need to be made to the operator to run in a different context, if the operator should logically be able to run but fails when accessed from a script it should be reported to the bug tracker.
65
66
67 Stale Data
68 ==========
69
70 No updates after setting values
71 -------------------------------
72
73 Sometimes you want to modify values from python and immediately access the updated values, eg:
74
75 Once changing the objects :class:`bpy.types.Object.location` you may want to access its transformation right after from :class:`bpy.types.Object.matrix_world`, but this doesn't work as you might expect.
76
77 Consider the calculations that might go into working out the objects final transformation, this includes:
78
79 * animation function curves.
80 * drivers and their pythons expressions.
81 * constraints
82 * parent objects and all of their f-curves, constraints etc.
83
84 To avoid expensive recalculations every time a property is modified, Blender defers making the actual calculations until they are needed.
85
86 However, while the script runs you may want to access the updated values.
87
88 This can be done by calling :class:`bpy.types.Scene.update` after modifying values which recalculates all data that is tagged to be updated.
89
90
91 Can I redraw during the script?
92 -------------------------------
93
94 The official answer to this is no, or... *"You don't want to do that"*.
95
96 To give some background on the topic...
97
98 While a script executes Blender waits for it to finish and is effectively locked until its done, while in this state Blender won't redraw or respond to user input.
99 Normally this is not such a problem because scripts distributed with Blender tend not to run for an extended period of time, nevertheless scripts *can* take ages to execute and its nice to see whats going on in the view port.
100
101 Tools that lock Blender in a loop and redraw are highly discouraged since they conflict with Blenders ability to run multiple operators at once and update different parts of the interface as the tool runs.
102
103 So the solution here is to write a **modal** operator, that is - an operator which defines a modal() function, See the modal operator template in the text  editor.
104
105 Modal operators execute on user input or setup their own timers to run frequently, they can handle the events or pass through to be handled by the keymap or other modal operators.
106
107 Transform, Painting, Fly-Mode and File-Select are example of a modal operators.
108
109 Writing modal operators takes more effort then a simple ``for`` loop that happens to redraw but is more flexible and integrates better with Blenders design.
110
111
112 **Ok, Ok! I still want to draw from python**
113
114 If you insist - yes its possible, but scripts that use this hack wont be considered for inclusion in Blender and any issues with using it wont be considered bugs, this is also not guaranteed to work in future releases.
115
116 .. code-block:: python
117
118    bpy.ops.wm.redraw_timer(type='DRAW_WIN_SWAP', iterations=1)
119
120
121 Matrix multiplication is wrong
122 ==============================
123
124 Every so often users complain that Blenders matrix math is wrong, the confusion comes from mathutils matrices being column-major to match OpenGL and the rest of Blenders matrix operations and stored matrix data.
125
126 This is different to **numpy** which is row-major which matches what you would expect when using conventional matrix math notation.
127
128
129 I can't edit the mesh in edit-mode!
130 ===================================
131
132 Blenders EditMesh is an internal data structure (not saved and not exposed to python), this gives the main annoyance that you need to exit edit-mode to edit the mesh from python.
133
134 The reason we have not made much attempt to fix this yet is because we
135 will likely move to BMesh mesh API eventually, so any work on the API now will be wasted effort.
136
137 With the BMesh API we may expose mesh data to python so we can
138 write useful tools in python which are also fast to execute while in edit-mode.
139
140 For the time being this limitation just has to be worked around but we're aware its frustrating needs to be addressed.
141
142
143 EditBones, PoseBones, Bone... Bones
144 ===================================
145
146 Armature Bones in Blender have three distinct data structures that contain them. If you are accessing the bones through one of them, you may not have access to the properties you really need.
147
148 .. note::
149
150         In the following examples ``bpy.context.object`` is assumed to be an armature object.
151
152
153 Edit Bones
154 ----------
155
156 ``bpy.context.object.data.edit_bones`` contains a editbones; to access them you must set the armature mode to edit mode first (editbones do not exist in object or pose mode). Use these to create new bones, set their head/tail or roll, change their parenting relationships to other bones, etc.
157
158 Example using :class:`bpy.types.EditBone` in armature editmode:
159
160 This is only possible in edit mode.
161
162    >>> bpy.context.object.data.edit_bones["Bone"].head = Vector((1.0, 2.0, 3.0)) 
163
164 This will be empty outside of editmode.
165
166         >>> mybones = bpy.context.selected_editable_bones
167
168 Returns an editbone only in edit mode.
169
170         >>> bpy.context.active_bone
171
172
173 Bones (Object Mode)
174 -------------------
175
176 ``bpy.context.object.data.bones`` contains bones. These *live* in object mode, and have various properties you can change, note that the head and tail properties are read-only.
177
178 Example using :class:`bpy.types.Bone` in object or pose mode:
179
180 Returns a bone (not an editbone) outside of edit mode
181
182         >>> bpy.context.active_bone
183
184 This works, as with blender the setting can be edited in any mode
185
186         >>> bpy.context.object.data.bones["Bone"].use_deform = True
187
188 Accessible but read-only
189
190         >>> tail = myobj.data.bones["Bone"].tail
191
192
193 Pose Bones
194 ----------
195
196 ``bpy.context.object.pose.bones`` contains pose bones. This is where animation data resides, i.e. animatable transformations are applied to pose bones, as are constraints and ik-settings.
197
198 Examples using :class:`bpy.types.PoseBone` in object or pose mode:
199
200 .. code-block:: python
201
202         # Gets the name of the first constraint (if it exists)
203         bpy.context.object.pose.bones["Bone"].constraints[0].name 
204
205         # Gets the last selected pose bone (pose mode only)
206         bpy.context.active_pose_bone
207
208
209 .. note::
210
211         Notice the pose is accessed from the object rather than the object data, this is why blender can have 2 or more objects sharing the same armature in different poses.
212
213 .. note::
214
215         Strictly speaking PoseBone's are not bones, they are just the state of the armature, stored in the :class:`bpy.types.Object` rather than the :class:`bpy.types.Armature`, the real bones are however accessible from the pose bones - :class:`bpy.types.PoseBone.bone`
216
217
218 Armature Mode Switching
219 -----------------------
220
221 While writing scripts that deal with armatures you may find you have to switch between modes, when doing so take care when switching out of editmode not to keep references to the edit-bones or their head/tail vectors. Further access to these will crash blender so its important the script clearly separates sections of the code which operate in different modes.
222
223 This is mainly an issue with editmode since pose data can be manipulated without having to be in pose mode, however for operator access you may still need to enter pose mode.
224
225
226 Unicode Problems
227 ================
228
229 Python supports many different encpdings so there is nothing stopping you from writing a script in latin1 or iso-8859-15.
230
231 See `pep-0263 <http://www.python.org/dev/peps/pep-0263/>`_
232
233 However this complicates things for the python api because blend files themselves dont have an encoding.
234
235 To simplify the problem for python integration and script authors we have decieded all strings in blend files **must** be UTF-8 or ASCII compatible.
236
237 This means assigning strings with different encodings to an object names for instance will raise an error.
238
239 Paths are an exception to this rule since we cannot ignore the existane of non-utf-8 paths on peoples filesystems.
240
241 This means seemingly harmless expressions can raise errors, eg.
242
243    >>> print(bpy.data.filepath)
244    UnicodeEncodeError: 'ascii' codec can't encode characters in position 10-21: ordinal not in range(128)
245
246    >>> bpy.context.object.name = bpy.data.filepath
247    Traceback (most recent call last):
248      File "<blender_console>", line 1, in <module>
249    TypeError: bpy_struct: item.attr= val: Object.name expected a string type, not str
250
251
252 Here are 2 ways around filesystem encoding issues:
253
254    >>> print(repr(bpy.data.filepath))
255
256    >>> import os
257    >>> filepath_bytes = os.fsencode(bpy.data.filepath)
258    >>> filepath_utf8 = filepath_bytes.decode('utf-8', "replace")
259    >>> bpy.context.object.name = filepath_utf8
260
261
262 Unicode encoding/decoding is a big topic with comprehensive python documentation, to avoid getting stuck too deep in encoding problems - here are some suggestions:
263
264 * Always use utf-8 encoiding or convert to utf-8 where the input is unknown.
265
266 * Avoid manipulating filepaths as strings directly, use ``os.path`` functions instead.
267
268 * Use ``os.fsencode()`` / ``os.fsdecode()`` rather then the built in string decoding functions when operating on paths.
269
270 * To print paths or to include them in the user interface use ``repr(path)`` first or ``"%r" % path`` with string formatting.
271
272 * **Possibly** - use bytes instead of python strings, when reading some input its less trouble to read it as binary data though you will still need to deciede how to treat any strings you want to use with Blender, some importers do this.
273
274
275 Strange errors using 'threading' module
276 =======================================
277
278 Python threading with Blender only works properly when the threads finish up before the script does. By using ``threading.join()`` for example.
279
280 Heres an example of threading supported by Blender:
281
282 .. code-block:: python
283
284    import threading
285    import time
286
287    def prod():
288        print(threading.current_thread().name, "Starting")
289
290        # do something vaguely useful
291        import bpy
292        from mathutils import Vector
293        from random import random
294
295        prod_vec = Vector((random() - 0.5, random() - 0.5, random() - 0.5))
296        print("Prodding", prod_vec)
297        bpy.data.objects["Cube"].location += prod_vec
298        time.sleep(random() + 1.0)
299        # finish
300
301        print(threading.current_thread().name, "Exiting")
302
303    threads = [threading.Thread(name="Prod %d" % i, target=prod) for i in range(10)]
304
305
306    print("Starting threads...")
307
308    for t in threads:
309        t.start()
310
311    print("Waiting for threads to finish...")
312
313    for t in threads:
314        t.join()
315
316
317 This an example of a timer which runs many times a second and moves the default cube continuously while Blender runs (Unsupported).
318
319 .. code-block:: python
320
321    def func():
322        print("Running...")
323        import bpy
324        bpy.data.objects['Cube'].location.x += 0.05
325
326    def my_timer():
327        from threading import Timer
328        t = Timer(0.1, my_timer)
329        t.start()
330        func()
331
332    my_timer()
333
334 Use cases like the one above which leave the thread running once the script finishes may seem to work for a while but end up causing random crashes or errors in Blenders own drawing code.
335
336 So far no work has gone into making Blenders python integration thread safe, so until its properly supported, best not make use of this.
337
338 .. note::
339
340    Pythons threads only allow co-currency and wont speed up you're scripts on multi-processor systems, the ``subprocess`` and ``multiprocess`` modules can be used with blender and make use of multiple CPU's too.
341
342
343 Help! My script crashes Blender
344 ===============================
345
346 Ideally it would be impossible to crash Blender from python however there are some problems with the API where it can be made to crash.
347
348 Strictly speaking this is a bug in the API but fixing it would mean adding memory verification on every access since most crashes are caused by the python objects referencing Blenders memory directly, whenever the memory is freed, further python access to it can crash the script. But fixing this would make the scripts run very slow, or writing a very different kind of API which doesn't reference the memory directly.
349
350 Here are some general hints to avoid running into these problems.
351
352 * Be aware of memory limits, especially when working with large lists since Blender can crash simply by running out of memory.
353
354 * Many hard to fix crashes end up being because of referencing freed data, when removing data be sure not to hold any references to it.
355
356 * Modules or classes that remain active while Blender is used, should not hold references to data the user may remove, instead, fetch data from the context each time the script is activated.
357
358 * Crashes may not happen every time, they may happen more on some configurations/operating-systems.
359
360
361 Undo/Redo
362 ---------
363
364 Undo invalidates all :class:`bpy.types.ID` instances (Object, Scene, Mesh etc).
365
366 This example shows how you can tell undo changes the memory locations.
367
368    >>> hash(bpy.context.object)
369    -9223372036849950810
370    >>> hash(bpy.context.object)
371    -9223372036849950810
372
373    # ... move the active object, then undo
374
375    >>> hash(bpy.context.object)
376    -9223372036849951740
377
378 As suggested above, simply not holding references to data when Blender is used interactively by the user is the only way to ensure the script doesn't become unstable.
379
380
381 Array Re-Allocation
382 -------------------
383
384 When adding new points to a curve or vertices's/edges/faces to a mesh, internally the array which stores this data is re-allocated.
385
386 .. code-block:: python
387
388    bpy.ops.curve.primitive_bezier_curve_add()
389    point = bpy.context.object.data.splines[0].bezier_points[0]
390    bpy.context.object.data.splines[0].bezier_points.add()
391
392    # this will crash!
393    point.co = 1.0, 2.0, 3.0
394
395 This can be avoided by re-assigning the point variables after adding the new one or by storing indices's to the points rather then the points themselves.
396
397 The best way is to sidestep the problem altogether add all the points to the curve at once. This means you don't have to worry about array re-allocation and its faster too since reallocating the entire array for every point added is inefficient.
398
399
400 Removing Data
401 -------------
402
403 **Any** data that you remove shouldn't be modified or accessed afterwards, this includes f-curves, drivers, render layers, timeline markers, modifiers, constraints along with objects, scenes, groups, bones.. etc.
404
405 This is a problem in the API at the moment that we should eventually solve.