fake-bpy-module 20240516__py3-none-any.whl → 20240517__py3-none-any.whl

bpy_extras/io_utils/__init__.pyi

@@ -42,7 +42,7 @@ class ImportHelper:
         """
         ...
 
-    def invoke_popup(self, context, confirm_text):
+    def invoke_popup(self, context, confirm_text=""):
         """
 
         :param context:
@@ -58,8 +58,11 @@ def axis_conversion(from_forward="Y", from_up="Z", to_forward="Y", to_up="Z"):
 
     ...
 
-def axis_conversion(from_forward, from_up, to_forward, to_up):
-    """ """
+def axis_conversion(from_forward="Y", from_up="Z", to_forward="Y", to_up="Z"):
+    """Each argument us an axis in ['X', 'Y', 'Z', '-X', '-Y', '-Z']
+    where the first 2 are a source and the second 2 are the target.
+
+    """
 
     ...
 
@@ -81,8 +84,21 @@ def axis_conversion_ensure(
 
     ...
 
-def axis_conversion_ensure(operator, forward_attr, up_attr):
-    """ """
+def axis_conversion_ensure(
+    operator: bpy.types.Operator, forward_attr: str, up_attr: str
+) -> bool:
+    """Function to ensure an operator has valid axis conversion settings, intended
+    to be used from `bpy.types.Operator.check`.
+
+        :param operator: the operator to access axis attributes from.
+        :type operator: bpy.types.Operator
+        :param forward_attr: attribute storing the forward axis
+        :type forward_attr: str
+        :param up_attr: attribute storing the up axis
+        :type up_attr: str
+        :return: True if the value was modified.
+        :rtype: bool
+    """
 
     ...
 
@@ -102,8 +118,19 @@ def create_derived_objects(
 
     ...
 
-def create_derived_objects(depsgraph, objects):
-    """ """
+def create_derived_objects(
+    depsgraph: bpy.types.Depsgraph, objects: typing.Iterable[bpy.types.Object]
+) -> dict:
+    """This function takes a sequence of objects, returning their instances.
+
+        :param depsgraph: The evaluated depsgraph.
+        :type depsgraph: bpy.types.Depsgraph
+        :param objects: A sequencer of objects.
+        :type objects: typing.Iterable[bpy.types.Object]
+        :return: A dictionary where each key is an object from objects,
+    values are lists of (`bpy.types.Object`, `mathutils.Matrix`) tuples representing instances.
+        :rtype: dict
+    """
 
     ...
 
@@ -115,8 +142,11 @@ def orientation_helper(axis_forward="Y", axis_up="Z"):
 
     ...
 
-def orientation_helper(axis_forward, axis_up):
-    """ """
+def orientation_helper(axis_forward="Y", axis_up="Z"):
+    """A decorator for import/export classes, generating properties needed by the axis conversion system and IO helpers,
+    with specified default values (axes).
+
+    """
 
     ...
 
@@ -127,7 +157,7 @@ def path_reference(
     mode: str = "AUTO",
     copy_subdir: str = "",
     copy_set: set = None,
-    library: typing.Optional[bpy.types.Library] = None,
+    library: bpy.types.Library | None = None,
 ) -> str:
     """Return a filepath relative to a destination directory, for use with
     exporters.
@@ -150,15 +180,47 @@ def path_reference(
     pass to path_reference_copy when exporting is done.
         :type copy_set: set
         :param library: The library this path is relative to.
-        :type library: typing.Optional[bpy.types.Library]
+        :type library: bpy.types.Library | None
         :return: the new filepath.
         :rtype: str
     """
 
     ...
 
-def path_reference(filepath, base_src, base_dst, mode, copy_subdir, copy_set, library):
-    """ """
+def path_reference(
+    filepath: str,
+    base_src: str,
+    base_dst: str,
+    mode: str = "AUTO",
+    copy_subdir: str = "",
+    copy_set: set = None,
+    library: bpy.types.Library | None = None,
+) -> str:
+    """Return a filepath relative to a destination directory, for use with
+    exporters.
+
+        :param filepath: the file path to return,
+    supporting blenders relative '//' prefix.
+        :type filepath: str
+        :param base_src: the directory the filepath is relative too
+    (normally the blend file).
+        :type base_src: str
+        :param base_dst: the directory the filepath will be referenced from
+    (normally the export path).
+        :type base_dst: str
+        :param mode: the method used get the path in
+    ['AUTO', 'ABSOLUTE', 'RELATIVE', 'MATCH', 'STRIP', 'COPY']
+        :type mode: str
+        :param copy_subdir: the subdirectory of base_dst to use when mode='COPY'.
+        :type copy_subdir: str
+        :param copy_set: collect from/to pairs when mode='COPY',
+    pass to path_reference_copy when exporting is done.
+        :type copy_set: set
+        :param library: The library this path is relative to.
+        :type library: bpy.types.Library | None
+        :return: the new filepath.
+        :rtype: str
+    """
 
     ...
 
@@ -173,13 +235,22 @@ def path_reference_copy(copy_set: set, report: typing.Any = None):
 
     ...
 
-def path_reference_copy(copy_set, report):
-    """ """
+def path_reference_copy(copy_set: set, report: typing.Any = None):
+    """Execute copying files of path_reference
+
+    :param copy_set: set of (from, to) pairs to copy.
+    :type copy_set: set
+    :param report: function used for reporting warnings, takes a string argument.
+    :type report: typing.Any
+    """
 
     ...
 
 def poll_file_object_drop(context):
-    """ """
+    """A default implementation for FileHandler poll_drop methods. Allows for both the 3D Viewport and
+    the Outliner (in ViewLayer display mode) to be targets for file drag and drop.
+
+    """
 
     ...
 
@@ -212,8 +283,32 @@ def unique_name(
 
     ...
 
-def unique_name(key, name, name_dict, name_max, clean_func, sep):
-    """ """
+def unique_name(
+    key,
+    name: str,
+    name_dict: dict,
+    name_max=-1,
+    clean_func: typing.Any = None,
+    sep: str = ".",
+):
+    """Helper function for storing unique names which may have special characters
+    stripped and restricted to a maximum length.
+
+        :param key: unique item this name belongs to, name_dict[key] will be reused
+    when available.
+    This can be the object, mesh, material, etc instance itself.
+        :param name: The name used to create a unique value in name_dict.
+        :type name: str
+        :param name_dict: This is used to cache namespace to ensure no collisions
+    occur, this should be an empty dict initially and only modified by this
+    function.
+        :type name_dict: dict
+        :param clean_func: Function to call on name before creating a unique value.
+        :type clean_func: typing.Any
+        :param sep: Separator to use when between the name and a number when a
+    duplicate name is found.
+        :type sep: str
+    """
 
     ...
 

bpy_extras/keyconfig_utils/__init__.pyi

@@ -8,7 +8,7 @@ def addon_keymap_register(keymap_data):
     ...
 
 def addon_keymap_register(keymap_data):
-    """ """
+    """Register a set of keymaps for addons using a list of keymaps.See 'blender_defaults.py' for examples of the format this takes."""
 
     ...
 
@@ -18,7 +18,7 @@ def addon_keymap_unregister(keymap_data):
     ...
 
 def addon_keymap_unregister(keymap_data):
-    """ """
+    """Unregister a set of keymaps for addons."""
 
     ...
 

bpy_extras/mesh_utils/__init__.pyi

@@ -12,8 +12,12 @@ def edge_face_count(mesh) -> list:
 
     ...
 
-def edge_face_count(mesh):
-    """ """
+def edge_face_count(mesh) -> list:
+    """
+
+    :return: list face users for each item in mesh.edges.
+    :rtype: list
+    """
 
     ...
 
@@ -27,8 +31,13 @@ def edge_face_count_dict(mesh) -> dict:
 
     ...
 
-def edge_face_count_dict(mesh):
-    """ """
+def edge_face_count_dict(mesh) -> dict:
+    """
+
+        :return: dict of edge keys with their value set to the number of
+    faces using each edge.
+        :rtype: dict
+    """
 
     ...
 
@@ -40,8 +49,11 @@ def edge_loops_from_edges(mesh, edges=None):
 
     ...
 
-def edge_loops_from_edges(mesh, edges):
-    """ """
+def edge_loops_from_edges(mesh, edges=None):
+    """Edge loops defined by edgesTakes me.edges or a list of edges and returns the edge loopsreturn a list of vertex indices.
+    [ [1, 6, 7, 2], ...]closed loops have matching start and end values.
+
+    """
 
     ...
 
@@ -57,8 +69,15 @@ def mesh_linked_triangles(mesh: bpy.types.Mesh) -> list:
 
     ...
 
-def mesh_linked_triangles(mesh):
-    """ """
+def mesh_linked_triangles(mesh: bpy.types.Mesh) -> list:
+    """Splits the mesh into connected triangles, use this for separating cubes from
+    other mesh elements within 1 mesh datablock.
+
+        :param mesh: the mesh used to group with.
+        :type mesh: bpy.types.Mesh
+        :return: lists of lists containing triangles.
+        :rtype: list
+    """
 
     ...
 
@@ -73,13 +92,19 @@ def mesh_linked_uv_islands(mesh: bpy.types.Mesh) -> list:
 
     ...
 
-def mesh_linked_uv_islands(mesh):
-    """ """
+def mesh_linked_uv_islands(mesh: bpy.types.Mesh) -> list:
+    """Returns lists of polygon indices connected by UV islands.
+
+    :param mesh: the mesh used to group with.
+    :type mesh: bpy.types.Mesh
+    :return: list of lists containing polygon indices
+    :rtype: list
+    """
 
     ...
 
 def ngon_tessellate(
-    from_data: typing.Union[list, bpy.types.Mesh],
+    from_data: list | bpy.types.Mesh,
     indices: list,
     fix_loops: bool = True,
     debug_print=True,
@@ -89,7 +114,7 @@ def ngon_tessellate(
     ngon to create from existing verts.
 
         :param from_data: either a mesh, or a list/tuple of vectors.
-        :type from_data: typing.Union[list, bpy.types.Mesh]
+        :type from_data: list | bpy.types.Mesh
         :param indices: a list of indices to use this list
     is the ordered closed poly-line
     to fill, and can be a subset of the data given.
@@ -102,27 +127,54 @@ def ngon_tessellate(
 
     ...
 
-def ngon_tessellate(from_data, indices, fix_loops, debug_print):
-    """ """
+def ngon_tessellate(
+    from_data: list | bpy.types.Mesh,
+    indices: list,
+    fix_loops: bool = True,
+    debug_print=True,
+):
+    """Takes a poly-line of indices (ngon) and returns a list of face
+    index lists. Designed to be used for importers that need indices for an
+    ngon to create from existing verts.
+
+        :param from_data: either a mesh, or a list/tuple of vectors.
+        :type from_data: list | bpy.types.Mesh
+        :param indices: a list of indices to use this list
+    is the ordered closed poly-line
+    to fill, and can be a subset of the data given.
+        :type indices: list
+        :param fix_loops: If this is enabled poly-lines
+    that use loops to make multiple
+    poly-lines are dealt with correctly.
+        :type fix_loops: bool
+    """
 
     ...
 
 def triangle_random_points(
-    num_points,
-    loop_triangles: typing.Union[bpy.types.MeshLoopTriangle, typing.Sequence],
+    num_points, loop_triangles: bpy.types.MeshLoopTriangle | typing.Sequence
 ) -> list:
     """Generates a list of random points over mesh loop triangles.
 
     :param num_points: the number of random points to generate on each triangle.
     :param loop_triangles: list of the triangles to generate points on.
-    :type loop_triangles: typing.Union[bpy.types.MeshLoopTriangle, typing.Sequence]
+    :type loop_triangles: bpy.types.MeshLoopTriangle | typing.Sequence
     :return: list of random points over all triangles.
     :rtype: list
     """
 
     ...
 
-def triangle_random_points(num_points, loop_triangles):
-    """ """
+def triangle_random_points(
+    num_points, loop_triangles: bpy.types.MeshLoopTriangle | typing.Sequence
+) -> list:
+    """Generates a list of random points over mesh loop triangles.
+
+    :param num_points: the number of random points to generate on each triangle.
+    :param loop_triangles: list of the triangles to generate points on.
+    :type loop_triangles: bpy.types.MeshLoopTriangle | typing.Sequence
+    :return: list of random points over all triangles.
+    :rtype: list
+    """
 
     ...

bpy_extras/node_shader_utils/__init__.pyi

@@ -3,7 +3,7 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class ShaderWrapper:
-    """ """
+    """Base class with minimal common ground for all types of shader interfaces we may want/need to implement."""
 
     NODES_LIST: typing.Any
     """ """
@@ -43,7 +43,9 @@ class ShaderWrapper:
         ...
 
 class ShaderImageTextureWrapper:
-    """ """
+    """Generic 'image texture'-like wrapper, handling image node, some mapping (texture coordinates transformations),
+    and texture coordinates source.
+    """
 
     NODES_LIST: typing.Any
     """ """
@@ -203,7 +205,10 @@ class ShaderImageTextureWrapper:
         ...
 
 class PrincipledBSDFWrapper(ShaderWrapper):
-    """ """
+    """Hard coded shader setup, based in Principled BSDF.
+    Should cover most common cases on import, and gives a basic nodal shaders support for export.
+    Supports basic: diffuse/spec/reflect/transparency/normal, with texturing.
+    """
 
     NODES_LIST: typing.Any
     """ """
@@ -483,7 +488,7 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-def node_input_value_get(node, input, default_value):
+def node_input_value_get(node, input, default_value=None):
     """ """
 
     ...

bpy_extras/node_utils/__init__.pyi

@@ -3,12 +3,19 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 def connect_sockets(input, output):
-    """ """
+    """Connect sockets in a node tree.This is useful because the links created through the normal Python API are
+    invalid when one of the sockets is a virtual socket (grayed out sockets in
+    Group Input and Group Output nodes).It replaces node_tree.links.new(input, output)
+
+    """
 
     ...
 
 def find_base_socket_type(socket):
-    """ """
+    """Find the base class of the socket.Sockets can have a subtype such as NodeSocketFloatFactor,
+    but only the base type is allowed, e. g. NodeSocketFloat
+
+    """
 
     ...
 

bpy_extras/object_utils/__init__.pyi

@@ -36,8 +36,18 @@ def add_object_align_init(
 
     ...
 
-def add_object_align_init(context, operator):
-    """ """
+def add_object_align_init(
+    context: bpy.types.Context, operator: bpy.types.Operator
+) -> mathutils.Matrix:
+    """Return a matrix using the operator settings and view context.
+
+    :param context: The context to use.
+    :type context: bpy.types.Context
+    :param operator: The operator, checked for location and rotation properties.
+    :type operator: bpy.types.Operator
+    :return: the matrix from the context and settings.
+    :rtype: mathutils.Matrix
+    """
 
     ...
 
@@ -50,7 +60,10 @@ def object_add_grid_scale(context):
     ...
 
 def object_add_grid_scale(context):
-    """ """
+    """Return scale which should be applied on object
+    data to align it to grid scale
+
+    """
 
     ...
 
@@ -60,7 +73,7 @@ def object_add_grid_scale_apply_operator(operator, context):
     ...
 
 def object_add_grid_scale_apply_operator(operator, context):
-    """ """
+    """Scale an operators distance values by the grid size."""
 
     ...
 
@@ -86,8 +99,25 @@ def object_data_add(
 
     ...
 
-def object_data_add(context, obdata, operator, name):
-    """ """
+def object_data_add(
+    context: bpy.types.Context,
+    obdata,
+    operator: bpy.types.Operator = None,
+    name: str = None,
+) -> bpy.types.Object:
+    """Add an object using the view context and preference to initialize the
+    location, rotation and layer.
+
+        :param context: The context to use.
+        :type context: bpy.types.Context
+        :param obdata: the data used for the new object.
+        :param operator: The operator, checked for location and rotation properties.
+        :type operator: bpy.types.Operator
+        :param name: Optional name
+        :type name: str
+        :return: the newly created object in the scene.
+        :rtype: bpy.types.Object
+    """
 
     ...
 
@@ -105,15 +135,24 @@ def object_report_if_active_shape_key_is_locked(
 
     ...
 
-def object_report_if_active_shape_key_is_locked(obj, operator):
-    """ """
+def object_report_if_active_shape_key_is_locked(
+    obj: bpy.types.Object, operator: bpy.types.Operator
+):
+    """Checks if the active shape key of the specified object is locked, and reports an error if so.If the object has no shape keys, there is nothing to lock, and the function returns False.
+
+    :param obj: Object to check.
+    :type obj: bpy.types.Object
+    :param operator: Currently running operator to report the error through. Use None to suppress emitting the message.
+    :type operator: bpy.types.Operator
+    :return: True if the shape key was locked.
+    """
 
     ...
 
 def world_to_camera_view(
     scene: bpy.types.Scene,
     obj: bpy.types.Object,
-    coord: typing.Union[typing.Sequence[float], mathutils.Vector],
+    coord: typing.Sequence[float] | mathutils.Vector,
 ) -> mathutils.Vector:
     """Returns the camera space coords for a 3d point.
     (also known as: normalized device coordinates - NDC).Where (0, 0) is the bottom left and (1, 1)
@@ -127,7 +166,7 @@ def world_to_camera_view(
         :param obj: Camera object.
         :type obj: bpy.types.Object
         :param coord: World space location.
-        :type coord: typing.Union[typing.Sequence[float], mathutils.Vector]
+        :type coord: typing.Sequence[float] | mathutils.Vector
         :return: a vector where X and Y map to the view plane and
     Z is the depth on the view axis.
         :rtype: mathutils.Vector
@@ -135,7 +174,27 @@ def world_to_camera_view(
 
     ...
 
-def world_to_camera_view(scene, obj, coord):
-    """ """
+def world_to_camera_view(
+    scene: bpy.types.Scene,
+    obj: bpy.types.Object,
+    coord: typing.Sequence[float] | mathutils.Vector,
+) -> mathutils.Vector:
+    """Returns the camera space coords for a 3d point.
+    (also known as: normalized device coordinates - NDC).Where (0, 0) is the bottom left and (1, 1)
+    is the top right of the camera frame.
+    values outside 0-1 are also supported.
+    A negative 'z' value means the point is behind the camera.Takes shift-x/y, lens angle and sensor size into account
+    as well as perspective/ortho projections.
+
+        :param scene: Scene to use for frame size.
+        :type scene: bpy.types.Scene
+        :param obj: Camera object.
+        :type obj: bpy.types.Object
+        :param coord: World space location.
+        :type coord: typing.Sequence[float] | mathutils.Vector
+        :return: a vector where X and Y map to the view plane and
+    Z is the depth on the view axis.
+        :rtype: mathutils.Vector
+    """
 
     ...