fake-bpy-module 20241009__py3-none-any.whl → 20241011__py3-none-any.whl

bpy/ops/wm/__init__.pyi

@@ -3633,7 +3633,48 @@ def properties_edit(
     step_float: float | None = 0.1,
     subtype: str | None = "",
     default_string: str = "",
-    id_type: typing.Literal["OBJECT"] | None = "OBJECT",
+    id_type: typing.Literal[
+        "ACTION",
+        "ARMATURE",
+        "BRUSH",
+        "CACHEFILE",
+        "CAMERA",
+        "COLLECTION",
+        "CURVE",
+        "CURVES",
+        "FONT",
+        "GREASEPENCIL",
+        "GREASEPENCIL_V3",
+        "IMAGE",
+        "KEY",
+        "LATTICE",
+        "LIBRARY",
+        "LIGHT",
+        "LIGHT_PROBE",
+        "LINESTYLE",
+        "MASK",
+        "MATERIAL",
+        "MESH",
+        "META",
+        "MOVIECLIP",
+        "NODETREE",
+        "OBJECT",
+        "PAINTCURVE",
+        "PALETTE",
+        "PARTICLE",
+        "POINTCLOUD",
+        "SCENE",
+        "SCREEN",
+        "SOUND",
+        "SPEAKER",
+        "TEXT",
+        "TEXTURE",
+        "VOLUME",
+        "WINDOWMANAGER",
+        "WORKSPACE",
+        "WORLD",
+    ]
+    | None = "OBJECT",
     eval_string: str = "",
 ):
     """Change a custom property's type, or adjust how it is displayed in the interface
@@ -3715,7 +3756,7 @@ def properties_edit(
         :param default_string: Default Value
         :type default_string: str
         :param id_type: ID Type
-        :type id_type: typing.Literal['OBJECT'] | None
+        :type id_type: typing.Literal['ACTION','ARMATURE','BRUSH','CACHEFILE','CAMERA','COLLECTION','CURVE','CURVES','FONT','GREASEPENCIL','GREASEPENCIL_V3','IMAGE','KEY','LATTICE','LIBRARY','LIGHT','LIGHT_PROBE','LINESTYLE','MASK','MATERIAL','MESH','META','MOVIECLIP','NODETREE','OBJECT','PAINTCURVE','PALETTE','PARTICLE','POINTCLOUD','SCENE','SCREEN','SOUND','SPEAKER','TEXT','TEXTURE','VOLUME','WINDOWMANAGER','WORKSPACE','WORLD'] | None
         :param eval_string: Value, Python value for unsupported custom property types
         :type eval_string: str
     """

bpy/props/__init__.pyi

@@ -91,6 +91,7 @@ import typing
 import collections.abc
 import typing_extensions
 import bpy.types
+import bpy.typing
 
 def BoolProperty(
     *,
@@ -98,10 +99,10 @@ def BoolProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default=False,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
     update: typing.Any | None = None,
     get: typing.Any | None = None,
     set: typing.Any | None = None,
@@ -115,13 +116,13 @@ 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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
-        :type subtype: str | None
+        :type subtype: bpy.typing.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.
@@ -140,10 +141,10 @@ def BoolVectorProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default: collections.abc.Sequence | None = (False, False, False),
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
     update: typing.Any | None = None,
     get: typing.Any | None = None,
@@ -160,13 +161,13 @@ def BoolVectorProperty(
         :param default: sequence of booleans the length of size.
         :type default: collections.abc.Sequence | None
         :param options: Enumerator in `rna_enum_property_flag_items`.
-        :type options: set | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
-        :type subtype: str | None
+        :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: collections.abc.Sequence[int] | int | None
         :param update: Function to be called when this value is modified,
@@ -187,8 +188,8 @@ def CollectionProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagCollectionItems] = set(),
     tags: set | None = set(),
 ):
     """Returns a new collection property definition.
@@ -201,9 +202,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 | None
+    :type options: set[bpy.typing.PropertyFlagItems]
     :param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
-    :type override: set | None
+    :type override: set[bpy.typing.PropertyOverrideFlagCollectionItems]
     :param tags: Enumerator of tags that are defined by parent class.
     :type tags: set | None
     """
@@ -229,8 +230,8 @@ def EnumProperty(
     description: str | None = "",
     translation_context: str | None = "*",
     default: int | set | str | None = None,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagEnumItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
     update: typing.Any | None = None,
     get: typing.Any | None = None,
@@ -289,9 +290,9 @@ def EnumProperty(
     (i.e. if a callback function is given as items parameter).
         :type default: int | set | str | None
         :param options: Enumerator in `rna_enum_property_flag_enum_items`.
-        :type options: set | None
+        :type options: set[bpy.typing.PropertyFlagEnumItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param update: Function to be called when this value is modified,
@@ -318,11 +319,11 @@ def FloatProperty(
     soft_max: float | None = 3.402823e38,
     step: int | None = 3,
     precision: int | None = 2,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
-    unit: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
+    unit: bpy.typing.PropertyUnitItems = "NONE",
     update: typing.Any | None = None,
     get: typing.Any | None = None,
     set: typing.Any | None = None,
@@ -348,15 +349,15 @@ 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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
-        :type subtype: str | None
+        :type subtype: bpy.typing.PropertySubtypeNumberItems
         :param unit: Enumerator in `rna_enum_property_unit_items`.
-        :type unit: str | None
+        :type unit: bpy.typing.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.
@@ -381,11 +382,11 @@ def FloatVectorProperty(
     soft_max: float | None = sys.float_info.max,
     step: int | None = 3,
     precision: int | None = 2,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
-    unit: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
+    unit: bpy.typing.PropertyUnitItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
     update: typing.Any | None = None,
     get: typing.Any | None = None,
@@ -414,15 +415,15 @@ 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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
-        :type subtype: str | None
+        :type subtype: bpy.typing.PropertySubtypeNumberArrayItems
         :param unit: Enumerator in `rna_enum_property_unit_items`.
-        :type unit: str | None
+        :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: collections.abc.Sequence[int] | int | None
         :param update: Function to be called when this value is modified,
@@ -448,10 +449,10 @@ def IntProperty(
     soft_min: int | None = None,
     soft_max: int | None = None,
     step: int | None = 1,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
     update: typing.Any | None = None,
     get: typing.Any | None = None,
     set: typing.Any | None = None,
@@ -475,13 +476,13 @@ 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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
-        :type subtype: str | None
+        :type subtype: bpy.typing.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.
@@ -505,10 +506,10 @@ def IntVectorProperty(
     soft_min: int | None = None,
     soft_max: int | None = None,
     step: int | None = 1,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
     size: collections.abc.Sequence[int] | int | None = 3,
     update: typing.Any | None = None,
     get: typing.Any | None = None,
@@ -535,13 +536,13 @@ 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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
-        :type subtype: str | None
+        :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: collections.abc.Sequence[int] | int | None
         :param update: Function to be called when this value is modified,
@@ -562,8 +563,8 @@ def PointerProperty(
     name: str | None = "",
     description: str | None = "",
     translation_context: str | None = "*",
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
     poll: typing.Any | None = None,
     update: typing.Any | None = None,
@@ -578,9 +579,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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param poll: function to be called to determine whether an item is valid for this property.
@@ -608,10 +609,10 @@ def StringProperty(
     translation_context: str | None = "*",
     default: str | None = "",
     maxlen: int | None = 0,
-    options: set | None = {"ANIMATABLE"},
-    override: set | None = set(),
+    options: set[bpy.typing.PropertyFlagItems] = {"ANIMATABLE"},
+    override: set[bpy.typing.PropertyOverrideFlagItems] = set(),
     tags: set | None = set(),
-    subtype: str | None = "NONE",
+    subtype: bpy.typing.PropertySubtypeStringItems = "NONE",
     update: typing.Any | None = None,
     get: typing.Any | None = None,
     set: typing.Any | None = None,
@@ -631,13 +632,13 @@ 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 | None
+        :type options: set[bpy.typing.PropertyFlagItems]
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
-        :type override: set | None
+        :type override: set[bpy.typing.PropertyOverrideFlagItems]
         :param tags: Enumerator of tags that are defined by parent class.
         :type tags: set | None
         :param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
-        :type subtype: str | None
+        :type subtype: bpy.typing.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.