1ce193ec4369af43e965a38b226746834c6ac78a
[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 .. code-block:: python
29
30    >>> bpy.ops.action.clean(threshold=0.001)
31    Traceback (most recent call last):
32      File "<blender_console>", line 1, in <module>
33      File "scripts/modules/bpy/ops.py", line 179, in __call__
34        ret = op_call(self.idname_py(), None, kw)
35    RuntimeError: Operator bpy.ops.action.clean.poll() failed, context is incorrect
36
37 Which raises the question as to what the correct context might be?
38
39 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.
40
41 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.
42
43
44 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.
45
46 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.
47
48 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.
49
50 .. note::
51
52    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.
53
54    .. code-block:: python
55
56       >>> bpy.ops.gpencil.draw()
57       RuntimeError: Operator bpy.ops.gpencil.draw.poll() Failed to find Grease Pencil data to draw into
58
59 ================================
60 The operator still doesn't work!
61 ================================
62
63 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.
64
65 Examples of this are:
66
67 * :mod:`bpy.ops.texture.slot_move`
68 * :mod:`bpy.ops.constraint.limitdistance_reset`
69 * :mod:`bpy.ops.object.modifier_copy`
70 * :mod:`bpy.ops.buttons.file_browse`
71
72 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.
73
74
75 **********
76 Stale Data
77 **********
78
79 ===============================
80 No updates after setting values
81 ===============================
82
83 Sometimes you want to modify values from python and immediately access the updated values, eg:
84
85 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.
86
87 Consider the calculations that might go into working out the objects final transformation, this includes:
88
89 * animation function curves.
90 * drivers and their pythons expressions.
91 * constraints
92 * parent objects and all of their f-curves, constraints etc.
93
94 To avoid expensive recalculations every time a property is modified, Blender defers making the actual calculations until they are needed.
95
96 However, while the script runs you may want to access the updated values.
97
98 This can be done by calling :class:`bpy.types.Scene.update` after modifying values which recalculates all data that is tagged to be updated.
99
100 ===============================
101 Can I redraw during the script?
102 ===============================
103
104 The official answer to this is no, or... *"You don't want to do that"*.
105
106 To give some background on the topic...
107
108 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.
109 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.
110
111 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.
112
113 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.
114
115 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.
116
117 Transform, Painting, Fly-Mode and File-Select are example of a modal operators.
118
119 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.
120
121
122 **Ok, Ok! I still want to draw from python**
123
124 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.
125
126 .. code-block:: python
127
128    bpy.ops.wm.redraw_timer(type='DRAW_WIN_SWAP', iterations=1)
129
130
131 ******************************
132 Matrix multiplication is wrong
133 ******************************
134
135 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.
136
137 This is different to **numpy** which is row-major which matches what you would expect when using conventional matrix math notation.
138
139
140 ***********************************
141 I can't edit the mesh in edit-mode!
142 ***********************************
143
144 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.
145
146 The reason we have not made much attempt to fix this yet is because we
147 will likely move to BMesh mesh API eventually, so any work on the API now will be wasted effort.
148
149 With the BMesh API we may expose mesh data to python so we can
150 write useful tools in python which are also fast to execute while in edit-mode.
151
152 For the time being this limitation just has to be worked around but we're aware its frustrating needs to be addressed.
153
154
155 ****************
156 Unicode Problems
157 ****************
158
159 Python supports many different encpdings so there is nothing stopping you from writing a script in latin1 or iso-8859-15.
160
161 See `pep-0263 <http://www.python.org/dev/peps/pep-0263/>`_
162
163 However this complicates things for the python api because blend files themselves dont have an encoding.
164
165 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.
166
167 This means assigning strings with different encodings to an object names for instance will raise an error.
168
169 Paths are an exception to this rule since we cannot ignore the existane of non-utf-8 paths on peoples filesystems.
170
171 This means seemingly harmless expressions can raise errors, eg.
172
173 .. code-block:: python
174
175    >>> print(bpy.data.filepath)
176    UnicodeEncodeError: 'ascii' codec can't encode characters in position 10-21: ordinal not in range(128)
177
178    >>> bpy.context.object.name = bpy.data.filepath
179    Traceback (most recent call last):
180      File "<blender_console>", line 1, in <module>
181    TypeError: bpy_struct: item.attr= val: Object.name expected a string type, not str
182
183
184 Here are 2 ways around filesystem encoding issues.
185
186 .. code-block:: python
187
188    >>> print(repr(bpy.data.filepath))
189
190    >>> import os
191    >>> filepath_bytes = os.fsencode(bpy.data.filepath)
192    >>> filepath_utf8 = filepath_bytes.decode('utf-8', "replace")
193    >>> bpy.context.object.name = filepath_utf8
194
195
196 Unicode encoding/decoding is a big topic with comprehensive python documentation, to avoid getting stuck too deep in encoding problems - here are some suggestions:
197
198 * Always use utf-8 encoiding or convert to utf-8 where the input is unknown.
199
200 * Avoid manipulating filepaths as strings directly, use ``os.path`` functions instead.
201
202 * Use ``os.fsencode()`` / ``os.fsdecode()`` rather then the built in string decoding functions when operating on paths.
203
204 * To print paths or to include them in the user interface use ``repr(path)`` first or ``"%r" % path`` with string formatting.
205
206 * **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.
207
208
209 ***************************************
210 Strange errors using 'threading' module
211 ***************************************
212
213 Python threading with Blender only works properly when the threads finish up before the script does. By using ``threading.join()`` for example.
214
215 Heres an example of threading supported by Blender:
216
217 .. code-block:: python
218
219    import threading
220    import time
221
222    def prod():
223        print(threading.current_thread().name, "Starting")
224
225        # do something vaguely useful
226        import bpy
227        from mathutils import Vector
228        from random import random
229
230        prod_vec = Vector((random() - 0.5, random() - 0.5, random() - 0.5))
231        print("Prodding", prod_vec)
232        bpy.data.objects["Cube"].location += prod_vec
233        time.sleep(random() + 1.0)
234        # finish
235
236        print(threading.current_thread().name, "Exiting")
237
238    threads = [threading.Thread(name="Prod %d" % i, target=prod) for i in range(10)]
239
240
241    print("Starting threads...")
242
243    for t in threads:
244        t.start()
245
246    print("Waiting for threads to finish...")
247
248    for t in threads:
249        t.join()
250
251
252 This an example of a timer which runs many times a second and moves the default cube continuously while Blender runs (Unsupported).
253
254 .. code-block:: python
255
256    def func():
257        print("Running...")
258        import bpy
259        bpy.data.objects['Cube'].location.x += 0.05
260
261    def my_timer():
262        from threading import Timer
263        t = Timer(0.1, my_timer)
264        t.start()
265        func()
266
267    my_timer()
268
269 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.
270
271 So far no work has gone into making Blenders python integration thread safe, so until its properly supported, best not make use of this.
272
273 .. note::
274
275    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.
276
277
278 *******************************
279 Help! My script crashes Blender
280 *******************************
281
282 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.
283
284 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.
285
286 Here are some general hints to avoid running into these problems.
287
288 * Be aware of memory limits, especially when working with large lists since Blender can crash simply by running out of memory.
289
290 * 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.
291
292 * 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.
293
294 * Crashes may not happen every time, they may happen more on some configurations/operating-systems.
295
296
297 =========
298 Undo/Redo
299 =========
300
301 Undo invalidates all :class:`bpy.types.ID` instances (Object, Scene, Mesh etc).
302
303 This example shows how you can tell undo changes the memory locations.
304
305 .. code-block:: python
306
307    >>> hash(bpy.context.object)
308    -9223372036849950810
309    >>> hash(bpy.context.object)
310    -9223372036849950810
311
312    # ... move the active object, then undo
313
314    >>> hash(bpy.context.object)
315    -9223372036849951740
316
317 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.
318
319
320 ===================
321 Array Re-Allocation
322 ===================
323
324 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.
325
326 .. code-block:: python
327
328    bpy.ops.curve.primitive_bezier_curve_add()
329    point = bpy.context.object.data.splines[0].bezier_points[0]
330    bpy.context.object.data.splines[0].bezier_points.add()
331
332    # this will crash!
333    point.co = 1.0, 2.0, 3.0
334
335 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.
336
337 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.
338
339
340 =============
341 Removing Data
342 =============
343
344 **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.
345
346 This is a problem in the API at the moment that we should eventually solve.