File Operators

bpy.ops.file.autopack_toggle()

Automatically pack all external files into the .blend file

bpy.ops.file.bookmark_add()

Add a bookmark for the selected/active directory

bpy.ops.file.bookmark_cleanup()

Delete all invalid bookmarks

bpy.ops.file.bookmark_delete(index=-1)

Delete selected bookmark

Parameters:index (int in [-1, 20000], (optional)) – Index
bpy.ops.file.bookmark_move(direction='TOP')

Move the active bookmark up/down in the list

Parameters:direction (enum in ['TOP', 'UP', 'DOWN', 'BOTTOM'], (optional)) –

Direction, Direction to move the active bookmark towards

  • TOP Top, Top of the list.
  • UP Up.
  • DOWN Down.
  • BOTTOM Bottom, Bottom of the list.
bpy.ops.file.bookmark_toggle()

Toggle bookmarks display

bpy.ops.file.cancel()

Cancel loading of selected file

bpy.ops.file.delete()

Delete selected files

bpy.ops.file.directory_new(directory="", open=False, confirm=True)

Create a new directory

Parameters:
  • directory (string, (optional, never None)) – Directory, Name of new directory
  • open (boolean, (optional)) – Open, Open new directory
  • confirm (boolean, (optional)) – Confirm, Prompt for confirmation
bpy.ops.file.execute(need_active=False)

Execute selected file

Parameters:need_active (boolean, (optional)) – Need Active, Only execute if there’s an active selected file in the file list
bpy.ops.file.filenum(increment=1)

Increment number in filename

Parameters:increment (int in [-100, 100], (optional)) – Increment
bpy.ops.file.filepath_drop(filepath="Path")

Undocumented contribute <https://developer.blender.org/T51061>

bpy.ops.file.find_missing_files(find_all=False, directory="", hide_props_region=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_folder=False, filter_blenlib=False, filemode=9, display_type='DEFAULT', sort_method='FILE_SORT_ALPHA', action_type='OPENFILE')

Try to find missing external files

Parameters:
  • find_all (boolean, (optional)) – Find All, Find all files in the search path (not just missing)
  • directory (string, (optional, never None)) – Directory, Directory of the file
  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings
  • filter_blender (boolean, (optional)) – Filter .blend files
  • filter_backup (boolean, (optional)) – Filter .blend files
  • filter_image (boolean, (optional)) – Filter image files
  • filter_movie (boolean, (optional)) – Filter movie files
  • filter_python (boolean, (optional)) – Filter python files
  • filter_font (boolean, (optional)) – Filter font files
  • filter_sound (boolean, (optional)) – Filter sound files
  • filter_text (boolean, (optional)) – Filter text files
  • filter_archive (boolean, (optional)) – Filter archive files
  • filter_btx (boolean, (optional)) – Filter btx files
  • filter_collada (boolean, (optional)) – Filter COLLADA files
  • filter_alembic (boolean, (optional)) – Filter Alembic files
  • filter_folder (boolean, (optional)) – Filter folders
  • filter_blenlib (boolean, (optional)) – Filter Blender IDs
  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default, Automatically determine display type for files.
    • LIST_VERTICAL Short List, Display files as short list.
    • LIST_HORIZONTAL Long List, Display files as a detailed list.
    • THUMBNAIL Thumbnails, Display files as thumbnails.
  • sort_method (enum in ['FILE_SORT_ALPHA', 'FILE_SORT_EXTENSION', 'FILE_SORT_TIME', 'FILE_SORT_SIZE'], (optional)) –

    File sorting mode

    • FILE_SORT_ALPHA Name, Sort the file list alphabetically.
    • FILE_SORT_EXTENSION Extension, Sort the file list by extension/type.
    • FILE_SORT_TIME Modified Date, Sort files by modification time.
    • FILE_SORT_SIZE Size, Sort files by size.
  • action_type (enum in ['OPENFILE', 'SAVE'], (optional)) –

    Action Type

    • OPENFILE Open, Use the file browser for opening files or a directory.
    • SAVE Save, Use the file browser for saving a file.
bpy.ops.file.hidedot()

Toggle hide hidden dot files

bpy.ops.file.highlight()

Highlight selected file(s)

bpy.ops.file.make_paths_absolute()

Make all paths to external files absolute

bpy.ops.file.make_paths_relative()

Make all paths to external files relative to current .blend

bpy.ops.file.next()

Move to next folder

bpy.ops.file.pack_all()

Pack all used external files into the .blend

bpy.ops.file.pack_libraries()

Pack all used Blender library files into the current .blend

bpy.ops.file.parent()

Move to parent directory

bpy.ops.file.previous()

Move to previous folder

bpy.ops.file.refresh()

Refresh the file list

bpy.ops.file.rename()

Rename file or file directory

bpy.ops.file.report_missing_files()

Report all missing external files

bpy.ops.file.reset_recent()

Reset Recent files

bpy.ops.file.select(extend=False, fill=False, open=True, deselect_all=False)

Handle mouse clicks to select and activate items

Parameters:
  • extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
  • fill (boolean, (optional)) – Fill, Select everything beginning with the last selection
  • open (boolean, (optional)) – Open, Open a directory when selecting it
  • deselect_all (boolean, (optional)) – Deselect On Nothing, Deselect all when nothing under the cursor
bpy.ops.file.select_all(action='TOGGLE')

Select or deselect all files

Parameters:action (enum in ['TOGGLE', 'SELECT', 'DESELECT', 'INVERT'], (optional)) –

Action, Selection action to execute

  • TOGGLE Toggle, Toggle selection for all elements.
  • SELECT Select, Select all elements.
  • DESELECT Deselect, Deselect all elements.
  • INVERT Invert, Invert selection of all elements.
bpy.ops.file.select_bookmark(dir="")

Select a bookmarked directory

Parameters:dir (string, (optional, never None)) – Dir
bpy.ops.file.select_box(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True, mode='SET')

Activate/select the file(s) contained in the border

Parameters:
  • xmin (int in [-inf, inf], (optional)) – X Min
  • xmax (int in [-inf, inf], (optional)) – X Max
  • ymin (int in [-inf, inf], (optional)) – Y Min
  • ymax (int in [-inf, inf], (optional)) – Y Max
  • wait_for_input (boolean, (optional)) – Wait for Input
  • mode (enum in ['SET', 'ADD', 'SUB'], (optional)) –

    Mode

    • SET Set, Set a new selection.
    • ADD Extend, Extend existing selection.
    • SUB Subtract, Subtract existing selection.
bpy.ops.file.select_walk(direction='UP', extend=False, fill=False)

Select/Deselect files by walking through them

Parameters:
  • direction (enum in ['UP', 'DOWN', 'LEFT', 'RIGHT'], (optional)) – Walk Direction, Select/Deselect file in this direction
  • extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
  • fill (boolean, (optional)) – Fill, Select everything beginning with the last selection
bpy.ops.file.smoothscroll()

Smooth scroll to make editable file visible

bpy.ops.file.sort_column_ui_context()

Change sorting to use column under cursor

bpy.ops.file.unpack_all(method='USE_LOCAL')

Unpack all files packed into this .blend to external ones

Parameters:method (enum in ['USE_LOCAL', 'WRITE_LOCAL', 'USE_ORIGINAL', 'WRITE_ORIGINAL', 'KEEP'], (optional)) – Method, How to unpack
bpy.ops.file.unpack_item(method='USE_LOCAL', id_name="", id_type=19785)

Unpack this file to an external file

Parameters:
  • method (enum in ['USE_LOCAL', 'WRITE_LOCAL', 'USE_ORIGINAL', 'WRITE_ORIGINAL'], (optional)) – Method, How to unpack
  • id_name (string, (optional, never None)) – ID name, Name of ID block to unpack
  • id_type (int in [0, inf], (optional)) – ID Type, Identifier type of ID block
bpy.ops.file.unpack_libraries()

Unpack all used Blender library files from this .blend file