Operators (bpy.ops)

Calling Operators

Provides python access to calling operators, this includes operators written in C, Python or Macros.

Only keyword arguments can be used to pass operator properties.

Operators don’t have return values as you might expect, instead they return a set() which is made up of: {‘RUNNING_MODAL’, ‘CANCELLED’, ‘FINISHED’, ‘PASS_THROUGH’}. Common return values are {‘FINISHED’} and {‘CANCELLED’}.

Calling an operator in the wrong context will raise a RuntimeError, there is a poll() method to avoid this problem.

Note that the operator ID (bl_idname) in this example is ‘mesh.subdivide’, ‘bpy.ops’ is just the access path for python.

import bpy

# calling an operator
bpy.ops.mesh.subdivide(number_cuts=3, smoothness=0.5)


# check poll() to avoid exception.
if bpy.ops.object.mode_set.poll():
	bpy.ops.object.mode_set(mode='EDIT')

Execution Context

When calling an operator you may want to pass the execution context.

This determines the context thats given to the operator to run in, and weather invoke() is called or execute().

‘EXEC_DEFAULT’ is used by default but you may want the operator to take user interaction with ‘INVOKE_DEFAULT’.

The execution context is as a non keyword, string argument in: (‘INVOKE_DEFAULT’, ‘INVOKE_REGION_WIN’, ‘INVOKE_REGION_CHANNELS’, ‘INVOKE_REGION_PREVIEW’, ‘INVOKE_AREA’, ‘INVOKE_SCREEN’, ‘EXEC_DEFAULT’, ‘EXEC_REGION_WIN’, ‘EXEC_REGION_CHANNELS’, ‘EXEC_REGION_PREVIEW’, ‘EXEC_AREA’, ‘EXEC_SCREEN’)

# group add popup
import bpy
bpy.ops.object.group_instance_add('INVOKE_DEFAULT')

Table Of Contents

Previous topic

Data Access (bpy.data)

Next topic

Action Operators