fake-bpy-module 20240417__py3-none-any.whl → 20240419__py3-none-any.whl

bmesh/types/__init__.pyi

@@ -1,3 +1,24 @@
+"""
+
+--------------------
+
+
+--------------------
+
+
+--------------------
+
+
+--------------------
+
+
+--------------------
+
+
+--------------------
+
+"""
+
 import typing
 import bpy.types
 import mathutils
@@ -11,11 +32,12 @@ class BMDeformVert:
         """Clears all weights."""
         ...
 
-    def get(self, key, default=None):
+    def get(self, key: int, default=None):
         """Returns the deform weight matching the key or default
         when not found (matches Python's dictionary function of the same name).
 
                 :param key: The key associated with deform weight.
+                :type key: int
                 :param default: Optional argument for the value to return if
         key is not found.
         """
@@ -29,7 +51,7 @@ class BMDeformVert:
         """
         ...
 
-    def keys(self):
+    def keys(self) -> typing.List[int]:
         """Return the group indices used by this vertex
         (matching Python's dict.keys() functionality).
 
@@ -38,7 +60,7 @@ class BMDeformVert:
         """
         ...
 
-    def values(self) -> typing.List[int]:
+    def values(self) -> typing.List[float]:
         """Return the weights of the deform vertex
         (matching Python's dict.values() functionality).
 
@@ -56,8 +78,11 @@ class BMEdge:
     :type: bool
     """
 
-    index: typing.Any
-    """ Index of this element."""
+    index: int
+    """ Index of this element.
+
+    :type: int
+    """
 
     is_boundary: bool
     """ True when this edge is at the boundary of a face (read-only).
@@ -137,34 +162,37 @@ class BMEdge:
     :type: typing.Union[typing.List[BMVert], BMElemSeq]
     """
 
-    def calc_face_angle(self, fallback: typing.Any = None) -> typing.Any:
+    def calc_face_angle(self, fallback: typing.Any = None) -> float:
         """
 
                 :param fallback: return this when the edge doesn't have 2 faces
         (instead of raising a `ValueError`).
                 :type fallback: typing.Any
                 :return: The angle between 2 connected faces in radians.
+                :rtype: float
         """
         ...
 
-    def calc_face_angle_signed(self, fallback: typing.Any = None) -> typing.Any:
+    def calc_face_angle_signed(self, fallback: typing.Any = None) -> float:
         """
 
                 :param fallback: return this when the edge doesn't have 2 faces
         (instead of raising a `ValueError`).
                 :type fallback: typing.Any
                 :return: The angle between 2 connected faces in radians (negative for concave join).
+                :rtype: float
         """
         ...
 
-    def calc_length(self):
+    def calc_length(self) -> float:
         """
 
         :return: The length between both verts.
+        :rtype: float
         """
         ...
 
-    def calc_tangent(self, loop: BMLoop) -> BMLoop:
+    def calc_tangent(self, loop: BMLoop) -> mathutils.Vector:
         """Return the tangent at this edge relative to a face (pointing inward into the face).
         This uses the face normal for calculation.
 
@@ -195,7 +223,7 @@ class BMEdge:
         """Update normals of all connected faces and the edge verts."""
         ...
 
-    def other_vert(self, vert: BMVert) -> BMVert:
+    def other_vert(self, vert: BMVert):
         """Return the other vertex on this edge or None if the vertex is not used by this edge.
 
         :param vert: a vert in this edge.
@@ -226,7 +254,7 @@ class BMEdgeSeq:
         """Ensure internal data needed for int subscription is initialized with verts/edges/faces, eg bm.verts[index].This needs to be called again after adding/removing data in this sequence."""
         ...
 
-    def get(self, verts: BMVert, fallback=None):
+    def get(self, verts: BMVert, fallback=None) -> BMEdge:
         """Return an edge which uses the verts passed.
 
         :param verts: Sequence of verts.
@@ -268,7 +296,7 @@ class BMEdgeSeq:
         """
         ...
 
-    def __getitem__(self, key: int) -> int:
+    def __getitem__(self, key: int) -> BMEdge:
         """
 
         :param key:
@@ -288,7 +316,7 @@ class BMEdgeSeq:
         """
         ...
 
-    def __delitem__(self, key: int) -> int:
+    def __delitem__(self, key: int) -> BMEdge:
         """
 
         :param key:
@@ -298,7 +326,7 @@ class BMEdgeSeq:
         """
         ...
 
-    def __iter__(self) -> BMEdge:
+    def __iter__(self) -> typing.Iterator[GenericType]:
         """
 
         :return:
@@ -306,7 +334,7 @@ class BMEdgeSeq:
         """
         ...
 
-    def __next__(self) -> typing.Iterator[GenericType]:
+    def __next__(self) -> GenericType:
         """
 
         :return:
@@ -314,7 +342,7 @@ class BMEdgeSeq:
         """
         ...
 
-    def __len__(self) -> GenericType:
+    def __len__(self) -> int:
         """
 
         :return:
@@ -375,7 +403,7 @@ class BMElemSeq:
         """Initialize the index values of this sequence.This is the equivalent of looping over all elements and assigning the index values."""
         ...
 
-    def __getitem__(self, key: int) -> int:
+    def __getitem__(self, key: int) -> GenericType:
         """
 
         :param key:
@@ -395,7 +423,7 @@ class BMElemSeq:
         """
         ...
 
-    def __delitem__(self, key: int) -> int:
+    def __delitem__(self, key: int) -> GenericType:
         """
 
         :param key:
@@ -405,7 +433,7 @@ class BMElemSeq:
         """
         ...
 
-    def __iter__(self) -> GenericType:
+    def __iter__(self) -> typing.Iterator[GenericType]:
         """
 
         :return:
@@ -413,7 +441,7 @@ class BMElemSeq:
         """
         ...
 
-    def __next__(self) -> typing.Iterator[GenericType]:
+    def __next__(self) -> GenericType:
         """
 
         :return:
@@ -421,7 +449,7 @@ class BMElemSeq:
         """
         ...
 
-    def __len__(self) -> GenericType:
+    def __len__(self) -> int:
         """
 
         :return:
@@ -444,8 +472,11 @@ class BMFace:
     :type: bool
     """
 
-    index: typing.Any
-    """ Index of this element."""
+    index: int
+    """ Index of this element.
+
+    :type: int
+    """
 
     is_valid: bool
     """ True when this element is valid (hasn't been removed).
@@ -459,8 +490,11 @@ class BMFace:
     :type: typing.Union[typing.List[BMLoop], BMElemSeq]
     """
 
-    material_index: typing.Any
-    """ The face's material index."""
+    material_index: int
+    """ The face's material index.
+
+    :type: int
+    """
 
     normal: typing.Union[typing.Sequence[float], mathutils.Vector]
     """ The normal for this face as a 3D, wrapped vector.
@@ -492,14 +526,15 @@ class BMFace:
     :type: typing.Union[typing.List[BMVert], BMElemSeq]
     """
 
-    def calc_area(self) -> typing.Union[typing.List[BMVert], BMElemSeq]:
+    def calc_area(self) -> float:
         """Return the area of the face.
 
         :return: Return the area of the face.
+        :rtype: float
         """
         ...
 
-    def calc_center_bounds(self):
+    def calc_center_bounds(self) -> mathutils.Vector:
         """Return bounds center of the face.
 
         :return: a 3D vector.
@@ -523,14 +558,15 @@ class BMFace:
         """
         ...
 
-    def calc_perimeter(self) -> mathutils.Vector:
+    def calc_perimeter(self) -> float:
         """Return the perimeter of the face.
 
         :return: Return the perimeter of the face.
+        :rtype: float
         """
         ...
 
-    def calc_tangent_edge(self):
+    def calc_tangent_edge(self) -> mathutils.Vector:
         """Return face tangent based on longest edge.
 
         :return: a normalized vector.
@@ -562,7 +598,7 @@ class BMFace:
         """
         ...
 
-    def copy(self, verts: bool = True, edges: bool = True) -> bool:
+    def copy(self, verts: bool = True, edges: bool = True) -> BMFace:
         """Make a copy of this face.
 
         :param verts: When set, the faces verts will be duplicated too.
@@ -636,7 +672,7 @@ class BMFaceSeq:
         """Ensure internal data needed for int subscription is initialized with verts/edges/faces, eg bm.verts[index].This needs to be called again after adding/removing data in this sequence."""
         ...
 
-    def get(self, verts: BMVert, fallback=None):
+    def get(self, verts: BMVert, fallback=None) -> BMFace:
         """Return a face which uses the verts passed.
 
         :param verts: Sequence of verts.
@@ -679,7 +715,7 @@ class BMFaceSeq:
         """
         ...
 
-    def __getitem__(self, key: int) -> int:
+    def __getitem__(self, key: int) -> BMFace:
         """
 
         :param key:
@@ -699,7 +735,7 @@ class BMFaceSeq:
         """
         ...
 
-    def __delitem__(self, key: int) -> int:
+    def __delitem__(self, key: int) -> BMFace:
         """
 
         :param key:
@@ -709,7 +745,7 @@ class BMFaceSeq:
         """
         ...
 
-    def __iter__(self) -> BMFace:
+    def __iter__(self) -> typing.Iterator[GenericType]:
         """
 
         :return:
@@ -717,7 +753,7 @@ class BMFaceSeq:
         """
         ...
 
-    def __next__(self) -> typing.Iterator[GenericType]:
+    def __next__(self) -> GenericType:
         """
 
         :return:
@@ -725,7 +761,7 @@ class BMFaceSeq:
         """
         ...
 
-    def __len__(self) -> GenericType:
+    def __len__(self) -> int:
         """
 
         :return:
@@ -879,7 +915,7 @@ class BMLayerCollection:
         """
         ...
 
-    def keys(self):
+    def keys(self) -> typing.List[str]:
         """Return the identifiers of collection members
         (matching Python's dict.keys() functionality).
 
@@ -888,7 +924,7 @@ class BMLayerCollection:
         """
         ...
 
-    def new(self, name: str) -> str:
+    def new(self, name: str) -> BMLayerItem:
         """Create a new layer
 
         :param name: Optional name argument (will be made unique).
@@ -906,7 +942,7 @@ class BMLayerCollection:
         """
         ...
 
-    def values(self) -> BMLayerItem:
+    def values(self) -> list:
         """Return the values of collection
         (matching Python's dict.values() functionality).
 
@@ -915,7 +951,7 @@ class BMLayerCollection:
         """
         ...
 
-    def verify(self) -> list:
+    def verify(self) -> BMLayerItem:
         """Create a new layer or return an existing active layer
 
         :return: The newly verified layer.
@@ -954,8 +990,11 @@ class BMLoop:
     :type: BMFace
     """
 
-    index: typing.Any
-    """ Index of this element."""
+    index: int
+    """ Index of this element.
+
+    :type: int
+    """
 
     is_convex: bool
     """ True when this loop is at the convex corner of a face, depends on a valid face normal (read-only).
@@ -1011,15 +1050,16 @@ class BMLoop:
     :type: BMVert
     """
 
-    def calc_angle(self) -> BMVert:
+    def calc_angle(self) -> float:
         """Return the angle at this loops corner of the face.
         This is calculated so sharper corners give lower angles.
 
                 :return: The angle in radians.
+                :rtype: float
         """
         ...
 
-    def calc_normal(self):
+    def calc_normal(self) -> mathutils.Vector:
         """Return normal at this loops corner of the face.
         Falls back to the face normal for straight lines.
 
@@ -1067,7 +1107,7 @@ class BMLoopSeq:
     :type: BMLayerAccessLoop
     """
 
-    def __getitem__(self, key: int) -> int:
+    def __getitem__(self, key: int) -> BMLoop:
         """
 
         :param key:
@@ -1087,7 +1127,7 @@ class BMLoopSeq:
         """
         ...
 
-    def __delitem__(self, key: int) -> int:
+    def __delitem__(self, key: int) -> BMLoop:
         """
 
         :param key:
@@ -1097,7 +1137,7 @@ class BMLoopSeq:
         """
         ...
 
-    def __iter__(self) -> BMLoop:
+    def __iter__(self) -> typing.Iterator[GenericType]:
         """
 
         :return:
@@ -1105,7 +1145,7 @@ class BMLoopSeq:
         """
         ...
 
-    def __next__(self) -> typing.Iterator[GenericType]:
+    def __next__(self) -> GenericType:
         """
 
         :return:
@@ -1113,7 +1153,7 @@ class BMLoopSeq:
         """
         ...
 
-    def __len__(self) -> GenericType:
+    def __len__(self) -> int:
         """
 
         :return:
@@ -1163,8 +1203,11 @@ class BMVert:
     :type: bool
     """
 
-    index: typing.Any
-    """ Index of this element."""
+    index: int
+    """ Index of this element.
+
+    :type: int
+    """
 
     is_boundary: bool
     """ True when this vertex is connected to boundary edges (read-only).
@@ -1226,22 +1269,24 @@ class BMVert:
     :type: bool
     """
 
-    def calc_edge_angle(self, fallback: typing.Any = None) -> typing.Any:
+    def calc_edge_angle(self, fallback: typing.Any = None) -> float:
         """Return the angle between this vert's two connected edges.
 
                 :param fallback: return this when the vert doesn't have 2 edges
         (instead of raising a `ValueError`).
                 :type fallback: typing.Any
                 :return: Angle between edges in radians.
+                :rtype: float
         """
         ...
 
-    def calc_shell_factor(self):
+    def calc_shell_factor(self) -> float:
         """Return a multiplier calculated based on the sharpness of the vertex.
         Where a flat surface gives 1.0, and higher values sharper edges.
         This is used to maintain shell thickness when offsetting verts along their normals.
 
                 :return: offset multiplier
+                :rtype: float
         """
         ...
 
@@ -1343,7 +1388,7 @@ class BMVertSeq:
         """
         ...
 
-    def __getitem__(self, key: int) -> int:
+    def __getitem__(self, key: int) -> BMVert:
         """
 
         :param key:
@@ -1363,7 +1408,7 @@ class BMVertSeq:
         """
         ...
 
-    def __delitem__(self, key: int) -> int:
+    def __delitem__(self, key: int) -> BMVert:
         """
 
         :param key:
@@ -1373,7 +1418,7 @@ class BMVertSeq:
         """
         ...
 
-    def __iter__(self) -> BMVert:
+    def __iter__(self) -> typing.Iterator[GenericType]:
         """
 
         :return:
@@ -1381,7 +1426,7 @@ class BMVertSeq:
         """
         ...
 
-    def __next__(self) -> typing.Iterator[GenericType]:
+    def __next__(self) -> GenericType:
         """
 
         :return:
@@ -1389,7 +1434,7 @@ class BMVertSeq:
         """
         ...
 
-    def __len__(self) -> GenericType:
+    def __len__(self) -> int:
         """
 
         :return:
@@ -1448,19 +1493,20 @@ class BMesh:
     :type: BMVertSeq
     """
 
-    def calc_loop_triangles(self) -> BMVertSeq:
+    def calc_loop_triangles(self):
         """Calculate triangle tessellation from quads/ngons.
 
         :return: The triangulated faces.
         """
         ...
 
-    def calc_volume(self, signed: bool = False) -> bool:
+    def calc_volume(self, signed: bool = False) -> float:
         """Calculate mesh volume based on face normals.
 
         :param signed: when signed is true, negative values may be returned.
         :type signed: bool
         :return: The volume of the mesh.
+        :rtype: float
         """
         ...
 
@@ -1468,7 +1514,7 @@ class BMesh:
         """Clear all mesh data."""
         ...
 
-    def copy(self):
+    def copy(self) -> BMesh:
         """
 
         :return: A copy of this BMesh.
@@ -1486,7 +1532,7 @@ class BMesh:
         face_normals=True,
         vertex_normals=True,
         use_shape_key: bool = False,
-        shape_key_index=0,
+        shape_key_index: int = 0,
     ):
         """Initialize this bmesh from existing mesh datablock.
 
@@ -1497,6 +1543,7 @@ class BMesh:
         :param use_shape_key: Use the locations from a shape key.
         :type use_shape_key: bool
         :param shape_key_index: The shape key index to use.
+        :type shape_key_index: int
         """
         ...
 

bmesh/utils/__init__.pyi

@@ -1,3 +1,8 @@
+"""
+This module provides access to blenders bmesh data structures.
+
+"""
+
 import typing
 import bmesh.types
 
@@ -17,7 +22,9 @@ def edge_rotate(edge: bmesh.types.BMEdge, ccw: bool = False) -> bmesh.types.BMEd
 
     ...
 
-def edge_split(edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac) -> typing.Tuple:
+def edge_split(
+    edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac: float
+) -> typing.Tuple:
     """Split an edge, return the newly created data.
 
     :param edge: The edge to split.
@@ -25,6 +32,7 @@ def edge_split(edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac) -> typin
     :param vert: One of the verts on the edge, defines the split direction.
     :type vert: bmesh.types.BMVert
     :param fac: The point on the edge where the new vert will be created [0 - 1].
+    :type fac: float
     :return: The newly created (edge, vert) pair.
     :rtype: typing.Tuple
     """
@@ -134,7 +142,7 @@ def vert_collapse_edge(
     ...
 
 def vert_collapse_faces(
-    vert: bmesh.types.BMVert, edge: bmesh.types.BMEdge, fac, join_faces: bool
+    vert: bmesh.types.BMVert, edge: bmesh.types.BMEdge, fac: float, join_faces: bool
 ) -> bmesh.types.BMEdge:
     """Collapses a vertex that has only two manifold edges onto a vertex it shares an edge with.
 
@@ -143,6 +151,7 @@ def vert_collapse_faces(
     :param edge: The edge to collapse into.
     :type edge: bmesh.types.BMEdge
     :param fac: The factor to use when merging customdata [0 - 1].
+    :type fac: float
     :param join_faces: When true the faces around the vertex will be joined otherwise collapse the vertex by merging the 2 edges this vertex connects to into one.
     :type join_faces: bool
     :return: The resulting edge from the collapse operation.

bpy/__init__.pyi

@@ -1,3 +1,10 @@
+"""
+This module is used for all Blender/Python access.
+
+```../examples/bpy.data.py```
+
+"""
+
 import typing
 import bpy.types
 

bpy/app/__init__.pyi

@@ -1,3 +1,16 @@
+"""
+This module contains application values that remain unchanged during runtime.
+
+bpy.app.handlers.rst
+bpy.app.translations.rst
+bpy.app.icons.rst
+bpy.app.timers.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+"""
+
 import typing
 from . import handlers
 from . import icons

bpy/app/handlers/__init__.pyi

@@ -1,3 +1,44 @@
+"""
+This module contains callback lists
+
+
+--------------------
+
+This script shows the most simple example of adding a handler.
+
+```../examples/bpy.app.handlers.py```
+
+
+--------------------
+
+By default handlers are freed when loading new files, in some cases you may
+want the handler stay running across multiple files (when the handler is
+part of an add-on for example).
+
+For this the bpy.app.handlers.persistent decorator needs to be used.
+
+```../examples/bpy.app.handlers.1.py```
+
+
+--------------------
+
+Altering data from handlers should be done carefully. While rendering the
+frame_change_pre
+
+ and frame_change_post
+
+ handlers are called from one
+thread and the viewport updates from a different thread. If the handler changes
+data that is accessed by the viewport, this can cause a crash of Blender. In
+such cases, lock the interface (Render → Lock Interface or
+bpy.types.RenderSettings.use_lock_interface) before starting a render.
+
+Below is an example of a mesh that is altered from a handler:
+
+```../examples/bpy.app.handlers.2.py```
+
+"""
+
 import typing
 import bpy.types