fake-bpy-module 20241229__py3-none-any.whl → 20250102__py3-none-any.whl

bpy/props/__init__.pyi

@@ -111,9 +111,10 @@ def BoolProperty(
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[[bpy.types.bpy_struct], bool] | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, bool], None] | None = None,
 ):
     """Returns a new boolean property definition.
 
@@ -133,13 +134,13 @@ def BoolProperty(
         :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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :type get: collections.abc.Callable[[bpy.types.bpy_struct], 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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, bool], None] | None
     """
 
 def BoolVectorProperty(
@@ -147,15 +148,20 @@ def BoolVectorProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    default=(False, False, False),
+    default: collections.abc.Sequence[bool] | None = (False, False, False),
     options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
-    size: int | None = 3,
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    size: collections.abc.Sequence[int] | int | None = 3,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[
+        [bpy.types.bpy_struct], collections.abc.Sequence[bool]
+    ]
+    | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, int]], None]
+    | None = None,
 ):
     """Returns a new vector boolean property definition.
 
@@ -166,6 +172,7 @@ def BoolVectorProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str | None
         :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
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
@@ -174,17 +181,17 @@ 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
+        :type size: collections.abc.Sequence[int] | 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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, int]], None] | None
     """
 
 def CollectionProperty(
@@ -238,9 +245,10 @@ def EnumProperty(
     options: bpy.typing.PropertyFlagEnumItems = {"ANIMATABLE"},
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[[bpy.types.bpy_struct], int] | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None = None,
 ):
     """Returns a new enumerator property definition.
 
@@ -305,13 +313,13 @@ def EnumProperty(
         :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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :type get: collections.abc.Callable[[bpy.types.bpy_struct], 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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None
     """
 
 def FloatProperty(
@@ -331,9 +339,10 @@ def FloatProperty(
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
     unit: bpy.typing.PropertyUnitItems = "NONE",
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[[bpy.types.bpy_struct], float] | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, float], None] | None = None,
 ):
     """Returns a new float (single precision) property definition.
 
@@ -367,13 +376,13 @@ def FloatProperty(
         :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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :type get: collections.abc.Callable[[bpy.types.bpy_struct], 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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, float], None] | None
     """
 
 def FloatVectorProperty(
@@ -381,7 +390,7 @@ def FloatVectorProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    default=(0.0, 0.0, 0.0),
+    default: collections.abc.Sequence[float] | None = (0.0, 0.0, 0.0),
     min: float | None = sys.float_info.min,
     max: float | None = sys.float_info.max,
     soft_min: float | None = sys.float_info.min,
@@ -393,10 +402,15 @@ def FloatVectorProperty(
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     unit: bpy.typing.PropertyUnitItems = "NONE",
-    size: int | None = 3,
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    size: collections.abc.Sequence[int] | int | None = 3,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[
+        [bpy.types.bpy_struct], collections.abc.Sequence[float]
+    ]
+    | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, int]], None]
+    | None = None,
 ):
     """Returns a new vector float property definition.
 
@@ -407,6 +421,7 @@ def FloatVectorProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str | None
         :param default: Sequence of floats the length of size.
+        :type default: collections.abc.Sequence[float] | None
         :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
         :type min: float | None
         :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
@@ -429,17 +444,17 @@ 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
+        :type size: collections.abc.Sequence[int] | 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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, int]], None] | None
     """
 
 def IntProperty(
@@ -457,9 +472,10 @@ def IntProperty(
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[[bpy.types.bpy_struct], int] | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None = None,
 ):
     """Returns a new int property definition.
 
@@ -489,13 +505,13 @@ def IntProperty(
         :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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :type get: collections.abc.Callable[[bpy.types.bpy_struct], 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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None
     """
 
 def IntVectorProperty(
@@ -503,7 +519,7 @@ def IntVectorProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    default=(0, 0, 0),
+    default: collections.abc.Sequence[int] | None = (0, 0, 0),
     min: int | None = None,
     max: int | None = None,
     soft_min: int | None = None,
@@ -513,10 +529,13 @@ def IntVectorProperty(
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
-    size: int | None = 3,
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
+    size: collections.abc.Sequence[int] | int | None = 3,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | 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]
+    | None = None,
 ):
     """Returns a new vector int property definition.
 
@@ -527,6 +546,7 @@ def IntVectorProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str | None
         :param default: sequence of ints the length of size.
+        :type default: collections.abc.Sequence[int] | None
         :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
         :type min: int | None
         :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
@@ -545,17 +565,17 @@ 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
+        :type size: collections.abc.Sequence[int] | 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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, int]], None] | None
     """
 
 def PointerProperty(
@@ -567,8 +587,10 @@ def PointerProperty(
     options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
-    poll: collections.abc.Callable | None = None,
-    update: collections.abc.Callable | None = None,
+    poll: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.ID], bool]
+    | None = None,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
 ):
     """Returns a new pointer property definition.
 
@@ -588,11 +610,11 @@ def PointerProperty(
         :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.
     Note that the poll return value will be checked only when assigning an item from the UI, but it is still possible to assign an "invalid" item to the property directly.
-        :type poll: collections.abc.Callable | None
+        :type poll: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.ID], bool] | 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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
     """
 
 def RemoveProperty(*, cls: typing.Any | None, attr: str | None):
@@ -615,10 +637,12 @@ def StringProperty(
     override: bpy.typing.PropertyOverrideFlagItems = set(),
     tags=set(),
     subtype: bpy.typing.PropertySubtypeStringItems = "NONE",
-    update: collections.abc.Callable | None = None,
-    get: collections.abc.Callable | None = None,
-    set: collections.abc.Callable | None = None,
-    search: collections.abc.Callable | None = None,
+    update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
+    | None = None,
+    get: collections.abc.Callable[[bpy.types.bpy_struct], str] | None = None,
+    set: collections.abc.Callable[[bpy.types.bpy_struct, str], None] | None = None,
+    search: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context, str]]
+    | None = None,
     search_options={"SUGGESTION"},
 ):
     """Returns a new string property definition.
@@ -643,13 +667,13 @@ def StringProperty(
         :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.
-        :type update: collections.abc.Callable | None
+        :type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
         :param get: Function to be called when this value is 'read',
     This function must take 1 value (self) and return the value of the property.
-        :type get: collections.abc.Callable | None
+        :type get: collections.abc.Callable[[bpy.types.bpy_struct], str] | 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 | None
+        :type set: collections.abc.Callable[[bpy.types.bpy_struct, str], None] | None
         :param search: Function to be called to show candidates for this string (shown in the UI).
     This function must take 3 values (self, context, edit_text)
     and return a sequence, iterator or generator where each item must be:
@@ -658,7 +682,7 @@ def StringProperty(
 
     A tuple-pair of strings, where the first is a candidate and the second
     is additional information about the candidate.
-        :type search: collections.abc.Callable | None
+        :type search: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context, str]] | None
         :param search_options: Set of strings in:
 
     'SORT' sorts the resulting items.