fake-bpy-module 20240320__py3-none-any.whl → 20240322__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 (285) hide show
  1. addon_utils/__init__.pyi +54 -10
  2. animsys_refactor/__init__.pyi +27 -11
  3. aud/__init__.pyi +130 -123
  4. bgl/__init__.pyi +1831 -216
  5. bl_app_override/__init__.pyi +14 -3
  6. bl_app_override/helpers/__init__.pyi +19 -10
  7. bl_app_template_utils/__init__.pyi +19 -4
  8. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -5
  9. bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -3
  10. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -5
  11. bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -2
  12. bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -15
  13. bl_i18n_utils/merge_po/__init__.pyi +4 -1
  14. bl_i18n_utils/settings/__init__.pyi +19 -23
  15. bl_i18n_utils/utils/__init__.pyi +81 -143
  16. bl_i18n_utils/utils_cli/__init__.pyi +29 -6
  17. bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -1
  18. bl_i18n_utils/utils_rtl/__init__.pyi +9 -2
  19. bl_keymap_utils/io/__init__.pyi +44 -9
  20. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -1
  21. bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -1
  22. bl_keymap_utils/platform_helpers/__init__.pyi +9 -2
  23. bl_keymap_utils/versioning/__init__.pyi +4 -1
  24. bl_math/__init__.pyi +3 -3
  25. bl_operators/__init__.pyi +9 -2
  26. bl_operators/add_mesh_torus/__init__.pyi +120 -49
  27. bl_operators/anim/__init__.pyi +903 -297
  28. bl_operators/assets/__init__.pyi +348 -123
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +44 -9
  30. bl_operators/clip/__init__.pyi +1262 -470
  31. bl_operators/console/__init__.pyi +542 -160
  32. bl_operators/constraint/__init__.pyi +452 -140
  33. bl_operators/file/__init__.pyi +339 -114
  34. bl_operators/freestyle/__init__.pyi +440 -132
  35. bl_operators/geometry_nodes/__init__.pyi +2131 -842
  36. bl_operators/image/__init__.pyi +330 -97
  37. bl_operators/mesh/__init__.pyi +339 -109
  38. bl_operators/node/__init__.pyi +1506 -621
  39. bl_operators/object/__init__.pyi +1828 -668
  40. bl_operators/object_align/__init__.pyi +124 -35
  41. bl_operators/object_quick_effects/__init__.pyi +470 -149
  42. bl_operators/object_randomize_transform/__init__.pyi +114 -35
  43. bl_operators/presets/__init__.pyi +3056 -1374
  44. bl_operators/rigidbody/__init__.pyi +336 -106
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +115 -33
  46. bl_operators/sequencer/__init__.pyi +579 -204
  47. bl_operators/spreadsheet/__init__.pyi +110 -38
  48. bl_operators/userpref/__init__.pyi +3201 -1236
  49. bl_operators/uvcalc_follow_active/__init__.pyi +119 -38
  50. bl_operators/uvcalc_lightmap/__init__.pyi +137 -54
  51. bl_operators/uvcalc_transform/__init__.pyi +295 -83
  52. bl_operators/vertexpaint_dirt/__init__.pyi +119 -34
  53. bl_operators/view3d/__init__.pyi +542 -184
  54. bl_operators/wm/__init__.pyi +5554 -2159
  55. bl_previews_utils/bl_previews_render/__init__.pyi +34 -7
  56. bl_rna_utils/data_path/__init__.pyi +12 -2
  57. bl_text_utils/external_editor/__init__.pyi +4 -1
  58. bl_ui/__init__.pyi +346 -146
  59. bl_ui/anim/__init__.pyi +107 -47
  60. bl_ui/asset_shelf/__init__.pyi +111 -33
  61. bl_ui/generic_ui_list/__init__.pyi +349 -146
  62. bl_ui/node_add_menu/__init__.pyi +138 -53
  63. bl_ui/node_add_menu_compositor/__init__.pyi +2134 -1016
  64. bl_ui/node_add_menu_geometry/__init__.pyi +5833 -2855
  65. bl_ui/node_add_menu_shader/__init__.pyi +1162 -511
  66. bl_ui/node_add_menu_texture/__init__.pyi +1008 -450
  67. bl_ui/properties_animviz/__init__.pyi +14 -12
  68. bl_ui/properties_collection/__init__.pyi +601 -218
  69. bl_ui/properties_constraint/__init__.pyi +10115 -10647
  70. bl_ui/properties_data_armature/__init__.pyi +1550 -648
  71. bl_ui/properties_data_bone/__init__.pyi +1317 -511
  72. bl_ui/properties_data_camera/__init__.pyi +1852 -719
  73. bl_ui/properties_data_curve/__init__.pyi +2015 -781
  74. bl_ui/properties_data_curves/__init__.pyi +713 -262
  75. bl_ui/properties_data_empty/__init__.pyi +252 -84
  76. bl_ui/properties_data_gpencil/__init__.pyi +2505 -1105
  77. bl_ui/properties_data_grease_pencil/__init__.pyi +1350 -594
  78. bl_ui/properties_data_lattice/__init__.pyi +374 -123
  79. bl_ui/properties_data_light/__init__.pyi +1319 -489
  80. bl_ui/properties_data_lightprobe/__init__.pyi +734 -241
  81. bl_ui/properties_data_mesh/__init__.pyi +2652 -1189
  82. bl_ui/properties_data_metaball/__init__.pyi +610 -197
  83. bl_ui/properties_data_modifier/__init__.pyi +1143 -506
  84. bl_ui/properties_data_pointcloud/__init__.pyi +670 -303
  85. bl_ui/properties_data_shaderfx/__init__.pyi +126 -36
  86. bl_ui/properties_data_speaker/__init__.pyi +618 -195
  87. bl_ui/properties_data_volume/__init__.pyi +1052 -408
  88. bl_ui/properties_freestyle/__init__.pyi +3366 -1450
  89. bl_ui/properties_grease_pencil_common/__init__.pyi +1634 -776
  90. bl_ui/properties_mask_common/__init__.pyi +803 -371
  91. bl_ui/properties_material/__init__.pyi +2038 -831
  92. bl_ui/properties_material_gpencil/__init__.pyi +1272 -523
  93. bl_ui/properties_object/__init__.pyi +1863 -745
  94. bl_ui/properties_output/__init__.pyi +2482 -1071
  95. bl_ui/properties_paint_common/__init__.pyi +317 -424
  96. bl_ui/properties_particle/__init__.pyi +7235 -2942
  97. bl_ui/properties_physics_cloth/__init__.pyi +1903 -758
  98. bl_ui/properties_physics_common/__init__.pyi +164 -51
  99. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2787 -1114
  100. bl_ui/properties_physics_field/__init__.pyi +1294 -486
  101. bl_ui/properties_physics_fluid/__init__.pyi +3631 -1545
  102. bl_ui/properties_physics_geometry_nodes/__init__.pyi +115 -34
  103. bl_ui/properties_physics_rigidbody/__init__.pyi +983 -312
  104. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1718 -656
  105. bl_ui/properties_physics_softbody/__init__.pyi +2091 -836
  106. bl_ui/properties_render/__init__.pyi +7177 -2939
  107. bl_ui/properties_scene/__init__.pyi +1881 -760
  108. bl_ui/properties_texture/__init__.pyi +3539 -1399
  109. bl_ui/properties_view_layer/__init__.pyi +2368 -940
  110. bl_ui/properties_workspace/__init__.pyi +517 -202
  111. bl_ui/properties_world/__init__.pyi +862 -269
  112. bl_ui/space_clip/__init__.pyi +9127 -4137
  113. bl_ui/space_console/__init__.pyi +666 -286
  114. bl_ui/space_dopesheet/__init__.pyi +3287 -1504
  115. bl_ui/space_filebrowser/__init__.pyi +3958 -1935
  116. bl_ui/space_graph/__init__.pyi +2406 -1142
  117. bl_ui/space_image/__init__.pyi +9242 -4526
  118. bl_ui/space_info/__init__.pyi +664 -285
  119. bl_ui/space_nla/__init__.pyi +2014 -932
  120. bl_ui/space_node/__init__.pyi +4549 -1949
  121. bl_ui/space_outliner/__init__.pyi +1619 -745
  122. bl_ui/space_properties/__init__.pyi +340 -105
  123. bl_ui/space_sequencer/__init__.pyi +9396 -4264
  124. bl_ui/space_spreadsheet/__init__.pyi +110 -60
  125. bl_ui/space_statusbar/__init__.pyi +107 -32
  126. bl_ui/space_text/__init__.pyi +1907 -872
  127. bl_ui/space_time/__init__.pyi +812 -327
  128. bl_ui/space_toolsystem_common/__init__.pyi +203 -99
  129. bl_ui/space_toolsystem_toolbar/__init__.pyi +845 -289
  130. bl_ui/space_topbar/__init__.pyi +3131 -1437
  131. bl_ui/space_userpref/__init__.pyi +11510 -4926
  132. bl_ui/space_view3d/__init__.pyi +31358 -14417
  133. bl_ui/space_view3d_toolbar/__init__.pyi +12401 -6163
  134. bl_ui/utils/__init__.pyi +7 -16
  135. bl_ui_utils/bug_report_url/__init__.pyi +4 -1
  136. bl_ui_utils/layout/__init__.pyi +4 -1
  137. blend_render_info/__init__.pyi +13 -3
  138. blf/__init__.pyi +5 -7
  139. bmesh/__init__.pyi +7 -7
  140. bmesh/geometry/__init__.pyi +5 -5
  141. bmesh/ops/__init__.pyi +490 -504
  142. bmesh/types/__init__.pyi +253 -247
  143. bmesh/utils/__init__.pyi +54 -54
  144. bpy/__init__.pyi +2 -2
  145. bpy/app/__init__.pyi +4 -5
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -10
  148. bpy/app/timers/__init__.pyi +9 -11
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +3 -12
  151. bpy/ops/action/__init__.pyi +316 -415
  152. bpy/ops/anim/__init__.pyi +428 -566
  153. bpy/ops/armature/__init__.pyi +360 -488
  154. bpy/ops/asset/__init__.pyi +146 -183
  155. bpy/ops/boid/__init__.pyi +50 -67
  156. bpy/ops/brush/__init__.pyi +72 -96
  157. bpy/ops/buttons/__init__.pyi +128 -142
  158. bpy/ops/cachefile/__init__.pyi +124 -137
  159. bpy/ops/camera/__init__.pyi +22 -28
  160. bpy/ops/clip/__init__.pyi +768 -1005
  161. bpy/ops/cloth/__init__.pyi +10 -13
  162. bpy/ops/collection/__init__.pyi +36 -50
  163. bpy/ops/console/__init__.pyi +150 -203
  164. bpy/ops/constraint/__init__.pyi +150 -201
  165. bpy/ops/curve/__init__.pyi +474 -607
  166. bpy/ops/curves/__init__.pyi +170 -221
  167. bpy/ops/cycles/__init__.pyi +18 -26
  168. bpy/ops/dpaint/__init__.pyi +34 -46
  169. bpy/ops/ed/__init__.pyi +122 -149
  170. bpy/ops/export_anim/__init__.pyi +18 -21
  171. bpy/ops/export_mesh/__init__.pyi +26 -29
  172. bpy/ops/export_scene/__init__.pyi +307 -342
  173. bpy/ops/file/__init__.pyi +342 -436
  174. bpy/ops/fluid/__init__.pyi +88 -117
  175. bpy/ops/font/__init__.pyi +252 -311
  176. bpy/ops/geometry/__init__.pyi +86 -113
  177. bpy/ops/gizmogroup/__init__.pyi +22 -27
  178. bpy/ops/gpencil/__init__.pyi +1444 -1864
  179. bpy/ops/graph/__init__.pyi +642 -822
  180. bpy/ops/grease_pencil/__init__.pyi +426 -576
  181. bpy/ops/image/__init__.pyi +612 -733
  182. bpy/ops/import_anim/__init__.pyi +26 -29
  183. bpy/ops/import_curve/__init__.pyi +6 -9
  184. bpy/ops/import_mesh/__init__.pyi +18 -23
  185. bpy/ops/import_scene/__init__.pyi +86 -101
  186. bpy/ops/info/__init__.pyi +60 -77
  187. bpy/ops/lattice/__init__.pyi +64 -85
  188. bpy/ops/marker/__init__.pyi +106 -137
  189. bpy/ops/mask/__init__.pyi +318 -420
  190. bpy/ops/material/__init__.pyi +18 -24
  191. bpy/ops/mball/__init__.pyi +70 -93
  192. bpy/ops/mesh/__init__.pyi +1988 -2460
  193. bpy/ops/nla/__init__.pyi +331 -429
  194. bpy/ops/node/__init__.pyi +852 -1115
  195. bpy/ops/object/__init__.pyi +2420 -3081
  196. bpy/ops/outliner/__init__.pyi +498 -661
  197. bpy/ops/paint/__init__.pyi +518 -667
  198. bpy/ops/paintcurve/__init__.pyi +64 -84
  199. bpy/ops/palette/__init__.pyi +48 -66
  200. bpy/ops/particle/__init__.pyi +264 -355
  201. bpy/ops/pose/__init__.pyi +336 -438
  202. bpy/ops/poselib/__init__.pyi +70 -92
  203. bpy/ops/preferences/__init__.pyi +336 -440
  204. bpy/ops/ptcache/__init__.pyi +46 -62
  205. bpy/ops/render/__init__.pyi +114 -147
  206. bpy/ops/rigidbody/__init__.pyi +102 -135
  207. bpy/ops/scene/__init__.pyi +270 -364
  208. bpy/ops/screen/__init__.pyi +378 -477
  209. bpy/ops/script/__init__.pyi +18 -26
  210. bpy/ops/sculpt/__init__.pyi +400 -488
  211. bpy/ops/sculpt_curves/__init__.pyi +40 -53
  212. bpy/ops/sequencer/__init__.pyi +1040 -1279
  213. bpy/ops/sound/__init__.pyi +208 -226
  214. bpy/ops/spreadsheet/__init__.pyi +30 -40
  215. bpy/ops/surface/__init__.pyi +108 -126
  216. bpy/ops/text/__init__.pyi +382 -486
  217. bpy/ops/text_editor/__init__.pyi +10 -13
  218. bpy/ops/texture/__init__.pyi +26 -35
  219. bpy/ops/transform/__init__.pyi +790 -905
  220. bpy/ops/ui/__init__.pyi +216 -291
  221. bpy/ops/uilist/__init__.pyi +20 -29
  222. bpy/ops/uv/__init__.pyi +600 -742
  223. bpy/ops/view2d/__init__.pyi +156 -195
  224. bpy/ops/view3d/__init__.pyi +576 -742
  225. bpy/ops/wm/__init__.pyi +2360 -2702
  226. bpy/ops/workspace/__init__.pyi +42 -57
  227. bpy/ops/world/__init__.pyi +6 -8
  228. bpy/path/__init__.pyi +110 -81
  229. bpy/props/__init__.pyi +263 -267
  230. bpy/types/__init__.pyi +86358 -87091
  231. bpy/utils/__init__.pyi +242 -154
  232. bpy/utils/previews/__init__.pyi +57 -57
  233. bpy/utils/units/__init__.pyi +19 -22
  234. bpy_extras/anim_utils/__init__.pyi +11 -31
  235. bpy_extras/asset_utils/__init__.pyi +4 -1
  236. bpy_extras/image_utils/__init__.pyi +2 -2
  237. bpy_extras/io_utils/__init__.pyi +30 -27
  238. bpy_extras/keyconfig_utils/__init__.pyi +4 -1
  239. bpy_extras/mesh_utils/__init__.pyi +18 -18
  240. bpy_extras/node_utils/__init__.pyi +4 -1
  241. bpy_extras/object_utils/__init__.pyi +25 -26
  242. bpy_extras/view3d_utils/__init__.pyi +33 -38
  243. bpy_restrict_state/__init__.pyi +14 -1
  244. bpy_types/__init__.pyi +3748 -1248
  245. console_python/__init__.pyi +41 -7
  246. console_shell/__init__.pyi +24 -5
  247. {fake_bpy_module-20240320.dist-info → fake_bpy_module-20240322.dist-info}/METADATA +1 -1
  248. fake_bpy_module-20240322.dist-info/RECORD +343 -0
  249. freestyle/chainingiterators/__init__.pyi +50 -52
  250. freestyle/functions/__init__.pyi +303 -207
  251. freestyle/predicates/__init__.pyi +299 -115
  252. freestyle/shaders/__init__.pyi +49 -80
  253. freestyle/types/__init__.pyi +463 -470
  254. freestyle/utils/ContextFunctions/__init__.pyi +9 -9
  255. freestyle/utils/__init__.pyi +27 -17
  256. gpu/capabilities/__init__.pyi +19 -20
  257. gpu/matrix/__init__.pyi +14 -16
  258. gpu/platform/__init__.pyi +5 -5
  259. gpu/shader/__init__.pyi +2 -5
  260. gpu/state/__init__.pyi +1 -1
  261. gpu/texture/__init__.pyi +3 -3
  262. gpu/types/__init__.pyi +54 -85
  263. gpu_extras/batch/__init__.pyi +26 -6
  264. gpu_extras/presets/__init__.pyi +51 -16
  265. graphviz_export/__init__.pyi +9 -2
  266. idprop/types/__init__.pyi +36 -12
  267. imbuf/__init__.pyi +8 -9
  268. imbuf/types/__init__.pyi +8 -15
  269. keyingsets_builtins/__init__.pyi +2520 -1085
  270. keyingsets_utils/__init__.pyi +69 -14
  271. mathutils/__init__.pyi +491 -423
  272. mathutils/bvhtree/__init__.pyi +26 -31
  273. mathutils/geometry/__init__.pyi +176 -185
  274. mathutils/kdtree/__init__.pyi +14 -17
  275. mathutils/noise/__init__.pyi +47 -48
  276. nodeitems_builtins/__init__.pyi +37 -15
  277. nodeitems_utils/__init__.pyi +45 -13
  278. rna_info/__init__.pyi +177 -76
  279. rna_keymap_ui/__init__.pyi +29 -6
  280. rna_prop_ui/__init__.pyi +56 -14
  281. rna_xml/__init__.pyi +29 -6
  282. sys_info/__init__.pyi +4 -1
  283. fake_bpy_module-20240320.dist-info/RECORD +0 -343
  284. {fake_bpy_module-20240320.dist-info → fake_bpy_module-20240322.dist-info}/WHEEL +0 -0
  285. {fake_bpy_module-20240320.dist-info → fake_bpy_module-20240322.dist-info}/top_level.txt +0 -0
@@ -4,36 +4,31 @@ import bpy.types
4
4
  GenericType = typing.TypeVar("GenericType")
5
5
 
6
6
  def add(
7
- override_context: typing.Optional[
8
- typing.Union["bpy.types.Context", typing.Dict]
9
- ] = None,
10
- execution_context: typing.Optional[typing.Union[int, str]] = None,
11
- undo: typing.Optional[bool] = None,
7
+ override_context: typing.Union[dict, bpy.types.Context] = None,
8
+ execution_context: typing.Union[str, int] = None,
9
+ undo: bool = None,
12
10
  ):
13
11
  """Add a new workspace by duplicating the current one or appending one from the user configuration
14
12
 
15
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
16
- :type execution_context: typing.Optional[typing.Union[int, str]]
17
- :type undo: typing.Optional[bool]
13
+ :type override_context: typing.Union[dict, bpy.types.Context]
14
+ :type execution_context: typing.Union[str, int]
15
+ :type undo: bool
18
16
  """
19
17
 
20
18
  ...
21
19
 
22
20
  def append_activate(
23
- override_context: typing.Optional[
24
- typing.Union["bpy.types.Context", typing.Dict]
25
- ] = None,
26
- execution_context: typing.Optional[typing.Union[int, str]] = None,
27
- undo: typing.Optional[bool] = None,
28
- *,
21
+ override_context: typing.Union[dict, bpy.types.Context] = None,
22
+ execution_context: typing.Union[str, int] = None,
23
+ undo: bool = None,
29
24
  idname: typing.Union[str, typing.Any] = "",
30
25
  filepath: typing.Union[str, typing.Any] = "",
31
26
  ):
32
27
  """Append a workspace and make it the active one in the current window
33
28
 
34
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
35
- :type execution_context: typing.Optional[typing.Union[int, str]]
36
- :type undo: typing.Optional[bool]
29
+ :type override_context: typing.Union[dict, bpy.types.Context]
30
+ :type execution_context: typing.Union[str, int]
31
+ :type undo: bool
37
32
  :param idname: Identifier, Name of the workspace to append and activate
38
33
  :type idname: typing.Union[str, typing.Any]
39
34
  :param filepath: Filepath, Path to the library
@@ -43,81 +38,71 @@ def append_activate(
43
38
  ...
44
39
 
45
40
  def delete(
46
- override_context: typing.Optional[
47
- typing.Union["bpy.types.Context", typing.Dict]
48
- ] = None,
49
- execution_context: typing.Optional[typing.Union[int, str]] = None,
50
- undo: typing.Optional[bool] = None,
41
+ override_context: typing.Union[dict, bpy.types.Context] = None,
42
+ execution_context: typing.Union[str, int] = None,
43
+ undo: bool = None,
51
44
  ):
52
45
  """Delete the active workspace
53
46
 
54
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
55
- :type execution_context: typing.Optional[typing.Union[int, str]]
56
- :type undo: typing.Optional[bool]
47
+ :type override_context: typing.Union[dict, bpy.types.Context]
48
+ :type execution_context: typing.Union[str, int]
49
+ :type undo: bool
57
50
  """
58
51
 
59
52
  ...
60
53
 
61
54
  def duplicate(
62
- override_context: typing.Optional[
63
- typing.Union["bpy.types.Context", typing.Dict]
64
- ] = None,
65
- execution_context: typing.Optional[typing.Union[int, str]] = None,
66
- undo: typing.Optional[bool] = None,
55
+ override_context: typing.Union[dict, bpy.types.Context] = None,
56
+ execution_context: typing.Union[str, int] = None,
57
+ undo: bool = None,
67
58
  ):
68
59
  """Add a new workspace
69
60
 
70
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
71
- :type execution_context: typing.Optional[typing.Union[int, str]]
72
- :type undo: typing.Optional[bool]
61
+ :type override_context: typing.Union[dict, bpy.types.Context]
62
+ :type execution_context: typing.Union[str, int]
63
+ :type undo: bool
73
64
  """
74
65
 
75
66
  ...
76
67
 
77
68
  def reorder_to_back(
78
- override_context: typing.Optional[
79
- typing.Union["bpy.types.Context", typing.Dict]
80
- ] = None,
81
- execution_context: typing.Optional[typing.Union[int, str]] = None,
82
- undo: typing.Optional[bool] = None,
69
+ override_context: typing.Union[dict, bpy.types.Context] = None,
70
+ execution_context: typing.Union[str, int] = None,
71
+ undo: bool = None,
83
72
  ):
84
73
  """Reorder workspace to be last in the list
85
74
 
86
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
87
- :type execution_context: typing.Optional[typing.Union[int, str]]
88
- :type undo: typing.Optional[bool]
75
+ :type override_context: typing.Union[dict, bpy.types.Context]
76
+ :type execution_context: typing.Union[str, int]
77
+ :type undo: bool
89
78
  """
90
79
 
91
80
  ...
92
81
 
93
82
  def reorder_to_front(
94
- override_context: typing.Optional[
95
- typing.Union["bpy.types.Context", typing.Dict]
96
- ] = None,
97
- execution_context: typing.Optional[typing.Union[int, str]] = None,
98
- undo: typing.Optional[bool] = None,
83
+ override_context: typing.Union[dict, bpy.types.Context] = None,
84
+ execution_context: typing.Union[str, int] = None,
85
+ undo: bool = None,
99
86
  ):
100
87
  """Reorder workspace to be first in the list
101
88
 
102
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
103
- :type execution_context: typing.Optional[typing.Union[int, str]]
104
- :type undo: typing.Optional[bool]
89
+ :type override_context: typing.Union[dict, bpy.types.Context]
90
+ :type execution_context: typing.Union[str, int]
91
+ :type undo: bool
105
92
  """
106
93
 
107
94
  ...
108
95
 
109
96
  def scene_pin_toggle(
110
- override_context: typing.Optional[
111
- typing.Union["bpy.types.Context", typing.Dict]
112
- ] = None,
113
- execution_context: typing.Optional[typing.Union[int, str]] = None,
114
- undo: typing.Optional[bool] = None,
97
+ override_context: typing.Union[dict, bpy.types.Context] = None,
98
+ execution_context: typing.Union[str, int] = None,
99
+ undo: bool = None,
115
100
  ):
116
101
  """Remember the last used scene for the current workspace and switch to it whenever this workspace is activated again
117
102
 
118
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
119
- :type execution_context: typing.Optional[typing.Union[int, str]]
120
- :type undo: typing.Optional[bool]
103
+ :type override_context: typing.Union[dict, bpy.types.Context]
104
+ :type execution_context: typing.Union[str, int]
105
+ :type undo: bool
121
106
  """
122
107
 
123
108
  ...
@@ -4,17 +4,15 @@ import bpy.types
4
4
  GenericType = typing.TypeVar("GenericType")
5
5
 
6
6
  def new(
7
- override_context: typing.Optional[
8
- typing.Union["bpy.types.Context", typing.Dict]
9
- ] = None,
10
- execution_context: typing.Optional[typing.Union[int, str]] = None,
11
- undo: typing.Optional[bool] = None,
7
+ override_context: typing.Union[dict, bpy.types.Context] = None,
8
+ execution_context: typing.Union[str, int] = None,
9
+ undo: bool = None,
12
10
  ):
13
11
  """Create a new world Data-Block
14
12
 
15
- :type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
16
- :type execution_context: typing.Optional[typing.Union[int, str]]
17
- :type undo: typing.Optional[bool]
13
+ :type override_context: typing.Union[dict, bpy.types.Context]
14
+ :type execution_context: typing.Union[str, int]
15
+ :type undo: bool
18
16
  """
19
17
 
20
18
  ...
bpy/path/__init__.pyi CHANGED
@@ -4,217 +4,246 @@ import bpy.types
4
4
  GenericType = typing.TypeVar("GenericType")
5
5
 
6
6
  def abspath(
7
- path,
8
- *,
9
- start: typing.Optional[typing.Union[bytes, str]] = None,
10
- library: typing.Optional["bpy.types.Library"] = None,
7
+ path, start: typing.Union[str, bytes] = None, library: bpy.types.Library = None
11
8
  ) -> str:
12
9
  """Returns the absolute path relative to the current blend file
13
10
  using the "//" prefix.
14
11
 
15
12
  :param start: Relative to this path,
16
13
  when not set the current filename is used.
17
- :type start: typing.Optional[typing.Union[bytes, str]]
14
+ :type start: typing.Union[str, bytes]
18
15
  :param library: The library this path is from. This is only included for
19
16
  convenience, when the library is not None its path replaces start.
20
- :type library: typing.Optional['bpy.types.Library']
21
- :rtype: str
17
+ :type library: bpy.types.Library
22
18
  :return: The absolute path.
19
+ :rtype: str
23
20
  """
24
21
 
25
22
  ...
26
23
 
27
- def abspath(path, start, library): ...
24
+ def abspath(path, start, library):
25
+ """ """
26
+
27
+ ...
28
+
28
29
  def basename(path) -> str:
29
30
  """Equivalent to os.path.basename, but skips a "//" prefix.Use for Windows compatibility.
30
31
 
31
- :rtype: str
32
32
  :return: The base name of the given path.
33
+ :rtype: str
33
34
  """
34
35
 
35
36
  ...
36
37
 
37
- def basename(path): ...
38
- def clean_name(
39
- name: typing.Optional[typing.Union[bytes, str]],
40
- *,
41
- replace: typing.Optional[str] = "_",
42
- ) -> str:
38
+ def basename(path):
39
+ """ """
40
+
41
+ ...
42
+
43
+ def clean_name(name: typing.Union[str, bytes], replace: str = "_") -> str:
43
44
  """Returns a name with characters replaced that
44
45
  may cause problems under various circumstances,
45
46
  such as writing to a file.All characters besides A-Z/a-z, 0-9 are replaced with "_"
46
47
  or the replace argument if defined.
47
48
 
48
49
  :param name: The path name.
49
- :type name: typing.Optional[typing.Union[bytes, str]]
50
+ :type name: typing.Union[str, bytes]
50
51
  :param replace: The replacement for non-valid characters.
51
- :type replace: typing.Optional[str]
52
- :rtype: str
52
+ :type replace: str
53
53
  :return: The cleaned name.
54
+ :rtype: str
54
55
  """
55
56
 
56
57
  ...
57
58
 
58
- def clean_name(name, replace): ...
59
- def display_name(
60
- name: typing.Optional[str],
61
- *,
62
- has_ext: typing.Optional[bool] = True,
63
- title_case: typing.Optional[bool] = True,
64
- ) -> str:
59
+ def clean_name(name, replace):
60
+ """ """
61
+
62
+ ...
63
+
64
+ def display_name(name: str, has_ext: bool = True, title_case: bool = True) -> str:
65
65
  """Creates a display string from name to be used menus and the user interface.
66
66
  Intended for use with filenames and module names.
67
67
 
68
68
  :param name: The name to be used for displaying the user interface.
69
- :type name: typing.Optional[str]
69
+ :type name: str
70
70
  :param has_ext: Remove file extension from name.
71
- :type has_ext: typing.Optional[bool]
71
+ :type has_ext: bool
72
72
  :param title_case: Convert lowercase names to title case.
73
- :type title_case: typing.Optional[bool]
74
- :rtype: str
73
+ :type title_case: bool
75
74
  :return: The display string.
75
+ :rtype: str
76
76
  """
77
77
 
78
78
  ...
79
79
 
80
- def display_name(name, has_ext, title_case): ...
81
- def display_name_from_filepath(name: typing.Optional[str]) -> str:
80
+ def display_name(name, has_ext, title_case):
81
+ """ """
82
+
83
+ ...
84
+
85
+ def display_name_from_filepath(name: str) -> str:
82
86
  """Returns the path stripped of directory and extension,
83
87
  ensured to be utf8 compatible.
84
88
 
85
89
  :param name: The file path to convert.
86
- :type name: typing.Optional[str]
87
- :rtype: str
90
+ :type name: str
88
91
  :return: The display name.
92
+ :rtype: str
89
93
  """
90
94
 
91
95
  ...
92
96
 
93
- def display_name_from_filepath(name): ...
94
- def display_name_to_filepath(name: typing.Optional[str]) -> str:
97
+ def display_name_from_filepath(name):
98
+ """ """
99
+
100
+ ...
101
+
102
+ def display_name_to_filepath(name: str) -> str:
95
103
  """Performs the reverse of display_name using literal versions of characters
96
104
  which aren't supported in a filepath.
97
105
 
98
106
  :param name: The display name to convert.
99
- :type name: typing.Optional[str]
100
- :rtype: str
107
+ :type name: str
101
108
  :return: The file path.
109
+ :rtype: str
102
110
  """
103
111
 
104
112
  ...
105
113
 
106
- def display_name_to_filepath(name): ...
107
- def ensure_ext(
108
- filepath: typing.Optional[str],
109
- ext: typing.Optional[str],
110
- *,
111
- case_sensitive: typing.Optional[bool] = False,
112
- ) -> str:
114
+ def display_name_to_filepath(name):
115
+ """ """
116
+
117
+ ...
118
+
119
+ def ensure_ext(filepath: str, ext: str, case_sensitive: bool = False) -> str:
113
120
  """Return the path with the extension added if it is not already set.
114
121
 
115
122
  :param filepath: The file path.
116
- :type filepath: typing.Optional[str]
123
+ :type filepath: str
117
124
  :param ext: The extension to check for, can be a compound extension. Should
118
125
  start with a dot, such as '.blend' or '.tar.gz'.
119
- :type ext: typing.Optional[str]
126
+ :type ext: str
120
127
  :param case_sensitive: Check for matching case when comparing extensions.
121
- :type case_sensitive: typing.Optional[bool]
122
- :rtype: str
128
+ :type case_sensitive: bool
123
129
  :return: The file path with the given extension.
130
+ :rtype: str
124
131
  """
125
132
 
126
133
  ...
127
134
 
128
- def ensure_ext(filepath, ext, case_sensitive): ...
129
- def is_subdir(path: typing.Optional[typing.Union[bytes, str]], directory) -> bool:
135
+ def ensure_ext(filepath, ext, case_sensitive):
136
+ """ """
137
+
138
+ ...
139
+
140
+ def is_subdir(path: typing.Union[str, bytes], directory) -> bool:
130
141
  """Returns true if path in a subdirectory of directory.
131
142
  Both paths must be absolute.
132
143
 
133
144
  :param path: An absolute path.
134
- :type path: typing.Optional[typing.Union[bytes, str]]
135
- :rtype: bool
145
+ :type path: typing.Union[str, bytes]
136
146
  :return: Whether or not the path is a subdirectory.
147
+ :rtype: bool
137
148
  """
138
149
 
139
150
  ...
140
151
 
141
- def is_subdir(path, directory): ...
152
+ def is_subdir(path, directory):
153
+ """ """
154
+
155
+ ...
156
+
142
157
  def module_names(
143
- path: typing.Optional[str],
144
- *,
145
- recursive: typing.Optional[bool] = False,
146
- package: typing.Optional[str] = "",
158
+ path: str, recursive: bool = False, package: str = ""
147
159
  ) -> typing.List[str]:
148
160
  """Return a list of modules which can be imported from path.
149
161
 
150
162
  :param path: a directory to scan.
151
- :type path: typing.Optional[str]
163
+ :type path: str
152
164
  :param recursive: Also return submodule names for packages.
153
- :type recursive: typing.Optional[bool]
165
+ :type recursive: bool
154
166
  :param package: Optional string, used as the prefix for module names (without the trailing ".").
155
- :type package: typing.Optional[str]
156
- :rtype: typing.List[str]
167
+ :type package: str
157
168
  :return: a list of string pairs (module_name, module_file).
169
+ :rtype: typing.List[str]
158
170
  """
159
171
 
160
172
  ...
161
173
 
162
- def module_names(path, recursive, package): ...
163
- def native_pathsep(path: typing.Optional[str]) -> str:
174
+ def module_names(path, recursive, package):
175
+ """ """
176
+
177
+ ...
178
+
179
+ def native_pathsep(path: str) -> str:
164
180
  """Replace the path separator with the systems native os.sep.
165
181
 
166
182
  :param path: The path to replace.
167
- :type path: typing.Optional[str]
168
- :rtype: str
183
+ :type path: str
169
184
  :return: The path with system native separators.
185
+ :rtype: str
170
186
  """
171
187
 
172
188
  ...
173
189
 
174
- def native_pathsep(path): ...
175
- def reduce_dirs(dirs: typing.Optional[typing.List[str]]) -> typing.List[str]:
190
+ def native_pathsep(path):
191
+ """ """
192
+
193
+ ...
194
+
195
+ def reduce_dirs(dirs: typing.List[str]) -> typing.List[str]:
176
196
  """Given a sequence of directories, remove duplicates and
177
197
  any directories nested in one of the other paths.
178
198
  (Useful for recursive path searching).
179
199
 
180
200
  :param dirs: Sequence of directory paths.
181
- :type dirs: typing.Optional[typing.List[str]]
182
- :rtype: typing.List[str]
201
+ :type dirs: typing.List[str]
183
202
  :return: A unique list of paths.
203
+ :rtype: typing.List[str]
184
204
  """
185
205
 
186
206
  ...
187
207
 
188
- def reduce_dirs(dirs): ...
208
+ def reduce_dirs(dirs):
209
+ """ """
210
+
211
+ ...
212
+
189
213
  def relpath(
190
- path: typing.Optional[typing.Union[bytes, str]],
191
- *,
192
- start: typing.Optional[typing.Union[bytes, str]] = None,
214
+ path: typing.Union[str, bytes], start: typing.Union[str, bytes] = None
193
215
  ) -> str:
194
216
  """Returns the path relative to the current blend file using the "//" prefix.
195
217
 
196
218
  :param path: An absolute path.
197
- :type path: typing.Optional[typing.Union[bytes, str]]
219
+ :type path: typing.Union[str, bytes]
198
220
  :param start: Relative to this path,
199
221
  when not set the current filename is used.
200
- :type start: typing.Optional[typing.Union[bytes, str]]
201
- :rtype: str
222
+ :type start: typing.Union[str, bytes]
202
223
  :return: The relative path.
224
+ :rtype: str
203
225
  """
204
226
 
205
227
  ...
206
228
 
207
- def relpath(path, start): ...
208
- def resolve_ncase(path: typing.Optional[str]) -> str:
229
+ def relpath(path, start):
230
+ """ """
231
+
232
+ ...
233
+
234
+ def resolve_ncase(path: str) -> str:
209
235
  """Resolve a case insensitive path on a case sensitive system,
210
236
  returning a string with the path if found else return the original path.
211
237
 
212
238
  :param path: The path name to resolve.
213
- :type path: typing.Optional[str]
214
- :rtype: str
239
+ :type path: str
215
240
  :return: The resolved path.
241
+ :rtype: str
216
242
  """
217
243
 
218
244
  ...
219
245
 
220
- def resolve_ncase(path): ...
246
+ def resolve_ncase(path):
247
+ """ """
248
+
249
+ ...