svn merge -r40197:40311 ^/trunk/blender
[blender.git] / doc / python_api / rst / info_tips_and_tricks.rst
1 ***************
2 Tips and Tricks
3 ***************
4
5 Here are various suggestions that you might find useful when writing scripts.
6
7 Some of these are just python features that scripters may not have thought to use with blender, others are blender specific.
8
9
10 Use The Terminal
11 ================
12
13 When writing python scripts, it's useful to have a terminal open, this is not the built-in python console but a terminal application which is used to start blender.
14
15 There are 3 main uses for the terminal, these are:
16
17 * You can see the output of ``print()`` as you're script runs, which is useful to view debug info.
18
19 * The error trace-back is printed in full to the terminal which won't always generate an error popup in blender's user interface (depending on how the script is executed).
20
21 * If the script runs for too long or you accidentally enter an infinite loop, Ctrl+C in the terminal (Ctrl+Break on Windows) will quit the script early.
22
23 .. note::
24    For Linux and OSX users this means starting the terminal first, then running blender from within it. On Windows the terminal can be enabled from the help menu.
25
26
27 Show All Operators
28 ==================
29
30 While blender logs operators in the Info space, this only reports operators with the ``REGISTER`` option enabeld so as not to flood the Info view with calls to ``bpy.ops.view3d.smoothview`` and ``bpy.ops.view3d.zoom``.
31
32 However, for testing it can be useful to see **every** operator called in a terminal, do this by enabling the debug option either by passing the ``--debug`` argument when starting blender or by setting :mod:`bpy.app.debug` to True while blender is running.
33
34
35 Use an External Editor
36 ======================
37
38 Blenders text editor is fine for small changes and writing tests but its not full featured, for larger projects you'll probably want to use a standalone editor or python IDE.
39
40 Editing a text file externally and having the same text open in blender does work but isn't that optimal so here are 2 ways you can easily use an external file from blender.
41
42 Using the following examples you'll still need textblock in blender to execute, but reference an external file rather then including it directly.
43
44 Executing External Scripts
45 --------------------------
46
47 This is the equivalent to running the script directly, referencing a scripts path from a 2 line textblock.
48
49 .. code-block:: python
50
51    filename = "/full/path/to/myscript.py"
52    exec(compile(open(filename).read(), filename, 'exec'))
53
54
55 You might want to reference a script relative to the blend file.
56
57 .. code-block:: python
58
59    import bpy
60    import os
61
62    filename = os.path.join(os.path.basename(bpy.data.filepath), "myscript.py")
63    exec(compile(open(filename).read(), filename, 'exec'))
64
65
66 Executing Modules
67 -----------------
68
69 This example shows loading a script in as a module and executing a module function.
70
71 .. code-block:: python
72
73    import myscript
74    import imp
75
76    imp.reload(myscript)
77    myscript.main()
78
79
80 Notice that the script is reloaded every time, this forces use of the modified version, otherwise the cached one in ``sys.modules`` would be used until blender was restarted.
81
82 The important difference between this and executing the script directly is it has to call a function in the module, in this case ``main()`` but it can be any function, an advantage with this is you can pass arguments to the function from this small script which is often useful for testing different settings quickly.
83
84 The other issue with this is the script has to be in pythons module search path.
85 While this is not best practice - for testing you can extend the search path, this example adds the current blend files directory to the search path, then loads the script as a module.
86
87 .. code-block:: python
88
89    import sys
90    import os
91    import bpy
92
93    blend_dir = os.path.basename(bpy.data.filepath)
94    if blend_dir not in sys.path:
95       sys.path.append(blend_dir)
96
97    import myscript
98    import imp
99    imp.reload(myscript)
100    myscript.main()
101
102
103 Don't Use Blender!
104 ==================
105
106 While developing your own scripts blenders interface can get in the way, manually reloading, running the scripts, opening file import etc. adds overhead.
107
108 For scripts that are not interactive it can end up being more efficient not to use blenders interface at all and instead execute the script on the command line.
109
110 .. code-block:: python
111
112    blender --background --python myscript.py
113
114
115 You might want to run this with a blend file so the script has some data to operate on.
116
117 .. code-block:: python
118
119    blender myscene.blend --background --python myscript.py
120
121
122 .. note::
123
124    Depending on your setup you might have to enter the full path to the blender executable.
125
126
127 Once the script is running properly in background mode, you'll want to check the output of the script, this depends completely on the task at hand however here are some suggestions.
128
129 * render the output to an image, use an image viewer and keep writing over the same image each time.
130
131 * save a new blend file, or export the file using one of blenders exporters.
132
133 * if the results can be displayed as text - print them or write them to a file.
134
135
136 This can take a little time to setup, but it can be well worth the effort to reduce the time it takes to test changes - you can even have blender running the script ever few seconds with a viewer updating the results, so no need to leave you're text editor to see changes.
137
138
139 Use External Tools
140 ==================
141
142 When there are no readily available python modules to perform specific tasks it's worth keeping in mind you may be able to have python execute an external command on you're data and read the result back in.
143
144 Using external programs adds an extra dependency and may limit who can use the script but to quickly setup you're own custom pipeline or writing one-off scripts this can be handy.
145
146 Examples include:
147
148 * Run The Gimp in batch mode to execute custom scripts for advanced image processing.
149
150 * Write out 3D models to use external mesh manipulation tools and read back in the results.
151
152 * Convert files into recognizable formats before reading.
153
154
155 Bundled Python & Extensions
156 ===========================
157
158 The Blender releases distributed from blender.org include a complete python installation on all platforms, this has the disadvantage that any extensions you have installed in you're systems python wont be found by blender.
159
160 There are 2 ways around this:
161
162 * remove blender python sub-directory, blender will then fallback on the systems python and use that instead **python version must match the one that blender comes with**.
163
164 * copy the extensions into blender's python sub-directory so blender can access them, you could also copy the entire python installation into blenders sub-directory, replacing the one blender comes with. This works as long as the python versions match and the paths are created in the same relative locations. Doing this has the advantage that you can redistribute this bundle to others with blender and/or the game player, including any extensions you rely on.
165
166
167 Drop Into a Python Interpreter in You're Script
168 ===============================================
169
170 In the middle of a script you may want to inspect some variables, run some function and generally dig about to see whats going on.
171
172 .. code-block:: python
173
174    import code
175    code.interact(local=locals())
176
177
178 If you want to access both global and local variables do this...
179
180 .. code-block:: python
181
182    import code
183    namespace = globals().copy()
184    namespace.update(locals())
185    code.interact(local=namespace)
186
187
188 The next example is an equivalent single line version of the script above which is easier to paste into you're code:
189
190 .. code-block:: python
191
192    __import__('code').interact(local={k: v for ns in (globals(), locals()) for k, v in ns.items()})
193
194
195 ``code.interact`` can be added at any line in the script and will pause the script an launch an interactive interpreter in the terminal, when you're done you can quit the interpreter and the script will continue execution.
196
197
198 Admittedly this highlights the lack of any python debugging support built into blender, but its still handy to know.
199
200 .. note::
201
202    This works in the game engine as well, it can be handy to inspect the state of a running game.
203
204
205 Advanced
206 ========
207
208
209 Blender as a module
210 -------------------
211
212 From a python perspective it's nicer to have everything as an extension which lets the python script combine many components.
213
214 Advantages include:
215
216 * you can use external editors/IDE's with blenders python API and execute scripts within the IDE (step over code, inspect variables as the script runs).
217
218 * editors/IDE's can auto complete blender modules & variables.
219
220 * existing scripts can import blender API's without having to run inside blender.
221
222
223 This is marked advanced because to run blender as a python module requires a special build option.
224
225 For instructions on building see `Building blender as a python module <http://wiki.blender.org/index.php/User:Ideasman42/BlenderAsPyModule>`_
226
227
228 Python Safety (Build Option)
229 ----------------------------
230
231 Since it's possible to access data which has been removed (see Gotcha's), this can be hard to track down the cause of crashes.
232
233 To raise python exceptions on accessing freed data (rather then crashing), enable the CMake build option WITH_PYTHON_SAFETY.
234
235 This enables data tracking which makes data access about 2x slower which is why the option is not enabled in release builds.