fake-bpy-module 20240210__py3-none-any.whl → 20240326__py3-none-any.whl

bpy/utils/previews/__init__.pyi

@@ -1,11 +1,12 @@
-import sys
 import typing
 import bpy.types
 
 GenericType = typing.TypeVar("GenericType")
 
 class ImagePreviewCollection:
-    """Dictionary-like class of previews. This is a subclass of Python's built-in dict type, used to store multiple image previews."""
+    """Dictionary-like class of previews.This is a subclass of Python's built-in dict type,
+    used to store multiple image previews.
+    """
 
     def clear(self):
         """Clear all previews."""
@@ -17,50 +18,136 @@ class ImagePreviewCollection:
 
     def load(
         self,
-        name: typing.Optional[str],
-        filepath: typing.Optional[typing.Union[str, bytes]],
-        filetype: typing.Optional[str],
-        force_reload: typing.Optional[bool] = False,
-    ) -> "bpy.types.ImagePreview":
-        """Generate a new preview from given file path. :raises KeyError: if ``name`` already exists.
+        name: str,
+        filepath: typing.Union[str, bytes],
+        filetype: str,
+        force_reload: bool = False,
+    ) -> bool:
+        """Generate a new preview from given file path.
 
         :param name: The name (unique id) identifying the preview.
-        :type name: typing.Optional[str]
+        :type name: str
         :param filepath: The file path to generate the preview from.
-        :type filepath: typing.Optional[typing.Union[str, bytes]]
+        :type filepath: typing.Union[str, bytes]
         :param filetype: The type of file, needed to generate the preview in ['IMAGE', 'MOVIE', 'BLEND', 'FONT'].
-        :type filetype: typing.Optional[str]
+        :type filetype: str
         :param force_reload: If True, force running thumbnail manager even if preview already exists in cache.
-        :type force_reload: typing.Optional[bool]
-        :rtype: 'bpy.types.ImagePreview'
+        :type force_reload: bool
         :return: The Preview matching given name, or a new empty one.
+        :rtype: bpy.types.ImagePreview
         """
         ...
 
-    def new(self, name: typing.Optional[str]) -> "bpy.types.ImagePreview":
-        """Generate a new empty preview. :raises KeyError: if ``name`` already exists.
+    def new(self, name: str) -> str:
+        """Generate a new empty preview.
 
         :param name: The name (unique id) identifying the preview.
-        :type name: typing.Optional[str]
-        :rtype: 'bpy.types.ImagePreview'
+        :type name: str
         :return: The Preview matching given name, or a new empty one.
+        :rtype: bpy.types.ImagePreview
+        """
+        ...
+
+class ImagePreviewCollection:
+    """ """
+
+    def clear(self):
+        """ """
+        ...
+
+    def close(self):
+        """ """
+        ...
+
+    def copy(self):
+        """ """
+        ...
+
+    def fromkeys(self):
+        """ """
+        ...
+
+    def get(self, key, default):
         """
+
+        :param key:
+        :param default:
+        """
+        ...
+
+    def items(self):
+        """ """
         ...
 
-def new() -> "ImagePreviewCollection":
+    def keys(self):
+        """ """
+        ...
+
+    def load(self, name, path, path_type, force_reload):
+        """
+
+        :param name:
+        :param path:
+        :param path_type:
+        :param force_reload:
+        """
+        ...
+
+    def new(self, name):
+        """
+
+        :param name:
+        """
+        ...
+
+    def pop(self):
+        """ """
+        ...
+
+    def popitem(self):
+        """ """
+        ...
+
+    def setdefault(self, key, default):
+        """
+
+        :param key:
+        :param default:
+        """
+        ...
+
+    def update(self):
+        """ """
+        ...
+
+    def values(self):
+        """ """
+        ...
+
+def new() -> ImagePreviewCollection:
     """
 
-    :rtype: 'ImagePreviewCollection'
     :return: a new preview collection.
+    :rtype: ImagePreviewCollection
     """
 
     ...
 
-def remove(pcoll: typing.Optional["ImagePreviewCollection"]):
+def new():
+    """ """
+
+    ...
+
+def remove(pcoll: ImagePreviewCollection):
     """Remove the specified previews collection.
 
     :param pcoll: Preview collection to close.
-    :type pcoll: typing.Optional['ImagePreviewCollection']
+    :type pcoll: ImagePreviewCollection
     """
 
     ...
+
+def remove(pcoll):
+    """ """
+
+    ...

bpy/utils/units/__init__.pyi

@@ -1,54 +1,52 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
 def to_string(
-    unit_system: typing.Optional[str],
-    unit_category: typing.Optional[str],
-    value: typing.Optional[float],
-    precision: typing.Optional[int] = 3,
-    split_unit: typing.Optional[bool] = False,
-    compatible_unit: typing.Optional[bool] = False,
+    unit_system: str,
+    unit_category: str,
+    value: float,
+    precision: int = 3,
+    split_unit: bool = False,
+    compatible_unit: bool = False,
 ) -> str:
-    """Convert a given input float value into a string with units. :raises ValueError: if conversion fails to generate a valid Python string.
-
-    :param unit_system: `bpy.utils.units.systems`.
-    :type unit_system: typing.Optional[str]
-    :param unit_category: The category of data we are converting (length, area, rotation, etc.), from :attr:`bpy.utils.units.categories`.
-    :type unit_category: typing.Optional[str]
-    :param value: The value to convert to a string.
-    :type value: typing.Optional[float]
-    :param precision: Number of digits after the comma.
-    :type precision: typing.Optional[int]
-    :param split_unit: Whether to use several units if needed (1m1cm), or always only one (1.01m).
-    :type split_unit: typing.Optional[bool]
-    :param compatible_unit: Whether to use keyboard-friendly units (1m2) or nicer utf-8 ones (1m²).
-    :type compatible_unit: typing.Optional[bool]
-    :rtype: str
-    :return: The converted string.
+    """Convert a given input float value into a string with units.
+
+        :param unit_system: The unit system, from `bpy.utils.units.systems`.
+        :type unit_system: str
+        :param unit_category: The category of data we are converting (length, area, rotation, etc.),
+    from `bpy.utils.units.categories`.
+        :type unit_category: str
+        :param value: The value to convert to a string.
+        :type value: float
+        :param precision: Number of digits after the comma.
+        :type precision: int
+        :param split_unit: Whether to use several units if needed (1m1cm), or always only one (1.01m).
+        :type split_unit: bool
+        :param compatible_unit: Whether to use keyboard-friendly units (1m2) or nicer utf-8 ones (1m²).
+        :type compatible_unit: bool
+        :return: The converted string.
+        :rtype: str
     """
 
     ...
 
 def to_value(
-    unit_system: typing.Optional[str],
-    unit_category: typing.Optional[str],
-    str_input: typing.Optional[str],
-    str_ref_unit: typing.Optional[str] = None,
+    unit_system: str, unit_category: str, str_input: str, str_ref_unit: str = None
 ) -> float:
-    """Convert a given input string into a float value. :raises ValueError: if conversion fails to generate a valid Python float value.
-
-    :param unit_system: `bpy.utils.units.systems`.
-    :type unit_system: typing.Optional[str]
-    :param unit_category: The category of data we are converting (length, area, rotation, etc.), from :attr:`bpy.utils.units.categories`.
-    :type unit_category: typing.Optional[str]
-    :param str_input: The string to convert to a float value.
-    :type str_input: typing.Optional[str]
-    :param str_ref_unit: A reference string from which to extract a default unit, if none is found in ``str_input``.
-    :type str_ref_unit: typing.Optional[str]
-    :rtype: float
-    :return: The converted/interpreted value.
+    """Convert a given input string into a float value.
+
+        :param unit_system: The unit system, from `bpy.utils.units.systems`.
+        :type unit_system: str
+        :param unit_category: The category of data we are converting (length, area, rotation, etc.),
+    from `bpy.utils.units.categories`.
+        :type unit_category: str
+        :param str_input: The string to convert to a float value.
+        :type str_input: str
+        :param str_ref_unit: A reference string from which to extract a default unit, if none is found in str_input.
+        :type str_ref_unit: str
+        :return: The converted/interpreted value.
+        :rtype: float
     """
 
     ...

bpy_extras/__init__.pyi

@@ -1,18 +1,13 @@
-import sys
 import typing
+from . import anim_utils
 from . import asset_utils
 from . import id_map_utils
-from . import node_utils
 from . import image_utils
+from . import io_utils
+from . import keyconfig_utils
 from . import mesh_utils
+from . import node_utils
 from . import object_utils
-from . import io_utils
 from . import view3d_utils
-from . import anim_utils
-from . import keyconfig_utils
-from . import node_shader_utils
-from . import extensions
-from . import bmesh_utils
-from . import wm_utils
 
 GenericType = typing.TypeVar("GenericType")

bpy_extras/anim_utils/__init__.pyi

@@ -1,85 +1,55 @@
-import sys
 import typing
 import bpy.types
 
 GenericType = typing.TypeVar("GenericType")
 
-class BakeOptions: ...
-
-class KeyframesCo:
-    keyframes_from_fcurve: typing.Any
-
-    def add_paths(self, rna_path, total_indices): ...
-    def extend_co_value(self, rna_path, frame, value): ...
-    def extend_co_values(self, rna_path, total_indices, frame, values): ...
-    def insert_keyframes_into_existing_action(
-        self, lookup_fcurves, total_new_keys, action, action_group_name
-    ): ...
-    def insert_keyframes_into_new_action(
-        self, total_new_keys, action, action_group_name
-    ): ...
-
 def bake_action(
-    obj: "bpy.types.Object",
-    *,
-    action: typing.Optional["bpy.types.Action"],
-    frames: int,
-    bake_o,
-) -> "bpy.types.Action":
+    obj: bpy.types.Object, action, frames, bake_options
+) -> bpy.types.Action:
     """
 
-    :param obj: Object to bake.
-    :type obj: 'bpy.types.Object'
-    :param action: An action to bake the data into, or None for a new action to be created.
-    :type action: typing.Optional['bpy.types.Action']
-    :param frames: Frames to bake.
-    :type frames: int
-    :rtype: 'bpy.types.Action'
-    :return: an action or None
+        :param obj: Object to bake.
+        :type obj: bpy.types.Object
+        :param action: An action to bake the data into, or None for a new action
+    to be created.
+        :param frames: Frames to bake.
+        :return: an action or None
+        :rtype: bpy.types.Action
     """
 
     ...
 
-def bake_action_iter(
-    obj: "bpy.types.Object", *, action: typing.Optional["bpy.types.Action"], bake_o
-) -> "bpy.types.Action":
+def bake_action_iter(obj: bpy.types.Object, action, bake_options) -> bpy.types.Action:
     """An coroutine that bakes action for a single object.
 
-    :param obj: Object to bake.
-    :type obj: 'bpy.types.Object'
-    :param action: An action to bake the data into, or None for a new action to be created.
-    :type action: typing.Optional['bpy.types.Action']
-    :param bake_options: Boolean options of what to include into the action bake.
-    :type bake_options: typing.Any
-    :rtype: 'bpy.types.Action'
-    :return: an action or None
+        :param obj: Object to bake.
+        :type obj: bpy.types.Object
+        :param action: An action to bake the data into, or None for a new action
+    to be created.
+        :param bake_options: Boolean options of what to include into the action bake.
+        :return: an action or None
+        :rtype: bpy.types.Action
     """
 
     ...
 
 def bake_action_objects(
-    object_action_pairs, *, frames: int, bake_o
-) -> typing.Iterable["bpy.types.Action"]:
-    """A version of :func:`bake_action_objects_iter` that takes frames and returns the output.
+    object_action_pairs, frames, bake_options
+) -> typing.Iterable[bpy.types.Action]:
+    """A version of `bake_action_objects_iter` that takes frames and returns the output.
 
     :param frames: Frames to bake.
-    :type frames: int
-    :rtype: typing.Iterable['bpy.types.Action']
-    :return: A sequence of Action or None types (aligned with `object_action_pairs`)
+    :return: A sequence of Action or None types (aligned with object_action_pairs)
+    :rtype: typing.Iterable[bpy.types.Action]
     """
 
     ...
 
-def bake_action_objects_iter(
-    object_action_pairs: typing.Union[
-        "bpy.types.Action", "bpy.types.Sequence", "bpy.types.Object"
-    ],
-    bake_o,
-):
+def bake_action_objects_iter(object_action_pairs, bake_options):
     """An coroutine that bakes actions for multiple objects.
 
-    :param object_action_pairs: Sequence of object action tuples, action is the destination for the baked data. When None a new action will be created.
-    :type object_action_pairs: typing.Union['bpy.types.Action', 'bpy.types.Sequence', 'bpy.types.Object']
+        :param object_action_pairs: Sequence of object action tuples,
+    action is the destination for the baked data. When None a new action will be created.
     """
 
     ...

bpy_extras/asset_utils/__init__.pyi

@@ -1,18 +1,8 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-class AssetBrowserPanel:
-    bl_space_type: typing.Any
+class SpaceAssetInfo:
+    """ """
 
-    def asset_browser_panel_poll(self, context): ...
-    def poll(self, context): ...
-
-class AssetMetaDataPanel:
-    bl_region_type: typing.Any
-    bl_space_type: typing.Any
-
-    def poll(self, context): ...
-
-class SpaceAssetInfo: ...
+    ...

bpy_extras/id_map_utils/__init__.pyi

@@ -1,9 +1,8 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def get_all_referenced_ids(i, ref_m):
+def get_all_referenced_ids(id, ref_map):
     """Return a set of IDs directly or indirectly referenced by id."""
 
     ...
@@ -12,5 +11,3 @@ def get_id_reference_map():
     """Return a dictionary of direct datablock references for every datablock in the blend file."""
 
     ...
-
-def recursive_get_referenced_ids(ref_map, id, referenced_ids, visited): ...

bpy_extras/image_utils/__init__.pyi

@@ -1,4 +1,3 @@
-import sys
 import typing
 import bpy.types
 
@@ -15,29 +14,40 @@ def load_image(
     relpath: str = None,
     check_existing: bool = False,
     force_reload: bool = False,
-) -> "bpy.types.Image":
-    """Return an image from the file path with options to search multiple paths and return a placeholder if its not found.
+) -> bpy.types.Image:
+    """Return an image from the file path with options to search multiple paths
+    and return a placeholder if its not found.
 
-    :param filepath: The image filename If a path precedes it, this will be searched as well.
-    :type filepath: str
-    :param dirname: is the directory where the image may be located - any file at the end will be ignored.
-    :type dirname: str
-    :param place_holder: if True a new place holder image will be created. this is useful so later you can relink the image to its original data.
-    :type place_holder: bool
-    :param recursive: If True, directories will be recursively searched. Be careful with this if you have files in your root directory because it may take a long time.
-    :type recursive: bool
-    :param ncase_cmp: on non windows systems, find the correct case for the file.
-    :type ncase_cmp: bool
-    :param convert_callback: a function that takes an existing path and returns a new one. Use this when loading image formats blender may not support, the CONVERT_CALLBACK can take the path for a GIF (for example), convert it to a PNG and return the PNG's path. For formats blender can read, simply return the path that is given.
-    :type convert_callback: typing.Any
-    :param relpath: If not None, make the file relative to this path.
-    :type relpath: str
-    :param check_existing: If true, returns already loaded image datablock if possible (based on file path).
-    :type check_existing: bool
-    :param force_reload: If true, force reloading of image (only useful when `check_existing` is also enabled).
-    :type force_reload: bool
-    :rtype: 'bpy.types.Image'
-    :return: an image or None
+        :param dirname: is the directory where the image may be located - any file at
+    the end will be ignored.
+        :type dirname: str
+        :param place_holder: if True a new place holder image will be created.
+    this is useful so later you can relink the image to its original data.
+        :type place_holder: bool
+        :param recursive: If True, directories will be recursively searched.
+    Be careful with this if you have files in your root directory because
+    it may take a long time.
+        :type recursive: bool
+        :param ncase_cmp: on non windows systems, find the correct case for the file.
+        :type ncase_cmp: bool
+        :param convert_callback: a function that takes an existing path and returns
+    a new one. Use this when loading image formats blender may not support,
+    the CONVERT_CALLBACK can take the path for a GIF (for example),
+    convert it to a PNG and return the PNG's path.
+    For formats blender can read, simply return the path that is given.
+        :type convert_callback: typing.Any
+        :param relpath: If not None, make the file relative to this path.
+        :type relpath: str
+        :param check_existing: If true,
+    returns already loaded image datablock if possible
+    (based on file path).
+        :type check_existing: bool
+        :param force_reload: If true,
+    force reloading of image (only useful when check_existing
+    is also enabled).
+        :type force_reload: bool
+        :return: an image or None
+        :rtype: bpy.types.Image
     """
 
     ...