Fix for memory leak caused by re-making mipmaps
[blender.git] / doc / python_api / examples / bpy.ops.py
1 """
2 Calling Operators
3 +++++++++++++++++
4
5 Provides python access to calling operators, this includes operators written in
6 C, Python or Macros.
7
8 Only keyword arguments can be used to pass operator properties.
9
10 Operators don't have return values as you might expect, instead they return a
11 set() which is made up of: {'RUNNING_MODAL', 'CANCELLED', 'FINISHED',
12 'PASS_THROUGH'}.
13 Common return values are {'FINISHED'} and {'CANCELLED'}.
14
15
16 Calling an operator in the wrong context will raise a RuntimeError,
17 there is a poll() method to avoid this problem.
18
19 Note that the operator ID (bl_idname) in this example is 'mesh.subdivide',
20 'bpy.ops' is just the access path for python.
21 """
22 import bpy
23
24 # calling an operator
25 bpy.ops.mesh.subdivide(number_cuts=3, smoothness=0.5)
26
27
28 # check poll() to avoid exception.
29 if bpy.ops.object.mode_set.poll():
30     bpy.ops.object.mode_set(mode='EDIT')