fake-bpy-module 20240720__py3-none-any.whl → 20240721__py3-none-any.whl

bpy/types/__init__.pyi

@@ -114197,13 +114197,13 @@ class BlendData(bpy_struct):
         """
         ...
 
-    def temp_data(self, filepath: bytes | str | None = None) -> BlendData:
+    def temp_data(self, filepath: bytes | str | None = None) -> typing.Self:
         """A context manager that temporarily creates blender file data.
 
         :param filepath: The file path for the newly temporary data. When None, the path of the currently open file is used.
         :type filepath: bytes | str | None
         :return: Blend file data which is freed once the context exists.
-        :rtype: BlendData
+        :rtype: typing.Self
         """
         ...
 
@@ -114896,16 +114896,16 @@ class Bone(bpy_struct):
     :type: float
     """
 
-    bbone_custom_handle_end: Bone | None
+    bbone_custom_handle_end: typing.Self
     """ Bone that serves as the end handle for the B-Bone curve
 
-    :type: Bone | None
+    :type: typing.Self
     """
 
-    bbone_custom_handle_start: Bone | None
+    bbone_custom_handle_start: typing.Self
     """ Bone that serves as the start handle for the B-Bone curve
 
-    :type: Bone | None
+    :type: typing.Self
     """
 
     bbone_easein: float
@@ -115094,10 +115094,10 @@ class Bone(bpy_struct):
     :type: str
     """
 
-    parent: Bone
+    parent: typing.Self
     """ Parent bone (in same Armature)
 
-    :type: Bone
+    :type: typing.Self
     """
 
     select: bool
@@ -115434,10 +115434,10 @@ class BoneCollection(bpy_struct):
     :type: str
     """
 
-    parent: BoneCollection | None
+    parent: typing.Self
     """ Parent bone collection. Note that accessing this requires a scan of all the bone collections to find the parent
 
-    :type: BoneCollection | None
+    :type: typing.Self
     """
 
     bones_recursive: typing.Any
@@ -132652,13 +132652,13 @@ class Depsgraph(bpy_struct):
         """Re-evaluate any modified data-blocks, for example for animation or modifiers. This invalidates all references to evaluated data-blocks from this dependency graph."""
         ...
 
-    def id_eval_get(self, id: ID | None) -> ID:
+    def id_eval_get(self, id: GenericType1 | None) -> GenericType1:
         """id_eval_get
 
         :param id: Original ID to get evaluated complementary part for
-        :type id: ID | None
+        :type id: GenericType1 | None
         :return: Evaluated ID for the given original one
-        :rtype: ID
+        :rtype: GenericType1
         """
         ...
 
@@ -134263,16 +134263,16 @@ class EditBone(bpy_struct):
     :type: float
     """
 
-    bbone_custom_handle_end: EditBone | None
+    bbone_custom_handle_end: typing.Self
     """ Bone that serves as the end handle for the B-Bone curve
 
-    :type: EditBone | None
+    :type: typing.Self
     """
 
-    bbone_custom_handle_start: EditBone | None
+    bbone_custom_handle_start: typing.Self
     """ Bone that serves as the start handle for the B-Bone curve
 
-    :type: EditBone | None
+    :type: typing.Self
     """
 
     bbone_easein: float
@@ -134449,10 +134449,10 @@ class EditBone(bpy_struct):
     :type: str
     """
 
-    parent: EditBone | None
+    parent: typing.Self
     """ Parent edit bone (in same Armature)
 
-    :type: EditBone | None
+    :type: typing.Self
     """
 
     roll: float
@@ -162935,10 +162935,10 @@ class ID(bpy_struct):
     :type: str
     """
 
-    original: ID
+    original: typing.Self
     """ Actual data-block from .blend file (Main database) that generated that evaluated one
 
-    :type: ID
+    :type: typing.Self
     """
 
     override_library: IDOverrideLibrary
@@ -162983,21 +162983,21 @@ class ID(bpy_struct):
     :type: int
     """
 
-    def evaluated_get(self, depsgraph: Depsgraph) -> ID:
+    def evaluated_get(self, depsgraph: Depsgraph) -> typing.Self:
         """Get corresponding evaluated ID from the given dependency graph. Note that this does not ensure the dependency graph is fully evaluated, it just returns the result of the last evaluation
 
         :param depsgraph: Dependency graph to perform lookup in
         :type depsgraph: Depsgraph
         :return: New copy of the ID
-        :rtype: ID
+        :rtype: typing.Self
         """
         ...
 
-    def copy(self) -> ID:
+    def copy(self) -> typing.Self:
         """Create a copy of this data-block (not supported for all data-blocks). The result is added to the Blend-File Data (Main database), with all references to other data-blocks ensured to be from within the same Blend-File Data
 
         :return: New copy of the ID
-        :rtype: ID
+        :rtype: typing.Self
         """
         ...
 
@@ -163013,13 +163013,13 @@ class ID(bpy_struct):
         """Generate preview image (might be scheduled in a background thread)"""
         ...
 
-    def override_create(self, remap_local_usages: bool | None = False) -> ID:
+    def override_create(self, remap_local_usages: bool | None = False) -> typing.Self:
         """Create an overridden local copy of this linked data-block (not supported for all data-blocks)
 
         :param remap_local_usages: Whether local usages of the linked ID should be remapped to the new library override of it
         :type remap_local_usages: bool | None
         :return: New overridden local copy of the ID
-        :rtype: ID
+        :rtype: typing.Self
         """
         ...
 
@@ -163027,9 +163027,9 @@ class ID(bpy_struct):
         self,
         scene: Scene,
         view_layer: ViewLayer,
-        reference: ID | None = None,
+        reference: typing.Self = None,
         do_fully_editable: bool | None = False,
-    ) -> ID:
+    ) -> typing.Self:
         """Create an overridden local copy of this linked data-block, and most of its dependencies when it is a Collection or and Object
 
         :param scene: In which scene the new overrides should be instantiated
@@ -163037,11 +163037,11 @@ class ID(bpy_struct):
         :param view_layer: In which view layer the new overrides should be instantiated
         :type view_layer: ViewLayer
         :param reference: Another ID (usually an Object or Collection) used as a hint to decide where to instantiate the new overrides
-        :type reference: ID | None
+        :type reference: typing.Self
         :param do_fully_editable: Make all library overrides generated by this call fully editable by the user (none will be 'system overrides')
         :type do_fully_editable: bool | None
         :return: New overridden local copy of the root ID
-        :rtype: ID
+        :rtype: typing.Self
         """
         ...
 
@@ -163052,11 +163052,11 @@ class ID(bpy_struct):
         """
         ...
 
-    def user_remap(self, new_id: ID):
+    def user_remap(self, new_id: typing.Self):
         """Replace all usage in the .blend file of this ID by new given one
 
         :param new_id: New ID to use
-        :type new_id: ID
+        :type new_id: typing.Self
         """
         ...
 
@@ -163065,7 +163065,7 @@ class ID(bpy_struct):
         clear_proxy: bool | None = True,
         clear_liboverride: bool | None = False,
         clear_asset_data: bool | None = True,
-    ) -> ID:
+    ) -> typing.Self:
         """Make this datablock local, return local one (may be a copy of the original, in case it is also indirectly used)
 
         :param clear_proxy: Deprecated, has no effect
@@ -163075,15 +163075,15 @@ class ID(bpy_struct):
         :param clear_asset_data: Remove potential asset metadata so the newly local data-block is not treated as asset data-block and won't show up in asset libraries
         :type clear_asset_data: bool | None
         :return: This ID, or the new ID if it was copied
-        :rtype: ID
+        :rtype: typing.Self
         """
         ...
 
-    def user_of_id(self, id: ID) -> int:
+    def user_of_id(self, id: typing.Self) -> int:
         """Count the number of times that ID uses/references given one
 
         :param id: ID to count usages
-        :type id: ID
+        :type id: typing.Self
         :return: Number of usages/references of given id by current data-block
         :rtype: int
         """
@@ -165502,11 +165502,11 @@ class KeyMap(bpy_struct):
     :type: str
     """
 
-    def active(self) -> KeyMap:
+    def active(self) -> typing.Self:
         """active
 
         :return: Key Map, Active key map
-        :rtype: KeyMap
+        :rtype: typing.Self
         """
         ...
 
@@ -165693,11 +165693,11 @@ class KeyMapItem(bpy_struct):
     :type: str
     """
 
-    def compare(self, item: KeyMapItem | None) -> bool:
+    def compare(self, item: typing.Self) -> bool:
         """compare
 
         :param item: Item
-        :type item: KeyMapItem | None
+        :type item: typing.Self
         :return: Comparison result
         :rtype: bool
         """
@@ -167154,10 +167154,10 @@ class Library(ID, bpy_struct):
     :type: PackedFile
     """
 
-    parent: Library
+    parent: typing.Self
     """ 
 
-    :type: Library
+    :type: typing.Self
     """
 
     version: bpy_prop_array[int]
@@ -174045,10 +174045,10 @@ class Mesh(ID, bpy_struct):
     :type: bpy_prop_collection[MeshSkinVertexLayer]
     """
 
-    texco_mesh: Mesh | None
+    texco_mesh: typing.Self
     """ Derive texture coordinates from another mesh
 
-    :type: Mesh | None
+    :type: typing.Self
     """
 
     texspace_location: mathutils.Vector
@@ -174063,10 +174063,10 @@ class Mesh(ID, bpy_struct):
     :type: mathutils.Vector
     """
 
-    texture_mesh: Mesh | None
+    texture_mesh: typing.Self
     """ Use another mesh for texture indices (vertex indices must be aligned)
 
-    :type: Mesh | None
+    :type: typing.Self
     """
 
     total_edge_sel: int
@@ -174321,12 +174321,12 @@ class Mesh(ID, bpy_struct):
         ...
 
     def unit_test_compare(
-        self, mesh: Mesh | None = None, threshold: float | None = 7.1526e-06
+        self, mesh: typing.Self = None, threshold: float | None = 7.1526e-06
     ) -> str:
         """unit_test_compare
 
         :param mesh: Mesh to compare to
-        :type mesh: Mesh | None
+        :type mesh: typing.Self
         :param threshold: Threshold, Comparison tolerance threshold
         :type threshold: float | None
         :return: Return value, String description of result of comparison
@@ -179082,10 +179082,10 @@ class Node(bpy_struct):
     :type: NodeOutputs
     """
 
-    parent: Node | None
+    parent: typing.Self
     """ Parent this node is attached to
 
-    :type: Node | None
+    :type: typing.Self
     """
 
     select: bool
@@ -179188,11 +179188,11 @@ class Node(bpy_struct):
         """
         ...
 
-    def copy(self, node: Node):
+    def copy(self, node: typing.Self):
         """Initialize a new instance of this node from an existing node
 
         :param node: Node, Existing node to copy
-        :type node: Node
+        :type node: typing.Self
         """
         ...
 
@@ -179873,11 +179873,11 @@ class NodeLink(bpy_struct):
     :type: NodeSocket
     """
 
-    def swap_multi_input_sort_id(self, other: NodeLink):
+    def swap_multi_input_sort_id(self, other: typing.Self):
         """Swap the order of two links connected to the same multi-input socket
 
         :param other: Other, The other link. Must link to the same multi input socket
-        :type other: NodeLink
+        :type other: typing.Self
         """
         ...
 
@@ -181656,11 +181656,11 @@ class NodeTree(ID, bpy_struct):
         """
         ...
 
-    def contains_tree(self, sub_tree: NodeTree) -> bool:
+    def contains_tree(self, sub_tree: typing.Self) -> bool:
         """Check if the node tree contains another. Used to avoid creating recursive node groups
 
         :param sub_tree: Node Tree, Node tree for recursive check
-        :type sub_tree: NodeTree
+        :type sub_tree: typing.Self
         :return: contained
         :rtype: bool
         """
@@ -185768,10 +185768,10 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
     :type: MotionPath
     """
 
-    parent: Object | None
+    parent: typing.Self
     """ Parent object
 
-    :type: Object | None
+    :type: typing.Self
     """
 
     parent_bone: str
@@ -186393,11 +186393,11 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
         """Clears curve data-block created by to_curve()"""
         ...
 
-    def find_armature(self) -> Object:
+    def find_armature(self) -> typing.Self:
         """Find armature influencing this object as a parent or via a modifier
 
         :return: Armature object influencing this object or nullptr
-        :rtype: Object
+        :rtype: typing.Self
         """
         ...
 
@@ -186528,7 +186528,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
 
     def generate_gpencil_strokes(
         self,
-        grease_pencil_object: Object,
+        grease_pencil_object: typing.Self,
         use_collections: bool | None = True,
         scale_thickness: float | None = 1.0,
         sample: float | None = 0.0,
@@ -186536,7 +186536,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
         """Convert a curve object to grease pencil strokes.
 
         :param grease_pencil_object: Grease Pencil object used to create new strokes
-        :type grease_pencil_object: Object
+        :type grease_pencil_object: typing.Self
         :param use_collections: Use Collections
         :type use_collections: bool | None
         :param scale_thickness: Thickness scaling factor
@@ -191863,16 +191863,16 @@ class PoseBone(bpy_struct):
     :type: float
     """
 
-    bbone_custom_handle_end: PoseBone
+    bbone_custom_handle_end: typing.Self
     """ Bone that serves as the end handle for the B-Bone curve
 
-    :type: PoseBone
+    :type: typing.Self
     """
 
-    bbone_custom_handle_start: PoseBone
+    bbone_custom_handle_start: typing.Self
     """ Bone that serves as the start handle for the B-Bone curve
 
-    :type: PoseBone
+    :type: typing.Self
     """
 
     bbone_easein: float
@@ -191917,10 +191917,10 @@ class PoseBone(bpy_struct):
     :type: Bone
     """
 
-    child: PoseBone
+    child: typing.Self
     """ Child of this pose bone
 
-    :type: PoseBone
+    :type: typing.Self
     """
 
     color: BoneColor
@@ -191953,10 +191953,10 @@ class PoseBone(bpy_struct):
     :type: mathutils.Vector
     """
 
-    custom_shape_transform: PoseBone | None
+    custom_shape_transform: typing.Self
     """ Bone that defines the display transform of this custom shape
 
-    :type: PoseBone | None
+    :type: typing.Self
     """
 
     custom_shape_translation: mathutils.Vector
@@ -192145,10 +192145,10 @@ class PoseBone(bpy_struct):
     :type: str
     """
 
-    parent: PoseBone
+    parent: typing.Self
     """ Parent of this pose bone
 
-    :type: PoseBone
+    :type: typing.Self
     """
 
     rotation_axis_angle: bpy_prop_array[float]
@@ -198067,10 +198067,10 @@ class Scene(ID, bpy_struct):
     :type: float
     """
 
-    background_set: Scene | None
+    background_set: typing.Self
     """ Background set scene
 
-    :type: Scene | None
+    :type: typing.Self
     """
 
     camera: Object | None
@@ -200253,27 +200253,27 @@ class Sequence(bpy_struct):
         """
         ...
 
-    def swap(self, other: Sequence):
+    def swap(self, other: typing.Self):
         """swap
 
         :param other: Other
-        :type other: Sequence
+        :type other: typing.Self
         """
         ...
 
-    def move_to_meta(self, meta_sequence: Sequence):
+    def move_to_meta(self, meta_sequence: typing.Self):
         """move_to_meta
 
         :param meta_sequence: Destination Meta Sequence, Meta to move the strip into
-        :type meta_sequence: Sequence
+        :type meta_sequence: typing.Self
         """
         ...
 
-    def parent_meta(self) -> Sequence:
+    def parent_meta(self) -> typing.Self:
         """Parent meta
 
         :return: Parent Meta
-        :rtype: Sequence
+        :rtype: typing.Self
         """
         ...
 
@@ -200285,7 +200285,7 @@ class Sequence(bpy_struct):
         """
         ...
 
-    def split(self, frame: int | None, split_method: str) -> Sequence:
+    def split(self, frame: int | None, split_method: str) -> typing.Self:
         """Split Sequence
 
         :param frame: Frame where to split the strip
@@ -200293,7 +200293,7 @@ class Sequence(bpy_struct):
         :param split_method:
         :type split_method: str
         :return: Right side Sequence
-        :rtype: Sequence
+        :rtype: typing.Self
         """
         ...
 
@@ -208905,10 +208905,10 @@ class ShapeKey(bpy_struct):
     :type: bpy_prop_collection[ShapeKeyPoint]
     """
 
-    relative_key: ShapeKey
+    relative_key: typing.Self
     """ Shape used as a relative key
 
-    :type: ShapeKey
+    :type: typing.Self
     """
 
     slider_max: float
@@ -213905,10 +213905,10 @@ class SpaceView3D(Space, bpy_struct):
     :type: float
     """
 
-    local_view: SpaceView3D
+    local_view: typing.Self
     """ Display an isolated subset of objects, apart from the scene visibility
 
-    :type: SpaceView3D
+    :type: typing.Self
     """
 
     lock_bone: str
@@ -215640,10 +215640,10 @@ class StringProperty(Property, bpy_struct):
 class Struct(bpy_struct):
     """RNA structure definition"""
 
-    base: Struct
+    base: typing.Self
     """ Struct definition this is derived from
 
-    :type: Struct
+    :type: typing.Self
     """
 
     description: str
@@ -215676,10 +215676,10 @@ class Struct(bpy_struct):
     :type: StringProperty
     """
 
-    nested: Struct
+    nested: typing.Self
     """ Struct in which this struct is always nested, and to which it logically belongs
 
-    :type: Struct
+    :type: typing.Self
     """
 
     properties: bpy_prop_collection[Property]
@@ -215701,14 +215701,14 @@ class Struct(bpy_struct):
     """
 
     @classmethod
-    def bl_rna_get_subclass(cls, id: str | None, default=None) -> Struct:
+    def bl_rna_get_subclass(cls, id: str | None, default=None) -> typing.Self:
         """
 
         :param id: The RNA type identifier.
         :type id: str | None
         :param default:
         :return: The RNA type or default when not found.
-        :rtype: Struct
+        :rtype: typing.Self
         """
         ...
 
@@ -226012,7 +226012,7 @@ class UILayout(bpy_struct):
         heading: str = "",
         heading_ctxt: str = "",
         translate: bool | None = True,
-    ) -> UILayout:
+    ) -> typing.Self:
         """Sub-layout. Items placed in this sublayout are placed next to each other in a row
 
         :param align: Align buttons to each other
@@ -226024,7 +226024,7 @@ class UILayout(bpy_struct):
         :param translate: Translate the given heading, when UI translation is enabled
         :type translate: bool | None
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
@@ -226034,7 +226034,7 @@ class UILayout(bpy_struct):
         heading: str = "",
         heading_ctxt: str = "",
         translate: bool | None = True,
-    ) -> UILayout:
+    ) -> typing.Self:
         """Sub-layout. Items placed in this sublayout are placed under each other in a column
 
         :param align: Align buttons to each other
@@ -226046,7 +226046,7 @@ class UILayout(bpy_struct):
         :param translate: Translate the given heading, when UI translation is enabled
         :type translate: bool | None
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
@@ -226078,7 +226078,7 @@ class UILayout(bpy_struct):
 
     def column_flow(
         self, columns: int | None = 0, align: bool | None = False
-    ) -> UILayout:
+    ) -> typing.Self:
         """column_flow
 
         :param columns: Number of columns, 0 is automatic
@@ -226086,7 +226086,7 @@ class UILayout(bpy_struct):
         :param align: Align buttons to each other
         :type align: bool | None
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
@@ -226097,7 +226097,7 @@ class UILayout(bpy_struct):
         even_columns: bool | None = False,
         even_rows: bool | None = False,
         align: bool | None = False,
-    ) -> UILayout:
+    ) -> typing.Self:
         """grid_flow
 
         :param row_major: Fill row by row, instead of column by column
@@ -226111,19 +226111,21 @@ class UILayout(bpy_struct):
         :param align: Align buttons to each other
         :type align: bool | None
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
-    def box(self) -> UILayout:
+    def box(self) -> typing.Self:
         """Sublayout (items placed in this sublayout are placed under each other in a column and are surrounded by a box)
 
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
-    def split(self, factor: float | None = 0.0, align: bool | None = False) -> UILayout:
+    def split(
+        self, factor: float | None = 0.0, align: bool | None = False
+    ) -> typing.Self:
         """split
 
         :param factor: Percentage, Percentage of width to split at (leave unset for automatic calculation)
@@ -226131,15 +226133,15 @@ class UILayout(bpy_struct):
         :param align: Align buttons to each other
         :type align: bool | None
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
-    def menu_pie(self) -> UILayout:
+    def menu_pie(self) -> typing.Self:
         """Sublayout. Items placed in this sublayout are placed in a radial fashion around the menu center)
 
         :return: Sub-layout to put items in
-        :rtype: UILayout
+        :rtype: typing.Self
         """
         ...
 
@@ -227666,12 +227668,12 @@ class UILayout(bpy_struct):
         ...
 
     def template_light_linking_collection(
-        self, context_layout: UILayout, data: typing.Any, property: str
+        self, context_layout: typing.Self, data: typing.Any, property: str
     ):
         """Visualization of a content of a light linking collection
 
         :param context_layout: Layout to set active list element as context properties
-        :type context_layout: UILayout
+        :type context_layout: typing.Self
         :param data: Data from which to take property
         :type data: typing.Any
         :param property: Identifier of property in data
@@ -233143,10 +233145,10 @@ class Window(bpy_struct):
     :type: bpy_prop_collection[Operator]
     """
 
-    parent: Window
+    parent: typing.Self
     """ Active workspace and scene follow this window
 
-    :type: Window
+    :type: typing.Self
     """
 
     scene: Scene