fake-bpy-module 20240528__tar.gz → 20240530__tar.gz

{fake_bpy_module-20240528 → fake_bpy_module-20240530}/PKG-INFO

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

{fake_bpy_module-20240528 → fake_bpy_module-20240530}/bl_console_utils/autocomplete/complete_calltip/__init__.pyi

@@ -20,16 +20,16 @@ def complete(line: str, cursor: int, namespace: dict) -> str:
     ...
 
 def get_argspec(
-    func, strip_self: bool = True, doc: str = None, source: str = None
+    func, strip_self: bool = True, doc: str | None = None, source: str | None = None
 ) -> str:
     """Get argument specifications.
 
     :param strip_self: strip self from argspec
     :type strip_self: bool
     :param doc: doc string of func (optional)
-    :type doc: str
+    :type doc: str | None
     :param source: source code of func (optional)
-    :type source: str
+    :type source: str | None
     :return: argument specification
     :rtype: str
     """

{fake_bpy_module-20240528 → fake_bpy_module-20240530}/bl_operators/__init__.pyi

@@ -5,6 +5,7 @@ from . import anim
 from . import assets
 from . import bmesh
 from . import clip
+from . import connect_to_output
 from . import console
 from . import constraint
 from . import file
@@ -14,6 +15,7 @@ from . import image
 from . import image_as_planes
 from . import mesh
 from . import node
+from . import node_editor
 from . import object
 from . import object_align
 from . import object_quick_effects

fake_bpy_module-20240530/bl_operators/connect_to_output/__init__.pyi

@@ -0,0 +1,325 @@
+import typing
+import collections.abc
+import bl_operators.node_editor.node_functions
+import bpy.types
+import bpy_types
+
+GenericType1 = typing.TypeVar("GenericType1")
+GenericType2 = typing.TypeVar("GenericType2")
+
+class NODE_OT_connect_to_output(
+    bpy_types.Operator, bl_operators.node_editor.node_functions.NodeEditorBase
+):
+    bl_description: typing.Any
+    bl_idname: typing.Any
+    bl_label: typing.Any
+    bl_options: typing.Any
+    bl_rna: typing.Any
+    id_data: typing.Any
+
+    def as_keywords(self, ignore=()):
+        """Return a copy of the properties as a dictionary
+
+        :param ignore:
+        """
+        ...
+
+    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) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
+        ...
+
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
+        ...
+
+    def cleanup(self): ...
+    def create_links(self, path, node, active_node_socket_id, socket_type):
+        """Create links at each step in the node group path.
+
+        :param path:
+        :param node:
+        :param active_node_socket_id:
+        :param socket_type:
+        """
+        ...
+
+    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) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
+        ...
+
+    def ensure_group_output(self, node_tree):
+        """Check if a group output node exists, otherwise create it
+
+        :param node_tree:
+        """
+        ...
+
+    def ensure_viewer_socket(self, node_tree, socket_type, connect_socket=None):
+        """Check if a viewer output already exists in a node group, otherwise create it
+
+        :param node_tree:
+        :param socket_type:
+        :param connect_socket:
+        """
+        ...
+
+    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 get_output_index(
+        self, node, output_node, is_base_node_tree, socket_type, check_type=False
+    ):
+        """Get the next available output socket in the active node
+
+        :param node:
+        :param output_node:
+        :param is_base_node_tree:
+        :param socket_type:
+        :param check_type:
+        """
+        ...
+
+    def get_output_sockets(self, node_tree):
+        """
+
+        :param node_tree:
+        """
+        ...
+
+    def has_socket_other_users(self, socket):
+        """List the other users for this socket (other materials or geometry nodes groups)
+
+        :param socket:
+        """
+        ...
+
+    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 init_shader_variables(self, space, shader_type):
+        """Get correct output node in shader editor
+
+        :param space:
+        :param shader_type:
+        """
+        ...
+
+    def invoke(self, context, event):
+        """
+
+        :param context:
+        :param event:
+        """
+        ...
+
+    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) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
+        ...
+
+    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) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
+        ...
+
+    def is_socket_used_active_tree(self, socket):
+        """Ensure used sockets in active node tree is calculated and check given socket
+
+        :param socket:
+        """
+        ...
+
+    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) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
+        ...
+
+    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 link_leads_to_used_socket(self, link):
+        """Return True if link leads to a socket that is already used in this node
+
+        :param link:
+        """
+        ...
+
+    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):
+        """Already implemented natively for compositing nodes.
+
+        :param context:
+        """
+        ...
+
+    def poll_message_set(self):
+        """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
+        ...
+
+    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 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_socket(self, tree, socket):
+        """
+
+        :param tree:
+        :param socket:
+        """
+        ...
+
+    def scan_nodes(self, tree, sockets):
+        """Recursively get all viewer sockets in a material tree
+
+        :param tree:
+        :param sockets:
+        """
+        ...
+
+    def search_sockets(self, node, r_sockets, index=None):
+        """Recursively scan nodes for viewer sockets and store them in a list
+
+        :param node:
+        :param r_sockets:
+        :param index:
+        """
+        ...
+
+    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.
+        """
+        ...

{fake_bpy_module-20240528 → fake_bpy_module-20240530}/bl_operators/image_as_planes/__init__.pyi

@@ -148,10 +148,9 @@ class IMAGE_OT_import_as_mesh_planes(
         ...
 
     def draw_material_config(self, context):
-        """layout = self.layoutbox = layout.box()box.label(text="Compositing Nodes:", icon='RENDERLAYERS')
-        box.prop(self, "compositing_nodes")
+        """
 
-                :param context:
+        :param context:
         """
         ...
 
@@ -162,6 +161,13 @@ class IMAGE_OT_import_as_mesh_planes(
         """
         ...
 
+    def draw_texture_config(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
     def driver_add(self) -> bpy.types.FCurve:
         """Adds driver(s) to the given property
 
@@ -433,14 +439,14 @@ def get_input_nodes(node, links):
     ...
 
 def get_shadeless_node(dest_node_tree):
-    """Return a "shadless" cycles/eevee node, creating a node group if nonexistent"""
+    """Return a "shadeless" cycles/EEVEE node, creating a node group if nonexistent"""
 
     ...
 
 def load_images(
     filenames, directory, force_reload=False, frame_start=1, find_sequences=False
 ):
-    """Wrapper for bpy's load_imageLoads a set of images, movies, or even image sequences
+    """Wrapper for bpy_extras.image_utils.load_image.Loads a set of images, movies, or even image sequences
     Returns a generator of ImageSpec wrapper objects later used for texture setup
 
     """

fake_bpy_module-20240530/bl_operators/node_editor/__init__.pyi

@@ -0,0 +1,6 @@
+import typing
+import collections.abc
+from . import node_functions
+
+GenericType1 = typing.TypeVar("GenericType1")
+GenericType2 = typing.TypeVar("GenericType2")

fake_bpy_module-20240530/bl_operators/node_editor/node_functions/__init__.pyi

@@ -0,0 +1,23 @@
+import typing
+import collections.abc
+
+GenericType1 = typing.TypeVar("GenericType1")
+GenericType2 = typing.TypeVar("GenericType2")
+
+class NodeEditorBase:
+    def poll(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+def force_update(context): ...
+def get_group_output_node(tree, output_node_idname="NodeGroupOutput"): ...
+def get_internal_socket(socket): ...
+def get_output_location(tree): ...
+def is_viewer_link(link, output_node): ...
+def is_viewer_socket(socket): ...
+def is_visible_socket(socket): ...
+def node_editor_poll(cls, context): ...
+def node_space_type_poll(cls, context, types): ...

{fake_bpy_module-20240528 → fake_bpy_module-20240530}/bl_operators/presets/__init__.pyi

@@ -434,10 +434,10 @@ class WM_MT_operator_presets(bpy_types.Menu, bpy_types._GenericUI):
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -450,14 +450,14 @@ class WM_MT_operator_presets(bpy_types.Menu, bpy_types._GenericUI):
                 :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
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """
@@ -913,10 +913,10 @@ class WM_PT_operator_presets(
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -929,14 +929,14 @@ class WM_PT_operator_presets(
                 :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
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """

{fake_bpy_module-20240528 → fake_bpy_module-20240530}/bl_operators/wm/__init__.pyi

@@ -377,10 +377,10 @@ class WM_MT_region_toggle_pie(bpy_types.Menu, bpy_types._GenericUI):
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -393,14 +393,14 @@ class WM_MT_region_toggle_pie(bpy_types.Menu, bpy_types._GenericUI):
                 :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
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """
@@ -654,10 +654,10 @@ class WM_MT_splash(bpy_types.Menu, bpy_types._GenericUI):
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -670,14 +670,14 @@ class WM_MT_splash(bpy_types.Menu, bpy_types._GenericUI):
                 :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
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """
@@ -924,10 +924,10 @@ class WM_MT_splash_about(bpy_types.Menu, bpy_types._GenericUI):
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -940,14 +940,14 @@ class WM_MT_splash_about(bpy_types.Menu, bpy_types._GenericUI):
                 :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
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """
@@ -1194,10 +1194,10 @@ class WM_MT_splash_quick_setup(bpy_types.Menu, bpy_types._GenericUI):
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -1210,14 +1210,14 @@ class WM_MT_splash_quick_setup(bpy_types.Menu, bpy_types._GenericUI):
                 :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
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """