user: How do I use Bpy.App in Blender? Include parameters, examples, warnings and best practices.

assistant: ad_post ) that initialized the name-space. While this works for background tasks it has the downside that opening the file from the file selector won’t setup the name-space. bpy.app. online_access ¶ Boolean, true when internet access is allowed by Blender & 3rd party scripts (read-only). Type : bool bpy.app. online_access_override ¶ Boolean, true when internet access preference is overridden by the command line (read-only). Type : bool bpy.app. python_args ¶ Leading arguments to use when calling Python directly (via sys.executable ). These arguments match settings Blender uses to ensure Python runs with a compatible environment (read-only). Type : tuple[str, …] bpy.app. render_icon_size ¶ Reference size for icon/preview renders (read-only). Type : int bpy.app. render_preview_size ¶ Reference size for icon/preview renders (read-only). Type : int bpy.app. tempdir ¶ String, the temp directory used by blender (read-only). Type : str bpy.app. use_event_simulate ¶ Boolean, for application behavior (started with --enable-* matching this attribute name) Type : bool bpy.app. use_userpref_skip_save_on_exit ¶ Boolean, for application behavior (started with --enable-* matching this attribute name) Type : bool bpy.app. background ¶ Boolean, True when blender is running without a user interface (started with -b) Type : bool bpy.app. factory_startup ¶ Boolean, True when blender is running with –factory-startup Type : bool bpy.app. module ¶ Boolean, True when running Blender as a python module Type : bool bpy.app. portable ¶ Boolean, True unless blender was built to reference absolute paths (on UNIX). Type : bool bpy.app. build_branch ¶ The branch this blender instance was built from Type : bytes bpy.app. build_cflags ¶ C compiler flags Type : bytes bpy.app. build_commit_date ¶ The date of commit this blender instance was built Type : bytes bpy.app. build_commit_time ¶ The time of commit this blender instance was built Type : bytes bpy.app. build_cxxflags ¶ C++ compiler flags Type : bytes bpy.app. build_date ¶ The date this blender instance was built Type : bytes bpy.app. build_hash ¶ The commit hash this blender instance was built with Type : bytes bpy.app. build_linkflags ¶ Binary linking flags Type : bytes bpy.app. build_platform ¶ The platform this blender instance was built for Type : bytes bpy.app. build_system ¶ Build system used Type : bytes bpy.app. build_time ¶ The time this blender instance was built Type : bytes bpy.app. build_type ¶ The type of build (Release, Debug) Type : bytes bpy.app. build_commit_timestamp ¶ The unix timestamp of commit this blender instance was built Type : int bpy.app. version_cycle ¶ The release status of this build alpha/beta/rc/release Type : str bpy.app. version_string ¶ The Blender version formatted as a string Type : str bpy.app. version ¶ The Blender version as a tuple of 3 numbers (major, minor, micro). eg. (4, 3, 1) Type : tuple[int, int, int] bpy.app. version_file ¶ The Blender File version, as a tuple of 3 numbers (major, minor, file sub-version), that will be used to save a .blend file. The last item in this tuple indicates the file sub-version, which is different from the release micro version (the last item of the bpy.app.version tuple). The file sub-version can be incremented multiple times while a Blender version is under development. This value is, and should be, used for handling compatibility changes between Blender versions Type : tuple[int, int, int] bpy.app. alembic ¶ Constant value bpy.app.alembic(supported=True, version=(1, 8, 3), version_string=’ 1, 8, 3’) bpy.app. build_options ¶ Constant value bpy.app.build_options(bullet=True, codec_avi=False, codec_ffmpeg=True, codec_sndfile=True, compositor_cpu=True, cycles=True, cycles_osl=True, freestyle=True, image_cineon=True, image_dds=True, image_hdr=True, image_openexr=True, image_openjpeg=True, image_tiff=True, image_webp=True, input_ndof=True, audaspace=True, international=True, openal=True, opensubdiv=True, sdl=False, coreaudio=False, jack=True, pulseaudio=True, wasapi=False, libmv=True, mod_oceansim=True, mod_remesh=True, io_wavefront_obj=True, io_ply=True, io_stl=True, io_fbx=True, io_gpencil=True, opencolorio=True, openmp=False, openvdb=True, alembic=True, usd=True, fluid=True, xr_openxr=True, potrace=True, pugixml=True, haru=True, experimental_features=False) bpy.app. ffmpeg ¶ Constant value bpy.app.ffmpeg(supported=True, avcodec_version=(61, 19, 101), avcodec_version_string=’61, 19, 101’, avdevice_version=(61, 3, 100), avdevice_version_string=’61, 3, 100’, avformat_version=(61, 7, 100), avformat_version_string=’61, 7, 100’, avutil_version=(59, 39, 100), avutil_version_string=’59, 39, 100’, swscale_version=(8, 3, 100), swscale_version_string=’ 8, 3, 100’) bpy.app. ocio ¶ Constant value bpy.app.ocio(supported=True, version=(2, 4, 2), version_string=’ 2, 4, 2’) bpy.app. oiio ¶ Constant value bpy.app.oiio(supported=True, version=(3, 0, 9), version_string=’ 3, 0, 9’) bpy.app. opensubdiv ¶ Constant value bpy.app.opensubdiv(supported=True, version=(3, 6, 0), version_string=’ 3, 6, 0’) bpy.app. openvdb ¶ Constant value bpy.app.openvdb(supported=True, version=(12, 0, 0), version_string=’12, 0, 0’) bpy.app. sdl ¶ Constant value bpy.app.sdl(supported=False, version=(0, 0, 0), version_string=’Unknown’) bpy.app. usd ¶ Constant value bpy.app.usd(supported=True, version=(0, 25, 8), version_string=’ 0, 25, 8’) 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. Returns : Help text. Return type : str 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 static bpy.app. memory_usage_undo ( ) ¶ Get undo memory usage information. Returns : Memory usage of the undo stack in bytes. Return type : int Next Application Handlers (bpy.app.handlers) Previous Path Utilities (bpy.path) Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page Application Data (bpy.app) autoexec_fail autoexec_fail_message autoexec_fail_quiet binary_path debug debug_depsgraph debug_depsgraph_build debug_depsgraph_eval debug_depsgraph_pretty debug_depsgraph_tag debug_depsgraph_time debug_events debug_freestyle debug_handlers debug_io debug_python debug_simdata debug_value debug_wm driver_namespace online_access online_access_override python_args render_icon_size render_preview_size tempdir use_event_simulate use_userpref_skip_save_on_exit background factory_startup module portable build_branch build_cflags build_commit_date build_commit_time build_cxxflags build_date build_hash build_linkflags build_platform build_system build_time build_type build_commit_timestamp version_cycle version_string version version_file alembic build_options ffmpeg ocio oiio opensubdiv openvdb sdl usd help_text() is_job_running() memory_usage_undo()