Application Data (bpy.app)

This module contains application values that remain unchanged during runtime.

Submodules

• Application Handlers (bpy.app.handlers)
• Application Translations (bpy.app.translations)
• Application Icons (bpy.app.icons)
• Application Timers (bpy.app.timers)

bpy.app.autoexec_fail

Undocumented, consider contributing.

bpy.app.autoexec_fail_message

Undocumented, consider contributing.

bpy.app.autoexec_fail_quiet

Undocumented, consider contributing.

bpy.app.binary_path

The location of Blender’s executable, useful for utilities that open new instances. Read-only unless Blender is built as a Python module - in this case the value is an empty string which script authors may point to a Blender binary.

bpy.app.debug

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_depsgraph

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_depsgraph_build

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_depsgraph_eval

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_depsgraph_pretty

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_depsgraph_tag

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_depsgraph_time

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_events

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_ffmpeg

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_freestyle

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_handlers

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_io

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_python

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_simdata

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.debug_value

Short, number which can be set to non-zero values for testing purposes

bpy.app.debug_wm

Boolean, for debug info (started with –debug / –debug_* matching this attribute name)

bpy.app.driver_namespace

Dictionary for drivers namespace, editable in-place, reset on file load (read-only)

bpy.app.render_icon_size

Reference size for icon/preview renders (read-only)

bpy.app.render_preview_size

Reference size for icon/preview renders (read-only)

bpy.app.tempdir

String, the temp directory used by blender (read-only)

bpy.app.use_event_simulate

Boolean, for application behavior (started with –enable-* matching this attribute name)

bpy.app.use_userpref_skip_save_on_exit

Boolean, for application behavior (started with –enable-* matching this attribute name)

bpy.app.background

Boolean, True when blender is running without a user interface (started with -b)

bpy.app.factory_startup

Boolean, True when blender is running with –factory-startup)

bpy.app.build_branch

The branch this blender instance was built from

bpy.app.build_cflags

C compiler flags

bpy.app.build_commit_date

The date of commit this blender instance was built

bpy.app.build_commit_time

The time of commit this blender instance was built

bpy.app.build_cxxflags

C++ compiler flags

bpy.app.build_date

The date this blender instance was built

bpy.app.build_hash

The commit hash this blender instance was built with

bpy.app.build_linkflags

Binary linking flags

bpy.app.build_platform

The platform this blender instance was built for

bpy.app.build_system

Build system used

bpy.app.build_time

The time this blender instance was built

bpy.app.build_type

The type of build (Release, Debug)

bpy.app.build_commit_timestamp

The unix timestamp of commit this blender instance was built

bpy.app.version_cycle

The release status of this build alpha/beta/rc/release

bpy.app.version_string

The Blender version formatted as a string

bpy.app.version

The Blender version as a tuple of 3 numbers. eg. (2, 83, 1)

bpy.app.version_file

The Blender version, as a tuple, last used to save a .blend file, compatible with bpy.data.version. This value should be used for handling compatibility changes between Blender versions

bpy.app.alembic

Constant value bpy.app.alembic(supported=False, version=(0, 0, 0), version_string=’Unknown’)

bpy.app.build_options

Constant value bpy.app.build_options(bullet=True, codec_avi=True, codec_ffmpeg=True, codec_sndfile=False, compositor_cpu=True, cycles=False, cycles_osl=False, freestyle=True, gameengine=True, image_cineon=True, image_dds=True, image_hdr=True, image_openexr=True, image_openjpeg=True, image_tiff=True, input_ndof=False, audaspace=True, international=True, openal=False, opensubdiv=False, sdl=False, sdl_dynload=False, coreaudio=False, jack=False, pulseaudio=False, wasapi=False, libmv=True, mod_oceansim=False, mod_remesh=True, player=False, collada=True, io_wavefront_obj=True, io_ply=True, io_stl=True, io_gpencil=False, opencolorio=False, openmp=True, openvdb=False, alembic=False, usd=False, fluid=True, xr_openxr=False, potrace=False, pugixml=False, haru=False)

bpy.app.ffmpeg

Constant value bpy.app.ffmpeg(supported=True, avcodec_version=(59, 37, 100), avcodec_version_string=’59, 37, 100’, avdevice_version=(59, 7, 100), avdevice_version_string=’59, 7, 100’, avformat_version=(59, 27, 100), avformat_version_string=’59, 27, 100’, avutil_version=(57, 28, 100), avutil_version_string=’57, 28, 100’, swscale_version=(6, 7, 100), swscale_version_string=’ 6, 7, 100’)

bpy.app.ocio

Constant value bpy.app.ocio(supported=False, version=(0, 0, 0), version_string=’Unknown’)

bpy.app.oiio

Constant value bpy.app.oiio(supported=True, version=(2, 4, 7), version_string=’ 2, 4, 7’)

bpy.app.opensubdiv

Constant value bpy.app.opensubdiv(supported=False, version=(0, 0, 0), version_string=’Unknown’)

bpy.app.openvdb

Constant value bpy.app.openvdb(supported=False, version=(0, 0, 0), version_string=’Unknown’)

bpy.app.sdl

Constant value bpy.app.sdl(supported=False, version=(0, 0, 0), version_string=’Unknown’, available=False)

bpy.app.usd

Constant value bpy.app.usd(supported=False, version=(0, 0, 0), version_string=’Unknown’)

static bpy.app.help_text(all=False)

Return the help text as a string.

Parameters:

all (bool) – Return all arguments, even those which aren’t available for the current platform.

static bpy.app.is_job_running(job_type)

Check whether a job of the given type is running.

Parameters:

job_type (str) – job type in Wm Job Type Items.

Returns:

Whether a job of the given type is currently running.

Return type:

bool.