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