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

bl_i18n_utils/utils/__init__.pyi

@@ -3,7 +3,7 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class I18n:
-    """ """
+    """Internal representation of a whole translation set."""
 
     parsers: typing.Any
     """ """
@@ -14,22 +14,23 @@ class I18n:
     writers: typing.Any
     """ """
 
-    def check_py_module_has_translations(self, src, settings):
-        """
+    def check_py_module_has_translations(self, src, settings=None):
+        """Check whether a given src (a py module, either a directory or a py file) has some i18n translation data,
+        and returns a tuple (src_file, translations_tuple) if yes, else (None, None).
 
-        :param src:
-        :param settings:
+                :param src:
+                :param settings:
         """
         ...
 
-    def escape(self, do_all):
+    def escape(self, do_all=False):
         """
 
         :param do_all:
         """
         ...
 
-    def parse(self, kind, src, langs):
+    def parse(self, kind, src, langs=None()):
         """
 
         :param kind:
@@ -38,7 +39,7 @@ class I18n:
         """
         ...
 
-    def parse_from_po(self, src, langs):
+    def parse_from_po(self, src, langs=None()):
         """
 
         :param src:
@@ -46,23 +47,26 @@ class I18n:
         """
         ...
 
-    def parse_from_py(self, src, langs):
-        """
+    def parse_from_py(self, src, langs=None()):
+        """src must be a valid path, either a py file or a module directory (in which case all py files inside it
+        will be checked, first file matching will win!).
+        if langs set is void, all languages found are loaded.
 
-        :param src:
-        :param langs:
+                :param src:
+                :param langs:
         """
         ...
 
-    def print_stats(self, prefix, print_msgs):
-        """
+    def print_stats(self, prefix="", print_msgs=True):
+        """Print out some stats about an I18n object.
+        If print_msgs is True, it will also print all its translations' stats.
 
-        :param prefix:
-        :param print_msgs:
+                :param prefix:
+                :param print_msgs:
         """
         ...
 
-    def unescape(self, do_all):
+    def unescape(self, do_all=True):
         """
 
         :param do_all:
@@ -73,7 +77,7 @@ class I18n:
         """ """
         ...
 
-    def write(self, kind, langs):
+    def write(self, kind, langs=None()):
         """
 
         :param kind:
@@ -81,14 +85,14 @@ class I18n:
         """
         ...
 
-    def write_to_po(self, langs):
+    def write_to_po(self, langs=None()):
         """
 
         :param langs:
         """
         ...
 
-    def write_to_py(self, langs):
+    def write_to_py(self, langs=None()):
         """
 
         :param langs:
@@ -96,7 +100,7 @@ class I18n:
         ...
 
 class I18nMessage:
-    """ """
+    """Internal representation of a message."""
 
     comment_lines: typing.Any
     """ """
@@ -139,34 +143,35 @@ class I18nMessage:
         ...
 
     def do_escape(self, txt):
-        """
+        """Replace some chars by their escaped versions!
 
         :param txt:
         """
         ...
 
     def do_unescape(self, txt):
-        """
+        """Replace escaped chars by real ones!
 
         :param txt:
         """
         ...
 
-    def escape(self, do_all):
+    def escape(self, do_all=False):
         """
 
         :param do_all:
         """
         ...
 
-    def normalize(self, max_len):
-        """
+    def normalize(self, max_len=80):
+        """Normalize this message, call this before exporting it...
+        Currently normalize msgctxt, msgid and msgstr lines to given max_len (if below 1, make them single line).
 
-        :param max_len:
+                :param max_len:
         """
         ...
 
-    def unescape(self, do_all):
+    def unescape(self, do_all=True):
         """
 
         :param do_all:
@@ -174,7 +179,7 @@ class I18nMessage:
         ...
 
 class I18nMessages:
-    """ """
+    """Internal representation of messages for one language (iso code), with additional stats info."""
 
     parsers: typing.Any
     """ """
@@ -182,10 +187,13 @@ class I18nMessages:
     writers: typing.Any
     """ """
 
-    def check(self, fix):
-        """
+    def check(self, fix=False):
+        """Check consistency between messages and their keys!
+        Check messages using format stuff are consistent between msgid and msgstr!
+        If fix is True, tries to fix the issues.
+        Return a list of found errors (empty if everything went OK!).
 
-        :param fix:
+                :param fix:
         """
         ...
 
@@ -193,7 +201,7 @@ class I18nMessages:
         """ """
         ...
 
-    def escape(self, do_all):
+    def escape(self, do_all=False):
         """
 
         :param do_all:
@@ -215,9 +223,15 @@ class I18nMessages:
         ...
 
     def gen_empty_messages(
-        self, uid, blender_ver, blender_hash, bl_time, default_copyright, settings
+        self,
+        uid,
+        blender_ver,
+        blender_hash,
+        bl_time,
+        default_copyright=True,
+        settings=None,
     ):
-        """
+        """Generate an empty I18nMessages object (only header is present!).
 
         :param uid:
         :param blender_ver:
@@ -228,14 +242,14 @@ class I18nMessages:
         """
         ...
 
-    def invalidate_reverse_cache(self, rebuild_now):
-        """
+    def invalidate_reverse_cache(self, rebuild_now=False):
+        """Invalidate the reverse cache used by find_best_messages_matches.
 
         :param rebuild_now:
         """
         ...
 
-    def merge(self, msgs, replace):
+    def merge(self, msgs, replace=False):
         """
 
         :param msgs:
@@ -243,7 +257,7 @@ class I18nMessages:
         """
         ...
 
-    def normalize(self, max_len):
+    def normalize(self, max_len=80):
         """
 
         :param max_len:
@@ -259,7 +273,7 @@ class I18nMessages:
         """
         ...
 
-    def parse_messages_from_po(self, src, key):
+    def parse_messages_from_po(self, src, key=None):
         """
 
         :param src:
@@ -267,8 +281,8 @@ class I18nMessages:
         """
         ...
 
-    def print_info(self, prefix, output, print_stats, print_errors):
-        """
+    def print_info(self, prefix="", output=None, print_stats=True, print_errors=True):
+        """Print out some info about an I18nMessages object.
 
         :param prefix:
         :param output:
@@ -281,19 +295,22 @@ class I18nMessages:
         """ """
         ...
 
-    def unescape(self, do_all):
+    def unescape(self, do_all=True):
         """
 
         :param do_all:
         """
         ...
 
-    def update(self, ref, use_similar, keep_old_commented):
-        """
+    def update(self, ref, use_similar=None, keep_old_commented=True):
+        """Update this I18nMessage with the ref one. Translations from ref are never used. Source comments from ref
+        completely replace current ones. If use_similar is not 0.0, it will try to match new messages in ref with an
+        existing one. Messages no more found in ref will be marked as commented if keep_old_commented is True,
+        or removed.
 
-        :param ref:
-        :param use_similar:
-        :param keep_old_commented:
+                :param ref:
+                :param use_similar:
+                :param keep_old_commented:
         """
         ...
 
@@ -310,27 +327,31 @@ class I18nMessages:
         ...
 
     def write_messages_to_mo(self, fname):
-        """
+        """Write messages in fname mo file.
 
         :param fname:
         """
         ...
 
-    def write_messages_to_po(self, fname, compact):
-        """
+    def write_messages_to_po(self, fname, compact=False):
+        """Write messages in fname po file.
 
         :param fname:
         :param compact:
         """
         ...
 
-def enable_addons(addons, support, disable, check_only):
-    """ """
+def enable_addons(addons=None, support=None, disable=False, check_only=False):
+    """Enable (or disable) addons based either on a set of names, or a set of 'support' types.
+    Returns the list of all affected addons (as fake modules)!
+    If "check_only" is set, no addon will be enabled nor disabled.
+
+    """
 
     ...
 
 def find_best_isocode_matches(uid, iso_codes):
-    """ """
+    """Return an ordered tuple of elements in iso_codes that can match the given uid, from most similar to lesser ones."""
 
     ...
 
@@ -339,8 +360,12 @@ def get_best_similar(data):
 
     ...
 
-def get_po_files_from_dir(root_dir, langs):
-    """ """
+def get_po_files_from_dir(root_dir, langs=None()):
+    """Yield tuples (uid, po_path) of translations for each po file found in the given directory, which should be either
+    a directory containing po files using language uid's as names (e.g. fr.po, es_ES.po, etc.), or
+    a directory containing directories which names are language uids, and containing po files of the same names.
+
+    """
 
     ...
 
@@ -350,12 +375,15 @@ def is_valid_po_path(path):
     ...
 
 def list_po_dir(root_path, settings):
-    """ """
+    """Generator. List given directory (expecting one sub-directory per languages)
+    and return all files matching languages listed in settings.Yield tuples (can_use, uid, num_id, name, isocode, po_path)Note that po_path may not actually exists.
+
+    """
 
     ...
 
 def locale_explode(locale):
-    """ """
+    """Copies behavior of BLT_lang_locale_explode, keep them in sync."""
 
     ...
 

bl_i18n_utils/utils_rtl/__init__.pyi

@@ -3,11 +3,17 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 def log2vis(msgs, settings):
-    """ """
+    """Globally mimics deprecated fribidi_log2vis.
+    msgs should be an iterable of messages to RTL-process.
+
+    """
 
     ...
 
 def protect_format_seq(msg):
-    """ """
+    """Find some specific escaping/formatting sequences (like ", %s, etc.,
+    and protect them from any modification!
+
+    """
 
     ...

bl_keymap_utils/io/__init__.pyi

@@ -7,12 +7,12 @@ def indent(levels):
 
     ...
 
-def keyconfig_export_as_data(wm, kc, filepath, all_keymaps):
+def keyconfig_export_as_data(wm, kc, filepath, all_keymaps=False):
     """ """
 
     ...
 
-def keyconfig_import_from_data(name, keyconfig_data, keyconfig_version):
+def keyconfig_import_from_data(name, keyconfig_data, keyconfig_version=(0, 0, 0)):
     """ """
 
     ...
@@ -23,11 +23,11 @@ def keyconfig_init_from_data(kc, keyconfig_data):
     ...
 
 def keyconfig_merge(kc1, kc2):
-    """ """
+    """note: kc1 takes priority over kc2"""
 
     ...
 
-def keymap_init_from_data(km, km_items, is_modal):
+def keymap_init_from_data(km, km_items, is_modal=False):
     """ """
 
     ...

bl_keymap_utils/keymap_from_toolbar/__init__.pyi

@@ -2,7 +2,7 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def generate(context, space_type, use_fallback_keys, use_reset):
-    """ """
+def generate(context, space_type, use_fallback_keys=True, use_reset=True):
+    """Keymap for popup toolbar, currently generated each time."""
 
     ...

bl_keymap_utils/platform_helpers/__init__.pyi

@@ -2,12 +2,12 @@ import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def keyconfig_data_oskey_from_ctrl(keyconfig_data_src, filter_fn):
+def keyconfig_data_oskey_from_ctrl(keyconfig_data_src, filter_fn=None):
     """ """
 
     ...
 
 def keyconfig_data_oskey_from_ctrl_for_macos(keyconfig_data_src):
-    """ """
+    """Use for apple since Cmd is typically used in-place of Ctrl."""
 
     ...