fake-bge-module 20250317__py3-none-any.whl → 20260201__py3-none-any.whl

bpy/ops/file/__init__.pyi

@@ -1,31 +1,28 @@
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 
 def autopack_toggle(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Automatically pack all external files into the .blend file
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def bookmark_add(execution_context: int | str | None = None, undo: bool | None = None):
-    """Add a bookmark for the selected/active directory
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Automatically pack all external files into the .blend file"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def bookmark_add(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Add a bookmark for the selected/active directory"""
 
 def bookmark_cleanup(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Delete all invalid bookmarks
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Delete all invalid bookmarks"""
 
 def bookmark_delete(
     execution_context: int | str | None = None,
@@ -33,13 +30,10 @@ def bookmark_delete(
     /,
     *,
     index: int | None = -1,
-):
+) -> None:
     """Delete selected bookmark
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param index: Index
-    :type index: int | None
     """
 
 def bookmark_move(
@@ -48,11 +42,9 @@ def bookmark_move(
     /,
     *,
     direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "TOP",
-):
+) -> None:
     """Move the active bookmark up/down in the list
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param direction: Direction, Direction to move the active bookmark towards
 
     TOP
@@ -66,22 +58,21 @@ def bookmark_move(
 
     BOTTOM
     Bottom -- Bottom of the list.
-        :type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
     """
 
-def cancel(execution_context: int | str | None = None, undo: bool | None = None):
-    """Cancel file operation
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def delete(execution_context: int | str | None = None, undo: bool | None = None):
-    """Move selected files to the trash or recycle bin
+def cancel(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Cancel file operation"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def delete(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move selected files to the trash or recycle bin"""
 
 def directory_new(
     execution_context: int | str | None = None,
@@ -91,41 +82,33 @@ def directory_new(
     directory: str = "",
     open: bool | None = False,
     confirm: bool | None = True,
-):
+) -> None:
     """Create a new directory
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param directory: Directory, Name of new directory
-    :type directory: str
     :param open: Open, Open new directory
-    :type open: bool | None
     :param confirm: Confirm, Prompt for confirmation
-    :type confirm: bool | None
     """
 
 def edit_directory_path(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Start editing directory field
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def execute(execution_context: int | str | None = None, undo: bool | None = None):
-    """Execute selected file
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Start editing directory field"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def execute(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Execute selected file"""
 
 def external_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     /,
     *,
-    filepath: str = "",
     operation: typing.Literal[
         "OPEN",
         "FOLDER_OPEN",
@@ -144,14 +127,10 @@ def external_operation(
         "CMD",
     ]
     | None = "OPEN",
-):
+) -> None:
     """Perform external operation on a file or folder
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
-        :param filepath: File or folder path
-        :type filepath: str
-        :param operation: Operation, Operation to perform on the file or path
+        :param operation: Operation, Operation to perform on the selected file or path
 
     OPEN
     Open -- Open the file.
@@ -197,7 +176,6 @@ def external_operation(
 
     CMD
     Command Prompt Here -- Open a command prompt here.
-        :type operation: typing.Literal['OPEN','FOLDER_OPEN','EDIT','NEW','FIND','SHOW','PLAY','BROWSE','PREVIEW','PRINT','INSTALL','RUNAS','PROPERTIES','FOLDER_FIND','CMD'] | None
     """
 
 def filenum(
@@ -206,13 +184,10 @@ def filenum(
     /,
     *,
     increment: int | None = 1,
-):
+) -> None:
     """Increment number in filename
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param increment: Increment
-    :type increment: int | None
     """
 
 def filepath_drop(
@@ -221,13 +196,8 @@ def filepath_drop(
     /,
     *,
     filepath: str = "Path",
-):
-    """Undocumented, consider contributing.
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :type filepath: str
-    """
+) -> None:
+    """Undocumented, consider contributing."""
 
 def find_missing_files(
     execution_context: int | str | None = None,
@@ -248,7 +218,6 @@ def find_missing_files(
     filter_text: bool | None = False,
     filter_archive: bool | None = False,
     filter_btx: bool | None = False,
-    filter_collada: bool | None = False,
     filter_alembic: bool | None = False,
     filter_usd: bool | None = False,
     filter_obj: bool | None = False,
@@ -261,55 +230,30 @@ def find_missing_files(
     ]
     | None = "DEFAULT",
     sort_method: str | None = "",
-):
+) -> None:
     """Try to find missing external files
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param find_all: Find All, Find all files in the search path (not just missing)
-        :type find_all: bool | None
         :param directory: Directory, Directory of the file
-        :type directory: str
         :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
-        :type hide_props_region: bool | None
         :param check_existing: Check Existing, Check and warn on overwriting existing files
-        :type check_existing: bool | None
         :param filter_blender: Filter .blend files
-        :type filter_blender: bool | None
         :param filter_backup: Filter .blend files
-        :type filter_backup: bool | None
         :param filter_image: Filter image files
-        :type filter_image: bool | None
         :param filter_movie: Filter movie files
-        :type filter_movie: bool | None
         :param filter_python: Filter Python files
-        :type filter_python: bool | None
         :param filter_font: Filter font files
-        :type filter_font: bool | None
         :param filter_sound: Filter sound files
-        :type filter_sound: bool | None
         :param filter_text: Filter text files
-        :type filter_text: bool | None
         :param filter_archive: Filter archive files
-        :type filter_archive: bool | None
         :param filter_btx: Filter btx files
-        :type filter_btx: bool | None
-        :param filter_collada: Filter COLLADA files
-        :type filter_collada: bool | None
         :param filter_alembic: Filter Alembic files
-        :type filter_alembic: bool | None
         :param filter_usd: Filter USD files
-        :type filter_usd: bool | None
         :param filter_obj: Filter OBJ files
-        :type filter_obj: bool | None
         :param filter_volume: Filter OpenVDB volume files
-        :type filter_volume: bool | None
         :param filter_folder: Filter folders
-        :type filter_folder: bool | None
         :param filter_blenlib: Filter Blender IDs
-        :type filter_blenlib: bool | None
         :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
-        :type filemode: int | None
         :param display_type: Display Type
 
     DEFAULT
@@ -323,116 +267,106 @@ def find_missing_files(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
-        :type sort_method: str | None
     """
 
-def hidedot(execution_context: int | str | None = None, undo: bool | None = None):
-    """Toggle hide hidden dot files
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def highlight(execution_context: int | str | None = None, undo: bool | None = None):
-    """Highlight selected file(s)
+def hidedot(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Toggle hide hidden dot files"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def highlight(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Highlight selected file(s)"""
 
 def make_paths_absolute(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Make all paths to external files absolute
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Make all paths to external files absolute"""
 
 def make_paths_relative(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Make all paths to external files relative to current .blend
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def mouse_execute(execution_context: int | str | None = None, undo: bool | None = None):
-    """Perform the current execute action for the file under the cursor (e.g. open the file)
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def next(execution_context: int | str | None = None, undo: bool | None = None):
-    """Move to next folder
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Make all paths to external files relative to current .blend"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def mouse_execute(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Perform the current execute action for the file under the cursor (e.g. open the file)"""
 
-def pack_all(execution_context: int | str | None = None, undo: bool | None = None):
-    """Pack all used external files into this .blend
+def next(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move to next folder"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def pack_all(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Pack all used external files into this .blend"""
 
 def pack_libraries(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Store all data-blocks linked from other .blend files in the current .blend file. Library references are preserved so the linked data-blocks can be unpacked again
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def parent(execution_context: int | str | None = None, undo: bool | None = None):
-    """Move to parent directory
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def previous(execution_context: int | str | None = None, undo: bool | None = None):
-    """Move to previous folder
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Store all data-blocks linked from other .blend files in the current .blend file. Library references are preserved so the linked data-blocks can be unpacked again"""
 
-def refresh(execution_context: int | str | None = None, undo: bool | None = None):
-    """Refresh the file list
+def parent(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move to parent directory"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def previous(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move to previous folder"""
 
-def rename(execution_context: int | str | None = None, undo: bool | None = None):
-    """Rename file or file directory
+def refresh(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Refresh the file list"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def rename(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Rename file or file directory"""
 
 def report_missing_files(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Report all missing external files
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def reset_recent(execution_context: int | str | None = None, undo: bool | None = None):
-    """Reset recent files
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Report all missing external files"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def reset_recent(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Reset recent files"""
 
 def select(
     execution_context: int | str | None = None,
@@ -440,6 +374,7 @@ def select(
     /,
     *,
     wait_to_deselect_others: bool | None = False,
+    use_select_on_click: bool | None = False,
     mouse_x: int | None = 0,
     mouse_y: int | None = 0,
     extend: bool | None = False,
@@ -448,29 +383,19 @@ def select(
     deselect_all: bool | None = False,
     only_activate_if_selected: bool | None = False,
     pass_through: bool | None = False,
-):
+) -> None:
     """Handle mouse clicks to select and activate items
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param wait_to_deselect_others: Wait to Deselect Others
-    :type wait_to_deselect_others: bool | None
+    :param use_select_on_click: Act on Click, Instead of selecting on mouse press, wait to see if theres drag event. Otherwise select on mouse release
     :param mouse_x: Mouse X
-    :type mouse_x: int | None
     :param mouse_y: Mouse Y
-    :type mouse_y: int | None
     :param extend: Extend, Extend selection instead of deselecting everything first
-    :type extend: bool | None
     :param fill: Fill, Select everything beginning with the last selection
-    :type fill: bool | None
     :param open: Open, Open a directory when selecting it
-    :type open: bool | None
     :param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
-    :type deselect_all: bool | None
     :param only_activate_if_selected: Only Activate if Selected, Do not change selection if the item under the cursor is already selected, only activate it
-    :type only_activate_if_selected: bool | None
     :param pass_through: Pass Through, Even on successful execution, pass the event on so other operators can execute on it as well
-    :type pass_through: bool | None
     """
 
 def select_all(
@@ -479,11 +404,9 @@ def select_all(
     /,
     *,
     action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
-):
+) -> None:
     """Select or deselect all files
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param action: Action, Selection action to execute
 
     TOGGLE
@@ -497,7 +420,6 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
 def select_bookmark(
@@ -506,13 +428,10 @@ def select_bookmark(
     /,
     *,
     dir: str = "",
-):
+) -> None:
     """Select a bookmarked directory
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param dir: Directory
-    :type dir: str
     """
 
 def select_box(
@@ -526,21 +445,14 @@ def select_box(
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
     mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
-):
+) -> None:
     """Activate/select the file(s) contained in the border
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param xmin: X Min
-        :type xmin: int | None
         :param xmax: X Max
-        :type xmax: int | None
         :param ymin: Y Min
-        :type ymin: int | None
         :param ymax: Y Max
-        :type ymax: int | None
         :param wait_for_input: Wait for Input
-        :type wait_for_input: bool | None
         :param mode: Mode
 
     SET
@@ -551,7 +463,6 @@ def select_box(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
 def select_walk(
@@ -562,41 +473,34 @@ def select_walk(
     direction: typing.Literal["UP", "DOWN", "LEFT", "RIGHT"] | None = "UP",
     extend: bool | None = False,
     fill: bool | None = False,
-):
+) -> None:
     """Select/Deselect files by walking through them
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param direction: Walk Direction, Select/Deselect element in this direction
-    :type direction: typing.Literal['UP','DOWN','LEFT','RIGHT'] | None
     :param extend: Extend, Extend selection instead of deselecting everything first
-    :type extend: bool | None
     :param fill: Fill, Select everything beginning with the last selection
-    :type fill: bool | None
     """
 
-def smoothscroll(execution_context: int | str | None = None, undo: bool | None = None):
-    """Smooth scroll to make editable file visible
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def smoothscroll(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Smooth scroll to make editable file visible"""
 
 def sort_column_ui_context(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Change sorting to use column under cursor
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def start_filter(execution_context: int | str | None = None, undo: bool | None = None):
-    """Start entering filter text
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Change sorting to use column under cursor"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def start_filter(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Start entering filter text"""
 
 def unpack_all(
     execution_context: int | str | None = None,
@@ -607,13 +511,10 @@ def unpack_all(
         "USE_LOCAL", "WRITE_LOCAL", "USE_ORIGINAL", "WRITE_ORIGINAL", "KEEP", "REMOVE"
     ]
     | None = "USE_LOCAL",
-):
+) -> None:
     """Unpack all files packed into this .blend to external ones
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param method: Method, How to unpack
-    :type method: typing.Literal['USE_LOCAL','WRITE_LOCAL','USE_ORIGINAL','WRITE_ORIGINAL','KEEP','REMOVE'] | None
     """
 
 def unpack_item(
@@ -625,31 +526,24 @@ def unpack_item(
     | None = "USE_LOCAL",
     id_name: str = "",
     id_type: int | None = 19785,
-):
+) -> None:
     """Unpack this file to an external file
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param method: Method, How to unpack
-    :type method: typing.Literal['USE_LOCAL','WRITE_LOCAL','USE_ORIGINAL','WRITE_ORIGINAL'] | None
     :param id_name: ID Name, Name of ID block to unpack
-    :type id_name: str
     :param id_type: ID Type, Identifier type of ID block
-    :type id_type: int | None
     """
 
 def unpack_libraries(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Restore all packed linked data-blocks to their original locations
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def view_selected(execution_context: int | str | None = None, undo: bool | None = None):
-    """Scroll the selected files into view
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Restore all packed linked data-blocks to their original locations"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def view_selected(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Scroll the selected files into view"""