fake-bpy-module 20240803__py3-none-any.whl → 20240805__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 (76) hide show
  1. _bpy_internal/extensions/__init__.pyi +1 -0
  2. _bpy_internal/extensions/stale_file_manager/__init__.pyi +39 -0
  3. _bpy_internal/extensions/wheel_manager/__init__.pyi +3 -1
  4. addon_utils/__init__.pyi +2 -0
  5. aud/__init__.pyi +77 -77
  6. bmesh/ops/__init__.pyi +54 -36
  7. bmesh/types/__init__.pyi +24 -24
  8. bpy/ops/action/__init__.pyi +55 -32
  9. bpy/ops/anim/__init__.pyi +22 -22
  10. bpy/ops/armature/__init__.pyi +47 -20
  11. bpy/ops/asset/__init__.pyi +5 -2
  12. bpy/ops/boid/__init__.pyi +12 -2
  13. bpy/ops/brush/__init__.pyi +18 -12
  14. bpy/ops/buttons/__init__.pyi +10 -4
  15. bpy/ops/cachefile/__init__.pyi +12 -6
  16. bpy/ops/clip/__init__.pyi +54 -38
  17. bpy/ops/console/__init__.pyi +17 -6
  18. bpy/ops/constraint/__init__.pyi +28 -28
  19. bpy/ops/curve/__init__.pyi +72 -34
  20. bpy/ops/curves/__init__.pyi +16 -16
  21. bpy/ops/dpaint/__init__.pyi +4 -4
  22. bpy/ops/ed/__init__.pyi +5 -2
  23. bpy/ops/export_anim/__init__.pyi +3 -2
  24. bpy/ops/export_scene/__init__.pyi +55 -45
  25. bpy/ops/file/__init__.pyi +40 -16
  26. bpy/ops/font/__init__.pyi +59 -16
  27. bpy/ops/geometry/__init__.pyi +55 -20
  28. bpy/ops/gpencil/__init__.pyi +155 -122
  29. bpy/ops/graph/__init__.pyi +131 -52
  30. bpy/ops/grease_pencil/__init__.pyi +78 -58
  31. bpy/ops/image/__init__.pyi +77 -54
  32. bpy/ops/import_anim/__init__.pyi +11 -8
  33. bpy/ops/import_scene/__init__.pyi +20 -18
  34. bpy/ops/info/__init__.pyi +4 -4
  35. bpy/ops/lattice/__init__.pyi +8 -8
  36. bpy/ops/marker/__init__.pyi +6 -6
  37. bpy/ops/mask/__init__.pyi +13 -12
  38. bpy/ops/mball/__init__.pyi +6 -6
  39. bpy/ops/mesh/__init__.pyi +290 -150
  40. bpy/ops/nla/__init__.pyi +28 -20
  41. bpy/ops/node/__init__.pyi +43 -32
  42. bpy/ops/object/__init__.pyi +651 -210
  43. bpy/ops/outliner/__init__.pyi +113 -32
  44. bpy/ops/paint/__init__.pyi +65 -56
  45. bpy/ops/palette/__init__.pyi +4 -4
  46. bpy/ops/particle/__init__.pyi +14 -14
  47. bpy/ops/pose/__init__.pyi +121 -44
  48. bpy/ops/preferences/__init__.pyi +9 -6
  49. bpy/ops/render/__init__.pyi +3 -2
  50. bpy/ops/rigidbody/__init__.pyi +45 -14
  51. bpy/ops/scene/__init__.pyi +69 -22
  52. bpy/ops/screen/__init__.pyi +78 -16
  53. bpy/ops/sculpt/__init__.pyi +131 -74
  54. bpy/ops/sculpt_curves/__init__.pyi +2 -2
  55. bpy/ops/sequencer/__init__.pyi +156 -60
  56. bpy/ops/sound/__init__.pyi +40 -16
  57. bpy/ops/surface/__init__.pyi +12 -12
  58. bpy/ops/text/__init__.pyi +65 -20
  59. bpy/ops/texture/__init__.pyi +2 -2
  60. bpy/ops/transform/__init__.pyi +344 -72
  61. bpy/ops/ui/__init__.pyi +9 -6
  62. bpy/ops/uilist/__init__.pyi +2 -2
  63. bpy/ops/uv/__init__.pyi +90 -66
  64. bpy/ops/view3d/__init__.pyi +36 -30
  65. bpy/ops/wm/__init__.pyi +443 -156
  66. bpy/types/__init__.pyi +28584 -2857
  67. {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240805.dist-info}/METADATA +1 -1
  68. {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240805.dist-info}/RECORD +76 -75
  69. freestyle/chainingiterators/__init__.pyi +4 -4
  70. freestyle/types/__init__.pyi +76 -63
  71. idprop/types/__init__.pyi +2 -2
  72. imbuf/types/__init__.pyi +2 -2
  73. mathutils/__init__.pyi +1004 -970
  74. mathutils/bvhtree/__init__.pyi +2 -2
  75. {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240805.dist-info}/WHEEL +0 -0
  76. {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240805.dist-info}/top_level.txt +0 -0
@@ -150,7 +150,7 @@ def easing_type(
150
150
  execution_context: int | str | None = None,
151
151
  undo: bool | None = None,
152
152
  *,
153
- type: str | None = "AUTO",
153
+ type: typing.Literal["AUTO", "EASE_IN", "EASE_OUT", "EASE_IN_OUT"] | None = "AUTO",
154
154
  ):
155
155
  """Set easing type for the F-Curve segments starting from the selected keyframes
156
156
 
@@ -158,7 +158,7 @@ def easing_type(
158
158
  :type execution_context: int | str | None
159
159
  :type undo: bool | None
160
160
  :param type: Type
161
- :type type: str | None
161
+ :type type: typing.Literal['AUTO', 'EASE_IN', 'EASE_OUT', 'EASE_IN_OUT'] | None
162
162
  """
163
163
 
164
164
  ...
@@ -168,7 +168,8 @@ def extrapolation_type(
168
168
  execution_context: int | str | None = None,
169
169
  undo: bool | None = None,
170
170
  *,
171
- type: str | None = "CONSTANT",
171
+ type: typing.Literal["CONSTANT", "LINEAR", "MAKE_CYCLIC", "CLEAR_CYCLIC"]
172
+ | None = "CONSTANT",
172
173
  ):
173
174
  """Set extrapolation mode for selected F-Curves
174
175
 
@@ -188,7 +189,7 @@ def extrapolation_type(
188
189
 
189
190
  CLEAR_CYCLIC
190
191
  Clear Cyclic (F-Modifier) -- Remove Cycles F-Modifier if not needed anymore.
191
- :type type: str | None
192
+ :type type: typing.Literal['CONSTANT','LINEAR','MAKE_CYCLIC','CLEAR_CYCLIC'] | None
192
193
  """
193
194
 
194
195
  ...
@@ -212,7 +213,8 @@ def handle_type(
212
213
  execution_context: int | str | None = None,
213
214
  undo: bool | None = None,
214
215
  *,
215
- type: str | None = "FREE",
216
+ type: typing.Literal["FREE", "ALIGNED", "VECTOR", "AUTO", "AUTO_CLAMPED"]
217
+ | None = "FREE",
216
218
  ):
217
219
  """Set type of handle for selected keyframes
218
220
 
@@ -220,7 +222,7 @@ def handle_type(
220
222
  :type execution_context: int | str | None
221
223
  :type undo: bool | None
222
224
  :param type: Type
223
- :type type: str | None
225
+ :type type: typing.Literal['FREE', 'ALIGNED', 'VECTOR', 'AUTO', 'AUTO_CLAMPED'] | None
224
226
  """
225
227
 
226
228
  ...
@@ -230,7 +232,22 @@ def interpolation_type(
230
232
  execution_context: int | str | None = None,
231
233
  undo: bool | None = None,
232
234
  *,
233
- type: str | None = "CONSTANT",
235
+ type: typing.Literal[
236
+ "CONSTANT",
237
+ "LINEAR",
238
+ "BEZIER",
239
+ "SINE",
240
+ "QUAD",
241
+ "CUBIC",
242
+ "QUART",
243
+ "QUINT",
244
+ "EXPO",
245
+ "CIRC",
246
+ "BACK",
247
+ "BOUNCE",
248
+ "ELASTIC",
249
+ ]
250
+ | None = "CONSTANT",
234
251
  ):
235
252
  """Set interpolation mode for the F-Curve segments starting from the selected keyframes
236
253
 
@@ -238,7 +255,7 @@ def interpolation_type(
238
255
  :type execution_context: int | str | None
239
256
  :type undo: bool | None
240
257
  :param type: Type
241
- :type type: str | None
258
+ :type type: typing.Literal['CONSTANT', 'LINEAR', 'BEZIER', 'SINE', 'QUAD', 'CUBIC', 'QUART', 'QUINT', 'EXPO', 'CIRC', 'BACK', 'BOUNCE', 'ELASTIC'] | None
242
259
  """
243
260
 
244
261
  ...
@@ -248,7 +265,7 @@ def keyframe_insert(
248
265
  execution_context: int | str | None = None,
249
266
  undo: bool | None = None,
250
267
  *,
251
- type: str | None = "ALL",
268
+ type: typing.Literal["ALL", "SEL", "GROUP"] | None = "ALL",
252
269
  ):
253
270
  """Insert keyframes for the specified channels
254
271
 
@@ -256,7 +273,7 @@ def keyframe_insert(
256
273
  :type execution_context: int | str | None
257
274
  :type undo: bool | None
258
275
  :param type: Type
259
- :type type: str | None
276
+ :type type: typing.Literal['ALL','SEL','GROUP'] | None
260
277
  """
261
278
 
262
279
  ...
@@ -266,7 +283,10 @@ def keyframe_type(
266
283
  execution_context: int | str | None = None,
267
284
  undo: bool | None = None,
268
285
  *,
269
- type: str | None = "KEYFRAME",
286
+ type: typing.Literal[
287
+ "KEYFRAME", "BREAKDOWN", "MOVING_HOLD", "EXTREME", "JITTER", "GENERATED"
288
+ ]
289
+ | None = "KEYFRAME",
270
290
  ):
271
291
  """Set type of keyframe for the selected keyframes
272
292
 
@@ -274,7 +294,7 @@ def keyframe_type(
274
294
  :type execution_context: int | str | None
275
295
  :type undo: bool | None
276
296
  :param type: Type
277
- :type type: str | None
297
+ :type type: typing.Literal['KEYFRAME', 'BREAKDOWN', 'MOVING_HOLD', 'EXTREME', 'JITTER', 'GENERATED'] | None
278
298
  """
279
299
 
280
300
  ...
@@ -326,7 +346,7 @@ def mirror(
326
346
  execution_context: int | str | None = None,
327
347
  undo: bool | None = None,
328
348
  *,
329
- type: str | None = "CFRA",
349
+ type: typing.Literal["CFRA", "XAXIS", "MARKER"] | None = "CFRA",
330
350
  ):
331
351
  """Flip selected keyframes over the selected mirror line
332
352
 
@@ -343,7 +363,7 @@ def mirror(
343
363
 
344
364
  MARKER
345
365
  By Times Over First Selected Marker -- Flip times of selected keyframes using the first selected marker as the reference point.
346
- :type type: str | None
366
+ :type type: typing.Literal['CFRA','XAXIS','MARKER'] | None
347
367
  """
348
368
 
349
369
  ...
@@ -367,8 +387,9 @@ def paste(
367
387
  execution_context: int | str | None = None,
368
388
  undo: bool | None = None,
369
389
  *,
370
- offset: str | None = "START",
371
- merge: str | None = "MIX",
390
+ offset: typing.Literal["START", "END", "RELATIVE", "NONE"] | None = "START",
391
+ merge: typing.Literal["MIX", "OVER_ALL", "OVER_RANGE", "OVER_RANGE_ALL"]
392
+ | None = "MIX",
372
393
  flipped: bool | None = False,
373
394
  ):
374
395
  """Paste keyframes from the internal clipboard for the selected channels, starting on the current frame
@@ -377,9 +398,9 @@ def paste(
377
398
  :type execution_context: int | str | None
378
399
  :type undo: bool | None
379
400
  :param offset: Offset, Paste time offset of keys
380
- :type offset: str | None
401
+ :type offset: typing.Literal['START', 'END', 'RELATIVE', 'NONE'] | None
381
402
  :param merge: Type, Method of merging pasted keys and existing
382
- :type merge: str | None
403
+ :type merge: typing.Literal['MIX', 'OVER_ALL', 'OVER_RANGE', 'OVER_RANGE_ALL'] | None
383
404
  :param flipped: Flipped, Paste keyframes from mirrored bones if they exist
384
405
  :type flipped: bool | None
385
406
  """
@@ -419,7 +440,7 @@ def select_all(
419
440
  execution_context: int | str | None = None,
420
441
  undo: bool | None = None,
421
442
  *,
422
- action: str | None = "TOGGLE",
443
+ action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
423
444
  ):
424
445
  """Toggle selection of all keyframes
425
446
 
@@ -439,7 +460,7 @@ def select_all(
439
460
 
440
461
  INVERT
441
462
  Invert -- Invert selection of all elements.
442
- :type action: str | None
463
+ :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
443
464
  """
444
465
 
445
466
  ...
@@ -455,7 +476,7 @@ def select_box(
455
476
  ymin: int | None = 0,
456
477
  ymax: int | None = 0,
457
478
  wait_for_input: bool | None = True,
458
- mode: str | None = "SET",
479
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
459
480
  tweak: bool | None = False,
460
481
  ):
461
482
  """Select all keyframes within the specified region
@@ -485,7 +506,7 @@ def select_box(
485
506
 
486
507
  SUB
487
508
  Subtract -- Subtract existing selection.
488
- :type mode: str | None
509
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
489
510
  :param tweak: Tweak, Operator has been activated using a click-drag event
490
511
  :type tweak: bool | None
491
512
  """
@@ -501,7 +522,7 @@ def select_circle(
501
522
  y: int | None = 0,
502
523
  radius: int | None = 25,
503
524
  wait_for_input: bool | None = True,
504
- mode: str | None = "SET",
525
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
505
526
  ):
506
527
  """Select keyframe points using circle selection
507
528
 
@@ -526,7 +547,7 @@ def select_circle(
526
547
 
527
548
  SUB
528
549
  Subtract -- Subtract existing selection.
529
- :type mode: str | None
550
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
530
551
  """
531
552
 
532
553
  ...
@@ -536,7 +557,8 @@ def select_column(
536
557
  execution_context: int | str | None = None,
537
558
  undo: bool | None = None,
538
559
  *,
539
- mode: str | None = "KEYS",
560
+ mode: typing.Literal["KEYS", "CFRA", "MARKERS_COLUMN", "MARKERS_BETWEEN"]
561
+ | None = "KEYS",
540
562
  ):
541
563
  """Select all keyframes on the specified frame(s)
542
564
 
@@ -544,7 +566,7 @@ def select_column(
544
566
  :type execution_context: int | str | None
545
567
  :type undo: bool | None
546
568
  :param mode: Mode
547
- :type mode: str | None
569
+ :type mode: typing.Literal['KEYS','CFRA','MARKERS_COLUMN','MARKERS_BETWEEN'] | None
548
570
  """
549
571
 
550
572
  ...
@@ -558,7 +580,7 @@ def select_lasso(
558
580
  use_smooth_stroke: bool | None = False,
559
581
  smooth_stroke_factor: float | None = 0.75,
560
582
  smooth_stroke_radius: int | None = 35,
561
- mode: str | None = "SET",
583
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
562
584
  ):
563
585
  """Select keyframe points using lasso selection
564
586
 
@@ -583,7 +605,7 @@ def select_lasso(
583
605
 
584
606
  SUB
585
607
  Subtract -- Subtract existing selection.
586
- :type mode: str | None
608
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
587
609
  """
588
610
 
589
611
  ...
@@ -593,7 +615,7 @@ def select_leftright(
593
615
  execution_context: int | str | None = None,
594
616
  undo: bool | None = None,
595
617
  *,
596
- mode: str | None = "CHECK",
618
+ mode: typing.Literal["CHECK", "LEFT", "RIGHT"] | None = "CHECK",
597
619
  extend: bool | None = False,
598
620
  ):
599
621
  """Select keyframes to the left or the right of the current frame
@@ -602,7 +624,7 @@ def select_leftright(
602
624
  :type execution_context: int | str | None
603
625
  :type undo: bool | None
604
626
  :param mode: Mode
605
- :type mode: str | None
627
+ :type mode: typing.Literal['CHECK','LEFT','RIGHT'] | None
606
628
  :param extend: Extend Select
607
629
  :type extend: bool | None
608
630
  """
@@ -656,7 +678,8 @@ def snap(
656
678
  execution_context: int | str | None = None,
657
679
  undo: bool | None = None,
658
680
  *,
659
- type: str | None = "CFRA",
681
+ type: typing.Literal["CFRA", "NEAREST_FRAME", "NEAREST_SECOND", "NEAREST_MARKER"]
682
+ | None = "CFRA",
660
683
  ):
661
684
  """Snap selected keyframes to the times specified
662
685
 
@@ -676,7 +699,7 @@ def snap(
676
699
 
677
700
  NEAREST_MARKER
678
701
  Selection to Nearest Marker -- Snap selected keyframes to the nearest marker.
679
- :type type: str | None
702
+ :type type: typing.Literal['CFRA','NEAREST_FRAME','NEAREST_SECOND','NEAREST_MARKER'] | None
680
703
  """
681
704
 
682
705
  ...
bpy/ops/anim/__init__.pyi CHANGED
@@ -74,7 +74,7 @@ def channels_bake(
74
74
  range: collections.abc.Iterable[int] | None = (0, 0),
75
75
  step: float | None = 1.0,
76
76
  remove_outside_range: bool | None = False,
77
- interpolation_type: str | None = "BEZIER",
77
+ interpolation_type: typing.Literal["BEZIER", "LIN", "CONST"] | None = "BEZIER",
78
78
  bake_modifiers: bool | None = True,
79
79
  ):
80
80
  """Create keyframes following the current shape of F-Curves of selected channels
@@ -98,7 +98,7 @@ def channels_bake(
98
98
 
99
99
  CONST
100
100
  Constant -- New keys will be constant.
101
- :type interpolation_type: str | None
101
+ :type interpolation_type: typing.Literal['BEZIER','LIN','CONST'] | None
102
102
  :param bake_modifiers: Bake Modifiers, Bake Modifiers into keyframes and delete them after
103
103
  :type bake_modifiers: bool | None
104
104
  """
@@ -180,8 +180,8 @@ def channels_editable_toggle(
180
180
  execution_context: int | str | None = None,
181
181
  undo: bool | None = None,
182
182
  *,
183
- mode: str | None = "TOGGLE",
184
- type: str | None = "PROTECT",
183
+ mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "TOGGLE",
184
+ type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
185
185
  ):
186
186
  """Toggle editability of selected channels
187
187
 
@@ -189,9 +189,9 @@ def channels_editable_toggle(
189
189
  :type execution_context: int | str | None
190
190
  :type undo: bool | None
191
191
  :param mode: Mode
192
- :type mode: str | None
192
+ :type mode: typing.Literal['TOGGLE','DISABLE','ENABLE','INVERT'] | None
193
193
  :param type: Type
194
- :type type: str | None
194
+ :type type: typing.Literal['PROTECT','MUTE'] | None
195
195
  """
196
196
 
197
197
  ...
@@ -251,7 +251,7 @@ def channels_move(
251
251
  execution_context: int | str | None = None,
252
252
  undo: bool | None = None,
253
253
  *,
254
- direction: str | None = "DOWN",
254
+ direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "DOWN",
255
255
  ):
256
256
  """Rearrange selected animation channels
257
257
 
@@ -259,7 +259,7 @@ def channels_move(
259
259
  :type execution_context: int | str | None
260
260
  :type undo: bool | None
261
261
  :param direction: Direction
262
- :type direction: str | None
262
+ :type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
263
263
  """
264
264
 
265
265
  ...
@@ -283,7 +283,7 @@ def channels_select_all(
283
283
  execution_context: int | str | None = None,
284
284
  undo: bool | None = None,
285
285
  *,
286
- action: str | None = "TOGGLE",
286
+ action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
287
287
  ):
288
288
  """Toggle selection of all animation channels
289
289
 
@@ -303,7 +303,7 @@ def channels_select_all(
303
303
 
304
304
  INVERT
305
305
  Invert -- Invert selection of all elements.
306
- :type action: str | None
306
+ :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
307
307
  """
308
308
 
309
309
  ...
@@ -363,8 +363,8 @@ def channels_setting_disable(
363
363
  execution_context: int | str | None = None,
364
364
  undo: bool | None = None,
365
365
  *,
366
- mode: str | None = "DISABLE",
367
- type: str | None = "PROTECT",
366
+ mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "DISABLE",
367
+ type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
368
368
  ):
369
369
  """Disable specified setting on all selected animation channels
370
370
 
@@ -372,9 +372,9 @@ def channels_setting_disable(
372
372
  :type execution_context: int | str | None
373
373
  :type undo: bool | None
374
374
  :param mode: Mode
375
- :type mode: str | None
375
+ :type mode: typing.Literal['TOGGLE','DISABLE','ENABLE','INVERT'] | None
376
376
  :param type: Type
377
- :type type: str | None
377
+ :type type: typing.Literal['PROTECT','MUTE'] | None
378
378
  """
379
379
 
380
380
  ...
@@ -384,8 +384,8 @@ def channels_setting_enable(
384
384
  execution_context: int | str | None = None,
385
385
  undo: bool | None = None,
386
386
  *,
387
- mode: str | None = "ENABLE",
388
- type: str | None = "PROTECT",
387
+ mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "ENABLE",
388
+ type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
389
389
  ):
390
390
  """Enable specified setting on all selected animation channels
391
391
 
@@ -393,9 +393,9 @@ def channels_setting_enable(
393
393
  :type execution_context: int | str | None
394
394
  :type undo: bool | None
395
395
  :param mode: Mode
396
- :type mode: str | None
396
+ :type mode: typing.Literal['TOGGLE','DISABLE','ENABLE','INVERT'] | None
397
397
  :param type: Type
398
- :type type: str | None
398
+ :type type: typing.Literal['PROTECT','MUTE'] | None
399
399
  """
400
400
 
401
401
  ...
@@ -405,8 +405,8 @@ def channels_setting_toggle(
405
405
  execution_context: int | str | None = None,
406
406
  undo: bool | None = None,
407
407
  *,
408
- mode: str | None = "TOGGLE",
409
- type: str | None = "PROTECT",
408
+ mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "TOGGLE",
409
+ type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
410
410
  ):
411
411
  """Toggle specified setting on all selected animation channels
412
412
 
@@ -414,9 +414,9 @@ def channels_setting_toggle(
414
414
  :type execution_context: int | str | None
415
415
  :type undo: bool | None
416
416
  :param mode: Mode
417
- :type mode: str | None
417
+ :type mode: typing.Literal['TOGGLE','DISABLE','ENABLE','INVERT'] | None
418
418
  :param type: Type
419
- :type type: str | None
419
+ :type type: typing.Literal['PROTECT','MUTE'] | None
420
420
  """
421
421
 
422
422
  ...
@@ -47,7 +47,7 @@ def autoside_names(
47
47
  execution_context: int | str | None = None,
48
48
  undo: bool | None = None,
49
49
  *,
50
- type: str | None = "XAXIS",
50
+ type: typing.Literal["XAXIS", "YAXIS", "ZAXIS"] | None = "XAXIS",
51
51
  ):
52
52
  """Automatically renames the selected bones according to which side of the target axis they fall on
53
53
 
@@ -64,7 +64,7 @@ def autoside_names(
64
64
 
65
65
  ZAXIS
66
66
  Z-Axis -- Top/Bottom.
67
- :type type: str | None
67
+ :type type: typing.Literal['XAXIS','YAXIS','ZAXIS'] | None
68
68
  """
69
69
 
70
70
  ...
@@ -92,7 +92,22 @@ def calculate_roll(
92
92
  execution_context: int | str | None = None,
93
93
  undo: bool | None = None,
94
94
  *,
95
- type: str | None = "POS_X",
95
+ type: typing.Literal[
96
+ "POS_X",
97
+ "POS_Z",
98
+ "GLOBAL_POS_X",
99
+ "GLOBAL_POS_Y",
100
+ "GLOBAL_POS_Z",
101
+ "NEG_X",
102
+ "NEG_Z",
103
+ "GLOBAL_NEG_X",
104
+ "GLOBAL_NEG_Y",
105
+ "GLOBAL_NEG_Z",
106
+ "ACTIVE",
107
+ "VIEW",
108
+ "CURSOR",
109
+ ]
110
+ | None = "POS_X",
96
111
  axis_flip: bool | None = False,
97
112
  axis_only: bool | None = False,
98
113
  ):
@@ -102,7 +117,7 @@ def calculate_roll(
102
117
  :type execution_context: int | str | None
103
118
  :type undo: bool | None
104
119
  :param type: Type
105
- :type type: str | None
120
+ :type type: typing.Literal['POS_X','POS_Z','GLOBAL_POS_X','GLOBAL_POS_Y','GLOBAL_POS_Z','NEG_X','NEG_Z','GLOBAL_NEG_X','GLOBAL_NEG_Y','GLOBAL_NEG_Z','ACTIVE','VIEW','CURSOR'] | None
106
121
  :param axis_flip: Flip Axis, Negate the alignment axis
107
122
  :type axis_flip: bool | None
108
123
  :param axis_only: Shortest Rotation, Ignore the axis direction, use the shortest rotation to align
@@ -194,7 +209,7 @@ def collection_move(
194
209
  execution_context: int | str | None = None,
195
210
  undo: bool | None = None,
196
211
  *,
197
- direction: str | None = "UP",
212
+ direction: typing.Literal["UP", "DOWN"] | None = "UP",
198
213
  ):
199
214
  """Change position of active Bone Collection in list of Bone collections
200
215
 
@@ -202,7 +217,7 @@ def collection_move(
202
217
  :type execution_context: int | str | None
203
218
  :type undo: bool | None
204
219
  :param direction: Direction, Direction to move the active Bone Collection towards
205
- :type direction: str | None
220
+ :type direction: typing.Literal['UP','DOWN'] | None
206
221
  """
207
222
 
208
223
  ...
@@ -321,7 +336,7 @@ def copy_bone_color_to_selected(
321
336
  execution_context: int | str | None = None,
322
337
  undo: bool | None = None,
323
338
  *,
324
- bone_type: str | None = "EDIT",
339
+ bone_type: typing.Literal["EDIT", "POSE"] | None = "EDIT",
325
340
  ):
326
341
  """Copy the bone color of the active bone to all selected bones
327
342
 
@@ -335,7 +350,7 @@ def copy_bone_color_to_selected(
335
350
 
336
351
  POSE
337
352
  Pose Bone -- Copy Pose Bone colors from the active pose bone to all selected pose bones.
338
- :type bone_type: str | None
353
+ :type bone_type: typing.Literal['EDIT','POSE'] | None
339
354
  """
340
355
 
341
356
  ...
@@ -547,7 +562,7 @@ def parent_clear(
547
562
  execution_context: int | str | None = None,
548
563
  undo: bool | None = None,
549
564
  *,
550
- type: str | None = "CLEAR",
565
+ type: typing.Literal["CLEAR", "DISCONNECT"] | None = "CLEAR",
551
566
  ):
552
567
  """Remove the parent-child relationship between selected bones and their parents
553
568
 
@@ -555,7 +570,7 @@ def parent_clear(
555
570
  :type execution_context: int | str | None
556
571
  :type undo: bool | None
557
572
  :param type: Clear Type, What way to clear parenting
558
- :type type: str | None
573
+ :type type: typing.Literal['CLEAR','DISCONNECT'] | None
559
574
  """
560
575
 
561
576
  ...
@@ -565,7 +580,7 @@ def parent_set(
565
580
  execution_context: int | str | None = None,
566
581
  undo: bool | None = None,
567
582
  *,
568
- type: str | None = "CONNECTED",
583
+ type: typing.Literal["CONNECTED", "OFFSET"] | None = "CONNECTED",
569
584
  ):
570
585
  """Set the active bone as the parent of the selected bones
571
586
 
@@ -573,7 +588,7 @@ def parent_set(
573
588
  :type execution_context: int | str | None
574
589
  :type undo: bool | None
575
590
  :param type: Parent Type, Type of parenting
576
- :type type: str | None
591
+ :type type: typing.Literal['CONNECTED','OFFSET'] | None
577
592
  """
578
593
 
579
594
  ...
@@ -619,7 +634,7 @@ def select_all(
619
634
  execution_context: int | str | None = None,
620
635
  undo: bool | None = None,
621
636
  *,
622
- action: str | None = "TOGGLE",
637
+ action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
623
638
  ):
624
639
  """Toggle selection status of all bones
625
640
 
@@ -639,7 +654,7 @@ def select_all(
639
654
 
640
655
  INVERT
641
656
  Invert -- Invert selection of all elements.
642
- :type action: str | None
657
+ :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
643
658
  """
644
659
 
645
660
  ...
@@ -649,7 +664,7 @@ def select_hierarchy(
649
664
  execution_context: int | str | None = None,
650
665
  undo: bool | None = None,
651
666
  *,
652
- direction: str | None = "PARENT",
667
+ direction: typing.Literal["PARENT", "CHILD"] | None = "PARENT",
653
668
  extend: bool | None = False,
654
669
  ):
655
670
  """Select immediate parent/children of selected bones
@@ -658,7 +673,7 @@ def select_hierarchy(
658
673
  :type execution_context: int | str | None
659
674
  :type undo: bool | None
660
675
  :param direction: Direction
661
- :type direction: str | None
676
+ :type direction: typing.Literal['PARENT','CHILD'] | None
662
677
  :param extend: Extend, Extend the selection
663
678
  :type extend: bool | None
664
679
  """
@@ -758,7 +773,19 @@ def select_similar(
758
773
  execution_context: int | str | None = None,
759
774
  undo: bool | None = None,
760
775
  *,
761
- type: str | None = "LENGTH",
776
+ type: typing.Literal[
777
+ "CHILDREN",
778
+ "CHILDREN_IMMEDIATE",
779
+ "SIBLINGS",
780
+ "LENGTH",
781
+ "DIRECTION",
782
+ "PREFIX",
783
+ "SUFFIX",
784
+ "BONE_COLLECTION",
785
+ "COLOR",
786
+ "SHAPE",
787
+ ]
788
+ | None = "LENGTH",
762
789
  threshold: float | None = 0.1,
763
790
  ):
764
791
  """Select similar bones by property types
@@ -767,7 +794,7 @@ def select_similar(
767
794
  :type execution_context: int | str | None
768
795
  :type undo: bool | None
769
796
  :param type: Type
770
- :type type: str | None
797
+ :type type: typing.Literal['CHILDREN','CHILDREN_IMMEDIATE','SIBLINGS','LENGTH','DIRECTION','PREFIX','SUFFIX','BONE_COLLECTION','COLOR','SHAPE'] | None
771
798
  :param threshold: Threshold
772
799
  :type threshold: float | None
773
800
  """
@@ -853,7 +880,7 @@ def symmetrize(
853
880
  execution_context: int | str | None = None,
854
881
  undo: bool | None = None,
855
882
  *,
856
- direction: str | None = "NEGATIVE_X",
883
+ direction: typing.Literal["NEGATIVE_X", "POSITIVE_X"] | None = "NEGATIVE_X",
857
884
  ):
858
885
  """Enforce symmetry, make copies of the selection or use existing
859
886
 
@@ -861,7 +888,7 @@ def symmetrize(
861
888
  :type execution_context: int | str | None
862
889
  :type undo: bool | None
863
890
  :param direction: Direction, Which sides to copy from and to (when both are selected)
864
- :type direction: str | None
891
+ :type direction: typing.Literal['NEGATIVE_X','POSITIVE_X'] | None
865
892
  """
866
893
 
867
894
  ...
@@ -47,7 +47,10 @@ def bundle_install(
47
47
  filter_folder: bool | None = True,
48
48
  filter_blenlib: bool | None = False,
49
49
  filemode: int | None = 8,
50
- display_type: str | None = "DEFAULT",
50
+ display_type: typing.Literal[
51
+ "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
52
+ ]
53
+ | None = "DEFAULT",
51
54
  sort_method: str | None = "",
52
55
  ):
53
56
  """Copy the current .blend file into an Asset Library. Only works on standalone .blend files (i.e. when no other files are referenced)
@@ -112,7 +115,7 @@ def bundle_install(
112
115
 
113
116
  THUMBNAIL
114
117
  Thumbnails -- Display files as thumbnails.
115
- :type display_type: str | None
118
+ :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
116
119
  :param sort_method: File sorting mode
117
120
  :type sort_method: str | None
118
121
  """
bpy/ops/boid/__init__.pyi CHANGED
@@ -11,7 +11,17 @@ def rule_add(
11
11
  execution_context: int | str | None = None,
12
12
  undo: bool | None = None,
13
13
  *,
14
- type: str | None = "GOAL",
14
+ type: typing.Literal[
15
+ "GOAL",
16
+ "AVOID",
17
+ "AVOID_COLLISION",
18
+ "SEPARATE",
19
+ "FLOCK",
20
+ "FOLLOW_LEADER",
21
+ "AVERAGE_SPEED",
22
+ "FIGHT",
23
+ ]
24
+ | None = "GOAL",
15
25
  ):
16
26
  """Add a boid rule to the current boid state
17
27
 
@@ -19,7 +29,7 @@ def rule_add(
19
29
  :type execution_context: int | str | None
20
30
  :type undo: bool | None
21
31
  :param type: Type
22
- :type type: str | None
32
+ :type type: typing.Literal['GOAL', 'AVOID', 'AVOID_COLLISION', 'SEPARATE', 'FLOCK', 'FOLLOW_LEADER', 'AVERAGE_SPEED', 'FIGHT'] | None
23
33
  """
24
34
 
25
35
  ...