fake-bpy-module 20241129__tar.gz → 20241204__tar.gz

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/PKG-INFO

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

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/_bpy_internal/freedesktop/__init__.pyi

@@ -14,7 +14,6 @@ def handle_mime_association_xml(do_register, all_users): ...
 def handle_thumbnailer(do_register, all_users): ...
 def main(): ...
 def main_run_as_root(do_register, *, python_args): ...
-def path_exists_or_is_link(path): ...
 def register(all_users=False): ...
 def register_impl(do_register, all_users): ...
 def system_path_contains(dirpath): ...

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/aud/__init__.pyi

@@ -639,7 +639,7 @@ class Sound:
                 :rtype: typing_extensions.Self
         """
 
-    def filter(self, b: list[float], a: list[float] = 1) -> typing_extensions.Self:
+    def filter(self, b: list[float], a: list[float] = (1)) -> typing_extensions.Self:
         """Filters a sound with the supplied IIR filter coefficients.
         Without the second parameter you'll get a FIR filter.If the first value of the a sequence is 0,
         it will be set to 1 automatically.

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/blf/__init__.pyi

@@ -91,10 +91,11 @@ def enable(fontid: int, option: int):
     :type option: int
     """
 
-def load(filepath) -> int:
+def load(filepath: bytes | str) -> int:
     """Load a new font.
 
     :param filepath: the filepath of the font.
+    :type filepath: bytes | str
     :return: the new font's fontid or -1 if there was an error.
     :rtype: int
     """
@@ -158,10 +159,11 @@ def size(fontid: int, size: float):
     :type size: float
     """
 
-def unload(filepath):
+def unload(filepath: bytes | str):
     """Unload an existing font.
 
     :param filepath: the filepath of the font.
+    :type filepath: bytes | str
     """
 
 def word_wrap(fontid: int, wrap_width: int):

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bmesh/types/__init__.pyi

@@ -206,12 +206,13 @@ class BMEdge:
     def normal_update(self):
         """Update normals of all connected faces and the edge verts."""
 
-    def other_vert(self, vert: BMVert):
+    def other_vert(self, vert: BMVert) -> BMVert:
         """Return the other vertex on this edge or None if the vertex is not used by this edge.
 
         :param vert: a vert in this edge.
         :type vert: BMVert
         :return: The edges other vert.
+        :rtype: BMVert
         """
 
     def select_set(self, select: bool):

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bpy/app/icons/__init__.pyi

@@ -14,10 +14,11 @@ def new_triangles(range, coords: bytes | None, colors: bytes | None) -> int:
     :rtype: int
     """
 
-def new_triangles_from_file(filepath) -> int:
+def new_triangles_from_file(filepath: str | None) -> int:
     """Create a new icon from triangle geometry.
 
     :param filepath: File path.
+    :type filepath: str | None
     :return: Unique icon value (pass to interface icon_value argument).
     :rtype: int
     """

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bpy/app/translations/__init__.pyi

@@ -67,57 +67,63 @@ def locale_explode(locale):
     :return: A tuple (language, country, variant, language_country, language@variant).
     """
 
-def pgettext(msgid: str | None, msgctxt=None):
+def pgettext(msgid: str | None, msgctxt: str | None = None):
     """Try to translate the given msgid (with optional msgctxt).
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_data(msgid: str | None, msgctxt=None):
+def pgettext_data(msgid: str | None, msgctxt: str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if new data name's translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_iface(msgid: str | None, msgctxt=None):
+def pgettext_iface(msgid: str | None, msgctxt: str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_n(msgid: str | None, msgctxt=None):
+def pgettext_n(msgid: str | None, msgctxt: str | None = None):
     """Extract the given msgid to translation files. This is a no-op function that will only mark the string to extract, but not perform the actual translation.
 
     :param msgid: The string to extract.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: str | None
     :return: The original string.
     """
 
-def pgettext_rpt(msgid: str | None, msgctxt=None):
+def pgettext_rpt(msgid: str | None, msgctxt: str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if reports' translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_tip(msgid: str | None, msgctxt=None):
+def pgettext_tip(msgid: str | None, msgctxt: str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: str | None
     :return: The translated string (or msgid if no translation was found).
     """
 

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bpy/msgbus/__init__.pyi

@@ -47,11 +47,12 @@ see bpy.app.handlers.load_post.
 import typing
 import collections.abc
 import typing_extensions
+import bpy.types
 
 def clear_by_owner(owner):
     """Clear all subscribers using this owner."""
 
-def publish_rna(key):
+def publish_rna(key: bpy.types.Property | bpy.types.Struct | None):
     """Notify subscribers of changes to this property
     (this typically doesn't need to be called explicitly since changes will automatically publish updates).
     In some cases it may be useful to publish changes explicitly using more general keys.
@@ -62,9 +63,16 @@ def publish_rna(key):
     - A property instance.
     - A struct type.
     - A tuple representing a (struct, property name) pair.
+        :type key: bpy.types.Property | bpy.types.Struct | None
     """
 
-def subscribe_rna(key, owner, args, notify, options=set()):
+def subscribe_rna(
+    key: bpy.types.Property | bpy.types.Struct | None,
+    owner,
+    args,
+    notify,
+    options=set(),
+):
     """Register a message bus subscription. It will be cleared when another blend file is
     loaded, or can be cleared explicitly via `bpy.msgbus.clear_by_owner`.
 
@@ -74,6 +82,7 @@ def subscribe_rna(key, owner, args, notify, options=set()):
     - A property instance.
     - A struct type.
     - A tuple representing a (struct, property name) pair.
+        :type key: bpy.types.Property | bpy.types.Struct | None
         :param owner: Handle for this subscription (compared by identity).
         :param options: Change the behavior of the subscriber.
 

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bpy/ops/wm/__init__.pyi

@@ -2572,6 +2572,7 @@ def obj_import(
     use_split_groups: bool | None = False,
     import_vertex_groups: bool | None = False,
     validate_meshes: bool | None = True,
+    close_spline_loops: bool | None = True,
     collection_separator: str = "",
     filter_glob: str = "*.obj;*.mtl",
 ):
@@ -2692,6 +2693,8 @@ def obj_import(
         :type import_vertex_groups: bool | None
         :param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
         :type validate_meshes: bool | None
+        :param close_spline_loops: Detect Cyclic Curves, Join curve endpoints if overlapping control points are detected(if disabled, no curves will be cyclic)
+        :type close_spline_loops: bool | None
         :param collection_separator: Path Separator, Character used to separate objects name into hierarchical structure
         :type collection_separator: str
         :param filter_glob: Extension Filter

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bpy/path/__init__.pyi

@@ -9,12 +9,15 @@ import collections.abc
 import typing_extensions
 import bpy.types
 
-def abspath(path, *, start=None, library: bpy.types.Library | None = None) -> str:
+def abspath(
+    path, *, start: bytes | str | None = None, library: bpy.types.Library | None = None
+) -> str:
     """Returns the absolute path relative to the current blend file
     using the "//" prefix.
 
         :param start: Relative to this path,
     when not set the current filename is used.
+        :type start: bytes | str | None
         :param library: The library this path is from. This is only included for
     convenience, when the library is not None its path replaces start.
         :type library: bpy.types.Library | None
@@ -29,13 +32,14 @@ def basename(path) -> str:
     :rtype: str
     """
 
-def clean_name(name, *, replace: str = "_") -> str:
+def clean_name(name: bytes | str, *, replace: str = "_") -> str:
     """Returns a name with characters replaced that
     may cause problems under various circumstances,
     such as writing to a file.All characters besides A-Z/a-z, 0-9 are replaced with "_"
     or the replace argument if defined.
 
         :param name: The path name.
+        :type name: bytes | str
         :param replace: The replacement for non-valid characters.
         :type replace: str
         :return: The cleaned name.
@@ -90,11 +94,12 @@ def ensure_ext(filepath: str, ext: str, *, case_sensitive: bool = False) -> str:
         :rtype: str
     """
 
-def is_subdir(path, directory) -> bool:
+def is_subdir(path: bytes | str, directory) -> bool:
     """Returns true if path in a subdirectory of directory.
     Both paths must be absolute.
 
         :param path: An absolute path.
+        :type path: bytes | str
         :return: Whether or not the path is a subdirectory.
         :rtype: bool
     """
@@ -129,12 +134,14 @@ def reduce_dirs(dirs):
         :return: A unique list of paths.
     """
 
-def relpath(path, *, start=None) -> str:
+def relpath(path: bytes | str, *, start: bytes | str | None = None) -> str:
     """Returns the path relative to the current blend file using the "//" prefix.
 
         :param path: An absolute path.
+        :type path: bytes | str
         :param start: Relative to this path,
     when not set the current filename is used.
+        :type start: bytes | str | None
         :return: The relative path.
         :rtype: str
     """

{fake_bpy_module-20241129 → fake_bpy_module-20241204}/bpy/props/__init__.pyi

@@ -148,7 +148,7 @@ def BoolVectorProperty(
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
-    size=3,
+    size: int | None = 3,
     update: collections.abc.Callable | None = None,
     get: collections.abc.Callable | None = None,
     set: collections.abc.Callable | None = None,
@@ -170,6 +170,7 @@ def BoolVectorProperty(
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberArrayItems
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
+        :type size: int | None
         :param update: Function to be called when this value is modified,
     This function must take 2 values (self, context) and return None.
     Warning there are no safety checks to avoid infinite recursion.
@@ -229,7 +230,7 @@ def EnumProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    default=None,
+    default: int | str | None = None,
     options: bpy.typing.PropertyFlagEnumItems = {"ANIMATABLE"},
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
@@ -291,6 +292,7 @@ def EnumProperty(
     If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
     WARNING: Strings cannot be specified for dynamic enums
     (i.e. if a callback function is given as items parameter).
+        :type default: int | str | None
         :param options: Enumerator in `rna_enum_property_flag_enum_items`.
         :type options: bpy.typing.PropertyFlagEnumItems
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
@@ -387,7 +389,7 @@ def FloatVectorProperty(
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     unit: bpy.typing.PropertyUnitItems = "NONE",
-    size=3,
+    size: int | None = 3,
     update: collections.abc.Callable | None = None,
     get: collections.abc.Callable | None = None,
     set: collections.abc.Callable | None = None,
@@ -423,6 +425,7 @@ def FloatVectorProperty(
         :param unit: Enumerator in `rna_enum_property_unit_items`.
         :type unit: bpy.typing.PropertyUnitItems
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
+        :type size: int | None
         :param update: Function to be called when this value is modified,
     This function must take 2 values (self, context) and return None.
     Warning there are no safety checks to avoid infinite recursion.
@@ -506,7 +509,7 @@ def IntVectorProperty(
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
-    size=3,
+    size: int | None = 3,
     update: collections.abc.Callable | None = None,
     get: collections.abc.Callable | None = None,
     set: collections.abc.Callable | None = None,
@@ -538,6 +541,7 @@ def IntVectorProperty(
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberArrayItems
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
+        :type size: int | None
         :param update: Function to be called when this value is modified,
     This function must take 2 values (self, context) and return None.
     Warning there are no safety checks to avoid infinite recursion.
@@ -552,7 +556,7 @@ def IntVectorProperty(
 
 def PointerProperty(
     *,
-    type=None,
+    type: bpy.types.ID | bpy.types.PropertyGroup | None = None,
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
@@ -565,6 +569,7 @@ def PointerProperty(
     """Returns a new pointer property definition.
 
         :param type: A subclass of a property group or ID types.
+        :type type: bpy.types.ID | bpy.types.PropertyGroup | None
         :param name: Name used in the user interface.
         :type name: str | None
         :param description: Text used for the tooltip and api documentation.