fake-bpy-module 20240802__py3-none-any.whl → 20240804__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 (73) hide show
  1. aud/__init__.pyi +77 -77
  2. bmesh/ops/__init__.pyi +54 -36
  3. bmesh/types/__init__.pyi +24 -24
  4. bpy/ops/action/__init__.pyi +55 -32
  5. bpy/ops/anim/__init__.pyi +22 -22
  6. bpy/ops/armature/__init__.pyi +47 -20
  7. bpy/ops/asset/__init__.pyi +5 -2
  8. bpy/ops/boid/__init__.pyi +12 -2
  9. bpy/ops/brush/__init__.pyi +18 -12
  10. bpy/ops/buttons/__init__.pyi +10 -4
  11. bpy/ops/cachefile/__init__.pyi +12 -6
  12. bpy/ops/clip/__init__.pyi +54 -38
  13. bpy/ops/console/__init__.pyi +17 -6
  14. bpy/ops/constraint/__init__.pyi +28 -28
  15. bpy/ops/curve/__init__.pyi +72 -34
  16. bpy/ops/curves/__init__.pyi +16 -16
  17. bpy/ops/dpaint/__init__.pyi +4 -4
  18. bpy/ops/ed/__init__.pyi +5 -2
  19. bpy/ops/export_anim/__init__.pyi +3 -2
  20. bpy/ops/export_scene/__init__.pyi +55 -45
  21. bpy/ops/file/__init__.pyi +40 -16
  22. bpy/ops/font/__init__.pyi +59 -16
  23. bpy/ops/geometry/__init__.pyi +55 -20
  24. bpy/ops/gpencil/__init__.pyi +155 -122
  25. bpy/ops/graph/__init__.pyi +131 -52
  26. bpy/ops/grease_pencil/__init__.pyi +96 -58
  27. bpy/ops/image/__init__.pyi +77 -54
  28. bpy/ops/import_anim/__init__.pyi +11 -8
  29. bpy/ops/import_scene/__init__.pyi +20 -18
  30. bpy/ops/info/__init__.pyi +4 -4
  31. bpy/ops/lattice/__init__.pyi +8 -8
  32. bpy/ops/marker/__init__.pyi +6 -6
  33. bpy/ops/mask/__init__.pyi +13 -12
  34. bpy/ops/mball/__init__.pyi +6 -6
  35. bpy/ops/mesh/__init__.pyi +290 -150
  36. bpy/ops/nla/__init__.pyi +28 -20
  37. bpy/ops/node/__init__.pyi +43 -32
  38. bpy/ops/object/__init__.pyi +651 -210
  39. bpy/ops/outliner/__init__.pyi +113 -32
  40. bpy/ops/paint/__init__.pyi +65 -56
  41. bpy/ops/palette/__init__.pyi +4 -4
  42. bpy/ops/particle/__init__.pyi +14 -14
  43. bpy/ops/pose/__init__.pyi +121 -44
  44. bpy/ops/preferences/__init__.pyi +9 -6
  45. bpy/ops/render/__init__.pyi +3 -2
  46. bpy/ops/rigidbody/__init__.pyi +45 -14
  47. bpy/ops/scene/__init__.pyi +69 -22
  48. bpy/ops/screen/__init__.pyi +78 -16
  49. bpy/ops/sculpt/__init__.pyi +131 -74
  50. bpy/ops/sculpt_curves/__init__.pyi +2 -2
  51. bpy/ops/sequencer/__init__.pyi +156 -60
  52. bpy/ops/sound/__init__.pyi +40 -16
  53. bpy/ops/surface/__init__.pyi +12 -12
  54. bpy/ops/text/__init__.pyi +65 -20
  55. bpy/ops/texture/__init__.pyi +2 -2
  56. bpy/ops/transform/__init__.pyi +344 -72
  57. bpy/ops/ui/__init__.pyi +9 -6
  58. bpy/ops/uilist/__init__.pyi +2 -2
  59. bpy/ops/uv/__init__.pyi +90 -66
  60. bpy/ops/view3d/__init__.pyi +36 -30
  61. bpy/ops/wm/__init__.pyi +443 -156
  62. bpy/types/__init__.pyi +56103 -30890
  63. {fake_bpy_module-20240802.dist-info → fake_bpy_module-20240804.dist-info}/METADATA +1 -1
  64. {fake_bpy_module-20240802.dist-info → fake_bpy_module-20240804.dist-info}/RECORD +73 -73
  65. freestyle/chainingiterators/__init__.pyi +4 -4
  66. freestyle/types/__init__.pyi +76 -63
  67. freestyle/utils/__init__.pyi +1 -1
  68. idprop/types/__init__.pyi +2 -2
  69. imbuf/types/__init__.pyi +2 -2
  70. mathutils/__init__.pyi +1004 -970
  71. mathutils/bvhtree/__init__.pyi +2 -2
  72. {fake_bpy_module-20240802.dist-info → fake_bpy_module-20240804.dist-info}/WHEEL +0 -0
  73. {fake_bpy_module-20240802.dist-info → fake_bpy_module-20240804.dist-info}/top_level.txt +0 -0
bpy/ops/nla/__init__.pyi CHANGED
@@ -107,14 +107,11 @@ def bake(
107
107
  clear_parents: bool | None = False,
108
108
  use_current_action: bool | None = False,
109
109
  clean_curves: bool | None = False,
110
- bake_types: set[str] | None = {"POSE"},
111
- channel_types: set[str] | None = {
112
- "BBONE",
113
- "LOCATION",
114
- "PROPS",
115
- "ROTATION",
116
- "SCALE",
117
- },
110
+ bake_types: set[typing.Literal["POSE", "OBJECT"]] | None = {"POSE"},
111
+ channel_types: set[
112
+ typing.Literal["LOCATION", "ROTATION", "SCALE", "BBONE", "PROPS"]
113
+ ]
114
+ | None = {"BBONE", "LOCATION", "PROPS", "ROTATION", "SCALE"},
118
115
  ):
119
116
  """Bake all selected objects location/scale/rotation animation to an action
120
117
 
@@ -146,7 +143,7 @@ def bake(
146
143
 
147
144
  OBJECT
148
145
  Object -- Bake object transformations.
149
- :type bake_types: set[str] | None
146
+ :type bake_types: set[typing.Literal['POSE','OBJECT']] | None
150
147
  :param channel_types: Channels, Which channels to bake
151
148
 
152
149
  LOCATION
@@ -163,7 +160,7 @@ def bake(
163
160
 
164
161
  PROPS
165
162
  Custom Properties -- Bake custom properties.
166
- :type channel_types: set[str] | None
163
+ :type channel_types: set[typing.Literal['LOCATION','ROTATION','SCALE','BBONE','PROPS']] | None
167
164
  """
168
165
 
169
166
  ...
@@ -309,7 +306,17 @@ def fmodifier_add(
309
306
  execution_context: int | str | None = None,
310
307
  undo: bool | None = None,
311
308
  *,
312
- type: str | None = "NULL",
309
+ type: typing.Literal[
310
+ "NULL",
311
+ "GENERATOR",
312
+ "FNGENERATOR",
313
+ "ENVELOPE",
314
+ "CYCLES",
315
+ "NOISE",
316
+ "LIMITS",
317
+ "STEPPED",
318
+ ]
319
+ | None = "NULL",
313
320
  only_active: bool | None = True,
314
321
  ):
315
322
  """Add F-Modifier to the active/selected NLA-Strips
@@ -318,7 +325,7 @@ def fmodifier_add(
318
325
  :type execution_context: int | str | None
319
326
  :type undo: bool | None
320
327
  :param type: Type
321
- :type type: str | None
328
+ :type type: typing.Literal['NULL', 'GENERATOR', 'FNGENERATOR', 'ENVELOPE', 'CYCLES', 'NOISE', 'LIMITS', 'STEPPED'] | None
322
329
  :param only_active: Only Active, Only add a F-Modifier of the specified type to the active strip
323
330
  :type only_active: bool | None
324
331
  """
@@ -467,7 +474,7 @@ def select_all(
467
474
  execution_context: int | str | None = None,
468
475
  undo: bool | None = None,
469
476
  *,
470
- action: str | None = "TOGGLE",
477
+ action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
471
478
  ):
472
479
  """Select or deselect all NLA-Strips
473
480
 
@@ -487,7 +494,7 @@ def select_all(
487
494
 
488
495
  INVERT
489
496
  Invert -- Invert selection of all elements.
490
- :type action: str | None
497
+ :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
491
498
  """
492
499
 
493
500
  ...
@@ -504,7 +511,7 @@ def select_box(
504
511
  ymin: int | None = 0,
505
512
  ymax: int | None = 0,
506
513
  wait_for_input: bool | None = True,
507
- mode: str | None = "SET",
514
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
508
515
  ):
509
516
  """Use box selection to grab NLA-Strips
510
517
 
@@ -535,7 +542,7 @@ def select_box(
535
542
 
536
543
  SUB
537
544
  Subtract -- Subtract existing selection.
538
- :type mode: str | None
545
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
539
546
  """
540
547
 
541
548
  ...
@@ -545,7 +552,7 @@ def select_leftright(
545
552
  execution_context: int | str | None = None,
546
553
  undo: bool | None = None,
547
554
  *,
548
- mode: str | None = "CHECK",
555
+ mode: typing.Literal["CHECK", "LEFT", "RIGHT"] | None = "CHECK",
549
556
  extend: bool | None = False,
550
557
  ):
551
558
  """Select strips to the left or the right of the current frame
@@ -554,7 +561,7 @@ def select_leftright(
554
561
  :type execution_context: int | str | None
555
562
  :type undo: bool | None
556
563
  :param mode: Mode
557
- :type mode: str | None
564
+ :type mode: typing.Literal['CHECK','LEFT','RIGHT'] | None
558
565
  :param extend: Extend Select
559
566
  :type extend: bool | None
560
567
  """
@@ -580,7 +587,8 @@ def snap(
580
587
  execution_context: int | str | None = None,
581
588
  undo: bool | None = None,
582
589
  *,
583
- type: str | None = "CFRA",
590
+ type: typing.Literal["CFRA", "NEAREST_FRAME", "NEAREST_SECOND", "NEAREST_MARKER"]
591
+ | None = "CFRA",
584
592
  ):
585
593
  """Move start of strips to specified time
586
594
 
@@ -588,7 +596,7 @@ def snap(
588
596
  :type execution_context: int | str | None
589
597
  :type undo: bool | None
590
598
  :param type: Type
591
- :type type: str | None
599
+ :type type: typing.Literal['CFRA','NEAREST_FRAME','NEAREST_SECOND','NEAREST_MARKER'] | None
592
600
  """
593
601
 
594
602
  ...
bpy/ops/node/__init__.pyi CHANGED
@@ -61,8 +61,18 @@ def add_file(
61
61
  relative_path: bool | None = True,
62
62
  show_multiview: bool | None = False,
63
63
  use_multiview: bool | None = False,
64
- display_type: str | None = "DEFAULT",
65
- sort_method: str | None = "",
64
+ display_type: typing.Literal[
65
+ "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
66
+ ]
67
+ | None = "DEFAULT",
68
+ sort_method: typing.Literal[
69
+ "DEFAULT",
70
+ "FILE_SORT_ALPHA",
71
+ "FILE_SORT_EXTENSION",
72
+ "FILE_SORT_TIME",
73
+ "FILE_SORT_SIZE",
74
+ ]
75
+ | None = "",
66
76
  name: str = "",
67
77
  session_uid: int | None = 0,
68
78
  ):
@@ -136,7 +146,7 @@ def add_file(
136
146
 
137
147
  THUMBNAIL
138
148
  Thumbnails -- Display files as thumbnails.
139
- :type display_type: str | None
149
+ :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
140
150
  :param sort_method: File sorting mode
141
151
 
142
152
  DEFAULT
@@ -153,7 +163,7 @@ def add_file(
153
163
 
154
164
  FILE_SORT_SIZE
155
165
  Size -- Sort files by size.
156
- :type sort_method: str | None
166
+ :type sort_method: typing.Literal['DEFAULT','FILE_SORT_ALPHA','FILE_SORT_EXTENSION','FILE_SORT_TIME','FILE_SORT_SIZE'] | None
157
167
  :param name: Name, Name of the data-block to use by the operator
158
168
  :type name: str
159
169
  :param session_uid: Session UID, Session UID of the data-block to use by the operator
@@ -191,7 +201,8 @@ def add_group_asset(
191
201
  execution_context: int | str | None = None,
192
202
  undo: bool | None = None,
193
203
  *,
194
- asset_library_type: str | None = "LOCAL",
204
+ asset_library_type: typing.Literal["ALL", "LOCAL", "ESSENTIALS", "CUSTOM"]
205
+ | None = "LOCAL",
195
206
  asset_library_identifier: str = "",
196
207
  relative_asset_identifier: str = "",
197
208
  ):
@@ -201,7 +212,7 @@ def add_group_asset(
201
212
  :type execution_context: int | str | None
202
213
  :type undo: bool | None
203
214
  :param asset_library_type: Asset Library Type
204
- :type asset_library_type: str | None
215
+ :type asset_library_type: typing.Literal['ALL', 'LOCAL', 'ESSENTIALS', 'CUSTOM'] | None
205
216
  :param asset_library_identifier: Asset Library Identifier
206
217
  :type asset_library_identifier: str
207
218
  :param relative_asset_identifier: Relative Asset Identifier
@@ -462,7 +473,7 @@ def bake_node_item_move(
462
473
  execution_context: int | str | None = None,
463
474
  undo: bool | None = None,
464
475
  *,
465
- direction: str | None = "UP",
476
+ direction: typing.Literal["UP", "DOWN"] | None = "UP",
466
477
  ):
467
478
  """Move active bake item
468
479
 
@@ -470,7 +481,7 @@ def bake_node_item_move(
470
481
  :type execution_context: int | str | None
471
482
  :type undo: bool | None
472
483
  :param direction: Direction, Move direction
473
- :type direction: str | None
484
+ :type direction: typing.Literal['UP','DOWN'] | None
474
485
  """
475
486
 
476
487
  ...
@@ -508,7 +519,7 @@ def capture_attribute_item_move(
508
519
  execution_context: int | str | None = None,
509
520
  undo: bool | None = None,
510
521
  *,
511
- direction: str | None = "UP",
522
+ direction: typing.Literal["UP", "DOWN"] | None = "UP",
512
523
  ):
513
524
  """Move active capture attribute item
514
525
 
@@ -516,7 +527,7 @@ def capture_attribute_item_move(
516
527
  :type execution_context: int | str | None
517
528
  :type undo: bool | None
518
529
  :param direction: Direction, Move direction
519
- :type direction: str | None
530
+ :type direction: typing.Literal['UP','DOWN'] | None
520
531
  """
521
532
 
522
533
  ...
@@ -824,7 +835,7 @@ def enum_definition_item_move(
824
835
  execution_context: int | str | None = None,
825
836
  undo: bool | None = None,
826
837
  *,
827
- direction: str | None = "UP",
838
+ direction: typing.Literal["UP", "DOWN"] | None = "UP",
828
839
  ):
829
840
  """Move active menu item
830
841
 
@@ -832,7 +843,7 @@ def enum_definition_item_move(
832
843
  :type execution_context: int | str | None
833
844
  :type undo: bool | None
834
845
  :param direction: Direction, Move direction
835
- :type direction: str | None
846
+ :type direction: typing.Literal['UP','DOWN'] | None
836
847
  """
837
848
 
838
849
  ...
@@ -930,7 +941,7 @@ def group_separate(
930
941
  execution_context: int | str | None = None,
931
942
  undo: bool | None = None,
932
943
  *,
933
- type: str | None = "COPY",
944
+ type: typing.Literal["COPY", "MOVE"] | None = "COPY",
934
945
  ):
935
946
  """Separate selected nodes from the node group
936
947
 
@@ -944,7 +955,7 @@ def group_separate(
944
955
 
945
956
  MOVE
946
957
  Move -- Move to parent node tree, remove from group.
947
- :type type: str | None
958
+ :type type: typing.Literal['COPY','MOVE'] | None
948
959
  """
949
960
 
950
961
  ...
@@ -1056,7 +1067,7 @@ def interface_item_new(
1056
1067
  execution_context: int | str | None = None,
1057
1068
  undo: bool | None = None,
1058
1069
  *,
1059
- item_type: str | None = "INPUT",
1070
+ item_type: typing.Literal["INPUT", "OUTPUT", "PANEL"] | None = "INPUT",
1060
1071
  ):
1061
1072
  """Add a new item to the interface
1062
1073
 
@@ -1064,7 +1075,7 @@ def interface_item_new(
1064
1075
  :type execution_context: int | str | None
1065
1076
  :type undo: bool | None
1066
1077
  :param item_type: Item Type, Type of the item to create
1067
- :type item_type: str | None
1078
+ :type item_type: typing.Literal['INPUT','OUTPUT','PANEL'] | None
1068
1079
  """
1069
1080
 
1070
1081
  ...
@@ -1418,7 +1429,7 @@ def output_file_move_active_socket(
1418
1429
  execution_context: int | str | None = None,
1419
1430
  undo: bool | None = None,
1420
1431
  *,
1421
- direction: str | None = "DOWN",
1432
+ direction: typing.Literal["UP", "DOWN"] | None = "DOWN",
1422
1433
  ):
1423
1434
  """Move the active input of a file output node up or down the list
1424
1435
 
@@ -1426,7 +1437,7 @@ def output_file_move_active_socket(
1426
1437
  :type execution_context: int | str | None
1427
1438
  :type undo: bool | None
1428
1439
  :param direction: Direction
1429
- :type direction: str | None
1440
+ :type direction: typing.Literal['UP','DOWN'] | None
1430
1441
  """
1431
1442
 
1432
1443
  ...
@@ -1520,7 +1531,7 @@ def repeat_zone_item_move(
1520
1531
  execution_context: int | str | None = None,
1521
1532
  undo: bool | None = None,
1522
1533
  *,
1523
- direction: str | None = "UP",
1534
+ direction: typing.Literal["UP", "DOWN"] | None = "UP",
1524
1535
  ):
1525
1536
  """Move active repeat zone item
1526
1537
 
@@ -1528,7 +1539,7 @@ def repeat_zone_item_move(
1528
1539
  :type execution_context: int | str | None
1529
1540
  :type undo: bool | None
1530
1541
  :param direction: Direction, Move direction
1531
- :type direction: str | None
1542
+ :type direction: typing.Literal['UP','DOWN'] | None
1532
1543
  """
1533
1544
 
1534
1545
  ...
@@ -1605,7 +1616,7 @@ def select_all(
1605
1616
  execution_context: int | str | None = None,
1606
1617
  undo: bool | None = None,
1607
1618
  *,
1608
- action: str | None = "TOGGLE",
1619
+ action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
1609
1620
  ):
1610
1621
  """(De)select all nodes
1611
1622
 
@@ -1625,7 +1636,7 @@ def select_all(
1625
1636
 
1626
1637
  INVERT
1627
1638
  Invert -- Invert selection of all elements.
1628
- :type action: str | None
1639
+ :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
1629
1640
  """
1630
1641
 
1631
1642
  ...
@@ -1641,7 +1652,7 @@ def select_box(
1641
1652
  ymin: int | None = 0,
1642
1653
  ymax: int | None = 0,
1643
1654
  wait_for_input: bool | None = True,
1644
- mode: str | None = "SET",
1655
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
1645
1656
  ):
1646
1657
  """Use box selection to select nodes
1647
1658
 
@@ -1670,7 +1681,7 @@ def select_box(
1670
1681
 
1671
1682
  SUB
1672
1683
  Subtract -- Subtract existing selection.
1673
- :type mode: str | None
1684
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
1674
1685
  """
1675
1686
 
1676
1687
  ...
@@ -1684,7 +1695,7 @@ def select_circle(
1684
1695
  y: int | None = 0,
1685
1696
  radius: int | None = 25,
1686
1697
  wait_for_input: bool | None = True,
1687
- mode: str | None = "SET",
1698
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
1688
1699
  ):
1689
1700
  """Use circle selection to select nodes
1690
1701
 
@@ -1709,7 +1720,7 @@ def select_circle(
1709
1720
 
1710
1721
  SUB
1711
1722
  Subtract -- Subtract existing selection.
1712
- :type mode: str | None
1723
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
1713
1724
  """
1714
1725
 
1715
1726
  ...
@@ -1720,7 +1731,7 @@ def select_grouped(
1720
1731
  undo: bool | None = None,
1721
1732
  *,
1722
1733
  extend: bool | None = False,
1723
- type: str | None = "TYPE",
1734
+ type: typing.Literal["TYPE", "COLOR", "PREFIX", "SUFFIX"] | None = "TYPE",
1724
1735
  ):
1725
1736
  """Select nodes with similar properties
1726
1737
 
@@ -1730,7 +1741,7 @@ def select_grouped(
1730
1741
  :param extend: Extend, Extend selection instead of deselecting everything first
1731
1742
  :type extend: bool | None
1732
1743
  :param type: Type
1733
- :type type: str | None
1744
+ :type type: typing.Literal['TYPE','COLOR','PREFIX','SUFFIX'] | None
1734
1745
  """
1735
1746
 
1736
1747
  ...
@@ -1745,7 +1756,7 @@ def select_lasso(
1745
1756
  use_smooth_stroke: bool | None = False,
1746
1757
  smooth_stroke_factor: float | None = 0.75,
1747
1758
  smooth_stroke_radius: int | None = 35,
1748
- mode: str | None = "SET",
1759
+ mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
1749
1760
  ):
1750
1761
  """Select nodes using lasso selection
1751
1762
 
@@ -1772,7 +1783,7 @@ def select_lasso(
1772
1783
 
1773
1784
  SUB
1774
1785
  Subtract -- Subtract existing selection.
1775
- :type mode: str | None
1786
+ :type mode: typing.Literal['SET','ADD','SUB'] | None
1776
1787
  """
1777
1788
 
1778
1789
  ...
@@ -1877,7 +1888,7 @@ def simulation_zone_item_move(
1877
1888
  execution_context: int | str | None = None,
1878
1889
  undo: bool | None = None,
1879
1890
  *,
1880
- direction: str | None = "UP",
1891
+ direction: typing.Literal["UP", "DOWN"] | None = "UP",
1881
1892
  ):
1882
1893
  """Move active simulation zone item
1883
1894
 
@@ -1885,7 +1896,7 @@ def simulation_zone_item_move(
1885
1896
  :type execution_context: int | str | None
1886
1897
  :type undo: bool | None
1887
1898
  :param direction: Direction, Move direction
1888
- :type direction: str | None
1899
+ :type direction: typing.Literal['UP','DOWN'] | None
1889
1900
  """
1890
1901
 
1891
1902
  ...