fake-bpy-module 20240802__py3-none-any.whl → 20240804__py3-none-any.whl

bpy/ops/pose/__init__.pyi

@@ -29,7 +29,7 @@ def autoside_names(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    axis: str | None = "XAXIS",
+    axis: typing.Literal["XAXIS", "YAXIS", "ZAXIS"] | None = "XAXIS",
 ):
     """Automatically renames the selected bones according to which side of the target axis they fall on
 
@@ -46,7 +46,7 @@ def autoside_names(
 
     ZAXIS
     Z-Axis -- Top/Bottom.
-        :type axis: str | None
+        :type axis: typing.Literal['XAXIS','YAXIS','ZAXIS'] | None
     """
 
     ...
@@ -59,8 +59,9 @@ def blend_to_neighbor(
     factor: float | None = 0.5,
     prev_frame: int | None = 0,
     next_frame: int | None = 0,
-    channels: str | None = "ALL",
-    axis_lock: str | None = "FREE",
+    channels: typing.Literal["ALL", "LOC", "ROT", "SIZE", "BBONE", "CUSTOM"]
+    | None = "ALL",
+    axis_lock: typing.Literal["FREE", "X", "Y", "Z"] | None = "FREE",
 ):
     """Blend from current position to previous or next keyframe
 
@@ -92,7 +93,7 @@ def blend_to_neighbor(
 
     CUSTOM
     Custom Properties -- Custom properties.
-        :type channels: str | None
+        :type channels: typing.Literal['ALL','LOC','ROT','SIZE','BBONE','CUSTOM'] | None
         :param axis_lock: Axis Lock, Transform axis to restrict effects to
 
     FREE
@@ -106,7 +107,7 @@ def blend_to_neighbor(
 
     Z
     Z -- Only Z-axis transforms are affected.
-        :type axis_lock: str | None
+        :type axis_lock: typing.Literal['FREE','X','Y','Z'] | None
     """
 
     ...
@@ -119,8 +120,9 @@ def blend_with_rest(
     factor: float | None = 0.5,
     prev_frame: int | None = 0,
     next_frame: int | None = 0,
-    channels: str | None = "ALL",
-    axis_lock: str | None = "FREE",
+    channels: typing.Literal["ALL", "LOC", "ROT", "SIZE", "BBONE", "CUSTOM"]
+    | None = "ALL",
+    axis_lock: typing.Literal["FREE", "X", "Y", "Z"] | None = "FREE",
 ):
     """Make the current pose more similar to, or further away from, the rest pose
 
@@ -152,7 +154,7 @@ def blend_with_rest(
 
     CUSTOM
     Custom Properties -- Custom properties.
-        :type channels: str | None
+        :type channels: typing.Literal['ALL','LOC','ROT','SIZE','BBONE','CUSTOM'] | None
         :param axis_lock: Axis Lock, Transform axis to restrict effects to
 
     FREE
@@ -166,7 +168,7 @@ def blend_with_rest(
 
     Z
     Z -- Only Z-axis transforms are affected.
-        :type axis_lock: str | None
+        :type axis_lock: typing.Literal['FREE','X','Y','Z'] | None
     """
 
     ...
@@ -179,8 +181,9 @@ def breakdown(
     factor: float | None = 0.5,
     prev_frame: int | None = 0,
     next_frame: int | None = 0,
-    channels: str | None = "ALL",
-    axis_lock: str | None = "FREE",
+    channels: typing.Literal["ALL", "LOC", "ROT", "SIZE", "BBONE", "CUSTOM"]
+    | None = "ALL",
+    axis_lock: typing.Literal["FREE", "X", "Y", "Z"] | None = "FREE",
 ):
     """Create a suitable breakdown pose on the current frame
 
@@ -212,7 +215,7 @@ def breakdown(
 
     CUSTOM
     Custom Properties -- Custom properties.
-        :type channels: str | None
+        :type channels: typing.Literal['ALL','LOC','ROT','SIZE','BBONE','CUSTOM'] | None
         :param axis_lock: Axis Lock, Transform axis to restrict effects to
 
     FREE
@@ -226,7 +229,7 @@ def breakdown(
 
     Z
     Z -- Only Z-axis transforms are affected.
-        :type axis_lock: str | None
+        :type axis_lock: typing.Literal['FREE','X','Y','Z'] | None
     """
 
     ...
@@ -236,7 +239,37 @@ def constraint_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "",
+    type: typing.Literal[
+        "CAMERA_SOLVER",
+        "FOLLOW_TRACK",
+        "OBJECT_SOLVER",
+        "COPY_LOCATION",
+        "COPY_ROTATION",
+        "COPY_SCALE",
+        "COPY_TRANSFORMS",
+        "LIMIT_DISTANCE",
+        "LIMIT_LOCATION",
+        "LIMIT_ROTATION",
+        "LIMIT_SCALE",
+        "MAINTAIN_VOLUME",
+        "TRANSFORM",
+        "TRANSFORM_CACHE",
+        "CLAMP_TO",
+        "DAMPED_TRACK",
+        "IK",
+        "LOCKED_TRACK",
+        "SPLINE_IK",
+        "STRETCH_TO",
+        "TRACK_TO",
+        "ACTION",
+        "ARMATURE",
+        "CHILD_OF",
+        "FLOOR",
+        "FOLLOW_PATH",
+        "PIVOT",
+        "SHRINKWRAP",
+    ]
+    | None = "",
 ):
     """Add a constraint to the active bone
 
@@ -244,7 +277,7 @@ def constraint_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['CAMERA_SOLVER', 'FOLLOW_TRACK', 'OBJECT_SOLVER', 'COPY_LOCATION', 'COPY_ROTATION', 'COPY_SCALE', 'COPY_TRANSFORMS', 'LIMIT_DISTANCE', 'LIMIT_LOCATION', 'LIMIT_ROTATION', 'LIMIT_SCALE', 'MAINTAIN_VOLUME', 'TRANSFORM', 'TRANSFORM_CACHE', 'CLAMP_TO', 'DAMPED_TRACK', 'IK', 'LOCKED_TRACK', 'SPLINE_IK', 'STRETCH_TO', 'TRACK_TO', 'ACTION', 'ARMATURE', 'CHILD_OF', 'FLOOR', 'FOLLOW_PATH', 'PIVOT', 'SHRINKWRAP'] | None
     """
 
     ...
@@ -254,7 +287,37 @@ def constraint_add_with_targets(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "",
+    type: typing.Literal[
+        "CAMERA_SOLVER",
+        "FOLLOW_TRACK",
+        "OBJECT_SOLVER",
+        "COPY_LOCATION",
+        "COPY_ROTATION",
+        "COPY_SCALE",
+        "COPY_TRANSFORMS",
+        "LIMIT_DISTANCE",
+        "LIMIT_LOCATION",
+        "LIMIT_ROTATION",
+        "LIMIT_SCALE",
+        "MAINTAIN_VOLUME",
+        "TRANSFORM",
+        "TRANSFORM_CACHE",
+        "CLAMP_TO",
+        "DAMPED_TRACK",
+        "IK",
+        "LOCKED_TRACK",
+        "SPLINE_IK",
+        "STRETCH_TO",
+        "TRACK_TO",
+        "ACTION",
+        "ARMATURE",
+        "CHILD_OF",
+        "FLOOR",
+        "FOLLOW_PATH",
+        "PIVOT",
+        "SHRINKWRAP",
+    ]
+    | None = "",
 ):
     """Add a constraint to the active bone, with target (where applicable) set to the selected Objects/Bones
 
@@ -262,7 +325,7 @@ def constraint_add_with_targets(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['CAMERA_SOLVER', 'FOLLOW_TRACK', 'OBJECT_SOLVER', 'COPY_LOCATION', 'COPY_ROTATION', 'COPY_SCALE', 'COPY_TRANSFORMS', 'LIMIT_DISTANCE', 'LIMIT_LOCATION', 'LIMIT_ROTATION', 'LIMIT_SCALE', 'MAINTAIN_VOLUME', 'TRANSFORM', 'TRANSFORM_CACHE', 'CLAMP_TO', 'DAMPED_TRACK', 'IK', 'LOCKED_TRACK', 'SPLINE_IK', 'STRETCH_TO', 'TRACK_TO', 'ACTION', 'ARMATURE', 'CHILD_OF', 'FLOOR', 'FOLLOW_PATH', 'PIVOT', 'SHRINKWRAP'] | None
     """
 
     ...
@@ -417,9 +480,10 @@ def paths_calculate(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    display_type: str | None = "RANGE",
-    range: str | None = "SCENE",
-    bake_location: str | None = "HEADS",
+    display_type: typing.Literal["CURRENT_FRAME", "RANGE"] | None = "RANGE",
+    range: typing.Literal["KEYS_ALL", "KEYS_SELECTED", "SCENE", "MANUAL"]
+    | None = "SCENE",
+    bake_location: typing.Literal["HEADS", "TAILS"] | None = "HEADS",
 ):
     """Calculate paths for the selected bones
 
@@ -427,11 +491,11 @@ def paths_calculate(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param display_type: Display type
-    :type display_type: str | None
+    :type display_type: typing.Literal['CURRENT_FRAME', 'RANGE'] | None
     :param range: Computation Range
-    :type range: str | None
+    :type range: typing.Literal['KEYS_ALL', 'KEYS_SELECTED', 'SCENE', 'MANUAL'] | None
     :param bake_location: Bake Location, Which point on the bones is used when calculating paths
-    :type bake_location: str | None
+    :type bake_location: typing.Literal['HEADS', 'TAILS'] | None
     """
 
     ...
@@ -487,7 +551,15 @@ def propagate(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "NEXT_KEY",
+    mode: typing.Literal[
+        "NEXT_KEY",
+        "LAST_KEY",
+        "BEFORE_FRAME",
+        "BEFORE_END",
+        "SELECTED_KEYS",
+        "SELECTED_MARKERS",
+    ]
+    | None = "NEXT_KEY",
     end_frame: float | None = 250.0,
 ):
     """Copy selected aspects of the current pose to subsequent poses already keyframed
@@ -514,7 +586,7 @@ def propagate(
 
     SELECTED_MARKERS
     On Selected Markers -- Propagate pose to all keyframes occurring on frames with Scene Markers after the current frame.
-        :type mode: str | None
+        :type mode: typing.Literal['NEXT_KEY','LAST_KEY','BEFORE_FRAME','BEFORE_END','SELECTED_KEYS','SELECTED_MARKERS'] | None
         :param end_frame: End Frame, Frame to stop propagating frames to (for 'Before Frame' mode)
         :type end_frame: float | None
     """
@@ -529,8 +601,9 @@ def push(
     factor: float | None = 0.5,
     prev_frame: int | None = 0,
     next_frame: int | None = 0,
-    channels: str | None = "ALL",
-    axis_lock: str | None = "FREE",
+    channels: typing.Literal["ALL", "LOC", "ROT", "SIZE", "BBONE", "CUSTOM"]
+    | None = "ALL",
+    axis_lock: typing.Literal["FREE", "X", "Y", "Z"] | None = "FREE",
 ):
     """Exaggerate the current pose in regards to the breakdown pose
 
@@ -562,7 +635,7 @@ def push(
 
     CUSTOM
     Custom Properties -- Custom properties.
-        :type channels: str | None
+        :type channels: typing.Literal['ALL','LOC','ROT','SIZE','BBONE','CUSTOM'] | None
         :param axis_lock: Axis Lock, Transform axis to restrict effects to
 
     FREE
@@ -576,7 +649,7 @@ def push(
 
     Z
     Z -- Only Z-axis transforms are affected.
-        :type axis_lock: str | None
+        :type axis_lock: typing.Literal['FREE','X','Y','Z'] | None
     """
 
     ...
@@ -603,8 +676,9 @@ def relax(
     factor: float | None = 0.5,
     prev_frame: int | None = 0,
     next_frame: int | None = 0,
-    channels: str | None = "ALL",
-    axis_lock: str | None = "FREE",
+    channels: typing.Literal["ALL", "LOC", "ROT", "SIZE", "BBONE", "CUSTOM"]
+    | None = "ALL",
+    axis_lock: typing.Literal["FREE", "X", "Y", "Z"] | None = "FREE",
 ):
     """Make the current pose more similar to its breakdown pose
 
@@ -636,7 +710,7 @@ def relax(
 
     CUSTOM
     Custom Properties -- Custom properties.
-        :type channels: str | None
+        :type channels: typing.Literal['ALL','LOC','ROT','SIZE','BBONE','CUSTOM'] | None
         :param axis_lock: Axis Lock, Transform axis to restrict effects to
 
     FREE
@@ -650,7 +724,7 @@ def relax(
 
     Z
     Z -- Only Z-axis transforms are affected.
-        :type axis_lock: str | None
+        :type axis_lock: typing.Literal['FREE','X','Y','Z'] | None
     """
 
     ...
@@ -692,7 +766,10 @@ def rotation_mode_set(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "QUATERNION",
+    type: typing.Literal[
+        "QUATERNION", "XYZ", "XZY", "YXZ", "YZX", "ZXY", "ZYX", "AXIS_ANGLE"
+    ]
+    | None = "QUATERNION",
 ):
     """Set the rotation representation used by selected bones
 
@@ -700,7 +777,7 @@ def rotation_mode_set(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Rotation Mode
-    :type type: str | None
+    :type type: typing.Literal['QUATERNION', 'XYZ', 'XZY', 'YXZ', 'YZX', 'ZXY', 'ZYX', 'AXIS_ANGLE'] | None
     """
 
     ...
@@ -724,7 +801,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",
 ):
     """Toggle selection status of all bones
 
@@ -744,7 +821,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -769,7 +846,7 @@ def select_grouped(
     undo: bool | None = None,
     *,
     extend: bool | None = False,
-    type: str | None = "COLLECTION",
+    type: typing.Literal["COLLECTION", "COLOR", "KEYINGSET"] | None = "COLLECTION",
 ):
     """Select all visible bones grouped by similar properties
 
@@ -788,7 +865,7 @@ def select_grouped(
 
     KEYINGSET
     Keying Set -- All bones affected by active Keying Set.
-        :type type: str | None
+        :type type: typing.Literal['COLLECTION','COLOR','KEYINGSET'] | None
     """
 
     ...
@@ -798,7 +875,7 @@ def select_hierarchy(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "PARENT",
+    direction: typing.Literal["PARENT", "CHILD"] | None = "PARENT",
     extend: bool | None = False,
 ):
     """Select immediate parent/children of selected bones
@@ -807,7 +884,7 @@ def select_hierarchy(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction
-    :type direction: str | None
+    :type direction: typing.Literal['PARENT','CHILD'] | None
     :param extend: Extend, Extend the selection
     :type extend: bool | None
     """
@@ -970,7 +1047,7 @@ def selection_set_move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Move the active Selection Set up/down the list of sets
 
@@ -978,7 +1055,7 @@ def selection_set_move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Move Direction, Direction to move the active Selection Set: UP (default) or DOWN
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...

bpy/ops/preferences/__init__.pyi

@@ -199,7 +199,10 @@ def asset_library_add(
     filter_folder: bool | None = True,
     filter_blenlib: bool | None = False,
     filemode: int | None = 9,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Add a directory to be used by the Asset Browser as source of assets
@@ -262,7 +265,7 @@ def asset_library_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
     """
@@ -359,7 +362,7 @@ def extension_repo_add(
     use_sync_on_startup: bool | None = False,
     use_custom_directory: bool | None = False,
     custom_directory: str = "",
-    type: str | None = "REMOTE",
+    type: typing.Literal["REMOTE", "LOCAL"] | None = "REMOTE",
 ):
     """Add a new repository used to store extensions
 
@@ -387,7 +390,7 @@ def extension_repo_add(
 
     LOCAL
     Add Local Repository -- Add a repository managed manually without referencing an external repository.
-        :type type: str | None
+        :type type: typing.Literal['REMOTE','LOCAL'] | None
     """
 
     ...
@@ -686,7 +689,7 @@ def studiolight_install(
     directory: str = "",
     filter_folder: bool | None = True,
     filter_glob: str = "*.png;*.jpg;*.hdr;*.exr",
-    type: str | None = "MATCAP",
+    type: typing.Literal["MATCAP", "WORLD", "STUDIO"] | None = "MATCAP",
 ):
     """Install a user defined light
 
@@ -711,7 +714,7 @@ def studiolight_install(
 
     STUDIO
     Studio -- Install custom Studio Lights.
-        :type type: str | None
+        :type type: typing.Literal['MATCAP','WORLD','STUDIO'] | None
     """
 
     ...

bpy/ops/render/__init__.pyi

@@ -253,7 +253,8 @@ def shutter_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 shutter curve
 
@@ -261,7 +262,7 @@ def shutter_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
     """
 
     ...

bpy/ops/rigidbody/__init__.pyi

@@ -35,9 +35,20 @@ def connect(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    con_type: str | None = "FIXED",
-    pivot_type: str | None = "CENTER",
-    connection_pattern: str | None = "SELECTED_TO_ACTIVE",
+    con_type: typing.Literal[
+        "FIXED",
+        "POINT",
+        "HINGE",
+        "SLIDER",
+        "PISTON",
+        "GENERIC",
+        "GENERIC_SPRING",
+        "MOTOR",
+    ]
+    | None = "FIXED",
+    pivot_type: typing.Literal["CENTER", "ACTIVE", "SELECTED"] | None = "CENTER",
+    connection_pattern: typing.Literal["SELECTED_TO_ACTIVE", "CHAIN_DISTANCE"]
+    | None = "SELECTED_TO_ACTIVE",
 ):
     """Create rigid body constraints between selected rigid bodies
 
@@ -69,7 +80,7 @@ def connect(
 
     MOTOR
     Motor -- Drive rigid body around or along an axis.
-        :type con_type: str | None
+        :type con_type: typing.Literal['FIXED','POINT','HINGE','SLIDER','PISTON','GENERIC','GENERIC_SPRING','MOTOR'] | None
         :param pivot_type: Location, Constraint pivot location
 
     CENTER
@@ -80,7 +91,7 @@ def connect(
 
     SELECTED
     Selected -- Pivot location is at the selected object position.
-        :type pivot_type: str | None
+        :type pivot_type: typing.Literal['CENTER','ACTIVE','SELECTED'] | None
         :param connection_pattern: Connection Pattern, Pattern used to connect objects
 
     SELECTED_TO_ACTIVE
@@ -88,7 +99,7 @@ def connect(
 
     CHAIN_DISTANCE
     Chain by Distance -- Connect objects as a chain based on distance, starting at the active object.
-        :type connection_pattern: str | None
+        :type connection_pattern: typing.Literal['SELECTED_TO_ACTIVE','CHAIN_DISTANCE'] | None
     """
 
     ...
@@ -98,7 +109,17 @@ def constraint_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "FIXED",
+    type: typing.Literal[
+        "FIXED",
+        "POINT",
+        "HINGE",
+        "SLIDER",
+        "PISTON",
+        "GENERIC",
+        "GENERIC_SPRING",
+        "MOTOR",
+    ]
+    | None = "FIXED",
 ):
     """Add Rigid Body Constraint to active object
 
@@ -106,7 +127,7 @@ def constraint_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Rigid Body Constraint Type
-    :type type: str | None
+    :type type: typing.Literal['FIXED', 'POINT', 'HINGE', 'SLIDER', 'PISTON', 'GENERIC', 'GENERIC_SPRING', 'MOTOR'] | None
     """
 
     ...
@@ -151,7 +172,7 @@ def object_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ACTIVE",
+    type: typing.Literal["ACTIVE", "PASSIVE"] | None = "ACTIVE",
 ):
     """Add active object as Rigid Body
 
@@ -159,7 +180,7 @@ def object_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Rigid Body Type
-    :type type: str | None
+    :type type: typing.Literal['ACTIVE', 'PASSIVE'] | None
     """
 
     ...
@@ -197,7 +218,7 @@ def objects_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ACTIVE",
+    type: typing.Literal["ACTIVE", "PASSIVE"] | None = "ACTIVE",
 ):
     """Add selected objects as Rigid Bodies
 
@@ -205,7 +226,7 @@ def objects_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Rigid Body Type
-    :type type: str | None
+    :type type: typing.Literal['ACTIVE', 'PASSIVE'] | None
     """
 
     ...
@@ -229,7 +250,17 @@ def shape_change(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "MESH",
+    type: typing.Literal[
+        "BOX",
+        "SPHERE",
+        "CAPSULE",
+        "CYLINDER",
+        "CONE",
+        "CONVEX_HULL",
+        "MESH",
+        "COMPOUND",
+    ]
+    | None = "MESH",
 ):
     """Change collision shapes for selected Rigid Body Objects
 
@@ -237,7 +268,7 @@ def shape_change(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Rigid Body Shape
-    :type type: str | None
+    :type type: typing.Literal['BOX', 'SPHERE', 'CAPSULE', 'CYLINDER', 'CONE', 'CONVEX_HULL', 'MESH', 'COMPOUND'] | None
     """
 
     ...