fake-bpy-module 20241207__py3-none-any.whl → 20241209__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

Files changed (115) hide show
  1. addon_utils/__init__.pyi +2 -1
  2. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +5 -2
  3. bl_console_utils/autocomplete/complete_import/__init__.pyi +6 -3
  4. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -1
  5. bl_console_utils/autocomplete/intellisense/__init__.pyi +8 -2
  6. blf/__init__.pyi +2 -1
  7. bmesh/ops/__init__.pyi +110 -53
  8. bmesh/types/__init__.pyi +18 -10
  9. bmesh/utils/__init__.pyi +14 -4
  10. bpy/app/icons/__init__.pyi +4 -1
  11. bpy/app/translations/__init__.pyi +4 -1
  12. bpy/msgbus/__init__.pyi +8 -5
  13. bpy/ops/action/__init__.pyi +38 -138
  14. bpy/ops/anim/__init__.pyi +61 -179
  15. bpy/ops/armature/__init__.pyi +48 -147
  16. bpy/ops/asset/__init__.pyi +16 -71
  17. bpy/ops/boid/__init__.pyi +8 -41
  18. bpy/ops/brush/__init__.pyi +13 -39
  19. bpy/ops/buttons/__init__.pyi +6 -29
  20. bpy/ops/cachefile/__init__.pyi +5 -19
  21. bpy/ops/camera/__init__.pyi +2 -5
  22. bpy/ops/clip/__init__.pyi +92 -290
  23. bpy/ops/cloth/__init__.pyi +1 -3
  24. bpy/ops/collection/__init__.pyi +9 -25
  25. bpy/ops/console/__init__.pyi +21 -79
  26. bpy/ops/constraint/__init__.pyi +18 -45
  27. bpy/ops/curve/__init__.pyi +51 -180
  28. bpy/ops/curves/__init__.pyi +28 -100
  29. bpy/ops/cycles/__init__.pyi +3 -9
  30. bpy/ops/dpaint/__init__.pyi +5 -19
  31. bpy/ops/ed/__init__.pyi +12 -53
  32. bpy/ops/export_anim/__init__.pyi +1 -3
  33. bpy/ops/export_scene/__init__.pyi +2 -5
  34. bpy/ops/extensions/__init__.pyi +34 -110
  35. bpy/ops/file/__init__.pyi +40 -167
  36. bpy/ops/fluid/__init__.pyi +14 -77
  37. bpy/ops/font/__init__.pyi +23 -85
  38. bpy/ops/geometry/__init__.pyi +10 -27
  39. bpy/ops/gizmogroup/__init__.pyi +2 -9
  40. bpy/ops/gpencil/__init__.pyi +8 -32
  41. bpy/ops/graph/__init__.pyi +65 -184
  42. bpy/ops/grease_pencil/__init__.pyi +108 -290
  43. bpy/ops/image/__init__.pyi +49 -154
  44. bpy/ops/import_anim/__init__.pyi +1 -3
  45. bpy/ops/import_curve/__init__.pyi +1 -3
  46. bpy/ops/import_scene/__init__.pyi +2 -4
  47. bpy/ops/info/__init__.pyi +7 -29
  48. bpy/ops/lattice/__init__.pyi +8 -29
  49. bpy/ops/marker/__init__.pyi +11 -31
  50. bpy/ops/mask/__init__.pyi +39 -132
  51. bpy/ops/material/__init__.pyi +3 -19
  52. bpy/ops/mball/__init__.pyi +8 -19
  53. bpy/ops/mesh/__init__.pyi +164 -401
  54. bpy/ops/nla/__init__.pyi +39 -147
  55. bpy/ops/node/__init__.pyi +115 -390
  56. bpy/ops/object/__init__.pyi +237 -630
  57. bpy/ops/outliner/__init__.pyi +71 -263
  58. bpy/ops/paint/__init__.pyi +54 -140
  59. bpy/ops/paintcurve/__init__.pyi +8 -33
  60. bpy/ops/palette/__init__.pyi +7 -27
  61. bpy/ops/particle/__init__.pyi +36 -134
  62. bpy/ops/pose/__init__.pyi +51 -169
  63. bpy/ops/poselib/__init__.pyi +9 -33
  64. bpy/ops/preferences/__init__.pyi +35 -94
  65. bpy/ops/ptcache/__init__.pyi +7 -33
  66. bpy/ops/render/__init__.pyi +13 -37
  67. bpy/ops/rigidbody/__init__.pyi +13 -45
  68. bpy/ops/scene/__init__.pyi +37 -121
  69. bpy/ops/screen/__init__.pyi +39 -137
  70. bpy/ops/script/__init__.pyi +3 -11
  71. bpy/ops/sculpt/__init__.pyi +37 -94
  72. bpy/ops/sculpt_curves/__init__.pyi +4 -10
  73. bpy/ops/sequencer/__init__.pyi +89 -284
  74. bpy/ops/sound/__init__.pyi +7 -23
  75. bpy/ops/spreadsheet/__init__.pyi +4 -15
  76. bpy/ops/surface/__init__.pyi +6 -13
  77. bpy/ops/text/__init__.pyi +43 -175
  78. bpy/ops/text_editor/__init__.pyi +1 -3
  79. bpy/ops/texture/__init__.pyi +4 -21
  80. bpy/ops/transform/__init__.pyi +27 -61
  81. bpy/ops/ui/__init__.pyi +34 -117
  82. bpy/ops/uilist/__init__.pyi +3 -7
  83. bpy/ops/uv/__init__.pyi +49 -134
  84. bpy/ops/view2d/__init__.pyi +14 -39
  85. bpy/ops/view3d/__init__.pyi +67 -232
  86. bpy/ops/wm/__init__.pyi +114 -298
  87. bpy/ops/workspace/__init__.pyi +7 -33
  88. bpy/ops/world/__init__.pyi +2 -11
  89. bpy/path/__init__.pyi +4 -2
  90. bpy/types/__init__.pyi +68 -32
  91. bpy/utils/__init__.pyi +18 -9
  92. bpy_extras/bmesh_utils/__init__.pyi +2 -1
  93. bpy_extras/io_utils/__init__.pyi +7 -2
  94. bpy_extras/mesh_utils/__init__.pyi +19 -7
  95. bpy_extras/view3d_utils/__init__.pyi +2 -2
  96. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/METADATA +1 -1
  97. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/RECORD +115 -115
  98. freestyle/functions/__init__.pyi +16 -4
  99. freestyle/types/__init__.pyi +60 -23
  100. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  101. gpu/capabilities/__init__.pyi +2 -1
  102. gpu/state/__init__.pyi +2 -2
  103. gpu/types/__init__.pyi +2 -2
  104. gpu_extras/batch/__init__.pyi +6 -3
  105. idprop/types/__init__.pyi +4 -3
  106. imbuf/__init__.pyi +2 -1
  107. imbuf/types/__init__.pyi +5 -2
  108. mathutils/__init__.pyi +25 -14
  109. mathutils/bvhtree/__init__.pyi +8 -7
  110. mathutils/geometry/__init__.pyi +38 -17
  111. mathutils/interpolate/__init__.pyi +2 -1
  112. mathutils/kdtree/__init__.pyi +11 -6
  113. mathutils/noise/__init__.pyi +2 -1
  114. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/WHEEL +0 -0
  115. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/top_level.txt +0 -0
@@ -1,31 +1,24 @@
1
1
  import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
- import bpy.types
5
4
 
6
- def add(
7
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
8
- execution_context: int | str | None = None,
9
- undo: bool | None = None,
10
- ):
5
+ def add(execution_context: int | str | None = None, undo: bool | None = None):
11
6
  """Add a new workspace by duplicating the current one or appending one from the user configuration
12
7
 
13
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
14
8
  :type execution_context: int | str | None
15
9
  :type undo: bool | None
16
10
  """
17
11
 
18
12
  def append_activate(
19
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
20
13
  execution_context: int | str | None = None,
21
14
  undo: bool | None = None,
15
+ /,
22
16
  *,
23
17
  idname: str = "",
24
18
  filepath: str = "",
25
19
  ):
26
20
  """Append a workspace and make it the active one in the current window
27
21
 
28
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
29
22
  :type execution_context: int | str | None
30
23
  :type undo: bool | None
31
24
  :param idname: Identifier, Name of the workspace to append and activate
@@ -34,62 +27,43 @@ def append_activate(
34
27
  :type filepath: str
35
28
  """
36
29
 
37
- def delete(
38
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
39
- execution_context: int | str | None = None,
40
- undo: bool | None = None,
41
- ):
30
+ def delete(execution_context: int | str | None = None, undo: bool | None = None):
42
31
  """Delete the active workspace
43
32
 
44
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
45
33
  :type execution_context: int | str | None
46
34
  :type undo: bool | None
47
35
  """
48
36
 
49
- def duplicate(
50
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
51
- execution_context: int | str | None = None,
52
- undo: bool | None = None,
53
- ):
37
+ def duplicate(execution_context: int | str | None = None, undo: bool | None = None):
54
38
  """Add a new workspace
55
39
 
56
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
57
40
  :type execution_context: int | str | None
58
41
  :type undo: bool | None
59
42
  """
60
43
 
61
44
  def reorder_to_back(
62
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
63
- execution_context: int | str | None = None,
64
- undo: bool | None = None,
45
+ execution_context: int | str | None = None, undo: bool | None = None
65
46
  ):
66
47
  """Reorder workspace to be last in the list
67
48
 
68
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
69
49
  :type execution_context: int | str | None
70
50
  :type undo: bool | None
71
51
  """
72
52
 
73
53
  def reorder_to_front(
74
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
75
- execution_context: int | str | None = None,
76
- undo: bool | None = None,
54
+ execution_context: int | str | None = None, undo: bool | None = None
77
55
  ):
78
56
  """Reorder workspace to be first in the list
79
57
 
80
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
81
58
  :type execution_context: int | str | None
82
59
  :type undo: bool | None
83
60
  """
84
61
 
85
62
  def scene_pin_toggle(
86
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
87
- execution_context: int | str | None = None,
88
- undo: bool | None = None,
63
+ execution_context: int | str | None = None, undo: bool | None = None
89
64
  ):
90
65
  """Remember the last used scene for the current workspace and switch to it whenever this workspace is activated again
91
66
 
92
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
93
67
  :type execution_context: int | str | None
94
68
  :type undo: bool | None
95
69
  """
@@ -1,28 +1,19 @@
1
1
  import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
- import bpy.types
5
4
 
6
5
  def convert_volume_to_mesh(
7
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
8
- execution_context: int | str | None = None,
9
- undo: bool | None = None,
6
+ execution_context: int | str | None = None, undo: bool | None = None
10
7
  ):
11
8
  """Convert the volume of a world to a mesh. The world's volume used to be rendered by EEVEE Legacy. Conversion is needed for it to render properly
12
9
 
13
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
14
10
  :type execution_context: int | str | None
15
11
  :type undo: bool | None
16
12
  """
17
13
 
18
- def new(
19
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
20
- execution_context: int | str | None = None,
21
- undo: bool | None = None,
22
- ):
14
+ def new(execution_context: int | str | None = None, undo: bool | None = None):
23
15
  """Create a new world Data-Block
24
16
 
25
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
26
17
  :type execution_context: int | str | None
27
18
  :type undo: bool | None
28
19
  """
bpy/path/__init__.pyi CHANGED
@@ -104,7 +104,7 @@ def is_subdir(path: bytes | str, directory) -> bool:
104
104
  :rtype: bool
105
105
  """
106
106
 
107
- def module_names(path: str, *, recursive: bool = False, package: str = ""):
107
+ def module_names(path: str, *, recursive: bool = False, package: str = "") -> list[str]:
108
108
  """Return a list of modules which can be imported from path.
109
109
 
110
110
  :param path: a directory to scan.
@@ -114,6 +114,7 @@ def module_names(path: str, *, recursive: bool = False, package: str = ""):
114
114
  :param package: Optional string, used as the prefix for module names (without the trailing ".").
115
115
  :type package: str
116
116
  :return: a list of string pairs (module_name, module_file).
117
+ :rtype: list[str]
117
118
  """
118
119
 
119
120
  def native_pathsep(path: str) -> str:
@@ -125,13 +126,14 @@ def native_pathsep(path: str) -> str:
125
126
  :rtype: str
126
127
  """
127
128
 
128
- def reduce_dirs(dirs):
129
+ def reduce_dirs(dirs) -> list[str]:
129
130
  """Given a sequence of directories, remove duplicates and
130
131
  any directories nested in one of the other paths.
131
132
  (Useful for recursive path searching).
132
133
 
133
134
  :param dirs: Sequence of directory paths.
134
135
  :return: A unique list of paths.
136
+ :rtype: list[str]
135
137
  """
136
138
 
137
139
  def relpath(path: bytes | str, *, start: bytes | str | None = None) -> str:
bpy/types/__init__.pyi CHANGED
@@ -102853,11 +102853,12 @@ class bpy_prop_collection[_GenericType1]:
102853
102853
  :rtype: list[tuple[str, _GenericType1]]
102854
102854
  """
102855
102855
 
102856
- def keys(self):
102856
+ def keys(self) -> list[str]:
102857
102857
  """Return the identifiers of collection members
102858
102858
  (matching Python's dict.keys() functionality).
102859
102859
 
102860
102860
  :return: the identifiers for each member of this collection.
102861
+ :rtype: list[str]
102861
102862
  """
102862
102863
 
102863
102864
  def values(self) -> list[_GenericType1 | None]:
@@ -102966,7 +102967,9 @@ class bpy_struct[_GenericType1]:
102966
102967
  :rtype: int
102967
102968
  """
102968
102969
 
102969
- def driver_add(self, path: str | None, index: int | None = -1) -> FCurve:
102970
+ def driver_add(
102971
+ self, path: str | None, index: int | None = -1
102972
+ ) -> FCurve | list[FCurve]:
102970
102973
  """Adds driver(s) to the given property
102971
102974
 
102972
102975
  :param path: path to the property to drive, analogous to the fcurve's data path.
@@ -102974,7 +102977,7 @@ class bpy_struct[_GenericType1]:
102974
102977
  :param index: array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array.
102975
102978
  :type index: int | None
102976
102979
  :return: The driver added or a list of drivers when index is -1.
102977
- :rtype: FCurve
102980
+ :rtype: FCurve | list[FCurve]
102978
102981
  """
102979
102982
 
102980
102983
  def driver_remove(self, path: str | None, index: int | None = -1) -> bool:
@@ -102988,7 +102991,7 @@ class bpy_struct[_GenericType1]:
102988
102991
  :rtype: bool
102989
102992
  """
102990
102993
 
102991
- def get(self, key: str | None, default=None):
102994
+ def get(self, key: str | None, default: typing.Any | None = None):
102992
102995
  """Returns the value of the custom property assigned to key or default
102993
102996
  when not found (matches Python's dictionary function of the same name).
102994
102997
 
@@ -102996,6 +102999,7 @@ class bpy_struct[_GenericType1]:
102996
102999
  :type key: str | None
102997
103000
  :param default: Optional argument for the value to return if
102998
103001
  key is not found.
103002
+ :type default: typing.Any | None
102999
103003
  """
103000
103004
 
103001
103005
  def id_properties_clear(self):
@@ -103155,7 +103159,7 @@ class bpy_struct[_GenericType1]:
103155
103159
  :type coerce: bool | None
103156
103160
  """
103157
103161
 
103158
- def pop(self, key: str | None, default=None):
103162
+ def pop(self, key: str | None, default: typing.Any | None = None):
103159
103163
  """Remove and return the value of the custom property assigned to key or default
103160
103164
  when not found (matches Python's dictionary function of the same name).
103161
103165
 
@@ -103163,6 +103167,7 @@ class bpy_struct[_GenericType1]:
103163
103167
  :type key: str | None
103164
103168
  :param default: Optional argument for the value to return if
103165
103169
  key is not found.
103170
+ :type default: typing.Any | None
103166
103171
  """
103167
103172
 
103168
103173
  def property_overridable_library_set(self, property, overridable) -> bool:
@@ -116432,13 +116437,14 @@ class BlendData(bpy_struct):
116432
116437
  :rtype: typing_extensions.Self
116433
116438
  """
116434
116439
 
116435
- def user_map(self, subset, key_types, value_types):
116440
+ def user_map(self, subset, key_types, value_types) -> dict[ID]:
116436
116441
  """Returns a mapping of all ID data-blocks in current bpy.data to a set of all data-blocks using them.For list of valid set members for key_types & value_types, see: `bpy.types.KeyingSetPath.id_type`.
116437
116442
 
116438
116443
  :param subset: When passed, only these data-blocks and their users will be included as keys/values in the map.
116439
116444
  :param key_types: Filter the keys mapped by ID types.
116440
116445
  :param value_types: Filter the values in the set by ID types.
116441
116446
  :return: dictionary that maps data-blocks ID's to their users.
116447
+ :rtype: dict[ID]
116442
116448
  """
116443
116449
 
116444
116450
  class BlendImportContext(bpy_struct):
@@ -157182,7 +157188,7 @@ class Gizmo(bpy_struct):
157182
157188
 
157183
157189
  def draw_custom_shape(
157184
157190
  self,
157185
- shape,
157191
+ shape: typing.Any | None,
157186
157192
  *,
157187
157193
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
157188
157194
  | mathutils.Matrix
@@ -157192,6 +157198,7 @@ class Gizmo(bpy_struct):
157192
157198
  """Draw a shape created form `Gizmo.draw_custom_shape`.
157193
157199
 
157194
157200
  :param shape: The cached shape to draw.
157201
+ :type shape: typing.Any | None
157195
157202
  :param matrix: 4x4 matrix, when not given `Gizmo.matrix_world` is used.
157196
157203
  :type matrix: collections.abc.Sequence[collections.abc.Sequence[float]] | mathutils.Matrix | None
157197
157204
  :param select_id: The selection id.
@@ -157200,13 +157207,14 @@ class Gizmo(bpy_struct):
157200
157207
  """
157201
157208
 
157202
157209
  @staticmethod
157203
- def new_custom_shape(type: str | None, verts):
157210
+ def new_custom_shape(type: str | None, verts) -> typing.Any:
157204
157211
  """Create a new shape that can be passed to `Gizmo.draw_custom_shape`.
157205
157212
 
157206
157213
  :param type: The type of shape to create in (POINTS, LINES, TRIS, LINE_STRIP).
157207
157214
  :type type: str | None
157208
157215
  :param verts: Sequence of 2D or 3D coordinates.
157209
157216
  :return: The newly created shape (the return type make change).
157217
+ :rtype: typing.Any
157210
157218
  """
157211
157219
 
157212
157220
  @classmethod
@@ -157231,20 +157239,21 @@ class Gizmo(bpy_struct):
157231
157239
  :rtype: typing.Any
157232
157240
  """
157233
157241
 
157234
- def target_get_range(self, target):
157242
+ def target_get_range(self, target) -> tuple[float, float]:
157235
157243
  """Get the range for this target property.
157236
157244
 
157237
157245
  :param target: Target property name.
157238
157246
  :return: The range of this property (min, max).
157247
+ :rtype: tuple[float, float]
157239
157248
  """
157240
157249
 
157241
- def target_get_value(self, target: str | None) -> float:
157250
+ def target_get_value(self, target: str | None) -> float | tuple[float, int]:
157242
157251
  """Get the value of this target property.
157243
157252
 
157244
157253
  :param target: Target property name.
157245
157254
  :type target: str | None
157246
157255
  :return: The value of the target property as a value or array based on the target type.
157247
- :rtype: float
157256
+ :rtype: float | tuple[float, int]
157248
157257
  """
157249
157258
 
157250
157259
  def target_set_handler(
@@ -173086,7 +173095,7 @@ class Menu(bpy_struct):
173086
173095
  searchpaths,
173087
173096
  operator: str | None,
173088
173097
  *,
173089
- props_default=None,
173098
+ props_default: dict[str, typing.Any] | None = None,
173090
173099
  prop_filepath: str | None = "filepath",
173091
173100
  filter_ext: collections.abc.Callable | None = None,
173092
173101
  filter_path=None,
@@ -173100,6 +173109,7 @@ class Menu(bpy_struct):
173100
173109
  :param operator: The operator id to use with each file.
173101
173110
  :type operator: str | None
173102
173111
  :param props_default: Properties to assign to each operator.
173112
+ :type props_default: dict[str, typing.Any] | None
173103
173113
  :param prop_filepath: Optional operator filepath property (defaults to "filepath").
173104
173114
  :type prop_filepath: str | None
173105
173115
  :param filter_ext: Optional callback that takes the file extensions.
@@ -207971,7 +207981,7 @@ class Space(bpy_struct):
207971
207981
  def draw_handler_add(
207972
207982
  cls,
207973
207983
  callback: collections.abc.Callable | None,
207974
- args,
207984
+ args: tuple[typing.Any, int] | None,
207975
207985
  region_type: str | None,
207976
207986
  draw_type: str | None,
207977
207987
  ) -> typing.Any:
@@ -207983,6 +207993,7 @@ class Space(bpy_struct):
207983
207993
  It gets the specified arguments as input, it's return value is ignored.
207984
207994
  :type callback: collections.abc.Callable | None
207985
207995
  :param args: Arguments that will be passed to the callback.
207996
+ :type args: tuple[typing.Any, int] | None
207986
207997
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
207987
207998
  :type region_type: str | None
207988
207999
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -208314,7 +208325,7 @@ class SpaceClipEditor(Space, bpy_struct):
208314
208325
  def draw_handler_add(
208315
208326
  cls,
208316
208327
  callback: collections.abc.Callable | None,
208317
- args,
208328
+ args: tuple[typing.Any, int] | None,
208318
208329
  region_type: str | None,
208319
208330
  draw_type: str | None,
208320
208331
  ) -> typing.Any:
@@ -208326,6 +208337,7 @@ class SpaceClipEditor(Space, bpy_struct):
208326
208337
  It gets the specified arguments as input, it's return value is ignored.
208327
208338
  :type callback: collections.abc.Callable | None
208328
208339
  :param args: Arguments that will be passed to the callback.
208340
+ :type args: tuple[typing.Any, int] | None
208329
208341
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
208330
208342
  :type region_type: str | None
208331
208343
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -208415,7 +208427,7 @@ class SpaceConsole(Space, bpy_struct):
208415
208427
  def draw_handler_add(
208416
208428
  cls,
208417
208429
  callback: collections.abc.Callable | None,
208418
- args,
208430
+ args: tuple[typing.Any, int] | None,
208419
208431
  region_type: str | None,
208420
208432
  draw_type: str | None,
208421
208433
  ) -> typing.Any:
@@ -208427,6 +208439,7 @@ class SpaceConsole(Space, bpy_struct):
208427
208439
  It gets the specified arguments as input, it's return value is ignored.
208428
208440
  :type callback: collections.abc.Callable | None
208429
208441
  :param args: Arguments that will be passed to the callback.
208442
+ :type args: tuple[typing.Any, int] | None
208430
208443
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
208431
208444
  :type region_type: str | None
208432
208445
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -208622,7 +208635,7 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
208622
208635
  def draw_handler_add(
208623
208636
  cls,
208624
208637
  callback: collections.abc.Callable | None,
208625
- args,
208638
+ args: tuple[typing.Any, int] | None,
208626
208639
  region_type: str | None,
208627
208640
  draw_type: str | None,
208628
208641
  ) -> typing.Any:
@@ -208634,6 +208647,7 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
208634
208647
  It gets the specified arguments as input, it's return value is ignored.
208635
208648
  :type callback: collections.abc.Callable | None
208636
208649
  :param args: Arguments that will be passed to the callback.
208650
+ :type args: tuple[typing.Any, int] | None
208637
208651
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
208638
208652
  :type region_type: str | None
208639
208653
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -208792,7 +208806,7 @@ class SpaceFileBrowser(Space, bpy_struct):
208792
208806
  def draw_handler_add(
208793
208807
  cls,
208794
208808
  callback: collections.abc.Callable | None,
208795
- args,
208809
+ args: tuple[typing.Any, int] | None,
208796
208810
  region_type: str | None,
208797
208811
  draw_type: str | None,
208798
208812
  ) -> typing.Any:
@@ -208804,6 +208818,7 @@ class SpaceFileBrowser(Space, bpy_struct):
208804
208818
  It gets the specified arguments as input, it's return value is ignored.
208805
208819
  :type callback: collections.abc.Callable | None
208806
208820
  :param args: Arguments that will be passed to the callback.
208821
+ :type args: tuple[typing.Any, int] | None
208807
208822
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
208808
208823
  :type region_type: str | None
208809
208824
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -208977,7 +208992,7 @@ class SpaceGraphEditor(Space, bpy_struct):
208977
208992
  def draw_handler_add(
208978
208993
  cls,
208979
208994
  callback: collections.abc.Callable | None,
208980
- args,
208995
+ args: tuple[typing.Any, int] | None,
208981
208996
  region_type: str | None,
208982
208997
  draw_type: str | None,
208983
208998
  ) -> typing.Any:
@@ -208989,6 +209004,7 @@ class SpaceGraphEditor(Space, bpy_struct):
208989
209004
  It gets the specified arguments as input, it's return value is ignored.
208990
209005
  :type callback: collections.abc.Callable | None
208991
209006
  :param args: Arguments that will be passed to the callback.
209007
+ :type args: tuple[typing.Any, int] | None
208992
209008
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
208993
209009
  :type region_type: str | None
208994
209010
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209260,7 +209276,7 @@ class SpaceImageEditor(Space, bpy_struct):
209260
209276
  def draw_handler_add(
209261
209277
  cls,
209262
209278
  callback: collections.abc.Callable | None,
209263
- args,
209279
+ args: tuple[typing.Any, int] | None,
209264
209280
  region_type: str | None,
209265
209281
  draw_type: str | None,
209266
209282
  ) -> typing.Any:
@@ -209272,6 +209288,7 @@ class SpaceImageEditor(Space, bpy_struct):
209272
209288
  It gets the specified arguments as input, it's return value is ignored.
209273
209289
  :type callback: collections.abc.Callable | None
209274
209290
  :param args: Arguments that will be passed to the callback.
209291
+ :type args: tuple[typing.Any, int] | None
209275
209292
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209276
209293
  :type region_type: str | None
209277
209294
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209386,7 +209403,7 @@ class SpaceInfo(Space, bpy_struct):
209386
209403
  def draw_handler_add(
209387
209404
  cls,
209388
209405
  callback: collections.abc.Callable | None,
209389
- args,
209406
+ args: tuple[typing.Any, int] | None,
209390
209407
  region_type: str | None,
209391
209408
  draw_type: str | None,
209392
209409
  ) -> typing.Any:
@@ -209398,6 +209415,7 @@ class SpaceInfo(Space, bpy_struct):
209398
209415
  It gets the specified arguments as input, it's return value is ignored.
209399
209416
  :type callback: collections.abc.Callable | None
209400
209417
  :param args: Arguments that will be passed to the callback.
209418
+ :type args: tuple[typing.Any, int] | None
209401
209419
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209402
209420
  :type region_type: str | None
209403
209421
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209499,7 +209517,7 @@ class SpaceNLA(Space, bpy_struct):
209499
209517
  def draw_handler_add(
209500
209518
  cls,
209501
209519
  callback: collections.abc.Callable | None,
209502
- args,
209520
+ args: tuple[typing.Any, int] | None,
209503
209521
  region_type: str | None,
209504
209522
  draw_type: str | None,
209505
209523
  ) -> typing.Any:
@@ -209511,6 +209529,7 @@ class SpaceNLA(Space, bpy_struct):
209511
209529
  It gets the specified arguments as input, it's return value is ignored.
209512
209530
  :type callback: collections.abc.Callable | None
209513
209531
  :param args: Arguments that will be passed to the callback.
209532
+ :type args: tuple[typing.Any, int] | None
209514
209533
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209515
209534
  :type region_type: str | None
209516
209535
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209701,7 +209720,7 @@ class SpaceNodeEditor(Space, bpy_struct):
209701
209720
  def draw_handler_add(
209702
209721
  cls,
209703
209722
  callback: collections.abc.Callable | None,
209704
- args,
209723
+ args: tuple[typing.Any, int] | None,
209705
209724
  region_type: str | None,
209706
209725
  draw_type: str | None,
209707
209726
  ) -> typing.Any:
@@ -209713,6 +209732,7 @@ class SpaceNodeEditor(Space, bpy_struct):
209713
209732
  It gets the specified arguments as input, it's return value is ignored.
209714
209733
  :type callback: collections.abc.Callable | None
209715
209734
  :param args: Arguments that will be passed to the callback.
209735
+ :type args: tuple[typing.Any, int] | None
209716
209736
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209717
209737
  :type region_type: str | None
209718
209738
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210033,7 +210053,7 @@ class SpaceOutliner(Space, bpy_struct):
210033
210053
  def draw_handler_add(
210034
210054
  cls,
210035
210055
  callback: collections.abc.Callable | None,
210036
- args,
210056
+ args: tuple[typing.Any, int] | None,
210037
210057
  region_type: str | None,
210038
210058
  draw_type: str | None,
210039
210059
  ) -> typing.Any:
@@ -210045,6 +210065,7 @@ class SpaceOutliner(Space, bpy_struct):
210045
210065
  It gets the specified arguments as input, it's return value is ignored.
210046
210066
  :type callback: collections.abc.Callable | None
210047
210067
  :param args: Arguments that will be passed to the callback.
210068
+ :type args: tuple[typing.Any, int] | None
210048
210069
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210049
210070
  :type region_type: str | None
210050
210071
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210104,7 +210125,7 @@ class SpacePreferences(Space, bpy_struct):
210104
210125
  def draw_handler_add(
210105
210126
  cls,
210106
210127
  callback: collections.abc.Callable | None,
210107
- args,
210128
+ args: tuple[typing.Any, int] | None,
210108
210129
  region_type: str | None,
210109
210130
  draw_type: str | None,
210110
210131
  ) -> typing.Any:
@@ -210116,6 +210137,7 @@ class SpacePreferences(Space, bpy_struct):
210116
210137
  It gets the specified arguments as input, it's return value is ignored.
210117
210138
  :type callback: collections.abc.Callable | None
210118
210139
  :param args: Arguments that will be passed to the callback.
210140
+ :type args: tuple[typing.Any, int] | None
210119
210141
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210120
210142
  :type region_type: str | None
210121
210143
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210218,7 +210240,7 @@ class SpaceProperties(Space, bpy_struct):
210218
210240
  def draw_handler_add(
210219
210241
  cls,
210220
210242
  callback: collections.abc.Callable | None,
210221
- args,
210243
+ args: tuple[typing.Any, int] | None,
210222
210244
  region_type: str | None,
210223
210245
  draw_type: str | None,
210224
210246
  ) -> typing.Any:
@@ -210230,6 +210252,7 @@ class SpaceProperties(Space, bpy_struct):
210230
210252
  It gets the specified arguments as input, it's return value is ignored.
210231
210253
  :type callback: collections.abc.Callable | None
210232
210254
  :param args: Arguments that will be passed to the callback.
210255
+ :type args: tuple[typing.Any, int] | None
210233
210256
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210234
210257
  :type region_type: str | None
210235
210258
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210473,7 +210496,7 @@ class SpaceSequenceEditor(Space, bpy_struct):
210473
210496
  def draw_handler_add(
210474
210497
  cls,
210475
210498
  callback: collections.abc.Callable | None,
210476
- args,
210499
+ args: tuple[typing.Any, int] | None,
210477
210500
  region_type: str | None,
210478
210501
  draw_type: str | None,
210479
210502
  ) -> typing.Any:
@@ -210485,6 +210508,7 @@ class SpaceSequenceEditor(Space, bpy_struct):
210485
210508
  It gets the specified arguments as input, it's return value is ignored.
210486
210509
  :type callback: collections.abc.Callable | None
210487
210510
  :param args: Arguments that will be passed to the callback.
210511
+ :type args: tuple[typing.Any, int] | None
210488
210512
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210489
210513
  :type region_type: str | None
210490
210514
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210616,7 +210640,7 @@ class SpaceSpreadsheet(Space, bpy_struct):
210616
210640
  def draw_handler_add(
210617
210641
  cls,
210618
210642
  callback: collections.abc.Callable | None,
210619
- args,
210643
+ args: tuple[typing.Any, int] | None,
210620
210644
  region_type: str | None,
210621
210645
  draw_type: str | None,
210622
210646
  ) -> typing.Any:
@@ -210628,6 +210652,7 @@ class SpaceSpreadsheet(Space, bpy_struct):
210628
210652
  It gets the specified arguments as input, it's return value is ignored.
210629
210653
  :type callback: collections.abc.Callable | None
210630
210654
  :param args: Arguments that will be passed to the callback.
210655
+ :type args: tuple[typing.Any, int] | None
210631
210656
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210632
210657
  :type region_type: str | None
210633
210658
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210815,7 +210840,7 @@ class SpaceTextEditor(Space, bpy_struct):
210815
210840
  def draw_handler_add(
210816
210841
  cls,
210817
210842
  callback: collections.abc.Callable | None,
210818
- args,
210843
+ args: tuple[typing.Any, int] | None,
210819
210844
  region_type: str | None,
210820
210845
  draw_type: str | None,
210821
210846
  ) -> typing.Any:
@@ -210827,6 +210852,7 @@ class SpaceTextEditor(Space, bpy_struct):
210827
210852
  It gets the specified arguments as input, it's return value is ignored.
210828
210853
  :type callback: collections.abc.Callable | None
210829
210854
  :param args: Arguments that will be passed to the callback.
210855
+ :type args: tuple[typing.Any, int] | None
210830
210856
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210831
210857
  :type region_type: str | None
210832
210858
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -211519,7 +211545,7 @@ class SpaceView3D(Space, bpy_struct):
211519
211545
  def draw_handler_add(
211520
211546
  cls,
211521
211547
  callback: collections.abc.Callable | None,
211522
- args,
211548
+ args: tuple[typing.Any, int] | None,
211523
211549
  region_type: str | None,
211524
211550
  draw_type: str | None,
211525
211551
  ) -> typing.Any:
@@ -211531,6 +211557,7 @@ class SpaceView3D(Space, bpy_struct):
211531
211557
  It gets the specified arguments as input, it's return value is ignored.
211532
211558
  :type callback: collections.abc.Callable | None
211533
211559
  :param args: Arguments that will be passed to the callback.
211560
+ :type args: tuple[typing.Any, int] | None
211534
211561
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
211535
211562
  :type region_type: str | None
211536
211563
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -213649,17 +213676,24 @@ class Text(ID, bpy_struct):
213649
213676
  :rtype: typing.Any
213650
213677
  """
213651
213678
 
213652
- def region_as_string(self, range=None) -> str:
213679
+ def region_as_string(
213680
+ self, range: tuple[tuple[int, int], tuple[int, int]] | None = None
213681
+ ) -> str:
213653
213682
  """
213654
213683
 
213655
213684
  :param range: The region of text to be returned, defaulting to the selection when no range is passed.
213656
213685
  Each int pair represents a line and column: ((start_line, start_column), (end_line, end_column))
213657
213686
  The values match Python's slicing logic (negative values count backwards from the end, the end value is not inclusive).
213687
+ :type range: tuple[tuple[int, int], tuple[int, int]] | None
213658
213688
  :return: The specified region as a string.
213659
213689
  :rtype: str
213660
213690
  """
213661
213691
 
213662
- def region_from_string(self, body: str | None, range=None):
213692
+ def region_from_string(
213693
+ self,
213694
+ body: str | None,
213695
+ range: tuple[tuple[int, int], tuple[int, int]] | None = None,
213696
+ ):
213663
213697
  """
213664
213698
 
213665
213699
  :param body: The text to be inserted.
@@ -213667,6 +213701,7 @@ class Text(ID, bpy_struct):
213667
213701
  :param range: The region of text to be returned, defaulting to the selection when no range is passed.
213668
213702
  Each int pair represents a line and column: ((start_line, start_column), (end_line, end_column))
213669
213703
  The values match Python's slicing logic (negative values count backwards from the end, the end value is not inclusive).
213704
+ :type range: tuple[tuple[int, int], tuple[int, int]] | None
213670
213705
  """
213671
213706
 
213672
213707
  class TextBox(bpy_struct):
@@ -229638,7 +229673,7 @@ class WindowManager(ID, bpy_struct):
229638
229673
  def draw_cursor_add(
229639
229674
  cls,
229640
229675
  callback: collections.abc.Callable | None,
229641
- args,
229676
+ args: tuple[typing.Any, int] | None,
229642
229677
  space_type: str | None,
229643
229678
  region_type: str | None,
229644
229679
  ) -> typing.Any:
@@ -229650,6 +229685,7 @@ class WindowManager(ID, bpy_struct):
229650
229685
  It gets the specified arguments as input with the mouse position (tuple) as last argument.
229651
229686
  :type callback: collections.abc.Callable | None
229652
229687
  :param args: Arguments that will be passed to the callback.
229688
+ :type args: tuple[typing.Any, int] | None
229653
229689
  :param space_type: The space type the callback draws in; for example VIEW_3D. (`bpy.types.Space.type`)
229654
229690
  :type space_type: str | None
229655
229691
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)