fake-bpy-module 20240420__py3-none-any.whl → 20240422__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.
Files changed (187) hide show
  1. bl_operators/add_mesh_torus/__init__.pyi +2 -1
  2. bl_operators/assets/__init__.pyi +12 -12
  3. bl_operators/geometry_nodes/__init__.pyi +256 -238
  4. bl_operators/node/__init__.pyi +262 -260
  5. bl_operators/object_quick_effects/__init__.pyi +19 -19
  6. bl_operators/presets/__init__.pyi +371 -368
  7. bl_operators/wm/__init__.pyi +4 -4
  8. bl_ui/__init__.pyi +3 -3
  9. bl_ui/anim/__init__.pyi +1 -1
  10. bl_ui/asset_shelf/__init__.pyi +1 -1
  11. bl_ui/generic_ui_list/__init__.pyi +3 -3
  12. bl_ui/node_add_menu/__init__.pyi +1 -1
  13. bl_ui/node_add_menu_compositor/__init__.pyi +18 -18
  14. bl_ui/node_add_menu_geometry/__init__.pyi +50 -48
  15. bl_ui/node_add_menu_shader/__init__.pyi +10 -10
  16. bl_ui/node_add_menu_texture/__init__.pyi +9 -9
  17. bl_ui/properties_collection/__init__.pyi +39 -25
  18. bl_ui/properties_constraint/__init__.pyi +1257 -1041
  19. bl_ui/properties_data_armature/__init__.pyi +120 -96
  20. bl_ui/properties_data_bone/__init__.pyi +36 -29
  21. bl_ui/properties_data_camera/__init__.pyi +32 -14
  22. bl_ui/properties_data_curve/__init__.pyi +143 -116
  23. bl_ui/properties_data_curves/__init__.pyi +30 -25
  24. bl_ui/properties_data_empty/__init__.pyi +21 -21
  25. bl_ui/properties_data_gpencil/__init__.pyi +297 -260
  26. bl_ui/properties_data_grease_pencil/__init__.pyi +228 -205
  27. bl_ui/properties_data_lattice/__init__.pyi +25 -22
  28. bl_ui/properties_data_light/__init__.pyi +44 -31
  29. bl_ui/properties_data_lightprobe/__init__.pyi +54 -32
  30. bl_ui/properties_data_mesh/__init__.pyi +579 -570
  31. bl_ui/properties_data_metaball/__init__.pyi +29 -24
  32. bl_ui/properties_data_modifier/__init__.pyi +55 -43
  33. bl_ui/properties_data_pointcloud/__init__.pyi +146 -139
  34. bl_ui/properties_data_shaderfx/__init__.pyi +13 -13
  35. bl_ui/properties_data_speaker/__init__.pyi +27 -24
  36. bl_ui/properties_data_volume/__init__.pyi +75 -68
  37. bl_ui/properties_freestyle/__init__.pyi +407 -284
  38. bl_ui/properties_grease_pencil_common/__init__.pyi +13 -13
  39. bl_ui/properties_mask_common/__init__.pyi +7 -7
  40. bl_ui/properties_material/__init__.pyi +186 -162
  41. bl_ui/properties_material_gpencil/__init__.pyi +111 -87
  42. bl_ui/properties_object/__init__.pyi +102 -84
  43. bl_ui/properties_output/__init__.pyi +255 -228
  44. bl_ui/properties_paint_common/__init__.pyi +9 -9
  45. bl_ui/properties_particle/__init__.pyi +341 -254
  46. bl_ui/properties_physics_cloth/__init__.pyi +54 -33
  47. bl_ui/properties_physics_common/__init__.pyi +20 -20
  48. bl_ui/properties_physics_dynamicpaint/__init__.pyi +231 -193
  49. bl_ui/properties_physics_field/__init__.pyi +52 -36
  50. bl_ui/properties_physics_fluid/__init__.pyi +119 -96
  51. bl_ui/properties_physics_geometry_nodes/__init__.pyi +1 -1
  52. bl_ui/properties_physics_rigidbody/__init__.pyi +36 -20
  53. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +51 -25
  54. bl_ui/properties_physics_softbody/__init__.pyi +62 -34
  55. bl_ui/properties_render/__init__.pyi +275 -187
  56. bl_ui/properties_scene/__init__.pyi +173 -154
  57. bl_ui/properties_texture/__init__.pyi +251 -205
  58. bl_ui/properties_view_layer/__init__.pyi +126 -93
  59. bl_ui/properties_workspace/__init__.pyi +82 -76
  60. bl_ui/properties_world/__init__.pyi +31 -26
  61. bl_ui/space_clip/__init__.pyi +495 -433
  62. bl_ui/space_console/__init__.pyi +6 -6
  63. bl_ui/space_dopesheet/__init__.pyi +209 -174
  64. bl_ui/space_filebrowser/__init__.pyi +691 -679
  65. bl_ui/space_graph/__init__.pyi +25 -20
  66. bl_ui/space_image/__init__.pyi +959 -845
  67. bl_ui/space_info/__init__.pyi +6 -6
  68. bl_ui/space_nla/__init__.pyi +26 -17
  69. bl_ui/space_node/__init__.pyi +49 -36
  70. bl_ui/space_outliner/__init__.pyi +14 -14
  71. bl_ui/space_properties/__init__.pyi +3 -3
  72. bl_ui/space_sequencer/__init__.pyi +510 -444
  73. bl_ui/space_spreadsheet/__init__.pyi +1 -1
  74. bl_ui/space_statusbar/__init__.pyi +1 -1
  75. bl_ui/space_text/__init__.pyi +16 -16
  76. bl_ui/space_time/__init__.pyi +27 -23
  77. bl_ui/space_toolsystem_common/__init__.pyi +1 -1
  78. bl_ui/space_toolsystem_toolbar/__init__.pyi +21 -4
  79. bl_ui/space_topbar/__init__.pyi +26 -26
  80. bl_ui/space_userpref/__init__.pyi +795 -658
  81. bl_ui/space_view3d/__init__.pyi +1460 -1428
  82. bl_ui/space_view3d_toolbar/__init__.pyi +2968 -2657
  83. bl_ui/temp_anim_layers/__init__.pyi +1 -1
  84. bmesh/types/__init__.pyi +13 -6
  85. bpy/app/__init__.pyi +4 -4
  86. bpy/app/icons/__init__.pyi +8 -6
  87. bpy/app/timers/__init__.pyi +10 -8
  88. bpy/app/translations/__init__.pyi +22 -20
  89. bpy/msgbus/__init__.pyi +4 -2
  90. bpy/ops/action/__init__.pyi +319 -316
  91. bpy/ops/anim/__init__.pyi +428 -428
  92. bpy/ops/armature/__init__.pyi +359 -358
  93. bpy/ops/asset/__init__.pyi +146 -146
  94. bpy/ops/boid/__init__.pyi +50 -50
  95. bpy/ops/brush/__init__.pyi +72 -72
  96. bpy/ops/buttons/__init__.pyi +128 -128
  97. bpy/ops/cachefile/__init__.pyi +124 -124
  98. bpy/ops/camera/__init__.pyi +22 -22
  99. bpy/ops/clip/__init__.pyi +773 -768
  100. bpy/ops/cloth/__init__.pyi +10 -10
  101. bpy/ops/collection/__init__.pyi +64 -64
  102. bpy/ops/console/__init__.pyi +150 -150
  103. bpy/ops/constraint/__init__.pyi +150 -150
  104. bpy/ops/curve/__init__.pyi +475 -472
  105. bpy/ops/curves/__init__.pyi +247 -244
  106. bpy/ops/cycles/__init__.pyi +18 -18
  107. bpy/ops/dpaint/__init__.pyi +34 -34
  108. bpy/ops/ed/__init__.pyi +122 -122
  109. bpy/ops/export_anim/__init__.pyi +18 -18
  110. bpy/ops/export_mesh/__init__.pyi +26 -26
  111. bpy/ops/export_scene/__init__.pyi +336 -307
  112. bpy/ops/file/__init__.pyi +340 -340
  113. bpy/ops/fluid/__init__.pyi +88 -88
  114. bpy/ops/font/__init__.pyi +252 -252
  115. bpy/ops/geometry/__init__.pyi +86 -86
  116. bpy/ops/gizmogroup/__init__.pyi +22 -22
  117. bpy/ops/gpencil/__init__.pyi +1459 -1444
  118. bpy/ops/graph/__init__.pyi +645 -642
  119. bpy/ops/grease_pencil/__init__.pyi +441 -436
  120. bpy/ops/image/__init__.pyi +614 -612
  121. bpy/ops/import_anim/__init__.pyi +26 -26
  122. bpy/ops/import_curve/__init__.pyi +6 -6
  123. bpy/ops/import_mesh/__init__.pyi +20 -18
  124. bpy/ops/import_scene/__init__.pyi +92 -86
  125. bpy/ops/info/__init__.pyi +60 -60
  126. bpy/ops/lattice/__init__.pyi +64 -64
  127. bpy/ops/marker/__init__.pyi +106 -106
  128. bpy/ops/mask/__init__.pyi +321 -318
  129. bpy/ops/material/__init__.pyi +18 -18
  130. bpy/ops/mball/__init__.pyi +71 -70
  131. bpy/ops/mesh/__init__.pyi +1997 -1990
  132. bpy/ops/nla/__init__.pyi +331 -330
  133. bpy/ops/node/__init__.pyi +867 -852
  134. bpy/ops/object/__init__.pyi +2433 -2430
  135. bpy/ops/outliner/__init__.pyi +498 -498
  136. bpy/ops/paint/__init__.pyi +554 -544
  137. bpy/ops/paintcurve/__init__.pyi +64 -64
  138. bpy/ops/palette/__init__.pyi +48 -48
  139. bpy/ops/particle/__init__.pyi +266 -264
  140. bpy/ops/pose/__init__.pyi +336 -336
  141. bpy/ops/poselib/__init__.pyi +70 -70
  142. bpy/ops/preferences/__init__.pyi +338 -336
  143. bpy/ops/ptcache/__init__.pyi +46 -46
  144. bpy/ops/render/__init__.pyi +114 -114
  145. bpy/ops/rigidbody/__init__.pyi +102 -102
  146. bpy/ops/scene/__init__.pyi +270 -270
  147. bpy/ops/screen/__init__.pyi +378 -378
  148. bpy/ops/script/__init__.pyi +18 -18
  149. bpy/ops/sculpt/__init__.pyi +411 -405
  150. bpy/ops/sculpt_curves/__init__.pyi +42 -40
  151. bpy/ops/sequencer/__init__.pyi +1053 -1040
  152. bpy/ops/sound/__init__.pyi +208 -208
  153. bpy/ops/spreadsheet/__init__.pyi +30 -30
  154. bpy/ops/surface/__init__.pyi +108 -108
  155. bpy/ops/text/__init__.pyi +382 -382
  156. bpy/ops/text_editor/__init__.pyi +10 -10
  157. bpy/ops/texture/__init__.pyi +26 -26
  158. bpy/ops/transform/__init__.pyi +826 -790
  159. bpy/ops/ui/__init__.pyi +216 -216
  160. bpy/ops/uilist/__init__.pyi +20 -20
  161. bpy/ops/uv/__init__.pyi +605 -600
  162. bpy/ops/view2d/__init__.pyi +156 -156
  163. bpy/ops/view3d/__init__.pyi +578 -576
  164. bpy/ops/wm/__init__.pyi +2412 -2376
  165. bpy/ops/workspace/__init__.pyi +42 -42
  166. bpy/ops/world/__init__.pyi +6 -6
  167. bpy/path/__init__.pyi +48 -33
  168. bpy/props/__init__.pyi +263 -261
  169. bpy/types/__init__.pyi +103670 -100517
  170. bpy/utils/__init__.pyi +87 -52
  171. bpy/utils/previews/__init__.pyi +2 -2
  172. bpy/utils/units/__init__.pyi +20 -17
  173. bpy_extras/anim_utils/__init__.pyi +9 -2
  174. bpy_extras/io_utils/__init__.pyi +2 -1
  175. bpy_extras/view3d_utils/__init__.pyi +2 -1
  176. bpy_types/__init__.pyi +236 -236
  177. {fake_bpy_module-20240420.dist-info → fake_bpy_module-20240422.dist-info}/METADATA +1 -1
  178. {fake_bpy_module-20240420.dist-info → fake_bpy_module-20240422.dist-info}/RECORD +187 -187
  179. freestyle/chainingiterators/__init__.pyi +7 -2
  180. freestyle/types/__init__.pyi +8 -3
  181. gpu_extras/presets/__init__.pyi +14 -2
  182. keyingsets_builtins/__init__.pyi +92 -92
  183. mathutils/__init__.pyi +9 -5
  184. mathutils/geometry/__init__.pyi +8 -4
  185. nodeitems_builtins/__init__.pyi +7 -7
  186. {fake_bpy_module-20240420.dist-info → fake_bpy_module-20240422.dist-info}/WHEEL +0 -0
  187. {fake_bpy_module-20240420.dist-info → fake_bpy_module-20240422.dist-info}/top_level.txt +0 -0
bpy/props/__init__.pyi CHANGED
@@ -92,136 +92,138 @@ import typing
92
92
  GenericType = typing.TypeVar("GenericType")
93
93
 
94
94
  def BoolProperty(
95
- name: str = "",
96
- description: str = "",
97
- translation_context: str = "*",
95
+ name: typing.Optional[str] = "",
96
+ description: typing.Optional[str] = "",
97
+ translation_context: typing.Optional[str] = "*",
98
98
  default=False,
99
- options: set = {'"ANIMATABLE"'},
100
- override: set = None(),
101
- tags: set = None(),
102
- subtype: str = "NONE",
103
- update: typing.Any = None,
104
- get: typing.Any = None,
105
- set: typing.Any = None,
99
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
100
+ override: typing.Optional[set] = None(),
101
+ tags: typing.Optional[set] = None(),
102
+ subtype: typing.Optional[str] = "NONE",
103
+ update: typing.Optional[typing.Any] = None,
104
+ get: typing.Optional[typing.Any] = None,
105
+ set: typing.Optional[typing.Any] = None,
106
106
  ):
107
107
  """Returns a new boolean property definition.
108
108
 
109
109
  :param name: Name used in the user interface.
110
- :type name: str
110
+ :type name: typing.Optional[str]
111
111
  :param description: Text used for the tooltip and api documentation.
112
- :type description: str
112
+ :type description: typing.Optional[str]
113
113
  :param translation_context: Text used as context to disambiguate translations.
114
- :type translation_context: str
114
+ :type translation_context: typing.Optional[str]
115
115
  :param options: Enumerator in `rna_enum_property_flag_items`.
116
- :type options: set
116
+ :type options: typing.Optional[set]
117
117
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
118
- :type override: set
118
+ :type override: typing.Optional[set]
119
119
  :param tags: Enumerator of tags that are defined by parent class.
120
- :type tags: set
120
+ :type tags: typing.Optional[set]
121
121
  :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
122
- :type subtype: str
122
+ :type subtype: typing.Optional[str]
123
123
  :param update: Function to be called when this value is modified,
124
124
  This function must take 2 values (self, context) and return None.
125
125
  Warning there are no safety checks to avoid infinite recursion.
126
- :type update: typing.Any
126
+ :type update: typing.Optional[typing.Any]
127
127
  :param get: Function to be called when this value is 'read',
128
128
  This function must take 1 value (self) and return the value of the property.
129
- :type get: typing.Any
129
+ :type get: typing.Optional[typing.Any]
130
130
  :param set: Function to be called when this value is 'written',
131
131
  This function must take 2 values (self, value) and return None.
132
- :type set: typing.Any
132
+ :type set: typing.Optional[typing.Any]
133
133
  """
134
134
 
135
135
  ...
136
136
 
137
137
  def BoolVectorProperty(
138
- name: str = "",
139
- description: str = "",
140
- translation_context: str = "*",
141
- default: typing.Sequence = (False, False, False),
142
- options: set = {'"ANIMATABLE"'},
143
- override: set = None(),
144
- tags: set = None(),
145
- subtype: str = "NONE",
146
- size: typing.Union[int, typing.Sequence[int]] = 3,
147
- update: typing.Any = None,
148
- get: typing.Any = None,
149
- set: typing.Any = None,
138
+ name: typing.Optional[str] = "",
139
+ description: typing.Optional[str] = "",
140
+ translation_context: typing.Optional[str] = "*",
141
+ default: typing.Optional[typing.Sequence] = (False, False, False),
142
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
143
+ override: typing.Optional[set] = None(),
144
+ tags: typing.Optional[set] = None(),
145
+ subtype: typing.Optional[str] = "NONE",
146
+ size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
147
+ update: typing.Optional[typing.Any] = None,
148
+ get: typing.Optional[typing.Any] = None,
149
+ set: typing.Optional[typing.Any] = None,
150
150
  ):
151
151
  """Returns a new vector boolean property definition.
152
152
 
153
153
  :param name: Name used in the user interface.
154
- :type name: str
154
+ :type name: typing.Optional[str]
155
155
  :param description: Text used for the tooltip and api documentation.
156
- :type description: str
156
+ :type description: typing.Optional[str]
157
157
  :param translation_context: Text used as context to disambiguate translations.
158
- :type translation_context: str
158
+ :type translation_context: typing.Optional[str]
159
159
  :param default: sequence of booleans the length of size.
160
- :type default: typing.Sequence
160
+ :type default: typing.Optional[typing.Sequence]
161
161
  :param options: Enumerator in `rna_enum_property_flag_items`.
162
- :type options: set
162
+ :type options: typing.Optional[set]
163
163
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
164
- :type override: set
164
+ :type override: typing.Optional[set]
165
165
  :param tags: Enumerator of tags that are defined by parent class.
166
- :type tags: set
166
+ :type tags: typing.Optional[set]
167
167
  :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
168
- :type subtype: str
168
+ :type subtype: typing.Optional[str]
169
169
  :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
170
- :type size: typing.Union[int, typing.Sequence[int]]
170
+ :type size: typing.Optional[typing.Union[int, typing.Sequence[int]]]
171
171
  :param update: Function to be called when this value is modified,
172
172
  This function must take 2 values (self, context) and return None.
173
173
  Warning there are no safety checks to avoid infinite recursion.
174
- :type update: typing.Any
174
+ :type update: typing.Optional[typing.Any]
175
175
  :param get: Function to be called when this value is 'read',
176
176
  This function must take 1 value (self) and return the value of the property.
177
- :type get: typing.Any
177
+ :type get: typing.Optional[typing.Any]
178
178
  :param set: Function to be called when this value is 'written',
179
179
  This function must take 2 values (self, value) and return None.
180
- :type set: typing.Any
180
+ :type set: typing.Optional[typing.Any]
181
181
  """
182
182
 
183
183
  ...
184
184
 
185
185
  def CollectionProperty(
186
186
  type=None,
187
- name: str = "",
188
- description: str = "",
189
- translation_context: str = "*",
190
- options: set = {'"ANIMATABLE"'},
191
- override: set = None(),
192
- tags: set = None(),
187
+ name: typing.Optional[str] = "",
188
+ description: typing.Optional[str] = "",
189
+ translation_context: typing.Optional[str] = "*",
190
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
191
+ override: typing.Optional[set] = None(),
192
+ tags: typing.Optional[set] = None(),
193
193
  ):
194
194
  """Returns a new collection property definition.
195
195
 
196
196
  :param type: A subclass of `bpy.types.PropertyGroup`.
197
197
  :param name: Name used in the user interface.
198
- :type name: str
198
+ :type name: typing.Optional[str]
199
199
  :param description: Text used for the tooltip and api documentation.
200
- :type description: str
200
+ :type description: typing.Optional[str]
201
201
  :param translation_context: Text used as context to disambiguate translations.
202
- :type translation_context: str
202
+ :type translation_context: typing.Optional[str]
203
203
  :param options: Enumerator in `rna_enum_property_flag_items`.
204
- :type options: set
204
+ :type options: typing.Optional[set]
205
205
  :param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
206
- :type override: set
206
+ :type override: typing.Optional[set]
207
207
  :param tags: Enumerator of tags that are defined by parent class.
208
- :type tags: set
208
+ :type tags: typing.Optional[set]
209
209
  """
210
210
 
211
211
  ...
212
212
 
213
213
  def EnumProperty(
214
- items: typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable],
215
- name: str = "",
216
- description: str = "",
217
- translation_context: str = "*",
218
- default: typing.Union[str, set] = None,
219
- options: set = {'"ANIMATABLE"'},
220
- override: set = None(),
221
- tags: set = None(),
222
- update: typing.Any = None,
223
- get: typing.Any = None,
224
- set: typing.Any = None,
214
+ items: typing.Optional[
215
+ typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable]
216
+ ],
217
+ name: typing.Optional[str] = "",
218
+ description: typing.Optional[str] = "",
219
+ translation_context: typing.Optional[str] = "*",
220
+ default: typing.Optional[typing.Union[str, set]] = None,
221
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
222
+ override: typing.Optional[set] = None(),
223
+ tags: typing.Optional[set] = None(),
224
+ update: typing.Optional[typing.Any] = None,
225
+ get: typing.Optional[typing.Any] = None,
226
+ set: typing.Optional[typing.Any] = None,
225
227
  ):
226
228
  """Returns a new enumerator property definition.
227
229
 
@@ -263,386 +265,386 @@ def EnumProperty(
263
265
  There is a known bug with using a callback,
264
266
  Python must keep a reference to the strings returned by the callback or Blender
265
267
  will misbehave or even crash.
266
- :type items: typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable]
268
+ :type items: typing.Optional[typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable]]
267
269
  :param name: Name used in the user interface.
268
- :type name: str
270
+ :type name: typing.Optional[str]
269
271
  :param description: Text used for the tooltip and api documentation.
270
- :type description: str
272
+ :type description: typing.Optional[str]
271
273
  :param translation_context: Text used as context to disambiguate translations.
272
- :type translation_context: str
274
+ :type translation_context: typing.Optional[str]
273
275
  :param default: The default value for this enum, a string from the identifiers used in items, or integer matching an item number.
274
276
  If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
275
277
  WARNING: Strings cannot be specified for dynamic enums
276
278
  (i.e. if a callback function is given as items parameter).
277
- :type default: typing.Union[str, set]
279
+ :type default: typing.Optional[typing.Union[str, set]]
278
280
  :param options: Enumerator in `rna_enum_property_flag_enum_items`.
279
- :type options: set
281
+ :type options: typing.Optional[set]
280
282
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
281
- :type override: set
283
+ :type override: typing.Optional[set]
282
284
  :param tags: Enumerator of tags that are defined by parent class.
283
- :type tags: set
285
+ :type tags: typing.Optional[set]
284
286
  :param update: Function to be called when this value is modified,
285
287
  This function must take 2 values (self, context) and return None.
286
288
  Warning there are no safety checks to avoid infinite recursion.
287
- :type update: typing.Any
289
+ :type update: typing.Optional[typing.Any]
288
290
  :param get: Function to be called when this value is 'read',
289
291
  This function must take 1 value (self) and return the value of the property.
290
- :type get: typing.Any
292
+ :type get: typing.Optional[typing.Any]
291
293
  :param set: Function to be called when this value is 'written',
292
294
  This function must take 2 values (self, value) and return None.
293
- :type set: typing.Any
295
+ :type set: typing.Optional[typing.Any]
294
296
  """
295
297
 
296
298
  ...
297
299
 
298
300
  def FloatProperty(
299
- name: str = "",
300
- description: str = "",
301
- translation_context: str = "*",
301
+ name: typing.Optional[str] = "",
302
+ description: typing.Optional[str] = "",
303
+ translation_context: typing.Optional[str] = "*",
302
304
  default=0.0,
303
- min: float = -3.402823e38,
304
- max: float = 3.402823e38,
305
- soft_min: float = -3.402823e38,
306
- soft_max: float = 3.402823e38,
307
- step: int = 3,
308
- precision: int = 2,
309
- options: set = {'"ANIMATABLE"'},
310
- override: set = None(),
311
- tags: set = None(),
312
- subtype: str = "NONE",
313
- unit: str = "NONE",
314
- update: typing.Any = None,
315
- get: typing.Any = None,
316
- set: typing.Any = None,
305
+ min: typing.Optional[float] = -3.402823e38,
306
+ max: typing.Optional[float] = 3.402823e38,
307
+ soft_min: typing.Optional[float] = -3.402823e38,
308
+ soft_max: typing.Optional[float] = 3.402823e38,
309
+ step: typing.Optional[int] = 3,
310
+ precision: typing.Optional[int] = 2,
311
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
312
+ override: typing.Optional[set] = None(),
313
+ tags: typing.Optional[set] = None(),
314
+ subtype: typing.Optional[str] = "NONE",
315
+ unit: typing.Optional[str] = "NONE",
316
+ update: typing.Optional[typing.Any] = None,
317
+ get: typing.Optional[typing.Any] = None,
318
+ set: typing.Optional[typing.Any] = None,
317
319
  ):
318
320
  """Returns a new float (single precision) property definition.
319
321
 
320
322
  :param name: Name used in the user interface.
321
- :type name: str
323
+ :type name: typing.Optional[str]
322
324
  :param description: Text used for the tooltip and api documentation.
323
- :type description: str
325
+ :type description: typing.Optional[str]
324
326
  :param translation_context: Text used as context to disambiguate translations.
325
- :type translation_context: str
327
+ :type translation_context: typing.Optional[str]
326
328
  :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
327
- :type min: float
329
+ :type min: typing.Optional[float]
328
330
  :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
329
- :type max: float
331
+ :type max: typing.Optional[float]
330
332
  :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
331
- :type soft_min: float
333
+ :type soft_min: typing.Optional[float]
332
334
  :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
333
- :type soft_max: float
335
+ :type soft_max: typing.Optional[float]
334
336
  :param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
335
- :type step: int
337
+ :type step: typing.Optional[int]
336
338
  :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.
337
- :type precision: int
339
+ :type precision: typing.Optional[int]
338
340
  :param options: Enumerator in `rna_enum_property_flag_items`.
339
- :type options: set
341
+ :type options: typing.Optional[set]
340
342
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
341
- :type override: set
343
+ :type override: typing.Optional[set]
342
344
  :param tags: Enumerator of tags that are defined by parent class.
343
- :type tags: set
345
+ :type tags: typing.Optional[set]
344
346
  :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
345
- :type subtype: str
347
+ :type subtype: typing.Optional[str]
346
348
  :param unit: Enumerator in `rna_enum_property_unit_items`.
347
- :type unit: str
349
+ :type unit: typing.Optional[str]
348
350
  :param update: Function to be called when this value is modified,
349
351
  This function must take 2 values (self, context) and return None.
350
352
  Warning there are no safety checks to avoid infinite recursion.
351
- :type update: typing.Any
353
+ :type update: typing.Optional[typing.Any]
352
354
  :param get: Function to be called when this value is 'read',
353
355
  This function must take 1 value (self) and return the value of the property.
354
- :type get: typing.Any
356
+ :type get: typing.Optional[typing.Any]
355
357
  :param set: Function to be called when this value is 'written',
356
358
  This function must take 2 values (self, value) and return None.
357
- :type set: typing.Any
359
+ :type set: typing.Optional[typing.Any]
358
360
  """
359
361
 
360
362
  ...
361
363
 
362
364
  def FloatVectorProperty(
363
- name: str = "",
364
- description: str = "",
365
- translation_context: str = "*",
366
- default: typing.Sequence = (0.0, 0.0, 0.0),
367
- min: float = None,
368
- max: float = None,
369
- soft_min: float = None,
370
- soft_max: float = None,
371
- step: int = 3,
372
- precision: int = 2,
373
- options: set = {'"ANIMATABLE"'},
374
- override: set = None(),
375
- tags: set = None(),
376
- subtype: str = "NONE",
377
- unit: str = "NONE",
378
- size: typing.Union[int, typing.Sequence[int]] = 3,
379
- update: typing.Any = None,
380
- get: typing.Any = None,
381
- set: typing.Any = None,
365
+ name: typing.Optional[str] = "",
366
+ description: typing.Optional[str] = "",
367
+ translation_context: typing.Optional[str] = "*",
368
+ default: typing.Optional[typing.Sequence] = (0.0, 0.0, 0.0),
369
+ min: typing.Optional[float] = None,
370
+ max: typing.Optional[float] = None,
371
+ soft_min: typing.Optional[float] = None,
372
+ soft_max: typing.Optional[float] = None,
373
+ step: typing.Optional[int] = 3,
374
+ precision: typing.Optional[int] = 2,
375
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
376
+ override: typing.Optional[set] = None(),
377
+ tags: typing.Optional[set] = None(),
378
+ subtype: typing.Optional[str] = "NONE",
379
+ unit: typing.Optional[str] = "NONE",
380
+ size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
381
+ update: typing.Optional[typing.Any] = None,
382
+ get: typing.Optional[typing.Any] = None,
383
+ set: typing.Optional[typing.Any] = None,
382
384
  ):
383
385
  """Returns a new vector float property definition.
384
386
 
385
387
  :param name: Name used in the user interface.
386
- :type name: str
388
+ :type name: typing.Optional[str]
387
389
  :param description: Text used for the tooltip and api documentation.
388
- :type description: str
390
+ :type description: typing.Optional[str]
389
391
  :param translation_context: Text used as context to disambiguate translations.
390
- :type translation_context: str
392
+ :type translation_context: typing.Optional[str]
391
393
  :param default: sequence of floats the length of size.
392
- :type default: typing.Sequence
394
+ :type default: typing.Optional[typing.Sequence]
393
395
  :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
394
- :type min: float
396
+ :type min: typing.Optional[float]
395
397
  :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
396
- :type max: float
398
+ :type max: typing.Optional[float]
397
399
  :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
398
- :type soft_min: float
400
+ :type soft_min: typing.Optional[float]
399
401
  :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
400
- :type soft_max: float
402
+ :type soft_max: typing.Optional[float]
401
403
  :param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
402
- :type step: int
404
+ :type step: typing.Optional[int]
403
405
  :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.
404
- :type precision: int
406
+ :type precision: typing.Optional[int]
405
407
  :param options: Enumerator in `rna_enum_property_flag_items`.
406
- :type options: set
408
+ :type options: typing.Optional[set]
407
409
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
408
- :type override: set
410
+ :type override: typing.Optional[set]
409
411
  :param tags: Enumerator of tags that are defined by parent class.
410
- :type tags: set
412
+ :type tags: typing.Optional[set]
411
413
  :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
412
- :type subtype: str
414
+ :type subtype: typing.Optional[str]
413
415
  :param unit: Enumerator in `rna_enum_property_unit_items`.
414
- :type unit: str
416
+ :type unit: typing.Optional[str]
415
417
  :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
416
- :type size: typing.Union[int, typing.Sequence[int]]
418
+ :type size: typing.Optional[typing.Union[int, typing.Sequence[int]]]
417
419
  :param update: Function to be called when this value is modified,
418
420
  This function must take 2 values (self, context) and return None.
419
421
  Warning there are no safety checks to avoid infinite recursion.
420
- :type update: typing.Any
422
+ :type update: typing.Optional[typing.Any]
421
423
  :param get: Function to be called when this value is 'read',
422
424
  This function must take 1 value (self) and return the value of the property.
423
- :type get: typing.Any
425
+ :type get: typing.Optional[typing.Any]
424
426
  :param set: Function to be called when this value is 'written',
425
427
  This function must take 2 values (self, value) and return None.
426
- :type set: typing.Any
428
+ :type set: typing.Optional[typing.Any]
427
429
  """
428
430
 
429
431
  ...
430
432
 
431
433
  def IntProperty(
432
- name: str = "",
433
- description: str = "",
434
- translation_context: str = "*",
434
+ name: typing.Optional[str] = "",
435
+ description: typing.Optional[str] = "",
436
+ translation_context: typing.Optional[str] = "*",
435
437
  default=0,
436
- min: int = None,
437
- max: int = None,
438
- soft_min: int = None,
439
- soft_max: int = None,
440
- step: int = 1,
441
- options: set = {'"ANIMATABLE"'},
442
- override: set = None(),
443
- tags: set = None(),
444
- subtype: str = "NONE",
445
- update: typing.Any = None,
446
- get: typing.Any = None,
447
- set: typing.Any = None,
438
+ min: typing.Optional[int] = None,
439
+ max: typing.Optional[int] = None,
440
+ soft_min: typing.Optional[int] = None,
441
+ soft_max: typing.Optional[int] = None,
442
+ step: typing.Optional[int] = 1,
443
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
444
+ override: typing.Optional[set] = None(),
445
+ tags: typing.Optional[set] = None(),
446
+ subtype: typing.Optional[str] = "NONE",
447
+ update: typing.Optional[typing.Any] = None,
448
+ get: typing.Optional[typing.Any] = None,
449
+ set: typing.Optional[typing.Any] = None,
448
450
  ):
449
451
  """Returns a new int property definition.
450
452
 
451
453
  :param name: Name used in the user interface.
452
- :type name: str
454
+ :type name: typing.Optional[str]
453
455
  :param description: Text used for the tooltip and api documentation.
454
- :type description: str
456
+ :type description: typing.Optional[str]
455
457
  :param translation_context: Text used as context to disambiguate translations.
456
- :type translation_context: str
458
+ :type translation_context: typing.Optional[str]
457
459
  :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
458
- :type min: int
460
+ :type min: typing.Optional[int]
459
461
  :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
460
- :type max: int
462
+ :type max: typing.Optional[int]
461
463
  :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
462
- :type soft_min: int
464
+ :type soft_min: typing.Optional[int]
463
465
  :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
464
- :type soft_max: int
466
+ :type soft_max: typing.Optional[int]
465
467
  :param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
466
- :type step: int
468
+ :type step: typing.Optional[int]
467
469
  :param options: Enumerator in `rna_enum_property_flag_items`.
468
- :type options: set
470
+ :type options: typing.Optional[set]
469
471
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
470
- :type override: set
472
+ :type override: typing.Optional[set]
471
473
  :param tags: Enumerator of tags that are defined by parent class.
472
- :type tags: set
474
+ :type tags: typing.Optional[set]
473
475
  :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
474
- :type subtype: str
476
+ :type subtype: typing.Optional[str]
475
477
  :param update: Function to be called when this value is modified,
476
478
  This function must take 2 values (self, context) and return None.
477
479
  Warning there are no safety checks to avoid infinite recursion.
478
- :type update: typing.Any
480
+ :type update: typing.Optional[typing.Any]
479
481
  :param get: Function to be called when this value is 'read',
480
482
  This function must take 1 value (self) and return the value of the property.
481
- :type get: typing.Any
483
+ :type get: typing.Optional[typing.Any]
482
484
  :param set: Function to be called when this value is 'written',
483
485
  This function must take 2 values (self, value) and return None.
484
- :type set: typing.Any
486
+ :type set: typing.Optional[typing.Any]
485
487
  """
486
488
 
487
489
  ...
488
490
 
489
491
  def IntVectorProperty(
490
- name: str = "",
491
- description: str = "",
492
- translation_context: str = "*",
493
- default: typing.Sequence = (0, 0, 0),
494
- min: int = None,
495
- max: int = None,
496
- soft_min: int = None,
497
- soft_max: int = None,
498
- step: int = 1,
499
- options: set = {'"ANIMATABLE"'},
500
- override: set = None(),
501
- tags: set = None(),
502
- subtype: str = "NONE",
503
- size: typing.Union[int, typing.Sequence[int]] = 3,
504
- update: typing.Any = None,
505
- get: typing.Any = None,
506
- set: typing.Any = None,
492
+ name: typing.Optional[str] = "",
493
+ description: typing.Optional[str] = "",
494
+ translation_context: typing.Optional[str] = "*",
495
+ default: typing.Optional[typing.Sequence] = (0, 0, 0),
496
+ min: typing.Optional[int] = None,
497
+ max: typing.Optional[int] = None,
498
+ soft_min: typing.Optional[int] = None,
499
+ soft_max: typing.Optional[int] = None,
500
+ step: typing.Optional[int] = 1,
501
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
502
+ override: typing.Optional[set] = None(),
503
+ tags: typing.Optional[set] = None(),
504
+ subtype: typing.Optional[str] = "NONE",
505
+ size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
506
+ update: typing.Optional[typing.Any] = None,
507
+ get: typing.Optional[typing.Any] = None,
508
+ set: typing.Optional[typing.Any] = None,
507
509
  ):
508
510
  """Returns a new vector int property definition.
509
511
 
510
512
  :param name: Name used in the user interface.
511
- :type name: str
513
+ :type name: typing.Optional[str]
512
514
  :param description: Text used for the tooltip and api documentation.
513
- :type description: str
515
+ :type description: typing.Optional[str]
514
516
  :param translation_context: Text used as context to disambiguate translations.
515
- :type translation_context: str
517
+ :type translation_context: typing.Optional[str]
516
518
  :param default: sequence of ints the length of size.
517
- :type default: typing.Sequence
519
+ :type default: typing.Optional[typing.Sequence]
518
520
  :param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
519
- :type min: int
521
+ :type min: typing.Optional[int]
520
522
  :param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
521
- :type max: int
523
+ :type max: typing.Optional[int]
522
524
  :param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
523
- :type soft_min: int
525
+ :type soft_min: typing.Optional[int]
524
526
  :param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
525
- :type soft_max: int
527
+ :type soft_max: typing.Optional[int]
526
528
  :param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
527
- :type step: int
529
+ :type step: typing.Optional[int]
528
530
  :param options: Enumerator in `rna_enum_property_flag_items`.
529
- :type options: set
531
+ :type options: typing.Optional[set]
530
532
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
531
- :type override: set
533
+ :type override: typing.Optional[set]
532
534
  :param tags: Enumerator of tags that are defined by parent class.
533
- :type tags: set
535
+ :type tags: typing.Optional[set]
534
536
  :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
535
- :type subtype: str
537
+ :type subtype: typing.Optional[str]
536
538
  :param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
537
- :type size: typing.Union[int, typing.Sequence[int]]
539
+ :type size: typing.Optional[typing.Union[int, typing.Sequence[int]]]
538
540
  :param update: Function to be called when this value is modified,
539
541
  This function must take 2 values (self, context) and return None.
540
542
  Warning there are no safety checks to avoid infinite recursion.
541
- :type update: typing.Any
543
+ :type update: typing.Optional[typing.Any]
542
544
  :param get: Function to be called when this value is 'read',
543
545
  This function must take 1 value (self) and return the value of the property.
544
- :type get: typing.Any
546
+ :type get: typing.Optional[typing.Any]
545
547
  :param set: Function to be called when this value is 'written',
546
548
  This function must take 2 values (self, value) and return None.
547
- :type set: typing.Any
549
+ :type set: typing.Optional[typing.Any]
548
550
  """
549
551
 
550
552
  ...
551
553
 
552
554
  def PointerProperty(
553
555
  type=None,
554
- name: str = "",
555
- description: str = "",
556
- translation_context: str = "*",
557
- options: set = {'"ANIMATABLE"'},
558
- override: set = None(),
559
- tags: set = None(),
560
- poll: typing.Any = None,
561
- update: typing.Any = None,
556
+ name: typing.Optional[str] = "",
557
+ description: typing.Optional[str] = "",
558
+ translation_context: typing.Optional[str] = "*",
559
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
560
+ override: typing.Optional[set] = None(),
561
+ tags: typing.Optional[set] = None(),
562
+ poll: typing.Optional[typing.Any] = None,
563
+ update: typing.Optional[typing.Any] = None,
562
564
  ):
563
565
  """Returns a new pointer property definition.
564
566
 
565
567
  :param type: A subclass of `bpy.types.PropertyGroup` or `bpy.types.ID`.
566
568
  :param name: Name used in the user interface.
567
- :type name: str
569
+ :type name: typing.Optional[str]
568
570
  :param description: Text used for the tooltip and api documentation.
569
- :type description: str
571
+ :type description: typing.Optional[str]
570
572
  :param translation_context: Text used as context to disambiguate translations.
571
- :type translation_context: str
573
+ :type translation_context: typing.Optional[str]
572
574
  :param options: Enumerator in `rna_enum_property_flag_items`.
573
- :type options: set
575
+ :type options: typing.Optional[set]
574
576
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
575
- :type override: set
577
+ :type override: typing.Optional[set]
576
578
  :param tags: Enumerator of tags that are defined by parent class.
577
- :type tags: set
579
+ :type tags: typing.Optional[set]
578
580
  :param poll: function to be called to determine whether an item is valid for this property.
579
581
  The function must take 2 values (self, object) and return Bool.
580
- :type poll: typing.Any
582
+ :type poll: typing.Optional[typing.Any]
581
583
  :param update: Function to be called when this value is modified,
582
584
  This function must take 2 values (self, context) and return None.
583
585
  Warning there are no safety checks to avoid infinite recursion.
584
- :type update: typing.Any
586
+ :type update: typing.Optional[typing.Any]
585
587
  """
586
588
 
587
589
  ...
588
590
 
589
- def RemoveProperty(cls: typing.Any, attr: str):
591
+ def RemoveProperty(cls: typing.Optional[typing.Any], attr: typing.Optional[str]):
590
592
  """Removes a dynamically defined property.
591
593
 
592
594
  :param cls: The class containing the property (must be a positional argument).
593
- :type cls: typing.Any
595
+ :type cls: typing.Optional[typing.Any]
594
596
  :param attr: Property name (must be passed as a keyword).
595
- :type attr: str
597
+ :type attr: typing.Optional[str]
596
598
  """
597
599
 
598
600
  ...
599
601
 
600
602
  def StringProperty(
601
- name: str = "",
602
- description: str = "",
603
- translation_context: str = "*",
604
- default: str = "",
605
- maxlen: int = 0,
606
- options: set = {'"ANIMATABLE"'},
607
- override: set = None(),
608
- tags: set = None(),
609
- subtype: str = "NONE",
610
- update: typing.Any = None,
611
- get: typing.Any = None,
612
- set: typing.Any = None,
613
- search: typing.Any = None,
614
- search_options: set = {'"SUGGESTION"'},
603
+ name: typing.Optional[str] = "",
604
+ description: typing.Optional[str] = "",
605
+ translation_context: typing.Optional[str] = "*",
606
+ default: typing.Optional[str] = "",
607
+ maxlen: typing.Optional[int] = 0,
608
+ options: typing.Optional[set] = {'"ANIMATABLE"'},
609
+ override: typing.Optional[set] = None(),
610
+ tags: typing.Optional[set] = None(),
611
+ subtype: typing.Optional[str] = "NONE",
612
+ update: typing.Optional[typing.Any] = None,
613
+ get: typing.Optional[typing.Any] = None,
614
+ set: typing.Optional[typing.Any] = None,
615
+ search: typing.Optional[typing.Any] = None,
616
+ search_options: typing.Optional[set] = {'"SUGGESTION"'},
615
617
  ):
616
618
  """Returns a new string property definition.
617
619
 
618
620
  :param name: Name used in the user interface.
619
- :type name: str
621
+ :type name: typing.Optional[str]
620
622
  :param description: Text used for the tooltip and api documentation.
621
- :type description: str
623
+ :type description: typing.Optional[str]
622
624
  :param translation_context: Text used as context to disambiguate translations.
623
- :type translation_context: str
625
+ :type translation_context: typing.Optional[str]
624
626
  :param default: initializer string.
625
- :type default: str
627
+ :type default: typing.Optional[str]
626
628
  :param maxlen: maximum length of the string.
627
- :type maxlen: int
629
+ :type maxlen: typing.Optional[int]
628
630
  :param options: Enumerator in `rna_enum_property_flag_items`.
629
- :type options: set
631
+ :type options: typing.Optional[set]
630
632
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
631
- :type override: set
633
+ :type override: typing.Optional[set]
632
634
  :param tags: Enumerator of tags that are defined by parent class.
633
- :type tags: set
635
+ :type tags: typing.Optional[set]
634
636
  :param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
635
- :type subtype: str
637
+ :type subtype: typing.Optional[str]
636
638
  :param update: Function to be called when this value is modified,
637
639
  This function must take 2 values (self, context) and return None.
638
640
  Warning there are no safety checks to avoid infinite recursion.
639
- :type update: typing.Any
641
+ :type update: typing.Optional[typing.Any]
640
642
  :param get: Function to be called when this value is 'read',
641
643
  This function must take 1 value (self) and return the value of the property.
642
- :type get: typing.Any
644
+ :type get: typing.Optional[typing.Any]
643
645
  :param set: Function to be called when this value is 'written',
644
646
  This function must take 2 values (self, value) and return None.
645
- :type set: typing.Any
647
+ :type set: typing.Optional[typing.Any]
646
648
  :param search: Function to be called to show candidates for this string (shown in the UI).
647
649
  This function must take 3 values (self, context, edit_text)
648
650
  and return a sequence, iterator or generator where each item must be:
@@ -651,7 +653,7 @@ def StringProperty(
651
653
 
652
654
  A tuple-pair of strings, where the first is a candidate and the second
653
655
  is additional information about the candidate.
654
- :type search: typing.Any
656
+ :type search: typing.Optional[typing.Any]
655
657
  :param search_options: Set of strings in:
656
658
 
657
659
  'SORT' sorts the resulting items.
@@ -659,7 +661,7 @@ def StringProperty(
659
661
  'SUGGESTION' lets the user enter values not found in search candidates.
660
662
  WARNING disabling this flag causes the search callback to run on redraw,
661
663
  so only disable this flag if it's not likely to cause performance issues.
662
- :type search_options: set
664
+ :type search_options: typing.Optional[set]
663
665
  """
664
666
 
665
667
  ...