Blender Python API

Context Access (bpy.context)¶

The context members available depend on the area of Blender which is currently being accessed.

Note that all context values are read-only, but may be modified through the data API or by running operators.

Global Context¶

These properties are available in any contexts.

bpy.context.area¶

Type:: bpy.types.Area, (readonly)

bpy.context.asset¶

Type:: bpy.types.AssetRepresentation, (readonly)

bpy.context.blend_data¶

Type:: bpy.types.BlendData, (readonly)

bpy.context.collection¶

Type:: bpy.types.Collection, (readonly)

bpy.context.engine¶

Type:: string, default “”, (readonly, never None)

bpy.context.gizmo_group¶

Type:: bpy.types.GizmoGroup, (readonly)

bpy.context.layer_collection¶

Type:: bpy.types.LayerCollection, (readonly)

bpy.context.mode¶

Type:: enum in Context Mode Items, default ‘EDIT_MESH’, (readonly)

bpy.context.preferences¶

Type:: bpy.types.Preferences, (readonly)

bpy.context.region¶

Type:: bpy.types.Region, (readonly)

bpy.context.region_data¶

Type:: bpy.types.RegionView3D, (readonly)

bpy.context.region_popup¶

The temporary region for pop-ups (including menus and pop-overs)

Type:: bpy.types.Region, (readonly)

bpy.context.scene¶

Type:: bpy.types.Scene, (readonly)

bpy.context.screen¶

Type:: bpy.types.Screen, (readonly)

bpy.context.space_data¶

The current space, may be None in background-mode, when the cursor is outside the window or when using menu-search

Type:: bpy.types.Space, (readonly)

bpy.context.tool_settings¶

Type:: bpy.types.ToolSettings, (readonly)

bpy.context.view_layer¶

Type:: bpy.types.ViewLayer, (readonly)

bpy.context.window¶

Type:: bpy.types.Window, (readonly)

bpy.context.window_manager¶

Type:: bpy.types.WindowManager, (readonly)

bpy.context.workspace¶

Type:: bpy.types.WorkSpace, (readonly)

Buttons Context¶

bpy.context.texture_slot¶

Type:: bpy.types.TextureSlot

bpy.context.scene

Type:: bpy.types.Scene

bpy.context.world¶

Type:: bpy.types.World

bpy.context.object¶

Type:: bpy.types.Object

bpy.context.mesh¶

Type:: bpy.types.Mesh

bpy.context.armature¶

Type:: bpy.types.Armature

bpy.context.lattice¶

Type:: bpy.types.Lattice

bpy.context.curve¶

Type:: bpy.types.Curve

bpy.context.meta_ball¶

Type:: bpy.types.MetaBall

bpy.context.light¶

Type:: bpy.types.Light

bpy.context.speaker¶

Type:: bpy.types.Speaker

bpy.context.lightprobe¶

Type:: bpy.types.LightProbe

bpy.context.camera¶

Type:: bpy.types.Camera

bpy.context.material¶

Type:: bpy.types.Material

bpy.context.material_slot¶

Type:: bpy.types.MaterialSlot

bpy.context.texture¶

Type:: bpy.types.Texture

bpy.context.texture_user¶

Type:: bpy.types.ID

bpy.context.texture_user_property¶

Type:: bpy.types.Property

bpy.context.texture_node¶

Type:: bpy.types.Node

bpy.context.bone¶

Type:: bpy.types.Bone

bpy.context.edit_bone¶

Type:: bpy.types.EditBone

bpy.context.pose_bone¶

Type:: bpy.types.PoseBone

bpy.context.particle_system¶

Type:: bpy.types.ParticleSystem

bpy.context.particle_system_editable¶

Type:: bpy.types.ParticleSystem

bpy.context.particle_settings¶

Type:: bpy.types.ParticleSettings

bpy.context.cloth¶

Type:: bpy.types.ClothModifier

bpy.context.soft_body¶

Type:: bpy.types.SoftBodyModifier

bpy.context.fluid¶

Type:: bpy.types.FluidSimulationModifier

bpy.context.collision¶

Type:: bpy.types.CollisionModifier

bpy.context.brush¶

Type:: bpy.types.Brush

bpy.context.dynamic_paint¶

Type:: bpy.types.DynamicPaintModifier

bpy.context.line_style¶

Type:: bpy.types.FreestyleLineStyle

bpy.context.collection

Type:: bpy.types.LayerCollection

bpy.context.gpencil¶

Type:: bpy.types.GreasePencil

bpy.context.grease_pencil¶

Type:: bpy.types.GreasePencilv3

bpy.context.curves¶

Type:: Hair Curves

bpy.context.volume¶

Type:: bpy.types.Volume

Clip Context¶

bpy.context.edit_movieclip¶

Type:: bpy.types.MovieClip

bpy.context.edit_mask¶

Type:: bpy.types.Mask

File Context¶

bpy.context.active_file¶

Type:: bpy.types.FileSelectEntry

bpy.context.selected_files¶

Type:: sequence of bpy.types.FileSelectEntry

bpy.context.asset_library_reference¶

Type:: bpy.types.AssetLibraryReference

bpy.context.selected_assets¶

Type:: sequence of bpy.types.AssetRepresentation

bpy.context.id¶

Type:: bpy.types.ID

bpy.context.selected_ids¶

Type:: sequence of bpy.types.ID

Image Context¶

bpy.context.edit_image¶

Type:: bpy.types.Image

bpy.context.edit_mask

Type:: bpy.types.Mask

Node Context¶

bpy.context.selected_nodes¶

Type:: sequence of bpy.types.Node

bpy.context.active_node¶

Type:: bpy.types.Node

bpy.context.light

Type:: bpy.types.Light

bpy.context.material

Type:: bpy.types.Material

bpy.context.world

Type:: bpy.types.World

Screen Context¶

bpy.context.scene

Type:: bpy.types.Scene

bpy.context.view_layer

Type:: bpy.types.ViewLayer

bpy.context.visible_objects¶

Type:: sequence of bpy.types.Object

bpy.context.selectable_objects¶

Type:: sequence of bpy.types.Object

bpy.context.selected_objects¶

Type:: sequence of bpy.types.Object

bpy.context.editable_objects¶

Type:: sequence of bpy.types.Object

bpy.context.selected_editable_objects¶

Type:: sequence of bpy.types.Object

bpy.context.objects_in_mode¶

Type:: sequence of bpy.types.Object

bpy.context.objects_in_mode_unique_data¶

Type:: sequence of bpy.types.Object

bpy.context.visible_bones¶

Type:: sequence of bpy.types.EditBone

bpy.context.editable_bones¶

Type:: sequence of bpy.types.EditBone

bpy.context.selected_bones¶

Type:: sequence of bpy.types.EditBone

bpy.context.selected_editable_bones¶

Type:: sequence of bpy.types.EditBone

bpy.context.visible_pose_bones¶

Type:: sequence of bpy.types.PoseBone

bpy.context.selected_pose_bones¶

Type:: sequence of bpy.types.PoseBone

bpy.context.selected_pose_bones_from_active_object¶

Type:: sequence of bpy.types.PoseBone

bpy.context.active_bone¶

Type:: bpy.types.EditBone or bpy.types.Bone

bpy.context.active_pose_bone¶

Type:: bpy.types.PoseBone

bpy.context.active_object¶

Type:: bpy.types.Object

bpy.context.object

Type:: bpy.types.Object

bpy.context.edit_object¶

Type:: bpy.types.Object

bpy.context.sculpt_object¶

Type:: bpy.types.Object

bpy.context.vertex_paint_object¶

Type:: bpy.types.Object

bpy.context.weight_paint_object¶

Type:: bpy.types.Object

bpy.context.image_paint_object¶

Type:: bpy.types.Object

bpy.context.particle_edit_object¶

Type:: bpy.types.Object

bpy.context.pose_object¶

Type:: bpy.types.Object

bpy.context.active_sequence_strip¶

Type:: bpy.types.Strip

bpy.context.sequences¶

Type:: sequence of bpy.types.Strip

bpy.context.selected_sequences¶

Type:: sequence of bpy.types.Strip

bpy.context.selected_editable_sequences¶

Type:: sequence of bpy.types.Strip

bpy.context.active_nla_track¶

Type:: bpy.types.NlaTrack

bpy.context.active_nla_strip¶

Type:: bpy.types.NlaStrip

bpy.context.selected_nla_strips¶

Type:: sequence of bpy.types.NlaStrip

bpy.context.selected_movieclip_tracks¶

Type:: sequence of bpy.types.MovieTrackingTrack

bpy.context.annotation_data¶

Type:: bpy.types.GreasePencil

bpy.context.annotation_data_owner¶

Type:: bpy.types.ID

bpy.context.active_annotation_layer¶

Type:: bpy.types.GPencilLayer

bpy.context.grease_pencil

Type:: bpy.types.GreasePencilv3

bpy.context.active_operator¶

Type:: bpy.types.Operator

bpy.context.active_action¶

Type:: bpy.types.Action

bpy.context.selected_visible_actions¶

Type:: sequence of bpy.types.Action

bpy.context.selected_editable_actions¶

Type:: sequence of bpy.types.Action

bpy.context.visible_fcurves¶

Type:: sequence of bpy.types.FCurve

bpy.context.editable_fcurves¶

Type:: sequence of bpy.types.FCurve

bpy.context.selected_visible_fcurves¶

Type:: sequence of bpy.types.FCurve

bpy.context.selected_editable_fcurves¶

Type:: sequence of bpy.types.FCurve

bpy.context.active_editable_fcurve¶

Type:: bpy.types.FCurve

bpy.context.selected_editable_keyframes¶

Type:: sequence of bpy.types.Keyframe

bpy.context.ui_list¶

Type:: bpy.types.UIList

bpy.context.property¶

Type:: bpy.types.AnyType or str or int

Get the property associated with a hovered button. Returns a tuple of the data-block, data path to the property, and array index.

Note

When the property doesn’t have an associated bpy.types.ID non-ID data may be returned. This may occur when accessing windowing data, for example, operator properties.

# Example inserting keyframe for the hovered property.
active_property = bpy.context.property
if active_property:
    datablock, data_path, index = active_property
    datablock.keyframe_insert(data_path=data_path, index=index, frame=1)

                                        

bpy.context.asset_library_reference

Type:: bpy.types.AssetLibraryReference

bpy.context.active_strip¶

Type:: bpy.types.Strip

bpy.context.strips¶

Type:: sequence of bpy.types.Strip

bpy.context.selected_strips¶

Type:: sequence of bpy.types.Strip

bpy.context.selected_editable_strips¶

Type:: sequence of bpy.types.Strip

Sequencer Context¶

bpy.context.edit_mask

Type:: bpy.types.Mask

Text Context¶

bpy.context.edit_text¶

Type:: bpy.types.Text

View3D Context¶

bpy.context.active_object

Type:: bpy.types.Object

bpy.context.selected_ids

Type:: sequence of bpy.types.ID