fake-bpy-module 20250103__py3-none-any.whl → 20250108__py3-none-any.whl

bpy/props/__init__.pyi

@@ -98,8 +98,8 @@ Instead use del cls.attr
 import typing
 import collections.abc
 import typing_extensions
+import bpy._typing.rna_enums
 import bpy.types
-import bpy.typing
 
 def BoolProperty(
     *,
@@ -107,10 +107,10 @@ def BoolProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default=False,
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems = "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,
@@ -125,12 +125,12 @@ 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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems
         :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.
@@ -149,10 +149,10 @@ def BoolVectorProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default: collections.abc.Sequence[bool] | None = (False, False, False),
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
     | None = None,
@@ -174,12 +174,12 @@ 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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
         :type size: collections.abc.Sequence[int] | int | None
         :param update: Function to be called when this value is modified,
@@ -196,18 +196,17 @@ def BoolVectorProperty(
 
 def CollectionProperty(
     *,
-    type: bpy.types.PropertyGroup | None = None,
+    type=None,
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagCollectionItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagCollectionItems] = set(),
     tags=set(),
 ):
     """Returns a new collection property definition.
 
     :param type: A subclass of a property group.
-    :type type: 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.
@@ -215,9 +214,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: set[bpy.typing.PropertyFlagItems]
+    :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
     :param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
-    :type override: set[bpy.typing.PropertyOverrideFlagCollectionItems]
+    :type override: set[bpy._typing.rna_enums.PropertyOverrideFlagCollectionItems]
     :param tags: Enumerator of tags that are defined by parent class.
     """
 
@@ -242,8 +241,8 @@ def EnumProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default: int | str | None = None,
-    options: set[bpy.typing.PropertyFlagEnumItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagEnumItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
     | None = None,
@@ -306,9 +305,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: set[bpy.typing.PropertyFlagEnumItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagEnumItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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,11 +333,11 @@ def FloatProperty(
     soft_max: float | None = 3.402823e38,
     step: int | None = 3,
     precision: int | None = 2,
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
-    unit: bpy.typing.PropertyUnitItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems = "NONE",
+    unit: bpy._typing.rna_enums.PropertyUnitItems = "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,
@@ -365,14 +364,14 @@ 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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems
         :param unit: Enumerator in `rna_enum_property_unit_items`.
-        :type unit: bpy.typing.PropertyUnitItems
+        :type unit: bpy._typing.rna_enums.PropertyUnitItems
         :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.
@@ -397,11 +396,11 @@ def FloatVectorProperty(
     soft_max: float | None = sys.float_info.max,
     step: int | None = 3,
     precision: int | None = 2,
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
-    unit: bpy.typing.PropertyUnitItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
+    unit: bpy._typing.rna_enums.PropertyUnitItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
     | None = None,
@@ -435,14 +434,14 @@ 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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems
         :param unit: Enumerator in `rna_enum_property_unit_items`.
-        :type unit: bpy.typing.PropertyUnitItems
+        :type unit: bpy._typing.rna_enums.PropertyUnitItems
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
         :type size: collections.abc.Sequence[int] | int | None
         :param update: Function to be called when this value is modified,
@@ -468,10 +467,10 @@ def IntProperty(
     soft_min: int | None = None,
     soft_max: int | None = None,
     step: int | None = 1,
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems = "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,
@@ -496,12 +495,12 @@ 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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems
         :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.
@@ -525,10 +524,10 @@ def IntVectorProperty(
     soft_min: int | None = None,
     soft_max: int | None = None,
     step: int | None = 1,
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
     update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
     | None = None,
@@ -558,12 +557,12 @@ 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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
         :type size: collections.abc.Sequence[int] | int | None
         :param update: Function to be called when this value is modified,
@@ -580,12 +579,12 @@ def IntVectorProperty(
 
 def PointerProperty(
     *,
-    type: bpy.types.ID | bpy.types.PropertyGroup | None = None,
+    type=None,
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
     poll: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.ID], bool]
     | None = None,
@@ -595,7 +594,6 @@ 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.
@@ -603,9 +601,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: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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,10 +631,10 @@ def StringProperty(
     translation_context: str | None = "*",
     default: str | None = "",
     maxlen: int | None = 0,
-    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
-    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
+    options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
     tags=set(),
-    subtype: bpy.typing.PropertySubtypeStringItems = "NONE",
+    subtype: bpy._typing.rna_enums.PropertySubtypeStringItems = "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,
@@ -658,12 +656,12 @@ def StringProperty(
         :param maxlen: maximum length of the string.
         :type maxlen: int | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: set[bpy.typing.PropertyFlagItems]
+        :type options: set[bpy._typing.rna_enums.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set[bpy.typing.PropertyOverrideFlagItems]
+        :type override: set[bpy._typing.rna_enums.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
+        :type subtype: bpy._typing.rna_enums.PropertySubtypeStringItems
         :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.