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

bpy/ops/paint/__init__.pyi

@@ -26,17 +26,26 @@ def add_texture_paint_slot(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "BASE_COLOR",
-    slot_type: str | None = "IMAGE",
+    type: typing.Literal[
+        "BASE_COLOR",
+        "SPECULAR",
+        "ROUGHNESS",
+        "METALLIC",
+        "NORMAL",
+        "BUMP",
+        "DISPLACEMENT",
+    ]
+    | None = "BASE_COLOR",
+    slot_type: typing.Literal["IMAGE", "COLOR_ATTRIBUTE"] | None = "IMAGE",
     name: str = "Untitled",
     color: collections.abc.Iterable[float] | None = (0.0, 0.0, 0.0, 1.0),
     width: int | None = 1024,
     height: int | None = 1024,
     alpha: bool | None = True,
-    generated_type: str | None = "BLANK",
+    generated_type: typing.Literal["BLANK", "UV_GRID", "COLOR_GRID"] | None = "BLANK",
     float: bool | None = False,
-    domain: str | None = "POINT",
-    data_type: str | None = "FLOAT_COLOR",
+    domain: typing.Literal["POINT", "CORNER"] | None = "POINT",
+    data_type: typing.Literal["FLOAT_COLOR", "BYTE_COLOR"] | None = "FLOAT_COLOR",
 ):
     """Add a paint slot
 
@@ -44,9 +53,9 @@ def add_texture_paint_slot(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Material Layer Type, Material layer type of new paint slot
-    :type type: str | None
+    :type type: typing.Literal['BASE_COLOR','SPECULAR','ROUGHNESS','METALLIC','NORMAL','BUMP','DISPLACEMENT'] | None
     :param slot_type: Slot Type, Type of new paint slot
-    :type slot_type: str | None
+    :type slot_type: typing.Literal['IMAGE','COLOR_ATTRIBUTE'] | None
     :param name: Name, Name for new paint slot source
     :type name: str
     :param color: Color, Default fill color
@@ -58,13 +67,13 @@ def add_texture_paint_slot(
     :param alpha: Alpha, Create an image with an alpha channel
     :type alpha: bool | None
     :param generated_type: Generated Type, Fill the image with a grid for UV map testing
-    :type generated_type: str | None
+    :type generated_type: typing.Literal['BLANK', 'UV_GRID', 'COLOR_GRID'] | None
     :param float: 32-bit Float, Create image with 32-bit floating-point bit depth
     :type float: bool | None
     :param domain: Domain, Type of element that attribute is stored on
-    :type domain: str | None
+    :type domain: typing.Literal['POINT', 'CORNER'] | None
     :param data_type: Data Type, Type of data stored in attribute
-    :type data_type: str | None
+    :type data_type: typing.Literal['FLOAT_COLOR', 'BYTE_COLOR'] | None
     """
 
     ...
@@ -88,7 +97,7 @@ def face_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 for all faces
 
@@ -108,7 +117,7 @@ def face_select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -266,8 +275,8 @@ def hide_show(
     ymin: int | None = 0,
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
-    action: str | None = "HIDE",
-    area: str | None = "Inside",
+    action: typing.Literal["HIDE", "SHOW"] | None = "HIDE",
+    area: typing.Literal["OUTSIDE", "Inside"] | None = "Inside",
     use_front_faces_only: bool | None = False,
 ):
     """Hide/show some vertices
@@ -292,7 +301,7 @@ def hide_show(
 
     SHOW
     Show -- Show vertices.
-        :type action: str | None
+        :type action: typing.Literal['HIDE','SHOW'] | None
         :param area: Visibility Area, Which vertices to hide or show
 
     OUTSIDE
@@ -300,7 +309,7 @@ def hide_show(
 
     Inside
     Inside -- Hide or show vertices inside the selection.
-        :type area: str | None
+        :type area: typing.Literal['OUTSIDE','Inside'] | None
         :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
         :type use_front_faces_only: bool | None
     """
@@ -312,7 +321,7 @@ def hide_show_all(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "HIDE",
+    action: typing.Literal["HIDE", "SHOW"] | None = "HIDE",
 ):
     """Hide/show all vertices
 
@@ -326,7 +335,7 @@ def hide_show_all(
 
     SHOW
     Show -- Show vertices.
-        :type action: str | None
+        :type action: typing.Literal['HIDE','SHOW'] | None
     """
 
     ...
@@ -340,8 +349,8 @@ def hide_show_lasso_gesture(
     use_smooth_stroke: bool | None = False,
     smooth_stroke_factor: float | None = 0.75,
     smooth_stroke_radius: int | None = 35,
-    action: str | None = "HIDE",
-    area: str | None = "Inside",
+    action: typing.Literal["HIDE", "SHOW"] | None = "HIDE",
+    area: typing.Literal["OUTSIDE", "Inside"] | None = "Inside",
     use_front_faces_only: bool | None = False,
 ):
     """Hide/show some vertices
@@ -364,7 +373,7 @@ def hide_show_lasso_gesture(
 
     SHOW
     Show -- Show vertices.
-        :type action: str | None
+        :type action: typing.Literal['HIDE','SHOW'] | None
         :param area: Visibility Area, Which vertices to hide or show
 
     OUTSIDE
@@ -372,7 +381,7 @@ def hide_show_lasso_gesture(
 
     Inside
     Inside -- Hide or show vertices inside the selection.
-        :type area: str | None
+        :type area: typing.Literal['OUTSIDE','Inside'] | None
         :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
         :type use_front_faces_only: bool | None
     """
@@ -390,8 +399,8 @@ def hide_show_line_gesture(
     yend: int | None = 0,
     flip: bool | None = False,
     cursor: int | None = 5,
-    action: str | None = "HIDE",
-    area: str | None = "Inside",
+    action: typing.Literal["HIDE", "SHOW"] | None = "HIDE",
+    area: typing.Literal["OUTSIDE", "Inside"] | None = "Inside",
     use_front_faces_only: bool | None = False,
     use_limit_to_segment: bool | None = False,
 ):
@@ -419,7 +428,7 @@ def hide_show_line_gesture(
 
     SHOW
     Show -- Show vertices.
-        :type action: str | None
+        :type action: typing.Literal['HIDE','SHOW'] | None
         :param area: Visibility Area, Which vertices to hide or show
 
     OUTSIDE
@@ -427,7 +436,7 @@ def hide_show_line_gesture(
 
     Inside
     Inside -- Hide or show vertices inside the selection.
-        :type area: str | None
+        :type area: typing.Literal['OUTSIDE','Inside'] | None
         :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
         :type use_front_faces_only: bool | None
         :param use_limit_to_segment: Limit to Segment, Apply the gesture action only to the area that is contained within the segment without extending its effect to the entire line
@@ -441,7 +450,7 @@ def hide_show_masked(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "HIDE",
+    action: typing.Literal["HIDE", "SHOW"] | None = "HIDE",
 ):
     """Hide/show all masked vertices above a threshold
 
@@ -455,7 +464,7 @@ def hide_show_masked(
 
     SHOW
     Show -- Show vertices.
-        :type action: str | None
+        :type action: typing.Literal['HIDE','SHOW'] | None
     """
 
     ...
@@ -466,8 +475,8 @@ def hide_show_polyline_gesture(
     undo: bool | None = None,
     *,
     path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None = None,
-    action: str | None = "HIDE",
-    area: str | None = "Inside",
+    action: typing.Literal["HIDE", "SHOW"] | None = "HIDE",
+    area: typing.Literal["OUTSIDE", "Inside"] | None = "Inside",
     use_front_faces_only: bool | None = False,
 ):
     """Hide/show some vertices
@@ -484,7 +493,7 @@ def hide_show_polyline_gesture(
 
     SHOW
     Show -- Show vertices.
-        :type action: str | None
+        :type action: typing.Literal['HIDE','SHOW'] | None
         :param area: Visibility Area, Which vertices to hide or show
 
     OUTSIDE
@@ -492,7 +501,7 @@ def hide_show_polyline_gesture(
 
     Inside
     Inside -- Hide or show vertices inside the selection.
-        :type area: str | None
+        :type area: typing.Literal['OUTSIDE','Inside'] | None
         :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
         :type use_front_faces_only: bool | None
     """
@@ -524,7 +533,7 @@ def image_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: str | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
 ):
     """Paint a stroke into the image
 
@@ -546,7 +555,7 @@ def image_paint(
 
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
-        :type mode: str | None
+        :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
     """
 
     ...
@@ -562,7 +571,7 @@ def mask_box_gesture(
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
     use_front_faces_only: bool | None = False,
-    mode: str | None = "VALUE",
+    mode: typing.Literal["VALUE", "VALUE_INVERSE", "INVERT"] | None = "VALUE",
     value: float | None = 1.0,
 ):
     """Mask within a rectangle defined by the cursor
@@ -592,7 +601,7 @@ def mask_box_gesture(
 
     INVERT
     Invert -- Invert the mask.
-        :type mode: str | None
+        :type mode: typing.Literal['VALUE','VALUE_INVERSE','INVERT'] | None
         :param value: Value, Mask level to use when mode is 'Value'; zero means no masking and one is fully masked
         :type value: float | None
     """
@@ -604,7 +613,7 @@ def mask_flood_fill(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "VALUE",
+    mode: typing.Literal["VALUE", "VALUE_INVERSE", "INVERT"] | None = "VALUE",
     value: float | None = 0.0,
 ):
     """Fill the whole mask with a given value, or invert its values
@@ -622,7 +631,7 @@ def mask_flood_fill(
 
     INVERT
     Invert -- Invert the mask.
-        :type mode: str | None
+        :type mode: typing.Literal['VALUE','VALUE_INVERSE','INVERT'] | None
         :param value: Value, Mask level to use when mode is 'Value'; zero means no masking and one is fully masked
         :type value: float | None
     """
@@ -639,7 +648,7 @@ def mask_lasso_gesture(
     smooth_stroke_factor: float | None = 0.75,
     smooth_stroke_radius: int | None = 35,
     use_front_faces_only: bool | None = False,
-    mode: str | None = "VALUE",
+    mode: typing.Literal["VALUE", "VALUE_INVERSE", "INVERT"] | None = "VALUE",
     value: float | None = 1.0,
 ):
     """Mask within a shape defined by the cursor
@@ -667,7 +676,7 @@ def mask_lasso_gesture(
 
     INVERT
     Invert -- Invert the mask.
-        :type mode: str | None
+        :type mode: typing.Literal['VALUE','VALUE_INVERSE','INVERT'] | None
         :param value: Value, Mask level to use when mode is 'Value'; zero means no masking and one is fully masked
         :type value: float | None
     """
@@ -687,7 +696,7 @@ def mask_line_gesture(
     cursor: int | None = 5,
     use_front_faces_only: bool | None = False,
     use_limit_to_segment: bool | None = False,
-    mode: str | None = "VALUE",
+    mode: typing.Literal["VALUE", "VALUE_INVERSE", "INVERT"] | None = "VALUE",
     value: float | None = 1.0,
 ):
     """Mask to one side of a line defined by the cursor
@@ -721,7 +730,7 @@ def mask_line_gesture(
 
     INVERT
     Invert -- Invert the mask.
-        :type mode: str | None
+        :type mode: typing.Literal['VALUE','VALUE_INVERSE','INVERT'] | None
         :param value: Value, Mask level to use when mode is 'Value'; zero means no masking and one is fully masked
         :type value: float | None
     """
@@ -735,7 +744,7 @@ def mask_polyline_gesture(
     *,
     path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None = None,
     use_front_faces_only: bool | None = False,
-    mode: str | None = "VALUE",
+    mode: typing.Literal["VALUE", "VALUE_INVERSE", "INVERT"] | None = "VALUE",
     value: float | None = 1.0,
 ):
     """Mask within a shape defined by the cursor
@@ -757,7 +766,7 @@ def mask_polyline_gesture(
 
     INVERT
     Invert -- Invert the mask.
-        :type mode: str | None
+        :type mode: typing.Literal['VALUE','VALUE_INVERSE','INVERT'] | None
         :param value: Value, Mask level to use when mode is 'Value'; zero means no masking and one is fully masked
         :type value: float | None
     """
@@ -825,7 +834,7 @@ def vert_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 for all vertices
 
@@ -845,7 +854,7 @@ def vert_select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -1120,7 +1129,7 @@ def vertex_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: str | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
 ):
     """Paint a stroke in the active color attribute layer
 
@@ -1142,7 +1151,7 @@ def vertex_paint(
 
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
-        :type mode: str | None
+        :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
     """
 
     ...
@@ -1166,7 +1175,7 @@ def visibility_filter(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "GROW",
+    action: typing.Literal["GROW", "SHRINK"] | None = "GROW",
     iterations: int | None = 1,
     auto_iteration_count: bool | None = True,
 ):
@@ -1182,7 +1191,7 @@ def visibility_filter(
 
     SHRINK
     Shrink Visibility -- Shrink the visibility by one face based on mesh topology.
-        :type action: str | None
+        :type action: typing.Literal['GROW','SHRINK'] | None
         :param iterations: Iterations, Number of times that the filter is going to be applied
         :type iterations: int | None
         :param auto_iteration_count: Auto Iteration Count, Use an automatic number of iterations based on the number of vertices of the sculpt
@@ -1210,7 +1219,7 @@ def weight_from_bones(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "AUTOMATIC",
+    type: typing.Literal["AUTOMATIC", "ENVELOPES"] | None = "AUTOMATIC",
 ):
     """Set the weights of the groups matching the attached armature's selected bones, using the distance between the vertices and the bones
 
@@ -1224,7 +1233,7 @@ def weight_from_bones(
 
     ENVELOPES
     From Envelopes -- Weights from envelopes with user defined radius.
-        :type type: str | None
+        :type type: typing.Literal['AUTOMATIC','ENVELOPES'] | None
     """
 
     ...
@@ -1234,7 +1243,7 @@ def weight_gradient(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "LINEAR",
+    type: typing.Literal["LINEAR", "RADIAL"] | None = "LINEAR",
     xstart: int | None = 0,
     xend: int | None = 0,
     ystart: int | None = 0,
@@ -1248,7 +1257,7 @@ def weight_gradient(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['LINEAR','RADIAL'] | None
     :param xstart: X Start
     :type xstart: int | None
     :param xend: X End
@@ -1272,7 +1281,7 @@ def weight_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: str | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
 ):
     """Paint a stroke in the current vertex group's weights
 
@@ -1294,7 +1303,7 @@ def weight_paint(
 
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
-        :type mode: str | None
+        :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
     """
 
     ...

bpy/ops/palette/__init__.pyi

@@ -39,7 +39,7 @@ def color_move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "UP",
+    type: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Move the active Color up/down in the list
 
@@ -47,7 +47,7 @@ def color_move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -107,7 +107,7 @@ def sort(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "HSV",
+    type: typing.Literal["HSV", "SVH", "VHS", "LUMINANCE"] | None = "HSV",
 ):
     """Sort Palette Colors
 
@@ -115,7 +115,7 @@ def sort(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['HSV','SVH','VHS','LUMINANCE'] | None
     """
 
     ...

bpy/ops/particle/__init__.pyi

@@ -48,7 +48,7 @@ def copy_particle_systems(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    space: str | None = "OBJECT",
+    space: typing.Literal["OBJECT", "WORLD"] | None = "OBJECT",
     remove_target_particles: bool | None = True,
     use_active: bool | None = False,
 ):
@@ -64,7 +64,7 @@ def copy_particle_systems(
 
     WORLD
     World -- Copy in world space.
-        :type space: str | None
+        :type space: typing.Literal['OBJECT','WORLD'] | None
         :param remove_target_particles: Remove Target Particles, Remove particle systems on the target objects
         :type remove_target_particles: bool | None
         :param use_active: Use Active, Use the active particle system from the context
@@ -78,7 +78,7 @@ def delete(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "PARTICLE",
+    type: typing.Literal["PARTICLE", "KEY"] | None = "PARTICLE",
 ):
     """Delete selected particles or keys
 
@@ -86,7 +86,7 @@ def delete(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type, Delete a full particle or only keys
-    :type type: str | None
+    :type type: typing.Literal['PARTICLE','KEY'] | None
     """
 
     ...
@@ -368,7 +368,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",
 ):
     """(De)select all particles' keys
 
@@ -388,7 +388,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -463,8 +463,8 @@ def select_random(
     *,
     ratio: float | None = 0.5,
     seed: int | None = 0,
-    action: str | None = "SELECT",
-    type: str | None = "HAIR",
+    action: typing.Literal["SELECT", "DESELECT"] | None = "SELECT",
+    type: typing.Literal["HAIR", "POINTS"] | None = "HAIR",
 ):
     """Select a randomly distributed set of hair or points
 
@@ -482,9 +482,9 @@ def select_random(
 
     DESELECT
     Deselect -- Deselect all elements.
-        :type action: str | None
+        :type action: typing.Literal['SELECT','DESELECT'] | None
         :param type: Type, Select either hair or points
-        :type type: str | None
+        :type type: typing.Literal['HAIR','POINTS'] | None
     """
 
     ...
@@ -494,7 +494,7 @@ def select_roots(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "SELECT",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "SELECT",
 ):
     """Select roots of all visible particles
 
@@ -514,7 +514,7 @@ def select_roots(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -524,7 +524,7 @@ def select_tips(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "SELECT",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "SELECT",
 ):
     """Select tips of all visible particles
 
@@ -544,7 +544,7 @@ def select_tips(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...