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

bl_app_override/__init__.pyi

@@ -9,11 +9,11 @@ def class_filter(cls_parent, kw):
     ...
 
 def ui_draw_filter_register(
-    ui_ignore_classes,
-    ui_ignore_operator,
-    ui_ignore_property,
-    ui_ignore_menu,
-    ui_ignore_label,
+    ui_ignore_classes=None,
+    ui_ignore_operator=None,
+    ui_ignore_property=None,
+    ui_ignore_menu=None,
+    ui_ignore_label=None,
 ):
     """ """
 

bl_app_override/helpers/__init__.pyi

@@ -3,7 +3,9 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class AppOverrideState:
-    """ """
+    """Utility class to encapsulate overriding the application state
+    so that settings can be restored afterwards.
+    """
 
     addon_paths: typing.Any
     """ """

bl_app_template_utils/__init__.pyi

@@ -2,22 +2,22 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def activate(template_id, reload_scripts):
+def activate(template_id=None, reload_scripts=False):
     """ """
 
     ...
 
-def import_from_id(template_id, ignore_not_found):
+def import_from_id(template_id, ignore_not_found=False):
     """ """
 
     ...
 
-def import_from_path(path, ignore_not_found):
+def import_from_path(path, ignore_not_found=False):
     """ """
 
     ...
 
-def reset(reload_scripts):
-    """ """
+def reset(reload_scripts=False):
+    """Sets default state."""
 
     ...

bl_console_utils/autocomplete/complete_calltip/__init__.pyi

@@ -2,27 +2,65 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def complete(line, cursor, namespace):
-    """ """
+def complete(line: str, cursor: int, namespace: dict) -> str:
+    """Complete callable with call-tip.
+
+    :param line: incomplete text line
+    :type line: str
+    :param cursor: current character position
+    :type cursor: int
+    :param namespace: namespace
+    :type namespace: dict
+    :return: (matches, world, scrollback)
+    :rtype: str
+    """
 
     ...
 
-def get_argspec(func, strip_self, doc, source):
-    """ """
+def get_argspec(
+    func, strip_self: bool = True, doc: str = None, source: str = 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
+    :param source: source code of func (optional)
+    :type source: str
+    :return: argument specification
+    :rtype: str
+    """
 
     ...
 
-def get_doc(obj):
-    """ """
+def get_doc(obj) -> str:
+    """Get the doc string or comments for an object.
+
+    :return: doc string
+    :rtype: str
+    """
 
     ...
 
-def reduce_newlines(text):
-    """ """
+def reduce_newlines(text: str) -> str:
+    """Reduces multiple newlines to a single newline.
+
+    :param text: text with multiple newlines
+    :type text: str
+    :return: text with single newlines
+    :rtype: str
+    """
 
     ...
 
-def reduce_spaces(text):
-    """ """
+def reduce_spaces(text: str) -> str:
+    """Reduces multiple white-spaces to a single space.
+
+    :param text: text with multiple spaces
+    :type text: str
+    :return: text with single spaces
+    :rtype: str
+    """
 
     ...

bl_console_utils/autocomplete/complete_import/__init__.pyi

@@ -2,17 +2,38 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def complete(line):
-    """ """
+def complete(line: str) -> list:
+    """Returns a list containing the completion possibilities for an import line.
+
+        :param line: incomplete line which contains an import statement:
+
+    import xml.d
+    from xml.dom import
+        :type line: str
+        :return: list of completion possibilities
+        :rtype: list
+    """
 
     ...
 
-def get_root_modules():
-    """ """
+def get_root_modules() -> list:
+    """Returns a list containing the names of all the modules available in the
+    folders of the python-path.
+
+        :return: modules
+        :rtype: list
+    """
 
     ...
 
-def module_list(path):
-    """ """
+def module_list(path: str) -> list:
+    """Return the list containing the names of the modules available in
+    the given folder.
+
+        :param path: folder path
+        :type path: str
+        :return: modules
+        :rtype: list
+    """
 
     ...

bl_console_utils/autocomplete/complete_namespace/__init__.pyi

@@ -2,27 +2,59 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def complete(word, namespace, private):
-    """ """
+def complete(word: str, namespace: dict, private: bool = True) -> list[str]:
+    """Complete word within a namespace with the standard rlcompleter
+    module. Also supports index or key access [].
+
+        :param word: word to be completed
+        :type word: str
+        :param namespace: namespace
+        :type namespace: dict
+        :param private: whether private attribute/methods should be returned
+        :type private: bool
+        :return: completion matches
+        :rtype: list[str]
+    """
 
     ...
 
-def complete_indices(word, namespace, obj, base):
-    """ """
+def complete_indices(
+    word: str, namespace: dict, obj=None, base: str = None
+) -> list[str]:
+    """Complete a list or dictionary with its indices:
+
+    :param word: word to be completed
+    :type word: str
+    :param namespace: namespace
+    :type namespace: dict
+    :param obj: object evaluated from base
+    :param base: sub-string which can be evaluated into an object.
+    :type base: str
+    :return: completion matches
+    :rtype: list[str]
+    """
 
     ...
 
-def complete_names(word, namespace):
-    """ """
+def complete_names(word: str, namespace: dict) -> list[str]:
+    """Complete variable names or attributes
+
+    :param word: word to be completed
+    :type word: str
+    :param namespace: namespace
+    :type namespace: dict
+    :return: completion matches
+    :rtype: list[str]
+    """
 
     ...
 
 def is_dict(obj):
-    """ """
+    """Returns whether obj is a dictionary"""
 
     ...
 
 def is_struct_seq(obj):
-    """ """
+    """Returns whether obj is a structured sequence subclass: sys.float_info"""
 
     ...

bl_console_utils/autocomplete/intellisense/__init__.pyi

@@ -2,12 +2,39 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def complete(line, cursor, namespace, private):
-    """ """
+def complete(line: str, cursor: int, namespace: dict, private: bool) -> list | str:
+    """Returns a list of possible completions:
+
+    :param line: incomplete text line
+    :type line: str
+    :param cursor: current character position
+    :type cursor: int
+    :param namespace: namespace
+    :type namespace: dict
+    :param private: whether private variables should be listed
+    :type private: bool
+    :return: list of completions, word
+    :rtype: list | str
+    """
 
     ...
 
-def expand(line, cursor, namespace, private):
-    """ """
+def expand(
+    line: str, cursor: int, namespace: dict, private: bool = True
+) -> str | int | str:
+    """This method is invoked when the user asks auto-completion,
+    e.g. when Ctrl+Space is clicked.
+
+        :param line: incomplete text line
+        :type line: str
+        :param cursor: current character position
+        :type cursor: int
+        :param namespace: namespace
+        :type namespace: dict
+        :param private: whether private variables should be listed
+        :type private: bool
+        :return: current expanded line, updated cursor position and scrollback
+        :rtype: str | int | str
+    """
 
     ...

bl_i18n_utils/bl_extract_messages/__init__.pyi

@@ -3,7 +3,7 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 def check(check_ctxt, msgs, key, msgsrc, settings):
-    """ """
+    """Performs a set of checks over the given key (context, message)..."""
 
     ...
 
@@ -32,7 +32,7 @@ def dump_preset_messages(msgs, reports, settings):
 
     ...
 
-def dump_py_messages(msgs, reports, addons, settings, addons_only):
+def dump_py_messages(msgs, reports, addons, settings, addons_only=False):
     """ """
 
     ...
@@ -42,8 +42,8 @@ def dump_py_messages_from_files(msgs, reports, files, settings):
 
     ...
 
-def dump_rna_messages(msgs, reports, settings, verbose):
-    """ """
+def dump_rna_messages(msgs, reports, settings, verbose=False):
+    """Dump into messages dict all RNA-defined UI messages (labels en tooltips)."""
 
     ...
 
@@ -57,7 +57,7 @@ def dump_template_messages(msgs, reports, settings):
 
     ...
 
-def init_spell_check(settings, lang):
+def init_spell_check(settings, lang="en_US"):
     """ """
 
     ...

bl_i18n_utils/settings/__init__.pyi

@@ -3,7 +3,9 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class I18nSettings:
-    """ """
+    """Class allowing persistence of our settings!
+    Saved in JSon format, so settings should be JSon'able objects!
+    """
 
     BLENDER_I18N_PO_DIR: typing.Any
     """ """
@@ -43,7 +45,7 @@ class I18nSettings:
         """
         ...
 
-    def load(self, fname, reset):
+    def load(self, fname, reset=False):
         """
 
         :param fname: