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

bl_ui/anim/__init__.pyi

@@ -1,4 +1,5 @@
 import typing
+import bpy.types
 import bpy_types
 
 GenericType = typing.TypeVar("GenericType")
@@ -16,22 +17,35 @@ class ANIM_MT_keyframe_insert_pie(bpy_types.Menu, bpy_types._GenericUI):
     """ """
 
     def append(self, draw_func):
-        """
+        """Append a draw function to this menu,
+        takes the same arguments as the menus draw function
 
-        :param draw_func:
+                :param draw_func:
         """
         ...
 
-    def as_pointer(self):
-        """ """
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
         ...
 
-    def bl_rna_get_subclass(self):
-        """ """
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
         ...
 
-    def bl_rna_get_subclass_py(self):
-        """ """
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
         ...
 
     def draw(self, context):
@@ -50,136 +64,222 @@ class ANIM_MT_keyframe_insert_pie(bpy_types.Menu, bpy_types._GenericUI):
         ...
 
     def draw_preset(self, _context):
+        """Define these on the subclass:
+        - preset_operator (string)
+        - preset_subdir (string)Optionally:
+        - preset_add_operator (string)
+        - preset_extensions (set of strings)
+        - preset_operator_defaults (dict of keyword args)
+
+                :param _context:
         """
+        ...
+
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
 
-        :param _context:
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
         """
         ...
 
-    def driver_add(self):
-        """ """
-        ...
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
 
-    def driver_remove(self):
-        """ """
+        :return: Success of driver removal.
+        :rtype: bool
+        """
         ...
 
     def get(self):
-        """ """
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def id_properties_clear(self):
-        """ """
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ensure(self):
-        """ """
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ui(self):
-        """ """
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
         ...
 
     def is_extended(self):
         """ """
         ...
 
-    def is_property_hidden(self):
-        """ """
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
         ...
 
-    def is_property_overridable_library(self):
-        """ """
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
         ...
 
-    def is_property_readonly(self):
-        """ """
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
         ...
 
-    def is_property_set(self):
-        """ """
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
         ...
 
     def items(self):
-        """ """
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
         ...
 
-    def keyframe_delete(self):
-        """ """
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
         ...
 
-    def keyframe_insert(self):
-        """ """
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
         ...
 
     def keys(self):
-        """ """
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
         ...
 
-    def path_from_id(self):
-        """ """
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
         ...
 
     def path_menu(
         self,
-        searchpaths,
-        operator,
-        props_default,
-        prop_filepath,
-        filter_ext,
-        filter_path,
-        display_name,
-        add_operator,
-        add_operator_props,
+        searchpaths: list[str],
+        operator: str,
+        props_default: dict = None,
+        prop_filepath: str = "filepath",
+        filter_ext: typing.Callable = None,
+        filter_path=None,
+        display_name: typing.Callable = None,
+        add_operator=None,
+        add_operator_props=None,
     ):
-        """
-
-        :param searchpaths:
-        :param operator:
-        :param props_default:
-        :param prop_filepath:
-        :param filter_ext:
-        :param filter_path:
-        :param display_name:
-        :param add_operator:
-        :param add_operator_props:
+        """Populate a menu from a list of paths.
+
+                :param searchpaths: Paths to scan.
+                :type searchpaths: list[str]
+                :param operator: The operator id to use with each file.
+                :type operator: str
+                :param props_default: Properties to assign to each operator.
+                :type props_default: dict
+                :param prop_filepath: Optional operator filepath property (defaults to "filepath").
+                :type prop_filepath: str
+                :param filter_ext: Optional callback that takes the file extensions.
+
+        Returning false excludes the file from the list.
+                :type filter_ext: typing.Callable
+                :param filter_path:
+                :param display_name: Optional callback that takes the full path, returns the name to display.
+                :type display_name: typing.Callable
+                :param add_operator:
+                :param add_operator_props:
         """
         ...
 
     def path_resolve(self):
-        """ """
+        """Returns the property from the path, raise an exception when not found."""
         ...
 
     def pop(self):
-        """ """
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def prepend(self, draw_func):
-        """
+        """Prepend a draw function to this menu, takes the same arguments as
+        the menus draw function
 
-        :param draw_func:
+                :param draw_func:
         """
         ...
 
-    def property_overridable_library_set(self):
-        """ """
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
         ...
 
     def property_unset(self):
-        """ """
+        """Unset a property, will use default value afterward."""
         ...
 
     def remove(self, draw_func):
-        """
+        """Remove a draw function that has been added to this menu
 
         :param draw_func:
         """
         ...
 
     def type_recast(self):
-        """ """
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
         ...
 
     def values(self):
-        """ """
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
         ...

bl_ui/asset_shelf/__init__.pyi

@@ -1,4 +1,5 @@
 import typing
+import bpy.types
 import bpy_types
 
 GenericType = typing.TypeVar("GenericType")
@@ -22,22 +23,35 @@ class ASSETSHELF_PT_display(bpy_types.Panel, bpy_types._GenericUI):
     """ """
 
     def append(self, draw_func):
-        """
+        """Append a draw function to this menu,
+        takes the same arguments as the menus draw function
 
-        :param draw_func:
+                :param draw_func:
         """
         ...
 
-    def as_pointer(self):
-        """ """
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
         ...
 
-    def bl_rna_get_subclass(self):
-        """ """
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
         ...
 
-    def bl_rna_get_subclass_py(self):
-        """ """
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
         ...
 
     def draw(self, context):
@@ -47,72 +61,129 @@ class ASSETSHELF_PT_display(bpy_types.Panel, bpy_types._GenericUI):
         """
         ...
 
-    def driver_add(self):
-        """ """
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
+
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
+        """
         ...
 
-    def driver_remove(self):
-        """ """
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
         ...
 
     def get(self):
-        """ """
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def id_properties_clear(self):
-        """ """
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ensure(self):
-        """ """
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ui(self):
-        """ """
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
         ...
 
     def is_extended(self):
         """ """
         ...
 
-    def is_property_hidden(self):
-        """ """
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
         ...
 
-    def is_property_overridable_library(self):
-        """ """
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
         ...
 
-    def is_property_readonly(self):
-        """ """
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
         ...
 
-    def is_property_set(self):
-        """ """
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
         ...
 
     def items(self):
-        """ """
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
         ...
 
-    def keyframe_delete(self):
-        """ """
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
         ...
 
-    def keyframe_insert(self):
-        """ """
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
         ...
 
     def keys(self):
-        """ """
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
         ...
 
-    def path_from_id(self):
-        """ """
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
         ...
 
     def path_resolve(self):
-        """ """
+        """Returns the property from the path, raise an exception when not found."""
         ...
 
     def poll(self, context):
@@ -123,35 +194,51 @@ class ASSETSHELF_PT_display(bpy_types.Panel, bpy_types._GenericUI):
         ...
 
     def pop(self):
-        """ """
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def prepend(self, draw_func):
-        """
+        """Prepend a draw function to this menu, takes the same arguments as
+        the menus draw function
 
-        :param draw_func:
+                :param draw_func:
         """
         ...
 
-    def property_overridable_library_set(self):
-        """ """
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
         ...
 
     def property_unset(self):
-        """ """
+        """Unset a property, will use default value afterward."""
         ...
 
     def remove(self, draw_func):
-        """
+        """Remove a draw function that has been added to this menu
 
         :param draw_func:
         """
         ...
 
     def type_recast(self):
-        """ """
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
         ...
 
     def values(self):
-        """ """
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
         ...