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

bpy/utils/__init__.pyi

@@ -1,3 +1,15 @@
+"""
+This module contains utility functions specific to blender but
+not associated with blenders internal data.
+
+bpy.utils.previews.rst
+bpy.utils.units.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+"""
+
 import typing
 from . import previews
 from . import units
@@ -320,12 +332,13 @@ def register_tool(tool_cls, after, separator, group):
 
     ...
 
-def resource_path(type: str, major=None[0], minor: str = None[1]) -> str:
+def resource_path(type: str, major: int = None[0], minor: str = None[1]) -> str:
     """Return the base path for storing system files.
 
     :param type: string in ['USER', 'LOCAL', 'SYSTEM'].
     :type type: str
     :param major: major version, defaults to current.
+    :type major: int
     :param minor: minor version, defaults to current.
     :type minor: str
     :return: the resource path (not necessarily existing).
@@ -371,11 +384,12 @@ def script_paths_pref():
 
     ...
 
-def smpte_from_frame(frame, fps=None, fps_base=None) -> str:
+def smpte_from_frame(frame: int, fps=None, fps_base=None) -> str:
     """Returns an SMPTE formatted string from the frame:
     HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
 
         :param frame: frame number.
+        :type frame: int
         :return: the frame string.
         :rtype: str
     """
@@ -387,11 +401,12 @@ def smpte_from_frame(frame, fps, fps_base):
 
     ...
 
-def smpte_from_seconds(time, fps=None, fps_base=None) -> str:
+def smpte_from_seconds(time: typing.Union[int, float], fps=None, fps_base=None) -> str:
     """Returns an SMPTE formatted string from the time:
     HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
 
         :param time: time in seconds.
+        :type time: typing.Union[int, float]
         :return: the frame string.
         :rtype: str
     """

bpy/utils/previews/__init__.pyi

@@ -1,3 +1,18 @@
+"""
+This module contains utility functions to handle custom previews.
+
+It behaves as a high-level 'cached' previews manager.
+
+This allows scripts to generate their own previews, and use them as icons in UI widgets
+('icon_value' for UILayout functions).
+
+
+--------------------
+
+```__/__/__/scripts/templates_py/ui_previews_custom_icon.py```
+
+"""
+
 import typing
 import bpy.types
 

bpy/utils/units/__init__.pyi

@@ -1,3 +1,8 @@
+"""
+This module contains some data/methods regarding units handling.
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")
@@ -5,8 +10,8 @@ GenericType = typing.TypeVar("GenericType")
 def to_string(
     unit_system: str,
     unit_category: str,
-    value,
-    precision=3,
+    value: float,
+    precision: int = 3,
     split_unit: bool = False,
     compatible_unit: bool = False,
 ) -> str:
@@ -18,7 +23,9 @@ def to_string(
     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²).
@@ -31,7 +38,7 @@ def to_string(
 
 def to_value(
     unit_system: str, unit_category: str, str_input: str, str_ref_unit: str = None
-):
+) -> float:
     """Convert a given input string into a float value.
 
         :param unit_system: The unit system, from `bpy.utils.units.systems`.
@@ -44,6 +51,7 @@ def to_value(
         :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,3 +1,22 @@
+"""
+Utility modules associated with the bpy module.
+
+bpy_extras.anim_utils.rst
+bpy_extras.asset_utils.rst
+bpy_extras.object_utils.rst
+bpy_extras.io_utils.rst
+bpy_extras.image_utils.rst
+bpy_extras.keyconfig_utils.rst
+bpy_extras.mesh_utils.rst
+bpy_extras.node_utils.rst
+bpy_extras.view3d_utils.rst
+bpy_extras.id_map_utils.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+"""
+
 import typing
 from . import anim_utils
 from . import asset_utils

bpy_extras/asset_utils/__init__.pyi

@@ -1,3 +1,8 @@
+"""
+Helpers for asset management tasks.
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")

{fake_bpy_module-20240417.dist-info → fake_bpy_module-20240419.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fake-bpy-module
-Version: 20240417
+Version: 20240419
 Summary: Collection of the fake Blender Python API module for the code completion.
 Author: nutti
 Author-email: nutti.metro@gmail.com