patch [#29049] Minor phrasing and grammar patch
[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 Use The Terminal
13 ================
14
15 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.
16
17 There are 3 main uses for the terminal, these are:
18
19 * You can see the output of ``print()`` as you're script runs, which is useful to view debug info.
20
21 * 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).
22
23 * 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.
24
25 .. note::
26    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.
27
28
29 Show All Operators
30 ==================
31
32 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``.
33
34 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.
35
36
37 Use an External Editor
38 ======================
39
40 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.
41
42 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.
43
44 Using the following examples you'll still need textblock in blender to execute, but reference an external file rather then including it directly.
45
46 Executing External Scripts
47 --------------------------
48
49 This is the equivalent to running the script directly, referencing a scripts path from a 2 line textblock.
50
51 .. code-block:: python
52
53    filename = "/full/path/to/myscript.py"
54    exec(compile(open(filename).read(), filename, 'exec'))
55
56
57 You might want to reference a script relative to the blend file.
58
59 .. code-block:: python
60
61    import bpy
62    import os
63
64    filename = os.path.join(os.path.basename(bpy.data.filepath), "myscript.py")
65    exec(compile(open(filename).read(), filename, 'exec'))
66
67
68 Executing Modules
69 -----------------
70
71 This example shows loading a script in as a module and executing a module function.
72
73 .. code-block:: python
74
75    import myscript
76    import imp
77
78    imp.reload(myscript)
79    myscript.main()
80
81
82 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.
83
84 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.
85
86 The other issue with this is the script has to be in pythons module search path.
87 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.
88
89 .. code-block:: python
90
91    import sys
92    import os
93    import bpy
94
95    blend_dir = os.path.basename(bpy.data.filepath)
96    if blend_dir not in sys.path:
97       sys.path.append(blend_dir)
98
99    import myscript
100    import imp
101    imp.reload(myscript)
102    myscript.main()
103
104
105 Don't Use Blender!
106 ==================
107
108 While developing your own scripts blenders interface can get in the way, manually reloading, running the scripts, opening file import etc. adds overhead.
109
110 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.
111
112 .. code-block:: python
113
114    blender --background --python myscript.py
115
116
117 You might want to run this with a blend file so the script has some data to operate on.
118
119 .. code-block:: python
120
121    blender myscene.blend --background --python myscript.py
122
123
124 .. note::
125
126    Depending on your setup you might have to enter the full path to the blender executable.
127
128
129 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.
130
131 * render the output to an image, use an image viewer and keep writing over the same image each time.
132
133 * save a new blend file, or export the file using one of blenders exporters.
134
135 * if the results can be displayed as text - print them or write them to a file.
136
137
138 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.
139
140
141 Use External Tools
142 ==================
143
144 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.
145
146 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.
147
148 Examples include:
149
150 * Run The Gimp in batch mode to execute custom scripts for advanced image processing.
151
152 * Write out 3D models to use external mesh manipulation tools and read back in the results.
153
154 * Convert files into recognizable formats before reading.
155
156
157 Bundled Python & Extensions
158 ===========================
159
160 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.
161
162 There are 2 ways around this:
163
164 * 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**.
165
166 * 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.
167
168
169 Drop Into a Python Interpreter in You're Script
170 ===============================================
171
172 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.
173
174 .. code-block:: python
175
176    import code
177    code.interact(local=locals())
178
179
180 If you want to access both global and local variables do this...
181
182 .. code-block:: python
183
184    import code
185    namespace = globals().copy()
186    namespace.update(locals())
187    code.interact(local=namespace)
188
189
190 The next example is an equivalent single line version of the script above which is easier to paste into you're code:
191
192 .. code-block:: python
193
194    __import__('code').interact(local={k: v for ns in (globals(), locals()) for k, v in ns.items()})
195
196
197 ``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.
198
199
200 Admittedly this highlights the lack of any python debugging support built into blender, but its still handy to know.
201
202 .. note::
203
204    This works in the game engine as well, it can be handy to inspect the state of a running game.
205
206
207 Advanced
208 ========
209
210
211 Blender as a module
212 -------------------
213
214 From a python perspective it's nicer to have everything as an extension which lets the python script combine many components.
215
216 Advantages include:
217
218 * 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).
219
220 * editors/IDE's can auto complete blender modules & variables.
221
222 * existing scripts can import blender API's without having to run inside blender.
223
224
225 This is marked advanced because to run blender as a python module requires a special build option.
226
227 For instructions on building see `Building blender as a python module <http://wiki.blender.org/index.php/User:Ideasman42/BlenderAsPyModule>`_
228
229
230 Python Safety (Build Option)
231 ----------------------------
232
233 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.
234
235 To raise python exceptions on accessing freed data (rather then crashing), enable the CMake build option WITH_PYTHON_SAFETY.
236
237 This enables data tracking which makes data access about 2x slower which is why the option is not enabled in release builds.