fake-bpy-module 20240210__py3-none-any.whl → 20240326__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 (309) hide show
  1. addon_utils/__init__.pyi +54 -11
  2. animsys_refactor/__init__.pyi +36 -7
  3. aud/__init__.pyi +307 -321
  4. bgl/__init__.pyi +2926 -865
  5. bl_app_override/__init__.pyi +14 -4
  6. bl_app_override/helpers/__init__.pyi +24 -3
  7. bl_app_template_utils/__init__.pyi +19 -5
  8. bl_console_utils/__init__.pyi +0 -1
  9. bl_console_utils/autocomplete/__init__.pyi +2 -3
  10. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -6
  11. bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -4
  12. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -6
  13. bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -3
  14. bl_i18n_utils/__init__.pyi +2 -3
  15. bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -16
  16. bl_i18n_utils/merge_po/__init__.pyi +4 -2
  17. bl_i18n_utils/settings/__init__.pyi +53 -7
  18. bl_i18n_utils/utils/__init__.pyi +332 -45
  19. bl_i18n_utils/utils_cli/__init__.pyi +29 -7
  20. bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -2
  21. bl_i18n_utils/utils_rtl/__init__.pyi +9 -3
  22. bl_keymap_utils/__init__.pyi +2 -3
  23. bl_keymap_utils/io/__init__.pyi +44 -10
  24. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -2
  25. bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -2
  26. bl_keymap_utils/platform_helpers/__init__.pyi +9 -3
  27. bl_keymap_utils/versioning/__init__.pyi +4 -2
  28. bl_math/__init__.pyi +21 -22
  29. bl_operators/__init__.pyi +30 -24
  30. bl_operators/add_mesh_torus/__init__.pyi +171 -38
  31. bl_operators/anim/__init__.pyi +1065 -227
  32. bl_operators/assets/__init__.pyi +427 -93
  33. bl_operators/bmesh/__init__.pyi +0 -1
  34. bl_operators/bmesh/find_adjacent/__init__.pyi +44 -10
  35. bl_operators/clip/__init__.pyi +1342 -288
  36. bl_operators/console/__init__.pyi +647 -141
  37. bl_operators/constraint/__init__.pyi +524 -113
  38. bl_operators/file/__init__.pyi +396 -85
  39. bl_operators/freestyle/__init__.pyi +532 -114
  40. bl_operators/geometry_nodes/__init__.pyi +2412 -597
  41. bl_operators/image/__init__.pyi +380 -83
  42. bl_operators/mesh/__init__.pyi +401 -86
  43. bl_operators/node/__init__.pyi +1756 -385
  44. bl_operators/object/__init__.pyi +2022 -553
  45. bl_operators/object_align/__init__.pyi +145 -32
  46. bl_operators/object_quick_effects/__init__.pyi +555 -125
  47. bl_operators/object_randomize_transform/__init__.pyi +136 -33
  48. bl_operators/presets/__init__.pyi +3516 -709
  49. bl_operators/rigidbody/__init__.pyi +401 -86
  50. bl_operators/screen_play_rendered_anim/__init__.pyi +129 -30
  51. bl_operators/sequencer/__init__.pyi +731 -150
  52. bl_operators/spreadsheet/__init__.pyi +145 -31
  53. bl_operators/userpref/__init__.pyi +3416 -825
  54. bl_operators/uvcalc_follow_active/__init__.pyi +149 -33
  55. bl_operators/uvcalc_lightmap/__init__.pyi +187 -35
  56. bl_operators/uvcalc_transform/__init__.pyi +344 -74
  57. bl_operators/vertexpaint_dirt/__init__.pyi +140 -31
  58. bl_operators/view3d/__init__.pyi +697 -147
  59. bl_operators/wm/__init__.pyi +6287 -1534
  60. bl_previews_utils/__init__.pyi +0 -1
  61. bl_previews_utils/bl_previews_render/__init__.pyi +34 -8
  62. bl_rna_utils/__init__.pyi +0 -1
  63. bl_rna_utils/data_path/__init__.pyi +12 -3
  64. bl_text_utils/__init__.pyi +0 -1
  65. bl_text_utils/external_editor/__init__.pyi +4 -2
  66. bl_ui/__init__.pyi +567 -170
  67. bl_ui/anim/__init__.pyi +164 -34
  68. bl_ui/asset_shelf/__init__.pyi +146 -32
  69. bl_ui/generic_ui_list/__init__.pyi +471 -100
  70. bl_ui/node_add_menu/__init__.pyi +196 -41
  71. bl_ui/node_add_menu_compositor/__init__.pyi +3017 -622
  72. bl_ui/node_add_menu_geometry/__init__.pyi +8075 -1592
  73. bl_ui/node_add_menu_shader/__init__.pyi +1709 -349
  74. bl_ui/node_add_menu_texture/__init__.pyi +1502 -306
  75. bl_ui/properties_animviz/__init__.pyi +32 -3
  76. bl_ui/properties_collection/__init__.pyi +787 -180
  77. bl_ui/properties_constraint/__init__.pyi +28635 -5524
  78. bl_ui/properties_data_armature/__init__.pyi +1905 -449
  79. bl_ui/properties_data_bone/__init__.pyi +1560 -337
  80. bl_ui/properties_data_camera/__init__.pyi +2269 -495
  81. bl_ui/properties_data_curve/__init__.pyi +2362 -535
  82. bl_ui/properties_data_curves/__init__.pyi +951 -204
  83. bl_ui/properties_data_empty/__init__.pyi +317 -70
  84. bl_ui/properties_data_gpencil/__init__.pyi +2924 -735
  85. bl_ui/properties_data_grease_pencil/__init__.pyi +1631 -189
  86. bl_ui/properties_data_lattice/__init__.pyi +472 -105
  87. bl_ui/properties_data_light/__init__.pyi +1570 -338
  88. bl_ui/properties_data_lightprobe/__init__.pyi +938 -209
  89. bl_ui/properties_data_mesh/__init__.pyi +3205 -768
  90. bl_ui/properties_data_metaball/__init__.pyi +774 -171
  91. bl_ui/properties_data_modifier/__init__.pyi +1554 -329
  92. bl_ui/properties_data_pointcloud/__init__.pyi +821 -195
  93. bl_ui/properties_data_shaderfx/__init__.pyi +154 -35
  94. bl_ui/properties_data_speaker/__init__.pyi +782 -169
  95. bl_ui/properties_data_volume/__init__.pyi +1243 -282
  96. bl_ui/properties_freestyle/__init__.pyi +4071 -1031
  97. bl_ui/properties_grease_pencil_common/__init__.pyi +2399 -484
  98. bl_ui/properties_mask_common/__init__.pyi +1256 -250
  99. bl_ui/properties_material/__init__.pyi +2351 -543
  100. bl_ui/properties_material_gpencil/__init__.pyi +1590 -366
  101. bl_ui/properties_object/__init__.pyi +2179 -513
  102. bl_ui/properties_output/__init__.pyi +2956 -706
  103. bl_ui/properties_paint_common/__init__.pyi +947 -141
  104. bl_ui/properties_particle/__init__.pyi +8322 -1971
  105. bl_ui/properties_physics_cloth/__init__.pyi +2254 -509
  106. bl_ui/properties_physics_common/__init__.pyi +200 -45
  107. bl_ui/properties_physics_dynamicpaint/__init__.pyi +4454 -966
  108. bl_ui/properties_physics_field/__init__.pyi +1695 -365
  109. bl_ui/properties_physics_fluid/__init__.pyi +6127 -1281
  110. bl_ui/properties_physics_geometry_nodes/__init__.pyi +157 -33
  111. bl_ui/properties_physics_rigidbody/__init__.pyi +1254 -279
  112. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +2053 -484
  113. bl_ui/properties_physics_softbody/__init__.pyi +2394 -543
  114. bl_ui/properties_render/__init__.pyi +8312 -1934
  115. bl_ui/properties_scene/__init__.pyi +2211 -540
  116. bl_ui/properties_texture/__init__.pyi +4185 -1014
  117. bl_ui/properties_view_layer/__init__.pyi +2803 -665
  118. bl_ui/properties_workspace/__init__.pyi +626 -149
  119. bl_ui/properties_world/__init__.pyi +1092 -235
  120. bl_ui/space_clip/__init__.pyi +11475 -2806
  121. bl_ui/space_console/__init__.pyi +967 -203
  122. bl_ui/space_dopesheet/__init__.pyi +4260 -967
  123. bl_ui/space_filebrowser/__init__.pyi +4852 -1188
  124. bl_ui/space_graph/__init__.pyi +3251 -703
  125. bl_ui/space_image/__init__.pyi +12218 -2968
  126. bl_ui/space_info/__init__.pyi +964 -201
  127. bl_ui/space_nla/__init__.pyi +2756 -585
  128. bl_ui/space_node/__init__.pyi +5661 -1266
  129. bl_ui/space_outliner/__init__.pyi +2294 -479
  130. bl_ui/space_properties/__init__.pyi +417 -93
  131. bl_ui/space_sequencer/__init__.pyi +12436 -3010
  132. bl_ui/space_spreadsheet/__init__.pyi +184 -37
  133. bl_ui/space_statusbar/__init__.pyi +135 -31
  134. bl_ui/space_text/__init__.pyi +2556 -543
  135. bl_ui/space_time/__init__.pyi +1151 -244
  136. bl_ui/space_toolsystem_common/__init__.pyi +368 -67
  137. bl_ui/space_toolsystem_toolbar/__init__.pyi +1378 -229
  138. bl_ui/space_topbar/__init__.pyi +4214 -888
  139. bl_ui/space_userpref/__init__.pyi +13920 -3468
  140. bl_ui/space_view3d/__init__.pyi +42751 -9613
  141. bl_ui/space_view3d_toolbar/__init__.pyi +16379 -3860
  142. bl_ui/utils/__init__.pyi +42 -5
  143. bl_ui_utils/__init__.pyi +0 -1
  144. bl_ui_utils/bug_report_url/__init__.pyi +4 -2
  145. bl_ui_utils/layout/__init__.pyi +4 -2
  146. blend_render_info/__init__.pyi +13 -4
  147. blf/__init__.pyi +15 -18
  148. bmesh/__init__.pyi +18 -18
  149. bmesh/geometry/__init__.pyi +5 -6
  150. bmesh/ops/__init__.pyi +1337 -1158
  151. bmesh/types/__init__.pyi +464 -374
  152. bmesh/utils/__init__.pyi +64 -70
  153. bpy/__init__.pyi +6 -7
  154. bpy/app/__init__.pyi +36 -38
  155. bpy/app/handlers/__init__.pyi +37 -38
  156. bpy/app/icons/__init__.pyi +8 -11
  157. bpy/app/timers/__init__.pyi +18 -17
  158. bpy/app/translations/__init__.pyi +32 -30
  159. bpy/msgbus/__init__.pyi +25 -20
  160. bpy/ops/__init__.pyi +63 -64
  161. bpy/ops/action/__init__.pyi +408 -436
  162. bpy/ops/anim/__init__.pyi +459 -577
  163. bpy/ops/armature/__init__.pyi +396 -498
  164. bpy/ops/asset/__init__.pyi +187 -213
  165. bpy/ops/boid/__init__.pyi +50 -68
  166. bpy/ops/brush/__init__.pyi +72 -97
  167. bpy/ops/buttons/__init__.pyi +202 -193
  168. bpy/ops/cachefile/__init__.pyi +198 -188
  169. bpy/ops/camera/__init__.pyi +24 -31
  170. bpy/ops/clip/__init__.pyi +1021 -1082
  171. bpy/ops/cloth/__init__.pyi +11 -15
  172. bpy/ops/collection/__init__.pyi +36 -51
  173. bpy/ops/console/__init__.pyi +155 -209
  174. bpy/ops/constraint/__init__.pyi +286 -254
  175. bpy/ops/curve/__init__.pyi +597 -659
  176. bpy/ops/curves/__init__.pyi +191 -225
  177. bpy/ops/cycles/__init__.pyi +21 -30
  178. bpy/ops/dpaint/__init__.pyi +34 -47
  179. bpy/ops/ed/__init__.pyi +160 -176
  180. bpy/ops/export_anim/__init__.pyi +51 -34
  181. bpy/ops/export_mesh/__init__.pyi +47 -45
  182. bpy/ops/export_scene/__init__.pyi +659 -504
  183. bpy/ops/file/__init__.pyi +469 -474
  184. bpy/ops/fluid/__init__.pyi +89 -119
  185. bpy/ops/font/__init__.pyi +325 -361
  186. bpy/ops/geometry/__init__.pyi +86 -114
  187. bpy/ops/gizmogroup/__init__.pyi +22 -28
  188. bpy/ops/gpencil/__init__.pyi +1900 -1976
  189. bpy/ops/graph/__init__.pyi +875 -894
  190. bpy/ops/grease_pencil/__init__.pyi +572 -508
  191. bpy/ops/image/__init__.pyi +805 -855
  192. bpy/ops/import_anim/__init__.pyi +66 -46
  193. bpy/ops/import_curve/__init__.pyi +7 -11
  194. bpy/ops/import_mesh/__init__.pyi +19 -25
  195. bpy/ops/import_scene/__init__.pyi +164 -147
  196. bpy/ops/info/__init__.pyi +88 -85
  197. bpy/ops/lattice/__init__.pyi +86 -90
  198. bpy/ops/marker/__init__.pyi +135 -146
  199. bpy/ops/mask/__init__.pyi +372 -436
  200. bpy/ops/material/__init__.pyi +18 -25
  201. bpy/ops/mball/__init__.pyi +93 -99
  202. bpy/ops/mesh/__init__.pyi +2525 -2664
  203. bpy/ops/nla/__init__.pyi +398 -455
  204. bpy/ops/node/__init__.pyi +1015 -1207
  205. bpy/ops/object/__init__.pyi +3423 -3390
  206. bpy/ops/outliner/__init__.pyi +667 -685
  207. bpy/ops/paint/__init__.pyi +719 -672
  208. bpy/ops/paintcurve/__init__.pyi +64 -85
  209. bpy/ops/palette/__init__.pyi +48 -67
  210. bpy/ops/particle/__init__.pyi +323 -367
  211. bpy/ops/pose/__init__.pyi +569 -474
  212. bpy/ops/poselib/__init__.pyi +77 -100
  213. bpy/ops/preferences/__init__.pyi +460 -512
  214. bpy/ops/ptcache/__init__.pyi +46 -63
  215. bpy/ops/render/__init__.pyi +121 -155
  216. bpy/ops/rigidbody/__init__.pyi +148 -143
  217. bpy/ops/scene/__init__.pyi +336 -380
  218. bpy/ops/screen/__init__.pyi +454 -530
  219. bpy/ops/script/__init__.pyi +19 -28
  220. bpy/ops/sculpt/__init__.pyi +734 -587
  221. bpy/ops/sculpt_curves/__init__.pyi +51 -56
  222. bpy/ops/sequencer/__init__.pyi +1617 -1500
  223. bpy/ops/sound/__init__.pyi +392 -315
  224. bpy/ops/spreadsheet/__init__.pyi +31 -42
  225. bpy/ops/surface/__init__.pyi +198 -163
  226. bpy/ops/text/__init__.pyi +479 -545
  227. bpy/ops/text_editor/__init__.pyi +11 -15
  228. bpy/ops/texture/__init__.pyi +26 -36
  229. bpy/ops/transform/__init__.pyi +825 -941
  230. bpy/ops/ui/__init__.pyi +246 -295
  231. bpy/ops/uilist/__init__.pyi +34 -38
  232. bpy/ops/uv/__init__.pyi +912 -824
  233. bpy/ops/view2d/__init__.pyi +157 -197
  234. bpy/ops/view3d/__init__.pyi +777 -878
  235. bpy/ops/wm/__init__.pyi +4102 -3595
  236. bpy/ops/workspace/__init__.pyi +42 -58
  237. bpy/ops/world/__init__.pyi +6 -9
  238. bpy/path/__init__.pyi +166 -109
  239. bpy/props/__init__.pyi +478 -395
  240. bpy/types/__init__.pyi +87194 -81467
  241. bpy/utils/__init__.pyi +325 -169
  242. bpy/utils/previews/__init__.pyi +108 -21
  243. bpy/utils/units/__init__.pyi +37 -39
  244. bpy_extras/__init__.pyi +4 -9
  245. bpy_extras/anim_utils/__init__.pyi +25 -55
  246. bpy_extras/asset_utils/__init__.pyi +3 -13
  247. bpy_extras/id_map_utils/__init__.pyi +1 -4
  248. bpy_extras/image_utils/__init__.pyi +33 -23
  249. bpy_extras/io_utils/__init__.pyi +116 -66
  250. bpy_extras/keyconfig_utils/__init__.pyi +5 -3
  251. bpy_extras/mesh_utils/__init__.pyi +42 -34
  252. bpy_extras/node_utils/__init__.pyi +4 -4
  253. bpy_extras/object_utils/__init__.pyi +58 -43
  254. bpy_extras/view3d_utils/__init__.pyi +64 -63
  255. bpy_restrict_state/__init__.pyi +14 -2
  256. bpy_types/__init__.pyi +3873 -998
  257. console_python/__init__.pyi +41 -8
  258. console_shell/__init__.pyi +24 -6
  259. {fake_bpy_module-20240210.dist-info → fake_bpy_module-20240326.dist-info}/METADATA +1 -1
  260. fake_bpy_module-20240326.dist-info/RECORD +343 -0
  261. {fake_bpy_module-20240210.dist-info → fake_bpy_module-20240326.dist-info}/WHEEL +1 -1
  262. freestyle/__init__.pyi +4 -5
  263. freestyle/chainingiterators/__init__.pyi +229 -73
  264. freestyle/functions/__init__.pyi +624 -402
  265. freestyle/predicates/__init__.pyi +381 -169
  266. freestyle/shaders/__init__.pyi +424 -155
  267. freestyle/types/__init__.pyi +1572 -726
  268. freestyle/utils/ContextFunctions/__init__.pyi +54 -43
  269. freestyle/utils/__init__.pyi +67 -31
  270. gpu/__init__.pyi +3 -4
  271. gpu/capabilities/__init__.pyi +57 -37
  272. gpu/matrix/__init__.pyi +14 -17
  273. gpu/platform/__init__.pyi +5 -6
  274. gpu/select/__init__.pyi +2 -5
  275. gpu/shader/__init__.pyi +14 -12
  276. gpu/state/__init__.pyi +48 -62
  277. gpu/texture/__init__.pyi +7 -7
  278. gpu/types/__init__.pyi +670 -229
  279. gpu_extras/__init__.pyi +1 -2
  280. gpu_extras/batch/__init__.pyi +27 -6
  281. gpu_extras/presets/__init__.pyi +67 -27
  282. graphviz_export/__init__.pyi +9 -3
  283. idprop/__init__.pyi +0 -1
  284. idprop/types/__init__.pyi +42 -13
  285. imbuf/__init__.pyi +6 -10
  286. imbuf/types/__init__.pyi +8 -16
  287. keyingsets_builtins/__init__.pyi +3149 -702
  288. keyingsets_utils/__init__.pyi +69 -15
  289. mathutils/__init__.pyi +951 -876
  290. mathutils/bvhtree/__init__.pyi +47 -48
  291. mathutils/geometry/__init__.pyi +237 -242
  292. mathutils/interpolate/__init__.pyi +3 -6
  293. mathutils/kdtree/__init__.pyi +23 -26
  294. mathutils/noise/__init__.pyi +50 -51
  295. nodeitems_builtins/__init__.pyi +50 -11
  296. nodeitems_utils/__init__.pyi +58 -11
  297. rna_info/__init__.pyi +230 -27
  298. rna_keymap_ui/__init__.pyi +29 -7
  299. rna_prop_ui/__init__.pyi +69 -13
  300. rna_xml/__init__.pyi +29 -7
  301. sys_info/__init__.pyi +4 -2
  302. bpy_extras/bmesh_utils/__init__.pyi +0 -7
  303. bpy_extras/extensions/__init__.pyi +0 -5
  304. bpy_extras/extensions/junction_module/__init__.pyi +0 -13
  305. bpy_extras/node_shader_utils/__init__.pyi +0 -132
  306. bpy_extras/wm_utils/__init__.pyi +0 -5
  307. bpy_extras/wm_utils/progress_report/__init__.pyi +0 -30
  308. fake_bpy_module-20240210.dist-info/RECORD +0 -349
  309. {fake_bpy_module-20240210.dist-info → fake_bpy_module-20240326.dist-info}/top_level.txt +0 -0
@@ -1,40 +1,34 @@
1
- import sys
2
1
  import typing
3
2
  import bpy.types
4
3
 
5
4
  GenericType = typing.TypeVar("GenericType")
6
5
 
7
6
  def add(
8
- override_context: typing.Optional[
9
- typing.Union[typing.Dict, "bpy.types.Context"]
10
- ] = None,
11
- execution_context: typing.Optional[typing.Union[str, int]] = None,
12
- 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,
13
10
  ):
14
11
  """Add a new workspace by duplicating the current one or appending one from the user configuration
15
12
 
16
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
17
- :type execution_context: typing.Optional[typing.Union[str, int]]
18
- :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
19
16
  """
20
17
 
21
18
  ...
22
19
 
23
20
  def append_activate(
24
- override_context: typing.Optional[
25
- typing.Union[typing.Dict, "bpy.types.Context"]
26
- ] = None,
27
- execution_context: typing.Optional[typing.Union[str, int]] = None,
28
- undo: typing.Optional[bool] = None,
29
- *,
21
+ override_context: typing.Union[dict, bpy.types.Context] = None,
22
+ execution_context: typing.Union[str, int] = None,
23
+ undo: bool = None,
30
24
  idname: typing.Union[str, typing.Any] = "",
31
25
  filepath: typing.Union[str, typing.Any] = "",
32
26
  ):
33
27
  """Append a workspace and make it the active one in the current window
34
28
 
35
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
36
- :type execution_context: typing.Optional[typing.Union[str, int]]
37
- :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
38
32
  :param idname: Identifier, Name of the workspace to append and activate
39
33
  :type idname: typing.Union[str, typing.Any]
40
34
  :param filepath: Filepath, Path to the library
@@ -44,81 +38,71 @@ def append_activate(
44
38
  ...
45
39
 
46
40
  def delete(
47
- override_context: typing.Optional[
48
- typing.Union[typing.Dict, "bpy.types.Context"]
49
- ] = None,
50
- execution_context: typing.Optional[typing.Union[str, int]] = None,
51
- 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,
52
44
  ):
53
45
  """Delete the active workspace
54
46
 
55
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
56
- :type execution_context: typing.Optional[typing.Union[str, int]]
57
- :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
58
50
  """
59
51
 
60
52
  ...
61
53
 
62
54
  def duplicate(
63
- override_context: typing.Optional[
64
- typing.Union[typing.Dict, "bpy.types.Context"]
65
- ] = None,
66
- execution_context: typing.Optional[typing.Union[str, int]] = None,
67
- 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,
68
58
  ):
69
59
  """Add a new workspace
70
60
 
71
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
72
- :type execution_context: typing.Optional[typing.Union[str, int]]
73
- :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
74
64
  """
75
65
 
76
66
  ...
77
67
 
78
68
  def reorder_to_back(
79
- override_context: typing.Optional[
80
- typing.Union[typing.Dict, "bpy.types.Context"]
81
- ] = None,
82
- execution_context: typing.Optional[typing.Union[str, int]] = None,
83
- 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,
84
72
  ):
85
73
  """Reorder workspace to be last in the list
86
74
 
87
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
88
- :type execution_context: typing.Optional[typing.Union[str, int]]
89
- :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
90
78
  """
91
79
 
92
80
  ...
93
81
 
94
82
  def reorder_to_front(
95
- override_context: typing.Optional[
96
- typing.Union[typing.Dict, "bpy.types.Context"]
97
- ] = None,
98
- execution_context: typing.Optional[typing.Union[str, int]] = None,
99
- 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,
100
86
  ):
101
87
  """Reorder workspace to be first in the list
102
88
 
103
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
104
- :type execution_context: typing.Optional[typing.Union[str, int]]
105
- :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
106
92
  """
107
93
 
108
94
  ...
109
95
 
110
96
  def scene_pin_toggle(
111
- override_context: typing.Optional[
112
- typing.Union[typing.Dict, "bpy.types.Context"]
113
- ] = None,
114
- execution_context: typing.Optional[typing.Union[str, int]] = None,
115
- 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,
116
100
  ):
117
101
  """Remember the last used scene for the current workspace and switch to it whenever this workspace is activated again
118
102
 
119
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
120
- :type execution_context: typing.Optional[typing.Union[str, int]]
121
- :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
122
106
  """
123
107
 
124
108
  ...
@@ -1,21 +1,18 @@
1
- import sys
2
1
  import typing
3
2
  import bpy.types
4
3
 
5
4
  GenericType = typing.TypeVar("GenericType")
6
5
 
7
6
  def new(
8
- override_context: typing.Optional[
9
- typing.Union[typing.Dict, "bpy.types.Context"]
10
- ] = None,
11
- execution_context: typing.Optional[typing.Union[str, int]] = None,
12
- 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,
13
10
  ):
14
11
  """Create a new world Data-Block
15
12
 
16
- :type override_context: typing.Optional[typing.Union[typing.Dict, 'bpy.types.Context']]
17
- :type execution_context: typing.Optional[typing.Union[str, int]]
18
- :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
19
16
  """
20
17
 
21
18
  ...
bpy/path/__init__.pyi CHANGED
@@ -1,192 +1,249 @@
1
- import sys
2
1
  import typing
3
2
  import bpy.types
4
3
 
5
4
  GenericType = typing.TypeVar("GenericType")
6
5
 
7
6
  def abspath(
8
- path,
9
- *,
10
- start: typing.Optional[typing.Union[str, bytes]] = None,
11
- library: typing.Optional["bpy.types.Library"] = None,
7
+ path, start: typing.Union[str, bytes] = None, library: bpy.types.Library = None
12
8
  ) -> str:
13
- """Returns the absolute path relative to the current blend file using the "//" prefix.
14
-
15
- :param start: Relative to this path, when not set the current filename is used.
16
- :type start: typing.Optional[typing.Union[str, bytes]]
17
- :param library: The library this path is from. This is only included for convenience, when the library is not None its path replaces *start*.
18
- :type library: typing.Optional['bpy.types.Library']
19
- :rtype: str
20
- :return: The absolute path.
9
+ """Returns the absolute path relative to the current blend file
10
+ using the "//" prefix.
11
+
12
+ :param start: Relative to this path,
13
+ when not set the current filename is used.
14
+ :type start: typing.Union[str, bytes]
15
+ :param library: The library this path is from. This is only included for
16
+ convenience, when the library is not None its path replaces start.
17
+ :type library: bpy.types.Library
18
+ :return: The absolute path.
19
+ :rtype: str
21
20
  """
22
21
 
23
22
  ...
24
23
 
24
+ def abspath(path, start, library):
25
+ """ """
26
+
27
+ ...
28
+
25
29
  def basename(path) -> str:
26
- """Equivalent to ``os.path.basename``, but skips a "//" prefix. Use for Windows compatibility.
30
+ """Equivalent to os.path.basename, but skips a "//" prefix.Use for Windows compatibility.
27
31
 
28
- :rtype: str
29
32
  :return: The base name of the given path.
33
+ :rtype: str
30
34
  """
31
35
 
32
36
  ...
33
37
 
34
- def clean_name(
35
- name: typing.Optional[typing.Union[str, bytes]],
36
- *,
37
- replace: typing.Optional[str] = "_",
38
- ) -> str:
39
- """Returns a name with characters replaced that may cause problems under various circumstances, such as writing to a file. All characters besides A-Z/a-z, 0-9 are replaced with "_" or the *replace* argument if defined.
38
+ def basename(path):
39
+ """ """
40
40
 
41
- :param name: The path name.
42
- :type name: typing.Optional[typing.Union[str, bytes]]
43
- :param replace: The replacement for non-valid characters.
44
- :type replace: typing.Optional[str]
45
- :rtype: str
46
- :return: The cleaned name.
41
+ ...
42
+
43
+ def clean_name(name: typing.Union[str, bytes], replace: str = "_") -> str:
44
+ """Returns a name with characters replaced that
45
+ may cause problems under various circumstances,
46
+ such as writing to a file.All characters besides A-Z/a-z, 0-9 are replaced with "_"
47
+ or the replace argument if defined.
48
+
49
+ :param name: The path name.
50
+ :type name: typing.Union[str, bytes]
51
+ :param replace: The replacement for non-valid characters.
52
+ :type replace: str
53
+ :return: The cleaned name.
54
+ :rtype: str
47
55
  """
48
56
 
49
57
  ...
50
58
 
51
- def display_name(
52
- name: typing.Optional[str],
53
- *,
54
- has_ext: typing.Optional[bool] = True,
55
- title_case: typing.Optional[bool] = True,
56
- ) -> str:
57
- """Creates a display string from name to be used menus and the user interface. Intended for use with filenames and module names.
58
-
59
- :param name: The name to be used for displaying the user interface.
60
- :type name: typing.Optional[str]
61
- :param has_ext: Remove file extension from name.
62
- :type has_ext: typing.Optional[bool]
63
- :param title_case: Convert lowercase names to title case.
64
- :type title_case: typing.Optional[bool]
65
- :rtype: str
66
- :return: The display string.
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
+ """Creates a display string from name to be used menus and the user interface.
66
+ Intended for use with filenames and module names.
67
+
68
+ :param name: The name to be used for displaying the user interface.
69
+ :type name: str
70
+ :param has_ext: Remove file extension from name.
71
+ :type has_ext: bool
72
+ :param title_case: Convert lowercase names to title case.
73
+ :type title_case: bool
74
+ :return: The display string.
75
+ :rtype: str
67
76
  """
68
77
 
69
78
  ...
70
79
 
71
- def display_name_from_filepath(name: typing.Optional[str]) -> str:
72
- """Returns the path stripped of directory and extension, ensured to be utf8 compatible.
80
+ def display_name(name, has_ext, title_case):
81
+ """ """
73
82
 
74
- :param name: The file path to convert.
75
- :type name: typing.Optional[str]
76
- :rtype: str
77
- :return: The display name.
83
+ ...
84
+
85
+ def display_name_from_filepath(name: str) -> str:
86
+ """Returns the path stripped of directory and extension,
87
+ ensured to be utf8 compatible.
88
+
89
+ :param name: The file path to convert.
90
+ :type name: str
91
+ :return: The display name.
92
+ :rtype: str
78
93
  """
79
94
 
80
95
  ...
81
96
 
82
- def display_name_to_filepath(name: typing.Optional[str]) -> str:
83
- """Performs the reverse of display_name using literal versions of characters which aren't supported in a filepath.
97
+ def display_name_from_filepath(name):
98
+ """ """
84
99
 
85
- :param name: The display name to convert.
86
- :type name: typing.Optional[str]
87
- :rtype: str
88
- :return: The file path.
100
+ ...
101
+
102
+ def display_name_to_filepath(name: str) -> str:
103
+ """Performs the reverse of display_name using literal versions of characters
104
+ which aren't supported in a filepath.
105
+
106
+ :param name: The display name to convert.
107
+ :type name: str
108
+ :return: The file path.
109
+ :rtype: str
89
110
  """
90
111
 
91
112
  ...
92
113
 
93
- def ensure_ext(
94
- filepath: typing.Optional[str],
95
- ext: typing.Optional[str],
96
- *,
97
- case_sensitive: typing.Optional[bool] = False,
98
- ) -> 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:
99
120
  """Return the path with the extension added if it is not already set.
100
121
 
101
- :param filepath: The file path.
102
- :type filepath: typing.Optional[str]
103
- :param ext: The extension to check for, can be a compound extension. Should start with a dot, such as '.blend' or '.tar.gz'.
104
- :type ext: typing.Optional[str]
105
- :param case_sensitive: Check for matching case when comparing extensions.
106
- :type case_sensitive: typing.Optional[bool]
107
- :rtype: str
108
- :return: The file path with the given extension.
122
+ :param filepath: The file path.
123
+ :type filepath: str
124
+ :param ext: The extension to check for, can be a compound extension. Should
125
+ start with a dot, such as '.blend' or '.tar.gz'.
126
+ :type ext: str
127
+ :param case_sensitive: Check for matching case when comparing extensions.
128
+ :type case_sensitive: bool
129
+ :return: The file path with the given extension.
130
+ :rtype: str
109
131
  """
110
132
 
111
133
  ...
112
134
 
113
- def is_subdir(path: typing.Optional[typing.Union[str, bytes]], directory) -> bool:
114
- """Returns true if *path* in a subdirectory of *directory*. Both paths must be absolute.
135
+ def ensure_ext(filepath, ext, case_sensitive):
136
+ """ """
115
137
 
116
- :param path: An absolute path.
117
- :type path: typing.Optional[typing.Union[str, bytes]]
118
- :rtype: bool
119
- :return: Whether or not the path is a subdirectory.
138
+ ...
139
+
140
+ def is_subdir(path: typing.Union[str, bytes], directory) -> bool:
141
+ """Returns true if path in a subdirectory of directory.
142
+ Both paths must be absolute.
143
+
144
+ :param path: An absolute path.
145
+ :type path: typing.Union[str, bytes]
146
+ :return: Whether or not the path is a subdirectory.
147
+ :rtype: bool
120
148
  """
121
149
 
122
150
  ...
123
151
 
152
+ def is_subdir(path, directory):
153
+ """ """
154
+
155
+ ...
156
+
124
157
  def module_names(
125
- path: typing.Optional[str],
126
- *,
127
- recursive: typing.Optional[bool] = False,
128
- package: typing.Optional[str] = "",
158
+ path: str, recursive: bool = False, package: str = ""
129
159
  ) -> typing.List[str]:
130
- """Return a list of modules which can be imported from *path*.
160
+ """Return a list of modules which can be imported from path.
131
161
 
132
162
  :param path: a directory to scan.
133
- :type path: typing.Optional[str]
163
+ :type path: str
134
164
  :param recursive: Also return submodule names for packages.
135
- :type recursive: typing.Optional[bool]
165
+ :type recursive: bool
136
166
  :param package: Optional string, used as the prefix for module names (without the trailing ".").
137
- :type package: typing.Optional[str]
138
- :rtype: typing.List[str]
167
+ :type package: str
139
168
  :return: a list of string pairs (module_name, module_file).
169
+ :rtype: typing.List[str]
140
170
  """
141
171
 
142
172
  ...
143
173
 
144
- def native_pathsep(path: typing.Optional[str]) -> str:
145
- """Replace the path separator with the systems native ``os.sep``.
174
+ def module_names(path, recursive, package):
175
+ """ """
176
+
177
+ ...
178
+
179
+ def native_pathsep(path: str) -> str:
180
+ """Replace the path separator with the systems native os.sep.
146
181
 
147
182
  :param path: The path to replace.
148
- :type path: typing.Optional[str]
149
- :rtype: str
183
+ :type path: str
150
184
  :return: The path with system native separators.
185
+ :rtype: str
151
186
  """
152
187
 
153
188
  ...
154
189
 
155
- def reduce_dirs(dirs: typing.Optional[typing.List[str]]) -> typing.List[str]:
156
- """Given a sequence of directories, remove duplicates and any directories nested in one of the other paths. (Useful for recursive path searching).
190
+ def native_pathsep(path):
191
+ """ """
157
192
 
158
- :param dirs: Sequence of directory paths.
159
- :type dirs: typing.Optional[typing.List[str]]
160
- :rtype: typing.List[str]
161
- :return: A unique list of paths.
193
+ ...
194
+
195
+ def reduce_dirs(dirs: typing.List[str]) -> typing.List[str]:
196
+ """Given a sequence of directories, remove duplicates and
197
+ any directories nested in one of the other paths.
198
+ (Useful for recursive path searching).
199
+
200
+ :param dirs: Sequence of directory paths.
201
+ :type dirs: typing.List[str]
202
+ :return: A unique list of paths.
203
+ :rtype: typing.List[str]
162
204
  """
163
205
 
164
206
  ...
165
207
 
208
+ def reduce_dirs(dirs):
209
+ """ """
210
+
211
+ ...
212
+
166
213
  def relpath(
167
- path: typing.Optional[typing.Union[str, bytes]],
168
- *,
169
- start: typing.Optional[typing.Union[str, bytes]] = None,
214
+ path: typing.Union[str, bytes], start: typing.Union[str, bytes] = None
170
215
  ) -> str:
171
216
  """Returns the path relative to the current blend file using the "//" prefix.
172
217
 
173
- :param path: An absolute path.
174
- :type path: typing.Optional[typing.Union[str, bytes]]
175
- :param start: Relative to this path, when not set the current filename is used.
176
- :type start: typing.Optional[typing.Union[str, bytes]]
177
- :rtype: str
178
- :return: The relative path.
218
+ :param path: An absolute path.
219
+ :type path: typing.Union[str, bytes]
220
+ :param start: Relative to this path,
221
+ when not set the current filename is used.
222
+ :type start: typing.Union[str, bytes]
223
+ :return: The relative path.
224
+ :rtype: str
179
225
  """
180
226
 
181
227
  ...
182
228
 
183
- def resolve_ncase(path: typing.Optional[str]) -> str:
184
- """Resolve a case insensitive path on a case sensitive system, returning a string with the path if found else return the original path.
229
+ def relpath(path, start):
230
+ """ """
185
231
 
186
- :param path: The path name to resolve.
187
- :type path: typing.Optional[str]
188
- :rtype: str
189
- :return: The resolved path.
232
+ ...
233
+
234
+ def resolve_ncase(path: str) -> str:
235
+ """Resolve a case insensitive path on a case sensitive system,
236
+ returning a string with the path if found else return the original path.
237
+
238
+ :param path: The path name to resolve.
239
+ :type path: str
240
+ :return: The resolved path.
241
+ :rtype: str
190
242
  """
191
243
 
192
244
  ...
245
+
246
+ def resolve_ncase(path):
247
+ """ """
248
+
249
+ ...