fake-bpy-module 20250505__py3-none-any.whl → 20250520__py3-none-any.whl

_bpy_internal/grease_pencil/stroke/__init__.pyi

@@ -6,6 +6,19 @@ import numpy.typing as npt
 class AttributeGetterSetter:
     """Helper class to get and set attributes at an index for a domain."""
 
+class BezierHandle:
+    LEFT: typing.Any
+    RIGHT: typing.Any
+    name: typing.Any
+    value: typing.Any
+
+class GreasePencilStrokePointHandle:
+    """Proxy giving read-only/write access to Bézier handle data."""
+
+    position: typing.Any
+    select: typing.Any
+    type: typing.Any
+
 class SliceHelper:
     """Helper class to handle custom slicing."""
 
@@ -41,13 +54,13 @@ class GreasePencilStrokePoint(AttributeGetterSetter):
     """A helper class to get access to stroke point data."""
 
     delta_time: typing.Any
+    handle_left: typing.Any
+    handle_right: typing.Any
     opacity: typing.Any
     position: typing.Any
     radius: typing.Any
     rotation: typing.Any
     select: typing.Any
-    select_handle_left: typing.Any
-    select_handle_right: typing.Any
     vertex_color: typing.Any
 
 class GreasePencilStrokePointSlice(SliceHelper):

bl_operators/node/__init__.pyi

@@ -59,6 +59,41 @@ class NODE_OT_add_closure_zone(NodeAddZoneOperator, bpy.types.Operator):
         :rtype: typing.Any
         """
 
+class NODE_OT_add_empty_group(NodeAddOperator, bpy.types.Operator):
+    bl_description: typing.Any
+    bl_idname: typing.Any
+    bl_label: typing.Any
+    bl_options: typing.Any
+    bl_rna: typing.Any
+    id_data: typing.Any
+
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
+
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
+
+    @staticmethod
+    def create_empty_group(idname):
+        """
+
+        :param idname:
+        """
+
+    def execute(self, context):
+        """
+
+        :param context:
+        """
+
 class NODE_OT_add_foreach_geometry_element_zone(
     NodeAddZoneOperator, bpy.types.Operator
 ):

bl_ui/node_add_menu/__init__.pyi

@@ -31,10 +31,18 @@ class NODE_MT_category_layout(bpy.types.Menu):
         """
 
 def add_closure_zone(layout, label): ...
+def add_color_mix_node(context, layout): ...
+def add_empty_group(layout): ...
 def add_foreach_geometry_element_zone(layout, label): ...
 def add_node_type(layout, node_type, *, label=None, poll=None, search_weight=0.0):
     """Add a node type to a menu."""
 
+def add_node_type_with_searchable_enum(
+    context, layout, node_idname, property_name, search_weight=0.0
+): ...
+def add_node_type_with_subnames(
+    context, layout, node_type, subnames, *, label=None, search_weight=0.0
+): ...
 def add_repeat_zone(layout, label): ...
 def add_simulation_zone(layout, label):
     """Add simulation zone to a menu."""

bl_ui/node_add_menu_compositor/__init__.pyi

@@ -76,10 +76,10 @@ class NODE_MT_category_compositor_color_mix(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_compositor_filter(bpy.types.Menu):
@@ -102,10 +102,10 @@ class NODE_MT_category_compositor_filter(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_compositor_filter_blur(bpy.types.Menu):
@@ -232,10 +232,10 @@ class NODE_MT_category_compositor_input_scene(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_compositor_keying(bpy.types.Menu):
@@ -415,10 +415,10 @@ class NODE_MT_category_compositor_utilities(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_compositor_vector(bpy.types.Menu):
@@ -441,10 +441,10 @@ class NODE_MT_category_compositor_vector(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_compositor_node_add_all(bpy.types.Menu):

bl_ui/node_add_menu_geometry/__init__.pyi

@@ -232,10 +232,10 @@ class NODE_MT_category_GEO_UTILITIES_MATH(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_GEO_UTILITIES_ROTATION(bpy.types.Menu):
@@ -310,10 +310,10 @@ class NODE_MT_category_GEO_VECTOR(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_GEO_VOLUME(bpy.types.Menu):
@@ -493,10 +493,10 @@ class NODE_MT_geometry_node_GEO_COLOR(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_geometry_node_GEO_CURVE(bpy.types.Menu):

bl_ui/node_add_menu_shader/__init__.pyi

@@ -24,10 +24,10 @@ class NODE_MT_category_shader_color(bpy.types.Menu):
         :rtype: typing.Any
         """
 
-    def draw(self, _context):
+    def draw(self, context):
         """
 
-        :param _context:
+        :param context:
         """
 
 class NODE_MT_category_shader_converter(bpy.types.Menu):

bl_ui/space_sequencer/__init__.pyi

@@ -2312,48 +2312,6 @@ class SEQUENCER_PT_strip(SequencerButtonsPanel, bpy.types.Panel):
         :param context:
         """
 
-class SEQUENCER_PT_strip_cache(SequencerButtonsPanel, bpy.types.Panel):
-    bl_category: typing.Any
-    bl_label: typing.Any
-    bl_options: typing.Any
-    bl_region_type: typing.Any
-    bl_rna: typing.Any
-    bl_space_type: typing.Any
-    id_data: typing.Any
-
-    def bl_rna_get_subclass(self) -> bpy.types.Struct:
-        """
-
-        :return: The RNA type or default when not found.
-        :rtype: bpy.types.Struct
-        """
-
-    def bl_rna_get_subclass_py(self) -> typing.Any:
-        """
-
-        :return: The class or default when not found.
-        :rtype: typing.Any
-        """
-
-    def draw(self, context):
-        """
-
-        :param context:
-        """
-
-    def draw_header(self, context):
-        """
-
-        :param context:
-        """
-
-    @classmethod
-    def poll(cls, context):
-        """
-
-        :param context:
-        """
-
 class SEQUENCER_PT_strip_proxy(SequencerButtonsPanel, bpy.types.Panel):
     bl_category: typing.Any
     bl_label: typing.Any

bl_ui/space_view3d/__init__.pyi

@@ -6788,6 +6788,7 @@ class VIEW3D_PT_shading_options_shadow(bpy.types.Panel):
     bl_region_type: typing.Any
     bl_rna: typing.Any
     bl_space_type: typing.Any
+    bl_ui_units_x: typing.Any
     id_data: typing.Any
 
     def bl_rna_get_subclass(self) -> bpy.types.Struct:

bpy/_typing/rna_enums/__init__.pyi

@@ -532,6 +532,8 @@ type EventTypeItems = typing.Literal[
     "WHEELDOWNMOUSE",  # Wheel Down.WhDown.
     "WHEELINMOUSE",  # Wheel In.WhIn.
     "WHEELOUTMOUSE",  # Wheel Out.WhOut.
+    "WHEELLEFTMOUSE",  # Wheel Left.WhLeft.
+    "WHEELRIGHTMOUSE",  # Wheel Right.WhRight.
     "A",
     "B",  # <string>:4: (INFO/1) Enumerated list start value not ordinal-1: "B" (ordinal 2)
     "C",  # <string>:4: (INFO/1) Enumerated list start value not ordinal-1: "C" (ordinal 3)
@@ -1522,6 +1524,9 @@ type IconItems = typing.Literal[
     "KEY_TAB",  # KEY_TAB.
     "KEY_WINDOWS_FILLED",  # KEY_WINDOWS_FILLED.
     "KEY_WINDOWS",  # KEY_WINDOWS.
+    "GESTURE_PAN",  # GESTURE_PAN.
+    "GESTURE_ROTATE",  # GESTURE_ROTATE.
+    "GESTURE_ZOOM",  # GESTURE_ZOOM.
     "FUND",  # FUND.
     "HEART",  # HEART.
     "INTERNET_OFFLINE",  # INTERNET_OFFLINE.
@@ -1713,6 +1718,9 @@ type IconItems = typing.Literal[
     "EVENT_EQUAL",  # EVENT_EQUAL.
     "EVENT_LEFTBRACKET",  # EVENT_LEFTBRACKET.
     "EVENT_RIGHTBRACKET",  # EVENT_RIGHTBRACKET.
+    "EVENT_PAD_PAN",  # EVENT_PAD_PAN.
+    "EVENT_PAD_ROTATE",  # EVENT_PAD_ROTATE.
+    "EVENT_PAD_ZOOM",  # EVENT_PAD_ZOOM.
     "EVENT_NDOF_BUTTON_V1",  # EVENT_NDOF_BUTTON_V1.
     "EVENT_NDOF_BUTTON_V2",  # EVENT_NDOF_BUTTON_V2.
     "EVENT_NDOF_BUTTON_V3",  # EVENT_NDOF_BUTTON_V3.
@@ -2523,6 +2531,7 @@ type PropertyFlagItems = typing.Literal[
     "TEXTEDIT_UPDATE",  # Update on every keystroke in textedit 'mode'.
     "OUTPUT_PATH",  # Output Path.
     "PATH_SUPPORTS_BLEND_RELATIVE",  # Relative Path Support.This path supports relative prefix "//" which is expanded the the directory where the current ".blend" file is located..
+    "SUPPORTS_TEMPLATES",  # Variable expression support.This path supports the "{variable_name}" template syntax, which substitutes the value of the referenced variable in place of the template expression.
 ]
 type PropertyOverrideFlagCollectionItems = typing.Literal[
     "LIBRARY_OVERRIDABLE",  # Library Overridable.Make that property editable in library overrides of linked data-blocks.NOTE: For a property to be overridable, its whole chain of parent properties must also be defined as overridable.

bpy/app/translations/__init__.pyi

@@ -16,7 +16,7 @@ To add translations to your Python script, you must define a dictionary formatte
 
  where:
 
-* locale is either a lang iso code (e.g. fr
+* locale is either a lang ISO code (e.g. fr
 
 ), a lang+country code (e.g. pt_BR
 

bpy/ops/__init__.pyi

@@ -26,9 +26,13 @@ If operator was cancelled but there wasn't any reports from it with {'ERROR'}
 it will just return {'CANCELLED'}
 
  without raising any exceptions.
-If it had error reports, then it will raise a RuntimeError
+However, if there are error reports, a RuntimeError
 
- including all report messages.
+ will be raised
+after the operator finishes execution, including all error report messages,
+regardless of the return status (even if it was {'FINISHED'}
+
+).
 
 Calling an operator in the wrong context will raise a RuntimeError
 

bpy/ops/brush/__init__.pyi

@@ -12,6 +12,7 @@ def asset_activate(
     asset_library_type: bpy._typing.rna_enums.AssetLibraryTypeItems | None = "LOCAL",
     asset_library_identifier: str = "",
     relative_asset_identifier: str = "",
+    use_toggle: bool | None = False,
 ):
     """Activate a brush asset as current sculpt and paint tool
 
@@ -23,6 +24,8 @@ def asset_activate(
     :type asset_library_identifier: str
     :param relative_asset_identifier: Relative Asset Identifier
     :type relative_asset_identifier: str
+    :param use_toggle: Toggle, Switch between the current and assigned brushes on consecutive uses.
+    :type use_toggle: bool | None
     """
 
 def asset_delete(execution_context: int | str | None = None, undo: bool | None = None):

bpy/ops/mesh/__init__.pyi

@@ -1035,30 +1035,6 @@ def face_make_planar(
     :type repeat: int | None
     """
 
-def face_set_extract(
-    execution_context: int | str | None = None,
-    undo: bool | None = None,
-    /,
-    *,
-    add_boundary_loop: bool | None = True,
-    smooth_iterations: int | None = 4,
-    apply_shrinkwrap: bool | None = True,
-    add_solidify: bool | None = True,
-):
-    """Create a new mesh object from the selected Face Set
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :param add_boundary_loop: Add Boundary Loop, Add an extra edge loop to better preserve the shape when applying a subdivision surface modifier
-    :type add_boundary_loop: bool | None
-    :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
-    :type smooth_iterations: int | None
-    :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
-    :type apply_shrinkwrap: bool | None
-    :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
-    :type add_solidify: bool | None
-    """
-
 def face_split_by_edges(
     execution_context: int | str | None = None, undo: bool | None = None
 ):
@@ -1696,54 +1672,6 @@ def offset_edge_loops_slide(
     :type TRANSFORM_OT_edge_slide: bpy.ops.transform.edge_slide | None
     """
 
-def paint_mask_extract(
-    execution_context: int | str | None = None,
-    undo: bool | None = None,
-    /,
-    *,
-    mask_threshold: float | None = 0.5,
-    add_boundary_loop: bool | None = True,
-    smooth_iterations: int | None = 4,
-    apply_shrinkwrap: bool | None = True,
-    add_solidify: bool | None = True,
-):
-    """Create a new mesh object from the current paint mask
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :param mask_threshold: Threshold, Minimum mask value to consider the vertex valid to extract a face from the original mesh
-    :type mask_threshold: float | None
-    :param add_boundary_loop: Add Boundary Loop, Add an extra edge loop to better preserve the shape when applying a subdivision surface modifier
-    :type add_boundary_loop: bool | None
-    :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
-    :type smooth_iterations: int | None
-    :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
-    :type apply_shrinkwrap: bool | None
-    :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
-    :type add_solidify: bool | None
-    """
-
-def paint_mask_slice(
-    execution_context: int | str | None = None,
-    undo: bool | None = None,
-    /,
-    *,
-    mask_threshold: float | None = 0.5,
-    fill_holes: bool | None = True,
-    new_object: bool | None = True,
-):
-    """Slices the paint mask from the mesh
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :param mask_threshold: Threshold, Minimum mask value to consider the vertex valid to extract a face from the original mesh
-    :type mask_threshold: float | None
-    :param fill_holes: Fill Holes, Fill holes after slicing the mask
-    :type fill_holes: bool | None
-    :param new_object: Slice to New Object, Create a new object from the sliced mask
-    :type new_object: bool | None
-    """
-
 def point_normals(
     execution_context: int | str | None = None,
     undo: bool | None = None,

bpy/ops/node/__init__.pyi

@@ -5,6 +5,7 @@ import numpy.typing as npt
 import bl_operators.node
 import bpy._typing.rna_enums
 import bpy.ops.transform
+import bpy.ops.wm
 import bpy.types
 
 def activate_viewer(
@@ -77,6 +78,25 @@ def add_color(
     :type has_alpha: bool | None
     """
 
+def add_empty_group(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    use_transform: bool | None = False,
+    settings: bpy.types.bpy_prop_collection[bl_operators.node.NodeSetting]
+    | None = None,
+):
+    """Add a group node with an empty group
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param use_transform: Use Transform, Start transform operator after inserting the node
+    :type use_transform: bool | None
+    :param settings: Settings, Settings to be applied on the newly created node
+    :type settings: bpy.types.bpy_prop_collection[bl_operators.node.NodeSetting] | None
+    """
+
 def add_foreach_geometry_element_zone(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -141,6 +161,24 @@ def add_group_asset(
     :type relative_asset_identifier: str
     """
 
+def add_group_input_node(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    socket_identifier: str = "",
+    panel_identifier: int | None = 0,
+):
+    """Add a Group Input node with selected sockets to the current node editor
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param socket_identifier: Socket Identifier, Socket to include in the added group input/output node
+    :type socket_identifier: str
+    :param panel_identifier: Panel Identifier, Panel from which to add sockets to the added group input/output node
+    :type panel_identifier: int | None
+    """
+
 def add_image(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -1239,6 +1277,24 @@ def join(execution_context: int | str | None = None, undo: bool | None = None):
     :type undo: bool | None
     """
 
+def join_named(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    NODE_OT_join: join | None = None,
+    WM_OT_call_panel: bpy.ops.wm.call_panel | None = None,
+):
+    """Create a new frame node around the selected nodes and name it immediately
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param NODE_OT_join: Join Nodes, Attach selected nodes to a new common frame
+    :type NODE_OT_join: join | None
+    :param WM_OT_call_panel: Call Panel, Open a predefined panel
+    :type WM_OT_call_panel: bpy.ops.wm.call_panel | None
+    """
+
 def link(
     execution_context: int | str | None = None,
     undo: bool | None = None,

bpy/ops/object/__init__.pyi

@@ -2442,6 +2442,15 @@ def material_slot_remove(
     :type undo: bool | None
     """
 
+def material_slot_remove_all(
+    execution_context: int | str | None = None, undo: bool | None = None
+):
+    """Remove all materials
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    """
+
 def material_slot_remove_unused(
     execution_context: int | str | None = None, undo: bool | None = None
 ):
@@ -3267,7 +3276,7 @@ def paths_update_visible(
     :type undo: bool | None
     """
 
-def pointcloud_add(
+def pointcloud_random_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     /,
@@ -3992,7 +4001,7 @@ def shape_key_clear(
 def shape_key_copy(
     execution_context: int | str | None = None, undo: bool | None = None
 ):
-    """Duplicate the acive shape key
+    """Duplicate the active shape key
 
     :type execution_context: int | str | None
     :type undo: bool | None

bpy/ops/sculpt/__init__.pyi

@@ -381,6 +381,30 @@ def face_set_edit(
         :type modify_hidden: bool | None
     """
 
+def face_set_extract(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    add_boundary_loop: bool | None = True,
+    smooth_iterations: int | None = 4,
+    apply_shrinkwrap: bool | None = True,
+    add_solidify: bool | None = True,
+):
+    """Create a new mesh object from the selected Face Set
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param add_boundary_loop: Add Boundary Loop, Add an extra edge loop to better preserve the shape when applying a subdivision surface modifier
+    :type add_boundary_loop: bool | None
+    :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
+    :type smooth_iterations: int | None
+    :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
+    :type apply_shrinkwrap: bool | None
+    :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
+    :type add_solidify: bool | None
+    """
+
 def face_set_lasso_gesture(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -827,6 +851,54 @@ def optimize(execution_context: int | str | None = None, undo: bool | None = Non
     :type undo: bool | None
     """
 
+def paint_mask_extract(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    mask_threshold: float | None = 0.5,
+    add_boundary_loop: bool | None = True,
+    smooth_iterations: int | None = 4,
+    apply_shrinkwrap: bool | None = True,
+    add_solidify: bool | None = True,
+):
+    """Create a new mesh object from the current paint mask
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param mask_threshold: Threshold, Minimum mask value to consider the vertex valid to extract a face from the original mesh
+    :type mask_threshold: float | None
+    :param add_boundary_loop: Add Boundary Loop, Add an extra edge loop to better preserve the shape when applying a subdivision surface modifier
+    :type add_boundary_loop: bool | None
+    :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
+    :type smooth_iterations: int | None
+    :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
+    :type apply_shrinkwrap: bool | None
+    :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
+    :type add_solidify: bool | None
+    """
+
+def paint_mask_slice(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    mask_threshold: float | None = 0.5,
+    fill_holes: bool | None = True,
+    new_object: bool | None = True,
+):
+    """Slices the paint mask from the mesh
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param mask_threshold: Threshold, Minimum mask value to consider the vertex valid to extract a face from the original mesh
+    :type mask_threshold: float | None
+    :param fill_holes: Fill Holes, Fill holes after slicing the mask
+    :type fill_holes: bool | None
+    :param new_object: Slice to New Object, Create a new object from the sliced mask
+    :type new_object: bool | None
+    """
+
 def project_line_gesture(
     execution_context: int | str | None = None,
     undo: bool | None = None,

bpy/ops/sequencer/__init__.pyi

@@ -2255,7 +2255,7 @@ def text_edit_mode_toggle(
 def text_edit_paste(
     execution_context: int | str | None = None, undo: bool | None = None
 ):
-    """Paste text to clipboard
+    """Paste text from clipboard
 
     :type execution_context: int | str | None
     :type undo: bool | None

bpy/ops/spreadsheet/__init__.pyi

@@ -30,6 +30,13 @@ def change_spreadsheet_data_source(
     :type attribute_domain_type: int | None
     """
 
+def fit_column(execution_context: int | str | None = None, undo: bool | None = None):
+    """Resize a spreadsheet column to the width of the data
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    """
+
 def remove_row_filter_rule(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -45,6 +52,13 @@ def remove_row_filter_rule(
     :type index: int | None
     """
 
+def resize_column(execution_context: int | str | None = None, undo: bool | None = None):
+    """Resize a spreadsheet column
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    """
+
 def toggle_pin(execution_context: int | str | None = None, undo: bool | None = None):
     """Turn on or off pinning