build fix: recent commit broke building on 64bit linux
[blender.git] / doc / python_api / rst / info_gotcha.rst
1 *******
2 Gotchas
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 it's 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 it's not so hard to find the source since it's included 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 object's 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 than 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 Modes and Mesh Access
122 =====================
123
124 When working with mesh data you may run into the problem where a script fails to run as expected in edit-mode. This is caused by edit-mode having its own data which is only written back to the mesh when exiting edit-mode.
125
126 A common example is that exporters may access a mesh through ``obj.data`` (a :class:`bpy.types.Mesh`) but the user is in edit-mode, where the mesh data is available but out of sync with the edit mesh.
127
128 In this situation you can...
129
130 * Exit edit-mode before running the tool.
131 * Explicitly update the mesh by calling :class:`bmesh.types.BMesh.to_mesh`.
132 * Modify the script to support working on the edit-mode data directly, see: :mod:`bmesh.from_edit_mesh`.
133 * Report the context as incorrect and only allow the script to run outside edit-mode.
134
135
136 .. _info_gotcha_mesh_faces:
137
138 NGons and Tessellation Faces
139 ============================
140
141 Since 2.63 NGons are supported, this adds some complexity since in some cases you need to access triangles/quads still (some exporters for example).
142
143 There are now 3 ways to access faces:
144
145 * :class:`bpy.types.MeshPolygon` - this is the data structure which now stores faces in object mode (access as ``mesh.polygons`` rather then ``mesh.faces``).
146 * :class:`bpy.types.MeshTessFace` - the result of triangulating (tessellated) polygons, the main method of face access in 2.62 or older (access as ``mesh.tessfaces``).
147 * :class:`bmesh.types.BMFace` - the polygons as used in editmode.
148
149 For the purpose of the following documentation, these will be referred to as polygons, tessfaces and bmesh-faces respectively.
150
151 5+ sided faces will be referred to as ``ngons``.
152
153 Support Overview
154 ----------------
155
156 +--------------+------------------------------+--------------------------------+--------------------------------+
157 |Usage         |:class:`bpy.types.MeshPolygon`|:class:`bpy.types.MeshTessFace` |:class:`bmesh.types.BMFace`     |
158 +==============+==============================+================================+================================+
159 |Import/Create |Bad (inflexible)              |Fine (supported as upgrade path)|Best                            |
160 +--------------+------------------------------+--------------------------------+--------------------------------+
161 |Manipulate    |Bad (inflexible)              |Bad (loses ngons)               |Best                            |
162 +--------------+------------------------------+--------------------------------+--------------------------------+
163 |Export/Output |Good (ngons)                  |Good (When ngons can't be used) |Good (ngons, memory overhead)   |
164 +--------------+------------------------------+--------------------------------+--------------------------------+
165
166
167 .. note::
168
169    Using the :mod:`bmesh` api is completely separate api from :mod:`bpy`, typically you would would use one or the other based on the level of editing needed, not simply for a different way to access faces.
170
171
172 Creating
173 --------
174
175 All 3 datatypes can be used for face creation.
176
177 * polygons are the most efficient way to create faces but the data structure is _very_ rigid and inflexible, you must have all your vertes and faces ready and create them all at once. This is further complicated by the fact that each polygon does not store its own verts (as with tessfaces), rather they reference an index and size in :class:`bpy.types.Mesh.loops` which are a fixed array too.
178 * tessfaces ideally should not be used for creating faces since they are really only tessellation cache of polygons, however for scripts upgrading from 2.62 this is by far the most straightforward option. This works by creating tessfaces and when finished - they can be converted into polygons by calling :class:`bpy.types.Mesh.update`. The obvious limitation is ngons can't be created this way.
179 * bmesh-faces are most likely the easiest way for new scripts to create faces, since faces can be added one by one and the api has features intended for mesh manipulation. While :class:`bmesh.types.BMesh` uses more memory it can be managed by only operating on one mesh at a time.
180
181
182 Editing
183 -------
184
185 Editing is where the 3 data types vary most.
186
187 * polygons are very limited for editing, changing materials and options like smooth works but for anything else they are too inflexible and are only intended for storage.
188 * tessfaces should not be used for editing geometry because doing so will cause existing ngons to be tessellated.
189 * bmesh-faces are by far the best way to manipulate geometry.
190
191 Exporting
192 ---------
193
194 All 3 data types can be used for exporting, the choice mostly depends on whether the target format supports ngons or not.
195
196 * polygons are the most direct & efficient way to export providing they convert into the output format easily enough.
197 * tessfaces work well for exporting to formats which dont support ngons, in fact this is the only place where their use is encouraged.
198 * bmesh-faces can work for exporting too but may not be necessary if polygons can be used since using bmesh gives some overhead because its not the native storage format in object mode.
199
200
201 Upgrading Importers from 2.62
202 -----------------------------
203
204 Importers can be upgraded to work with only minor changes.
205
206 The main change to be made is used the tessellation versions of each attribute.
207
208 * mesh.faces --> :class:`bpy.types.Mesh.tessfaces`
209 * mesh.uv_textures --> :class:`bpy.types.Mesh.tessface_uv_textures`
210 * mesh.vertex_colors --> :class:`bpy.types.Mesh.tessface_vertex_colors`
211
212 Once the data is created call :class:`bpy.types.Mesh.update` to convert the tessfaces into polygons.
213
214
215 Upgrading Exporters from 2.62
216 -----------------------------
217
218 For exporters the most direct way to upgrade is to use tessfaces as with importing however its important to know that tessfaces may **not** exist for a mesh, the array will be empty as if there are no faces.
219
220 So before accessing tessface data call: :class:`bpy.types.Mesh.update` ``(calc_tessface=True)``.
221
222
223 EditBones, PoseBones, Bone... Bones
224 ===================================
225
226 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.
227
228 .. note::
229
230    In the following examples ``bpy.context.object`` is assumed to be an armature object.
231
232
233 Edit Bones
234 ----------
235
236 ``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.
237
238 Example using :class:`bpy.types.EditBone` in armature editmode:
239
240 This is only possible in edit mode.
241
242    >>> bpy.context.object.data.edit_bones["Bone"].head = Vector((1.0, 2.0, 3.0)) 
243
244 This will be empty outside of editmode.
245
246    >>> mybones = bpy.context.selected_editable_bones
247
248 Returns an editbone only in edit mode.
249
250    >>> bpy.context.active_bone
251
252
253 Bones (Object Mode)
254 -------------------
255
256 ``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.
257
258 Example using :class:`bpy.types.Bone` in object or pose mode:
259
260 Returns a bone (not an editbone) outside of edit mode
261
262    >>> bpy.context.active_bone
263
264 This works, as with blender the setting can be edited in any mode
265
266    >>> bpy.context.object.data.bones["Bone"].use_deform = True
267
268 Accessible but read-only
269
270    >>> tail = myobj.data.bones["Bone"].tail
271
272
273 Pose Bones
274 ----------
275
276 ``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.
277
278 Examples using :class:`bpy.types.PoseBone` in object or pose mode:
279
280 .. code-block:: python
281
282    # Gets the name of the first constraint (if it exists)
283    bpy.context.object.pose.bones["Bone"].constraints[0].name 
284
285    # Gets the last selected pose bone (pose mode only)
286    bpy.context.active_pose_bone
287
288
289 .. note::
290
291    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.
292
293 .. note::
294
295    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`
296
297
298 Armature Mode Switching
299 -----------------------
300
301 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.
302
303 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.
304
305
306 Data Names
307 ==========
308
309
310 Naming Limitations
311 ------------------
312
313 A common mistake is to assume newly created data is given the requested name.
314
315 This can cause bugs when you add some data (normally imported) then reference it later by name.
316
317 .. code-block:: python
318
319    bpy.data.meshes.new(name=meshid)
320    
321    # normally some code, function calls...
322    bpy.data.meshes[meshid]
323
324
325 Or with name assignment...
326
327 .. code-block:: python
328
329    obj.name = objname
330    
331    # normally some code, function calls...
332    obj = bpy.data.meshes[objname]
333
334
335 Data names may not match the assigned values if they exceed the maximum length, are already used or an empty string.
336
337
338 Its better practice not to reference objects by names at all, once created you can store the data in a list, dictionary, on a class etc, there is rarely a reason to have to keep searching for the same data by name.
339
340
341 If you do need to use name references, its best to use a dictionary to maintain a mapping between the names of the imported assets and the newly created data, this way you don't run this risk of referencing existing data from the blend file, or worse modifying it.
342
343 .. code-block:: python
344
345    # typically declared in the main body of the function.
346    mesh_name_mapping = {}
347    
348    mesh = bpy.data.meshes.new(name=meshid)
349    mesh_name_mapping[meshid] = mesh
350    
351    # normally some code, or function calls...
352    
353    # use own dictionary rather then bpy.data
354    mesh = mesh_name_mapping[meshid]
355
356
357 Library Collisions
358 ------------------
359
360 Blender keeps data names unique - :class:`bpy.types.ID.name` so you can't name two objects, meshes, scenes etc the same thing by accident.
361
362 However when linking in library data from another blend file naming collisions can occur, so its best to avoid referencing data by name at all.
363
364 This can be tricky at times and not even blender handles this correctly in some case (when selecting the modifier object for eg you can't select between multiple objects with the same name), but its still good to try avoid problems in this area.
365
366
367 If you need to select between local and library data, there is a feature in ``bpy.data`` members to allow for this.
368
369 .. code-block:: python
370
371    # typical name lookup, could be local or library.
372    obj = bpy.data.objects["my_obj"]
373
374    # library object name look up using a pair
375    # where the second argument is the library path matching bpy.types.Library.filepath
376    obj = bpy.data.objects["my_obj", "//my_lib.blend"]
377
378    # local object name look up using a pair
379    # where the second argument excludes library data from being returned.
380    obj = bpy.data.objects["my_obj", None]
381
382    # both the examples above also works for 'get'
383    obj = bpy.data.objects.get(("my_obj", None))
384
385
386 Relative File Paths
387 ===================
388
389 Blenders relative file paths are not compatible with standard python modules such as ``sys`` and ``os``.
390
391 Built in python functions don't understand blenders ``//`` prefix which denotes the blend file path.
392
393 A common case where you would run into this problem is when exporting a material with associated image paths.
394
395 >>> bpy.path.abspath(image.filepath)
396
397
398 When using blender data from linked libraries there is an unfortunate complication since the path will be relative to the library rather then the open blend file. When the data block may be from an external blend file pass the library argument from the :class:`bpy.types.ID`.
399
400 >>> bpy.path.abspath(image.filepath, library=image.library)
401
402
403 These returns the absolute path which can be used with native python modules.
404
405
406 Unicode Problems
407 ================
408
409 Python supports many different encodings so there is nothing stopping you from writing a script in latin1 or iso-8859-15.
410
411 See `pep-0263 <http://www.python.org/dev/peps/pep-0263/>`_
412
413 However this complicates things for the python api because blend files themselves don't have an encoding.
414
415 To simplify the problem for python integration and script authors we have decided all strings in blend files **must** be UTF-8 or ASCII compatible.
416
417 This means assigning strings with different encodings to an object names for instance will raise an error.
418
419 Paths are an exception to this rule since we cannot ignore the existane of non-utf-8 paths on peoples filesystems.
420
421 This means seemingly harmless expressions can raise errors, eg.
422
423    >>> print(bpy.data.filepath)
424    UnicodeEncodeError: 'ascii' codec can't encode characters in position 10-21: ordinal not in range(128)
425
426    >>> bpy.context.object.name = bpy.data.filepath
427    Traceback (most recent call last):
428      File "<blender_console>", line 1, in <module>
429    TypeError: bpy_struct: item.attr= val: Object.name expected a string type, not str
430
431
432 Here are 2 ways around filesystem encoding issues:
433
434    >>> print(repr(bpy.data.filepath))
435
436    >>> import os
437    >>> filepath_bytes = os.fsencode(bpy.data.filepath)
438    >>> filepath_utf8 = filepath_bytes.decode('utf-8', "replace")
439    >>> bpy.context.object.name = filepath_utf8
440
441
442 Unicode encoding/decoding is a big topic with comprehensive python documentation, to avoid getting stuck too deep in encoding problems - here are some suggestions:
443
444 * Always use utf-8 encoiding or convert to utf-8 where the input is unknown.
445
446 * Avoid manipulating filepaths as strings directly, use ``os.path`` functions instead.
447
448 * Use ``os.fsencode()`` / ``os.fsdecode()`` rather then the built in string decoding functions when operating on paths.
449
450 * To print paths or to include them in the user interface use ``repr(path)`` first or ``"%r" % path`` with string formatting.
451
452 * **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 decide how to treat any strings you want to use with Blender, some importers do this.
453
454
455 Strange errors using 'threading' module
456 =======================================
457
458 Python threading with Blender only works properly when the threads finish up before the script does. By using ``threading.join()`` for example.
459
460 Heres an example of threading supported by Blender:
461
462 .. code-block:: python
463
464    import threading
465    import time
466
467    def prod():
468        print(threading.current_thread().name, "Starting")
469
470        # do something vaguely useful
471        import bpy
472        from mathutils import Vector
473        from random import random
474
475        prod_vec = Vector((random() - 0.5, random() - 0.5, random() - 0.5))
476        print("Prodding", prod_vec)
477        bpy.data.objects["Cube"].location += prod_vec
478        time.sleep(random() + 1.0)
479        # finish
480
481        print(threading.current_thread().name, "Exiting")
482
483    threads = [threading.Thread(name="Prod %d" % i, target=prod) for i in range(10)]
484
485
486    print("Starting threads...")
487
488    for t in threads:
489        t.start()
490
491    print("Waiting for threads to finish...")
492
493    for t in threads:
494        t.join()
495
496
497 This an example of a timer which runs many times a second and moves the default cube continuously while Blender runs (Unsupported).
498
499 .. code-block:: python
500
501    def func():
502        print("Running...")
503        import bpy
504        bpy.data.objects['Cube'].location.x += 0.05
505
506    def my_timer():
507        from threading import Timer
508        t = Timer(0.1, my_timer)
509        t.start()
510        func()
511
512    my_timer()
513
514 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 Blender's own drawing code.
515
516 So far, no work has gone into making Blender's python integration thread safe, so until its properly supported, best not make use of this.
517
518 .. note::
519
520    Pythons threads only allow co-currency and won't speed up your scripts on multi-processor systems, the ``subprocess`` and ``multiprocess`` modules can be used with blender and make use of multiple CPU's too.
521
522
523 Help! My script crashes Blender
524 ===============================
525
526 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.
527
528 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.
529
530 Here are some general hints to avoid running into these problems.
531
532 * Be aware of memory limits, especially when working with large lists since Blender can crash simply by running out of memory.
533
534 * 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.
535
536 * 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.
537
538 * Crashes may not happen every time, they may happen more on some configurations/operating-systems.
539
540
541 Undo/Redo
542 ---------
543
544 Undo invalidates all :class:`bpy.types.ID` instances (Object, Scene, Mesh etc).
545
546 This example shows how you can tell undo changes the memory locations.
547
548    >>> hash(bpy.context.object)
549    -9223372036849950810
550    >>> hash(bpy.context.object)
551    -9223372036849950810
552
553    # ... move the active object, then undo
554
555    >>> hash(bpy.context.object)
556    -9223372036849951740
557
558 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.
559
560
561 Undo & Library Data
562 ^^^^^^^^^^^^^^^^^^^
563
564 One of the advantages with Blenders library linking system that undo can skip checking changes in library data since it is assumed to be static.
565
566 Tools in Blender are not allowed to modify library data.
567
568 Python however does not enforce this restriction.
569
570 This can be useful in some cases, using a script to adjust material values for example.
571 But its also possible to use a script to make library data point to newly created local data, which is not supported since a call to undo will remove the local data but leave the library referencing it and likely crash.
572
573 So it's best to consider modifying library data an advanced usage of the API and only to use it when you know what you're doing.
574
575
576 Edit Mode / Memory Access
577 -------------------------
578
579 Switching edit-mode ``bpy.ops.object.mode_set(mode='EDIT')`` / ``bpy.ops.object.mode_set(mode='OBJECT')`` will re-allocate objects data, any references to a meshes vertices/faces/uvs, armatures bones, curves points etc cannot be accessed after switching edit-mode.
580
581 Only the reference to the data its self can be re-accessed, the following example will crash.
582
583 .. code-block:: python
584
585    mesh = bpy.context.active_object.data
586    faces = mesh.faces
587    bpy.ops.object.mode_set(mode='EDIT')
588    bpy.ops.object.mode_set(mode='OBJECT')
589
590    # this will crash
591    print(faces)
592
593
594 So after switching edit-mode you need to re-access any object data variables, the following example shows how to avoid the crash above.
595
596 .. code-block:: python
597
598    mesh = bpy.context.active_object.data
599    faces = mesh.faces
600    bpy.ops.object.mode_set(mode='EDIT')
601    bpy.ops.object.mode_set(mode='OBJECT')
602
603    # faces have been re-allocated
604    faces = mesh.faces
605    print(faces)
606
607
608 These kinds of problems can happen for any functions which re-allocate the object data but are most common when switching edit-mode.
609
610
611 Array Re-Allocation
612 -------------------
613
614 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.
615
616 .. code-block:: python
617
618    bpy.ops.curve.primitive_bezier_curve_add()
619    point = bpy.context.object.data.splines[0].bezier_points[0]
620    bpy.context.object.data.splines[0].bezier_points.add()
621
622    # this will crash!
623    point.co = 1.0, 2.0, 3.0
624
625 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.
626
627 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.
628
629
630 Removing Data
631 -------------
632
633 **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.
634
635 The ``remove()`` api calls will invalidate the data they free to prevent common mistakes.
636
637 The following example shows how this precortion works.
638
639 .. code-block:: python
640
641    mesh = bpy.data.meshes.new(name="MyMesh")
642    # normally the script would use the mesh here...
643    bpy.data.meshes.remove(mesh)
644    print(mesh.name)  # <- give an exception rather then crashing:
645
646    # ReferenceError: StructRNA of type Mesh has been removed
647
648
649 But take care because this is limited to scripts accessing the variable which is removed, the next example will still crash.
650
651 .. code-block:: python
652
653    mesh = bpy.data.meshes.new(name="MyMesh")
654    vertices = mesh.vertices
655    bpy.data.meshes.remove(mesh)
656    print(vertices)  # <- this may crash
657
658
659 sys.exit
660 ========
661
662 Some python modules will call sys.exit() themselves when an error occurs, while not common behavior this is something to watch out for because it may seem as if blender is crashing since sys.exit() will quit blender immediately.
663
664 For example, the ``optparse`` module will print an error and exit if the arguments are invalid.
665
666 An ugly way of troubleshooting this is to set ``sys.exit = None`` and see what line of python code is quitting, you could of course replace ``sys.exit``/ with your own function but manipulating python in this way is bad practice.
667