fake-bpy-module 20240417__py3-none-any.whl → 20240418__py3-none-any.whl

bpy/ops/workspace/__init__.pyi

@@ -5,13 +5,13 @@ GenericType = typing.TypeVar("GenericType")
 
 def add(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Add a new workspace by duplicating the current one or appending one from the user configuration
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 
@@ -19,7 +19,7 @@ def add(
 
 def append_activate(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
     idname: typing.Union[str, typing.Any] = "",
     filepath: typing.Union[str, typing.Any] = "",
@@ -27,7 +27,7 @@ def append_activate(
     """Append a workspace and make it the active one in the current window
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     :param idname: Identifier, Name of the workspace to append and activate
     :type idname: typing.Union[str, typing.Any]
@@ -39,13 +39,13 @@ def append_activate(
 
 def delete(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Delete the active workspace
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 
@@ -53,13 +53,13 @@ def delete(
 
 def duplicate(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Add a new workspace
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 
@@ -67,13 +67,13 @@ def duplicate(
 
 def reorder_to_back(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Reorder workspace to be last in the list
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 
@@ -81,13 +81,13 @@ def reorder_to_back(
 
 def reorder_to_front(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Reorder workspace to be first in the list
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 
@@ -95,13 +95,13 @@ def reorder_to_front(
 
 def scene_pin_toggle(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Remember the last used scene for the current workspace and switch to it whenever this workspace is activated again
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 

bpy/ops/world/__init__.pyi

@@ -5,13 +5,13 @@ GenericType = typing.TypeVar("GenericType")
 
 def new(
     override_context: typing.Union[dict, bpy.types.Context] = None,
-    execution_context: str = None,
+    execution_context: typing.Union[str, int] = None,
     undo: bool = None,
 ):
     """Create a new world Data-Block
 
     :type override_context: typing.Union[dict, bpy.types.Context]
-    :type execution_context: str
+    :type execution_context: typing.Union[str, int]
     :type undo: bool
     """
 

bpy/path/__init__.pyi

@@ -1,3 +1,9 @@
+"""
+This module has a similar scope to os.path, containing utility
+functions for dealing with paths in Blender.
+
+"""
+
 import typing
 import bpy.types
 

bpy/props/__init__.pyi

@@ -1,3 +1,92 @@
+"""
+This module defines properties to extend Blender's internal data. The result of these functions is used to assign properties to classes registered with Blender and can't be used directly.
+
+[NOTE]
+All parameters to these functions must be passed as keywords.
+
+
+--------------------
+
+Custom properties can be added to any subclass of an ID,
+Bone and PoseBone.
+
+These properties can be animated, accessed by the user interface and python
+like Blender's existing properties.
+
+[WARNING]
+Access to these properties might happen in threaded context, on a per-data-block level.
+This has to be carefully considered when using accessors or update callbacks.
+Typically, these callbacks should not affect any other data that the one owned by their data-block.
+When accessing external non-Blender data, thread safety mechanisms should be considered.
+
+```../examples/bpy.props.py```
+
+
+--------------------
+
+A common use of custom properties is for python based Operator
+classes. Test this code by running it in the text editor, or by clicking the
+button in the 3D Viewport's Tools panel. The latter will show the properties
+in the Redo panel and allow you to change them.
+
+```../examples/bpy.props.1.py```
+
+
+--------------------
+
+PropertyGroups can be used for collecting custom settings into one value
+to avoid many individual settings mixed in together.
+
+```../examples/bpy.props.2.py```
+
+
+--------------------
+
+Custom properties can be added to any subclass of an ID,
+Bone and PoseBone.
+
+```../examples/bpy.props.3.py```
+
+
+--------------------
+
+It can be useful to perform an action when a property is changed and can be
+used to update other properties or synchronize with external data.
+
+All properties define update functions except for CollectionProperty.
+
+[WARNING]
+Remember that these callbacks may be executed in threaded context.
+
+[WARNING]
+If the property belongs to an Operator, the update callback's first
+parameter will be an OperatorProperties instance, rather than an instance
+of the operator itself. This means you can't access other internal functions
+of the operator, only its other properties.
+
+```../examples/bpy.props.4.py```
+
+
+--------------------
+
+Getter/setter functions can be used for boolean, int, float, string and enum properties.
+If these callbacks are defined the property will not be stored in the ID properties
+automatically. Instead, the get and set functions will be called when the property
+is respectively read or written from the API.
+
+[WARNING]
+Remember that these callbacks may be executed in threaded context.
+
+```../examples/bpy.props.5.py```
+
+[NOTE]
+Typically this function doesn't need to be accessed directly.
+Instead use del cls.attr
+
+
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")
@@ -54,7 +143,7 @@ def BoolVectorProperty(
     override: set = None(),
     tags: set = None(),
     subtype: str = "NONE",
-    size: typing.Sequence[int] = 3,
+    size: typing.Union[int, typing.Sequence[int]] = 3,
     update: typing.Any = None,
     get: typing.Any = None,
     set: typing.Any = None,
@@ -78,7 +167,7 @@ def BoolVectorProperty(
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: str
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
-        :type size: typing.Sequence[int]
+        :type size: typing.Union[int, typing.Sequence[int]]
         :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.
@@ -211,12 +300,12 @@ def FloatProperty(
     description: str = "",
     translation_context: str = "*",
     default=0.0,
-    min=-3.402823e38,
-    max=3.402823e38,
-    soft_min=-3.402823e38,
-    soft_max=3.402823e38,
-    step=3,
-    precision=2,
+    min: float = -3.402823e38,
+    max: float = 3.402823e38,
+    soft_min: float = -3.402823e38,
+    soft_max: float = 3.402823e38,
+    step: int = 3,
+    precision: int = 2,
     options: set = {'"ANIMATABLE"'},
     override: set = None(),
     tags: set = None(),
@@ -235,11 +324,17 @@ def FloatProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str
         :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
+        :type min: float
         :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
+        :type max: float
         :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
+        :type soft_min: float
         :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
+        :type soft_max: float
         :param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
+        :type step: int
         :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
         :param options: Enumerator in `rna_enum_property_flag_items`.
         :type options: set
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
@@ -269,18 +364,18 @@ def FloatVectorProperty(
     description: str = "",
     translation_context: str = "*",
     default: typing.Sequence = (0.0, 0.0, 0.0),
-    min=None,
-    max=None,
-    soft_min=None,
-    soft_max=None,
-    step=3,
-    precision=2,
+    min: float = None,
+    max: float = None,
+    soft_min: float = None,
+    soft_max: float = None,
+    step: int = 3,
+    precision: int = 2,
     options: set = {'"ANIMATABLE"'},
     override: set = None(),
     tags: set = None(),
     subtype: str = "NONE",
     unit: str = "NONE",
-    size: typing.Sequence[int] = 3,
+    size: typing.Union[int, typing.Sequence[int]] = 3,
     update: typing.Any = None,
     get: typing.Any = None,
     set: typing.Any = None,
@@ -296,11 +391,17 @@ def FloatVectorProperty(
         :param default: sequence of floats the length of size.
         :type default: typing.Sequence
         :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
+        :type min: float
         :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
+        :type max: float
         :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
+        :type soft_min: float
         :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
+        :type soft_max: float
         :param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
+        :type step: int
         :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
         :param options: Enumerator in `rna_enum_property_flag_items`.
         :type options: set
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
@@ -312,7 +413,7 @@ def FloatVectorProperty(
         :param unit: Enumerator in `rna_enum_property_unit_items`.
         :type unit: str
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
-        :type size: typing.Sequence[int]
+        :type size: typing.Union[int, typing.Sequence[int]]
         :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.
@@ -332,11 +433,11 @@ def IntProperty(
     description: str = "",
     translation_context: str = "*",
     default=0,
-    min=None,
-    max=None,
-    soft_min=None,
-    soft_max=None,
-    step=1,
+    min: int = None,
+    max: int = None,
+    soft_min: int = None,
+    soft_max: int = None,
+    step: int = 1,
     options: set = {'"ANIMATABLE"'},
     override: set = None(),
     tags: set = None(),
@@ -354,10 +455,15 @@ def IntProperty(
         :param translation_context: Text used as context to disambiguate translations.
         :type translation_context: str
         :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
+        :type min: int
         :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
+        :type max: int
         :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
+        :type soft_min: int
         :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
+        :type soft_max: int
         :param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
+        :type step: int
         :param options: Enumerator in `rna_enum_property_flag_items`.
         :type options: set
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
@@ -385,16 +491,16 @@ def IntVectorProperty(
     description: str = "",
     translation_context: str = "*",
     default: typing.Sequence = (0, 0, 0),
-    min=None,
-    max=None,
-    soft_min=None,
-    soft_max=None,
-    step=1,
+    min: int = None,
+    max: int = None,
+    soft_min: int = None,
+    soft_max: int = None,
+    step: int = 1,
     options: set = {'"ANIMATABLE"'},
     override: set = None(),
     tags: set = None(),
     subtype: str = "NONE",
-    size: typing.Sequence[int] = 3,
+    size: typing.Union[int, typing.Sequence[int]] = 3,
     update: typing.Any = None,
     get: typing.Any = None,
     set: typing.Any = None,
@@ -410,10 +516,15 @@ def IntVectorProperty(
         :param default: sequence of ints the length of size.
         :type default: typing.Sequence
         :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
+        :type min: int
         :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
+        :type max: int
         :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
+        :type soft_min: int
         :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
+        :type soft_max: int
         :param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
+        :type step: int
         :param options: Enumerator in `rna_enum_property_flag_items`.
         :type options: set
         :param override: Enumerator in `rna_enum_property_override_flag_items`.
@@ -423,7 +534,7 @@ def IntVectorProperty(
         :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
         :type subtype: str
         :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
-        :type size: typing.Sequence[int]
+        :type size: typing.Union[int, typing.Sequence[int]]
         :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.
@@ -491,7 +602,7 @@ def StringProperty(
     description: str = "",
     translation_context: str = "*",
     default: str = "",
-    maxlen=0,
+    maxlen: int = 0,
     options: set = {'"ANIMATABLE"'},
     override: set = None(),
     tags: set = None(),
@@ -513,6 +624,7 @@ def StringProperty(
         :param default: initializer string.
         :type default: str
         :param maxlen: maximum length of the string.
+        :type maxlen: int
         :param options: Enumerator in `rna_enum_property_flag_items`.
         :type options: set
         :param override: Enumerator in `rna_enum_property_override_flag_items`.