fake-bpy-module 20241230__tar.gz → 20250103__tar.gz

{fake_bpy_module-20241230 → fake_bpy_module-20250103}/PKG-INFO

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

{fake_bpy_module-20241230 → fake_bpy_module-20250103}/bmesh/utils/__init__.pyi

@@ -77,7 +77,7 @@ def face_split(
 
 def face_split_edgenet(
     face: bmesh.types.BMFace, edgenet: collections.abc.Sequence[bmesh.types.BMEdge]
-) -> tuple[bmesh.types.BMFace, int]:
+) -> tuple[bmesh.types.BMFace, ...]:
     """Splits a face into any number of regions defined by an edgenet.
 
     :param face: The face to split.The face to split.
@@ -85,7 +85,7 @@ def face_split_edgenet(
     :param edgenet: Sequence of edges.
     :type edgenet: collections.abc.Sequence[bmesh.types.BMEdge]
     :return: The newly created faces.
-    :rtype: tuple[bmesh.types.BMFace, int]
+    :rtype: tuple[bmesh.types.BMFace, ...]
     """
 
 def face_vert_separate(
@@ -151,7 +151,7 @@ def vert_dissolve(vert: bmesh.types.BMVert) -> bool:
 
 def vert_separate(
     vert: bmesh.types.BMVert, edges: bmesh.types.BMEdge
-) -> tuple[bmesh.types.BMVert, int]:
+) -> tuple[bmesh.types.BMVert, ...]:
     """Separate this vertex at every edge.
 
     :param vert: The vert to be separated.
@@ -159,7 +159,7 @@ def vert_separate(
     :param edges: The edges to separated.
     :type edges: bmesh.types.BMEdge
     :return: The newly separated verts (including the vertex passed).
-    :rtype: tuple[bmesh.types.BMVert, int]
+    :rtype: tuple[bmesh.types.BMVert, ...]
     """
 
 def vert_splice(vert: bmesh.types.BMVert, vert_target: bmesh.types.BMVert):

{fake_bpy_module-20241230 → fake_bpy_module-20250103}/bpy/ops/wm/__init__.pyi

@@ -4950,6 +4950,18 @@ def usd_export(
     | None = "KEEP",
     usdz_downscale_custom_size: int | None = 128,
     merge_parent_xform: bool | None = False,
+    convert_scene_units: typing.Literal[
+        "METERS",
+        "KILOMETERS",
+        "CENTIMETERS",
+        "MILLIMETERS",
+        "INCHES",
+        "FEET",
+        "YARDS",
+        "CUSTOM",
+    ]
+    | None = "METERS",
+    meters_per_unit: float | None = 1.0,
 ):
     """Export current scene in a USD archive
 
@@ -5191,6 +5203,34 @@ def usd_export(
         :type usdz_downscale_custom_size: int | None
         :param merge_parent_xform: Merge parent Xform, Merge USD primitives with their Xform parent if possible. USD does not allow nested UsdGeomGprims, intermediary Xform prims will be defined to keep the USD file valid when encountering object hierarchies.
         :type merge_parent_xform: bool | None
+        :param convert_scene_units: Units, Set the USD Stage meters per unit to the chosen measurement, or a custom value
+
+    METERS
+    Meters -- Scene meters per unit to 1.0.
+
+    KILOMETERS
+    Kilometers -- Scene meters per unit to 1000.0.
+
+    CENTIMETERS
+    Centimeters -- Scene meters per unit to 0.01.
+
+    MILLIMETERS
+    Millimeters -- Scene meters per unit to 0.001.
+
+    INCHES
+    Inches -- Scene meters per unit to 0.0254.
+
+    FEET
+    Feet -- Scene meters per unit to 0.3048.
+
+    YARDS
+    Yards -- Scene meters per unit to 0.9144.
+
+    CUSTOM
+    Custom -- Specify a custom scene meters per unit value.
+        :type convert_scene_units: typing.Literal['METERS','KILOMETERS','CENTIMETERS','MILLIMETERS','INCHES','FEET','YARDS','CUSTOM'] | None
+        :param meters_per_unit: Meters Per Unit, Custom value for meters per unit in the USD Stage
+        :type meters_per_unit: float | None
     """
 
 def usd_import(
@@ -5266,6 +5306,7 @@ def usd_import(
     create_world_material: bool | None = True,
     import_defined_only: bool | None = True,
     merge_parent_xform: bool | None = True,
+    apply_unit_conversion_scale: bool | None = True,
 ):
     """Import USD stage into current scene
 
@@ -5443,6 +5484,8 @@ def usd_import(
         :type import_defined_only: bool | None
         :param merge_parent_xform: Merge parent Xform, Allow USD primitives to merge with their Xform parent if they are the only child in the hierarchy
         :type merge_parent_xform: bool | None
+        :param apply_unit_conversion_scale: Apply Unit Conversion Scale, Scale the scene objects by the USD stage's meters per unit value. This scaling is applied in addition to the value specified in the Scale option
+        :type apply_unit_conversion_scale: bool | None
     """
 
 def window_close(execution_context: int | str | None = None, undo: bool | None = None):

{fake_bpy_module-20241230 → fake_bpy_module-20250103}/bpy/props/__init__.pyi

@@ -107,8 +107,8 @@ def BoolProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default=False,
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
@@ -125,9 +125,9 @@ def BoolProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberItems
@@ -149,8 +149,8 @@ def BoolVectorProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default: collections.abc.Sequence[bool] | None = (False, False, False),
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
@@ -160,7 +160,7 @@ def BoolVectorProperty(
         [bpy.types.bpy_struct], collections.abc.Sequence[bool]
     ]
     | None = None,
-    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, int]], None]
+    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, ...]], None]
     | None = None,
 ):
     """Returns a new vector boolean property definition.
@@ -174,9 +174,9 @@ def BoolVectorProperty(
         :param default: sequence of booleans the length of size.
         :type default: collections.abc.Sequence[bool] | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberArrayItems
@@ -191,7 +191,7 @@ def BoolVectorProperty(
         :type get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[bool]] | None
         :param set: Function to be called when this value is 'written',
     This function must take 2 values (self, value) and return None.
-        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, int]], None] | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, ...]], None] | None
     """
 
 def CollectionProperty(
@@ -200,8 +200,8 @@ def CollectionProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagCollectionItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagCollectionItems] = set(),
     tags=set(),
 ):
     """Returns a new collection property definition.
@@ -215,9 +215,9 @@ def CollectionProperty(
     :param translation_context: Text used as context to disambiguate translations.
     :type translation_context: str | None
     :param options: Enumerator in `rna_enum_property_flag_items`.
-    :type options: bpy.typing.PropertyFlagItems
+    :type options: set[bpy.typing.PropertyFlagItems]
     :param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
-    :type override: bpy.typing.PropertyOverrideFlagCollectionItems
+    :type override: set[bpy.typing.PropertyOverrideFlagCollectionItems]
     :param tags: Enumerator of tags that are defined by parent class.
     """
 
@@ -242,8 +242,8 @@ def EnumProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default: int | str | None = None,
-    options: bpy.typing.PropertyFlagEnumItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagEnumItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
     | None = None,
@@ -306,9 +306,9 @@ def EnumProperty(
     (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
+        :type options: set[bpy.typing.PropertyFlagEnumItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param update: Function to be called when this value is modified,
     This function must take 2 values (self, context) and return None.
@@ -334,8 +334,8 @@ def FloatProperty(
     soft_max: float | None = 3.402823e38,
     step: int | None = 3,
     precision: int | None = 2,
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
     unit: bpy.typing.PropertyUnitItems = "NONE",
@@ -365,9 +365,9 @@ def FloatProperty(
         :param precision: Maximum number of decimal digits to display, in [0, 6]. Fraction is automatically hidden for exact integer values of fields with unit 'NONE' or 'TIME' (frame count) and step divisible by 100.
         :type precision: int | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberItems
@@ -397,8 +397,8 @@ def FloatVectorProperty(
     soft_max: float | None = sys.float_info.max,
     step: int | None = 3,
     precision: int | None = 2,
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     unit: bpy.typing.PropertyUnitItems = "NONE",
@@ -409,7 +409,7 @@ def FloatVectorProperty(
         [bpy.types.bpy_struct], collections.abc.Sequence[float]
     ]
     | None = None,
-    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, int]], None]
+    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, ...]], None]
     | None = None,
 ):
     """Returns a new vector float property definition.
@@ -435,9 +435,9 @@ def FloatVectorProperty(
         :param precision: Maximum number of decimal digits to display, in [0, 6]. Fraction is automatically hidden for exact integer values of fields with unit 'NONE' or 'TIME' (frame count) and step divisible by 100.
         :type precision: int | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberArrayItems
@@ -454,7 +454,7 @@ def FloatVectorProperty(
         :type get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[float]] | None
         :param set: Function to be called when this value is 'written',
     This function must take 2 values (self, value) and return None.
-        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, int]], None] | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, ...]], None] | None
     """
 
 def IntProperty(
@@ -468,8 +468,8 @@ def IntProperty(
     soft_min: int | None = None,
     soft_max: int | None = None,
     step: int | None = 1,
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
@@ -496,9 +496,9 @@ def IntProperty(
         :param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
         :type step: int | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberItems
@@ -525,8 +525,8 @@ def IntVectorProperty(
     soft_min: int | None = None,
     soft_max: int | None = None,
     step: int | None = 1,
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
@@ -534,7 +534,7 @@ def IntVectorProperty(
     | None = None,
     get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[int]]
     | None = None,
-    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, int]], None]
+    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, ...]], None]
     | None = None,
 ):
     """Returns a new vector int property definition.
@@ -558,9 +558,9 @@ def IntVectorProperty(
         :param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
         :type step: int | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: bpy.typing.PropertySubtypeNumberArrayItems
@@ -575,7 +575,7 @@ def IntVectorProperty(
         :type get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[int]] | None
         :param set: Function to be called when this value is 'written',
     This function must take 2 values (self, value) and return None.
-        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, int]], None] | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, ...]], None] | None
     """
 
 def PointerProperty(
@@ -584,8 +584,8 @@ def PointerProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     poll: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.ID], bool]
     | None = None,
@@ -603,9 +603,9 @@ def PointerProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param poll: function to be called to determine whether an item is valid for this property.
     The function must take 2 values (self, object) and return Bool.
@@ -633,8 +633,8 @@ def StringProperty(
     translation_context: str | None = "*",
     default: str | None = "",
     maxlen: int | None = 0,
-    options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
-    override: bpy.typing.PropertyOverrideFlagItems = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeStringItems = "NONE",
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
@@ -658,9 +658,9 @@ def StringProperty(
         :param maxlen: maximum length of the string.
         :type maxlen: int | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: bpy.typing.PropertyFlagItems
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: bpy.typing.PropertyOverrideFlagItems
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
         :type subtype: bpy.typing.PropertySubtypeStringItems