fake-bpy-module 20240803__py3-none-any.whl → 20240805__py3-none-any.whl

bpy/ops/brush/__init__.pyi

@@ -11,7 +11,8 @@ def asset_activate(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    asset_library_type: str | None = "LOCAL",
+    asset_library_type: typing.Literal["ALL", "LOCAL", "ESSENTIALS", "CUSTOM"]
+    | None = "LOCAL",
     asset_library_identifier: str = "",
     relative_asset_identifier: str = "",
 ):
@@ -21,7 +22,7 @@ def asset_activate(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param asset_library_type: Asset Library Type
-    :type asset_library_type: str | None
+    :type asset_library_type: typing.Literal['ALL', 'LOCAL', 'ESSENTIALS', 'CUSTOM'] | None
     :param asset_library_identifier: Asset Library Identifier
     :type asset_library_identifier: str
     :param relative_asset_identifier: Relative Asset Identifier
@@ -96,7 +97,10 @@ def asset_load_preview(
     filemode: int | None = 9,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Choose a preview image for the brush
@@ -163,7 +167,7 @@ def asset_load_preview(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """
@@ -227,7 +231,8 @@ def curve_preset(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    shape: str | None = "SMOOTH",
+    shape: typing.Literal["SHARP", "SMOOTH", "MAX", "LINE", "ROUND", "ROOT"]
+    | None = "SMOOTH",
 ):
     """Set brush shape
 
@@ -235,7 +240,7 @@ def curve_preset(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param shape: Mode
-    :type shape: str | None
+    :type shape: typing.Literal['SHARP','SMOOTH','MAX','LINE','ROUND','ROOT'] | None
     """
 
     ...
@@ -263,7 +268,8 @@ def sculpt_curves_falloff_preset(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    shape: str | None = "SMOOTH",
+    shape: typing.Literal["SHARP", "SMOOTH", "MAX", "LINE", "ROUND", "ROOT"]
+    | None = "SMOOTH",
 ):
     """Set Curve Falloff Preset
 
@@ -271,7 +277,7 @@ def sculpt_curves_falloff_preset(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param shape: Mode
-    :type shape: str | None
+    :type shape: typing.Literal['SHARP','SMOOTH','MAX','LINE','ROUND','ROOT'] | None
     """
 
     ...
@@ -281,8 +287,8 @@ def stencil_control(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "TRANSLATION",
-    texmode: str | None = "PRIMARY",
+    mode: typing.Literal["TRANSLATION", "SCALE", "ROTATION"] | None = "TRANSLATION",
+    texmode: typing.Literal["PRIMARY", "SECONDARY"] | None = "PRIMARY",
 ):
     """Control the stencil brush
 
@@ -290,9 +296,9 @@ def stencil_control(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Tool
-    :type mode: str | None
+    :type mode: typing.Literal['TRANSLATION','SCALE','ROTATION'] | None
     :param texmode: Tool
-    :type texmode: str | None
+    :type texmode: typing.Literal['PRIMARY','SECONDARY'] | None
     """
 
     ...

bpy/ops/buttons/__init__.pyi

@@ -61,7 +61,10 @@ def directory_browse(
     filter_blenlib: bool | None = False,
     filemode: int | None = 9,
     relative_path: bool | None = True,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Open a directory browser, hold Shift to open the file, Alt to browse containing directory
@@ -126,7 +129,7 @@ def directory_browse(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """
@@ -160,7 +163,10 @@ def file_browse(
     filter_blenlib: bool | None = False,
     filemode: int | None = 9,
     relative_path: bool | None = True,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Open a file browser, hold Shift to open the file, Alt to browse containing directory
@@ -225,7 +231,7 @@ def file_browse(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """

bpy/ops/cachefile/__init__.pyi

@@ -33,7 +33,10 @@ def layer_add(
     filter_blenlib: bool | None = False,
     filemode: int | None = 8,
     relative_path: bool | None = True,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Add an override layer to the archive
@@ -98,7 +101,7 @@ def layer_add(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """
@@ -110,7 +113,7 @@ def layer_move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Move layer in the list, layers further down the list will overwrite data from the layers higher up
 
@@ -118,7 +121,7 @@ def layer_move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction, Direction to move the active vertex group towards
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -164,7 +167,10 @@ def open(
     filter_blenlib: bool | None = False,
     filemode: int | None = 8,
     relative_path: bool | None = True,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Load a cache file
@@ -229,7 +235,7 @@ def open(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """

bpy/ops/clip/__init__.pyi

@@ -184,7 +184,8 @@ def clean_tracks(
     *,
     frames: int | None = 0,
     error: float | None = 0.0,
-    action: str | None = "SELECT",
+    action: typing.Literal["SELECT", "DELETE_TRACK", "DELETE_SEGMENTS"]
+    | None = "SELECT",
 ):
     """Clean tracks with high error values or few frames
 
@@ -205,7 +206,7 @@ def clean_tracks(
 
     DELETE_SEGMENTS
     Delete Segments -- Delete unclean segments of tracks.
-        :type action: str | None
+        :type action: typing.Literal['SELECT','DELETE_TRACK','DELETE_SEGMENTS'] | None
     """
 
     ...
@@ -229,7 +230,7 @@ def clear_track_path(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "REMAINED",
+    action: typing.Literal["UPTO", "REMAINED", "ALL"] | None = "REMAINED",
     clear_active: bool | None = False,
 ):
     """Clear tracks after/before current position or clear the whole track
@@ -247,7 +248,7 @@ def clear_track_path(
 
     ALL
     Clear All -- Clear the whole path.
-        :type action: str | None
+        :type action: typing.Literal['UPTO','REMAINED','ALL'] | None
         :param clear_active: Clear Active, Clear active track only instead of all selected tracks
         :type clear_active: bool | None
     """
@@ -369,7 +370,8 @@ def detect_features(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    placement: str | None = "FRAME",
+    placement: typing.Literal["FRAME", "INSIDE_GPENCIL", "OUTSIDE_GPENCIL"]
+    | None = "FRAME",
     margin: int | None = 16,
     threshold: float | None = 0.5,
     min_distance: int | None = 120,
@@ -389,7 +391,7 @@ def detect_features(
 
     OUTSIDE_GPENCIL
     Outside Annotated Area -- Place markers only outside areas outlined with the Annotation tool.
-        :type placement: str | None
+        :type placement: typing.Literal['FRAME','INSIDE_GPENCIL','OUTSIDE_GPENCIL'] | None
         :param margin: Margin, Only features further than margin pixels from the image edges are considered
         :type margin: int | None
         :param threshold: Threshold, Threshold level to consider feature good enough for tracking
@@ -405,7 +407,7 @@ def disable_markers(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "DISABLE",
+    action: typing.Literal["DISABLE", "ENABLE", "TOGGLE"] | None = "DISABLE",
 ):
     """Disable/enable selected markers
 
@@ -422,7 +424,7 @@ def disable_markers(
 
     TOGGLE
     Toggle -- Toggle disabled flag for selected markers.
-        :type action: str | None
+        :type action: typing.Literal['DISABLE','ENABLE','TOGGLE'] | None
     """
 
     ...
@@ -485,7 +487,8 @@ def frame_jump(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    position: str | None = "PATHSTART",
+    position: typing.Literal["PATHSTART", "PATHEND", "FAILEDPREV", "FAILNEXT"]
+    | None = "PATHSTART",
 ):
     """Jump to special frame
 
@@ -505,7 +508,7 @@ def frame_jump(
 
     FAILNEXT
     Next Failed -- Jump to next failed frame.
-        :type position: str | None
+        :type position: typing.Literal['PATHSTART','PATHEND','FAILEDPREV','FAILNEXT'] | None
     """
 
     ...
@@ -561,7 +564,7 @@ def graph_disable_markers(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "DISABLE",
+    action: typing.Literal["DISABLE", "ENABLE", "TOGGLE"] | None = "DISABLE",
 ):
     """Disable/enable selected markers
 
@@ -578,7 +581,7 @@ def graph_disable_markers(
 
     TOGGLE
     Toggle -- Toggle disabled flag for selected markers.
-        :type action: str | None
+        :type action: typing.Literal['DISABLE','ENABLE','TOGGLE'] | None
     """
 
     ...
@@ -609,7 +612,7 @@ def graph_select_all_markers(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "TOGGLE",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
 ):
     """Change selection of all markers of active track
 
@@ -629,7 +632,7 @@ def graph_select_all_markers(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -777,7 +780,7 @@ def lock_tracks(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "LOCK",
+    action: typing.Literal["LOCK", "UNLOCK", "TOGGLE"] | None = "LOCK",
 ):
     """Lock/unlock selected tracks
 
@@ -794,7 +797,7 @@ def lock_tracks(
 
     TOGGLE
     Toggle -- Toggle locked flag for selected tracks.
-        :type action: str | None
+        :type action: typing.Literal['LOCK','UNLOCK','TOGGLE'] | None
     """
 
     ...
@@ -804,7 +807,7 @@ def mode_set(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "TRACKING",
+    mode: typing.Literal["TRACKING", "MASK"] | None = "TRACKING",
 ):
     """Set the clip interaction mode
 
@@ -812,7 +815,7 @@ def mode_set(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['TRACKING', 'MASK'] | None
     """
 
     ...
@@ -862,8 +865,18 @@ def open(
     relative_path: bool | None = True,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
-    sort_method: str | None = "",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
+    sort_method: typing.Literal[
+        "DEFAULT",
+        "FILE_SORT_ALPHA",
+        "FILE_SORT_EXTENSION",
+        "FILE_SORT_TIME",
+        "FILE_SORT_SIZE",
+    ]
+    | None = "",
 ):
     """Load a sequence of frames or a movie file
 
@@ -933,7 +946,7 @@ def open(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
 
     DEFAULT
@@ -950,7 +963,7 @@ def open(
 
     FILE_SORT_SIZE
     Size -- Sort files by size.
-        :type sort_method: str | None
+        :type sort_method: typing.Literal['DEFAULT','FILE_SORT_ALPHA','FILE_SORT_EXTENSION','FILE_SORT_TIME','FILE_SORT_SIZE'] | None
     """
 
     ...
@@ -1058,7 +1071,7 @@ def select_all(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "TOGGLE",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
 ):
     """Change selection of all tracking markers
 
@@ -1078,7 +1091,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -1093,7 +1106,7 @@ def select_box(
     ymin: int | None = 0,
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
 ):
     """Select markers using box selection
 
@@ -1120,7 +1133,7 @@ def select_box(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -1134,7 +1147,7 @@ def select_circle(
     y: int | None = 0,
     radius: int | None = 25,
     wait_for_input: bool | None = True,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
 ):
     """Select markers using circle selection
 
@@ -1159,7 +1172,7 @@ def select_circle(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -1169,7 +1182,10 @@ def select_grouped(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    group: str | None = "ESTIMATED",
+    group: typing.Literal[
+        "KEYFRAMED", "ESTIMATED", "TRACKED", "LOCKED", "DISABLED", "COLOR", "FAILED"
+    ]
+    | None = "ESTIMATED",
 ):
     """Select all tracks from specified group
 
@@ -1198,7 +1214,7 @@ def select_grouped(
 
     FAILED
     Failed Tracks -- Select all tracks which failed to be reconstructed.
-        :type group: str | None
+        :type group: typing.Literal['KEYFRAMED','ESTIMATED','TRACKED','LOCKED','DISABLED','COLOR','FAILED'] | None
     """
 
     ...
@@ -1212,7 +1228,7 @@ def select_lasso(
     use_smooth_stroke: bool | None = False,
     smooth_stroke_factor: float | None = 0.75,
     smooth_stroke_radius: int | None = 35,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
 ):
     """Select markers using lasso selection
 
@@ -1237,7 +1253,7 @@ def select_lasso(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -1261,7 +1277,7 @@ def set_axis(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    axis: str | None = "X",
+    axis: typing.Literal["X", "Y"] | None = "X",
 ):
     """Set the direction of a scene axis by rotating the camera (or its parent if present). This assumes that the selected track lies on a real axis connecting it to the origin
 
@@ -1275,7 +1291,7 @@ def set_axis(
 
     Y
     Y -- Align bundle align Y axis.
-        :type axis: str | None
+        :type axis: typing.Literal['X','Y'] | None
     """
 
     ...
@@ -1303,7 +1319,7 @@ def set_plane(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    plane: str | None = "FLOOR",
+    plane: typing.Literal["FLOOR", "WALL"] | None = "FLOOR",
 ):
     """Set plane based on 3 selected bundles by moving camera (or its parent if present) in 3D space
 
@@ -1317,7 +1333,7 @@ def set_plane(
 
     WALL
     Wall -- Set wall plane.
-        :type plane: str | None
+        :type plane: typing.Literal['FLOOR','WALL'] | None
     """
 
     ...
@@ -1377,7 +1393,7 @@ def set_solver_keyframe(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    keyframe: str | None = "KEYFRAME_A",
+    keyframe: typing.Literal["KEYFRAME_A", "KEYFRAME_B"] | None = "KEYFRAME_A",
 ):
     """Set keyframe used by solver
 
@@ -1385,7 +1401,7 @@ def set_solver_keyframe(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param keyframe: Keyframe, Keyframe to set
-    :type keyframe: str | None
+    :type keyframe: typing.Literal['KEYFRAME_A','KEYFRAME_B'] | None
     """
 
     ...

bpy/ops/console/__init__.pyi

@@ -106,7 +106,10 @@ def delete(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "NEXT_CHARACTER",
+    type: typing.Literal[
+        "NEXT_CHARACTER", "PREVIOUS_CHARACTER", "NEXT_WORD", "PREVIOUS_WORD"
+    ]
+    | None = "NEXT_CHARACTER",
 ):
     """Delete text by cursor position
 
@@ -114,7 +117,7 @@ def delete(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type, Which part of the text to delete
-    :type type: str | None
+    :type type: typing.Literal['NEXT_CHARACTER','PREVIOUS_CHARACTER','NEXT_WORD','PREVIOUS_WORD'] | None
     """
 
     ...
@@ -248,7 +251,15 @@ def move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "LINE_BEGIN",
+    type: typing.Literal[
+        "LINE_BEGIN",
+        "LINE_END",
+        "PREVIOUS_CHARACTER",
+        "NEXT_CHARACTER",
+        "PREVIOUS_WORD",
+        "NEXT_WORD",
+    ]
+    | None = "LINE_BEGIN",
     select: bool | None = False,
 ):
     """Move cursor position
@@ -257,7 +268,7 @@ def move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type, Where to move cursor to
-    :type type: str | None
+    :type type: typing.Literal['LINE_BEGIN','LINE_END','PREVIOUS_CHARACTER','NEXT_CHARACTER','PREVIOUS_WORD','NEXT_WORD'] | None
     :param select: Select, Whether to select while moving
     :type select: bool | None
     """
@@ -288,7 +299,7 @@ def scrollback_append(
     undo: bool | None = None,
     *,
     text: str = "",
-    type: str | None = "OUTPUT",
+    type: typing.Literal["OUTPUT", "INPUT", "INFO", "ERROR"] | None = "OUTPUT",
 ):
     """Append scrollback text by type
 
@@ -298,7 +309,7 @@ def scrollback_append(
     :param text: Text, Text to insert at the cursor position
     :type text: str
     :param type: Type, Console output type
-    :type type: str | None
+    :type type: typing.Literal['OUTPUT','INPUT','INFO','ERROR'] | None
     """
 
     ...