fake-bpy-module 20250828__py3-none-any.whl → 20260119__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (309) hide show
  1. {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +0 -13
  2. {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +0 -5
  3. {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +0 -11
  4. {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +0 -10
  5. {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +1 -0
  6. {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +1 -0
  7. {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +2 -0
  8. _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
  9. {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
  10. _bpy_internal/__init__.pyi +3 -1
  11. _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
  12. _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
  13. _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
  14. _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
  15. _bpy_internal/filesystem/__init__.pyi +5 -0
  16. _bpy_internal/filesystem/locking/__init__.pyi +28 -0
  17. _bpy_internal/platform/__init__.pyi +5 -0
  18. _bpy_types/__init__.pyi +115 -117
  19. {rna_info → _rna_info}/__init__.pyi +0 -1
  20. addon_utils/__init__.pyi +0 -13
  21. aud/__init__.pyi +66 -142
  22. bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
  23. bl_app_templates_system/__init__.pyi +5 -0
  24. bl_app_templates_system/py.typed +0 -0
  25. bl_math/__init__.pyi +2 -12
  26. bl_operators/__init__.pyi +1 -0
  27. bl_operators/add_mesh_torus/__init__.pyi +0 -2
  28. bl_operators/anim/__init__.pyi +47 -24
  29. bl_operators/assets/__init__.pyi +0 -6
  30. bl_operators/bone_selection_sets/__init__.pyi +0 -28
  31. bl_operators/clip/__init__.pyi +0 -20
  32. bl_operators/connect_to_output/__init__.pyi +0 -2
  33. bl_operators/console/__init__.pyi +0 -10
  34. bl_operators/constraint/__init__.pyi +0 -8
  35. bl_operators/copy_global_transform/__init__.pyi +261 -0
  36. bl_operators/file/__init__.pyi +0 -6
  37. bl_operators/freestyle/__init__.pyi +0 -8
  38. bl_operators/geometry_nodes/__init__.pyi +0 -8
  39. bl_operators/grease_pencil/__init__.pyi +0 -2
  40. bl_operators/image/__init__.pyi +0 -10
  41. bl_operators/image_as_planes/__init__.pyi +0 -4
  42. bl_operators/mesh/__init__.pyi +0 -47
  43. bl_operators/node/__init__.pyi +277 -57
  44. bl_operators/object/__init__.pyi +0 -37
  45. bl_operators/object_align/__init__.pyi +0 -2
  46. bl_operators/object_quick_effects/__init__.pyi +0 -8
  47. bl_operators/object_randomize_transform/__init__.pyi +0 -2
  48. bl_operators/presets/__init__.pyi +1 -51
  49. bl_operators/rigidbody/__init__.pyi +0 -6
  50. bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
  51. bl_operators/sequencer/__init__.pyi +0 -16
  52. bl_operators/spreadsheet/__init__.pyi +0 -2
  53. bl_operators/userpref/__init__.pyi +0 -50
  54. bl_operators/uvcalc_follow_active/__init__.pyi +1 -3
  55. bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
  56. bl_operators/uvcalc_transform/__init__.pyi +21 -12
  57. bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
  58. bl_operators/view3d/__init__.pyi +0 -16
  59. bl_operators/wm/__init__.pyi +0 -92
  60. bl_operators/world/__init__.pyi +0 -2
  61. bl_ui/__init__.pyi +3 -4
  62. bl_ui/anim/__init__.pyi +0 -2
  63. bl_ui/asset_shelf/__init__.pyi +0 -2
  64. bl_ui/generic_ui_list/__init__.pyi +1 -17
  65. bl_ui/node_add_menu/__init__.pyi +261 -6
  66. bl_ui/node_add_menu_compositor/__init__.pyi +96 -80
  67. bl_ui/node_add_menu_geometry/__init__.pyi +266 -306
  68. bl_ui/node_add_menu_shader/__init__.pyi +49 -50
  69. bl_ui/node_add_menu_texture/__init__.pyi +16 -62
  70. bl_ui/properties_collection/__init__.pyi +0 -14
  71. bl_ui/properties_constraint/__init__.pyi +55 -209
  72. bl_ui/properties_data_armature/__init__.pyi +0 -36
  73. bl_ui/properties_data_bone/__init__.pyi +0 -20
  74. bl_ui/properties_data_camera/__init__.pyi +0 -30
  75. bl_ui/properties_data_curve/__init__.pyi +0 -30
  76. bl_ui/properties_data_curves/__init__.pyi +0 -16
  77. bl_ui/properties_data_empty/__init__.pyi +0 -4
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
  79. bl_ui/properties_data_lattice/__init__.pyi +0 -8
  80. bl_ui/properties_data_light/__init__.pyi +0 -20
  81. bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
  82. bl_ui/properties_data_mesh/__init__.pyi +1 -42
  83. bl_ui/properties_data_metaball/__init__.pyi +0 -12
  84. bl_ui/properties_data_modifier/__init__.pyi +12 -19
  85. bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
  86. bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
  87. bl_ui/properties_data_speaker/__init__.pyi +0 -12
  88. bl_ui/properties_data_volume/__init__.pyi +0 -18
  89. bl_ui/properties_freestyle/__init__.pyi +0 -50
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +0 -159
  91. bl_ui/properties_mask_common/__init__.pyi +0 -14
  92. bl_ui/properties_material/__init__.pyi +0 -32
  93. bl_ui/properties_material_gpencil/__init__.pyi +23 -45
  94. bl_ui/properties_object/__init__.pyi +35 -42
  95. bl_ui/properties_output/__init__.pyi +0 -40
  96. bl_ui/properties_paint_common/__init__.pyi +23 -19
  97. bl_ui/properties_particle/__init__.pyi +0 -106
  98. bl_ui/properties_physics_cloth/__init__.pyi +0 -28
  99. bl_ui/properties_physics_common/__init__.pyi +0 -2
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
  101. bl_ui/properties_physics_field/__init__.pyi +0 -20
  102. bl_ui/properties_physics_fluid/__init__.pyi +0 -56
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
  106. bl_ui/properties_physics_softbody/__init__.pyi +0 -30
  107. bl_ui/properties_render/__init__.pyi +58 -86
  108. bl_ui/properties_scene/__init__.pyi +0 -34
  109. bl_ui/properties_strip/__init__.pyi +744 -0
  110. bl_ui/properties_strip_modifier/__init__.pyi +45 -0
  111. bl_ui/properties_texture/__init__.pyi +0 -54
  112. bl_ui/properties_view_layer/__init__.pyi +7 -28
  113. bl_ui/properties_workspace/__init__.pyi +0 -8
  114. bl_ui/properties_world/__init__.pyi +0 -22
  115. bl_ui/space_clip/__init__.pyi +82 -166
  116. bl_ui/space_console/__init__.pyi +0 -12
  117. bl_ui/space_dopesheet/__init__.pyi +67 -76
  118. bl_ui/space_filebrowser/__init__.pyi +0 -60
  119. bl_ui/space_graph/__init__.pyi +0 -66
  120. bl_ui/space_image/__init__.pyi +28 -162
  121. bl_ui/space_info/__init__.pyi +0 -12
  122. bl_ui/space_nla/__init__.pyi +0 -58
  123. bl_ui/space_node/__init__.pyi +99 -132
  124. bl_ui/space_outliner/__init__.pyi +0 -30
  125. bl_ui/space_properties/__init__.pyi +29 -6
  126. bl_ui/space_sequencer/__init__.pyi +159 -987
  127. bl_ui/space_spreadsheet/__init__.pyi +0 -6
  128. bl_ui/space_statusbar/__init__.pyi +0 -2
  129. bl_ui/space_text/__init__.pyi +0 -32
  130. bl_ui/space_time/__init__.pyi +29 -22
  131. bl_ui/space_toolsystem_toolbar/__init__.pyi +7 -2
  132. bl_ui/space_topbar/__init__.pyi +7 -52
  133. bl_ui/space_userpref/__init__.pyi +77 -225
  134. bl_ui/space_view3d/__init__.pyi +69 -551
  135. bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
  136. bl_ui/space_view3d_toolbar/__init__.pyi +22 -799
  137. bl_ui/utils/__init__.pyi +0 -17
  138. blf/__init__.pyi +6 -50
  139. bmesh/__init__.pyi +0 -7
  140. bmesh/geometry/__init__.pyi +0 -3
  141. bmesh/ops/__init__.pyi +5 -450
  142. bmesh/types/__init__.pyi +298 -639
  143. bmesh/utils/__init__.pyi +16 -43
  144. bpy/app/__init__.pyi +66 -58
  145. bpy/app/icons/__init__.pyi +0 -6
  146. bpy/app/timers/__init__.pyi +0 -6
  147. bpy/app/translations/__init__.pyi +1 -16
  148. bpy/msgbus/__init__.pyi +1 -4
  149. bpy/ops/action/__init__.pyi +17 -186
  150. bpy/ops/anim/__init__.pyi +38 -279
  151. bpy/ops/armature/__init__.pyi +20 -191
  152. bpy/ops/asset/__init__.pyi +11 -97
  153. bpy/ops/boid/__init__.pyi +7 -38
  154. bpy/ops/brush/__init__.pyi +3 -104
  155. bpy/ops/buttons/__init__.pyi +4 -71
  156. bpy/ops/cachefile/__init__.pyi +2 -63
  157. bpy/ops/camera/__init__.pyi +0 -11
  158. bpy/ops/clip/__init__.pyi +43 -427
  159. bpy/ops/cloth/__init__.pyi +0 -5
  160. bpy/ops/collection/__init__.pyi +3 -35
  161. bpy/ops/console/__init__.pyi +10 -88
  162. bpy/ops/constraint/__init__.pyi +3 -80
  163. bpy/ops/curve/__init__.pyi +23 -254
  164. bpy/ops/curves/__init__.pyi +54 -149
  165. bpy/ops/cycles/__init__.pyi +1 -14
  166. bpy/ops/dpaint/__init__.pyi +3 -21
  167. bpy/ops/ed/__init__.pyi +10 -82
  168. bpy/ops/export_anim/__init__.pyi +2 -10
  169. bpy/ops/export_scene/__init__.pyi +1 -155
  170. bpy/ops/extensions/__init__.pyi +15 -150
  171. bpy/ops/file/__init__.pyi +29 -216
  172. bpy/ops/fluid/__init__.pyi +13 -70
  173. bpy/ops/font/__init__.pyi +10 -134
  174. bpy/ops/geometry/__init__.pyi +3 -124
  175. bpy/ops/gizmogroup/__init__.pyi +1 -12
  176. bpy/ops/gpencil/__init__.pyi +5 -49
  177. bpy/ops/graph/__init__.pyi +20 -315
  178. bpy/ops/grease_pencil/__init__.pyi +62 -523
  179. bpy/ops/image/__init__.pyi +19 -379
  180. bpy/ops/import_anim/__init__.pyi +2 -16
  181. bpy/ops/import_curve/__init__.pyi +0 -6
  182. bpy/ops/import_scene/__init__.pyi +0 -50
  183. bpy/ops/info/__init__.pyi +4 -35
  184. bpy/ops/lattice/__init__.pyi +3 -33
  185. bpy/ops/marker/__init__.pyi +4 -49
  186. bpy/ops/mask/__init__.pyi +17 -176
  187. bpy/ops/material/__init__.pyi +3 -15
  188. bpy/ops/mball/__init__.pyi +1 -30
  189. bpy/ops/mesh/__init__.pyi +34 -932
  190. bpy/ops/nla/__init__.pyi +22 -183
  191. bpy/ops/node/__init__.pyi +420 -625
  192. bpy/ops/object/__init__.pyi +197 -1239
  193. bpy/ops/outliner/__init__.pyi +47 -327
  194. bpy/ops/paint/__init__.pyi +29 -282
  195. bpy/ops/paintcurve/__init__.pyi +4 -36
  196. bpy/ops/palette/__init__.pyi +3 -27
  197. bpy/ops/particle/__init__.pyi +20 -160
  198. bpy/ops/pointcloud/__init__.pyi +3 -35
  199. bpy/ops/pose/__init__.pyi +29 -234
  200. bpy/ops/poselib/__init__.pyi +19 -66
  201. bpy/ops/preferences/__init__.pyi +9 -177
  202. bpy/ops/ptcache/__init__.pyi +5 -31
  203. bpy/ops/render/__init__.pyi +10 -68
  204. bpy/ops/rigidbody/__init__.pyi +6 -56
  205. bpy/ops/scene/__init__.pyi +23 -168
  206. bpy/ops/screen/__init__.pyi +36 -202
  207. bpy/ops/script/__init__.pyi +1 -12
  208. bpy/ops/sculpt/__init__.pyi +42 -313
  209. bpy/ops/sculpt_curves/__init__.pyi +6 -21
  210. bpy/ops/sequencer/__init__.pyi +187 -644
  211. bpy/ops/sound/__init__.pyi +3 -109
  212. bpy/ops/spreadsheet/__init__.pyi +5 -32
  213. bpy/ops/surface/__init__.pyi +0 -48
  214. bpy/ops/text/__init__.pyi +27 -225
  215. bpy/ops/text_editor/__init__.pyi +0 -5
  216. bpy/ops/texture/__init__.pyi +3 -18
  217. bpy/ops/transform/__init__.pyi +10 -382
  218. bpy/ops/ui/__init__.pyi +29 -154
  219. bpy/ops/uilist/__init__.pyi +0 -13
  220. bpy/ops/uv/__init__.pyi +195 -288
  221. bpy/ops/view2d/__init__.pyi +3 -73
  222. bpy/ops/view3d/__init__.pyi +37 -339
  223. bpy/ops/wm/__init__.pyi +129 -1317
  224. bpy/ops/workspace/__init__.pyi +7 -39
  225. bpy/ops/world/__init__.pyi +2 -10
  226. bpy/path/__init__.pyi +0 -34
  227. bpy/props/__init__.pyi +332 -203
  228. bpy/stub_internal/rna_enums/__init__.pyi +102 -82
  229. bpy/types/__init__.pyi +51712 -89245
  230. bpy/utils/__init__.pyi +4 -75
  231. bpy/utils/previews/__init__.pyi +1 -10
  232. bpy/utils/units/__init__.pyi +0 -12
  233. bpy_extras/anim_utils/__init__.pyi +24 -16
  234. bpy_extras/bmesh_utils/__init__.pyi +0 -1
  235. bpy_extras/id_map_utils/__init__.pyi +14 -6
  236. bpy_extras/image_utils/__init__.pyi +0 -9
  237. bpy_extras/io_utils/__init__.pyi +4 -23
  238. bpy_extras/keyconfig_utils/__init__.pyi +1 -1
  239. bpy_extras/mesh_utils/__init__.pyi +0 -12
  240. bpy_extras/node_shader_utils/__init__.pyi +0 -8
  241. bpy_extras/object_utils/__init__.pyi +0 -14
  242. bpy_extras/view3d_utils/__init__.pyi +0 -18
  243. {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/METADATA +4 -1
  244. fake_bpy_module-20260119.dist-info/RECORD +385 -0
  245. {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/top_level.txt +15 -14
  246. freestyle/chainingiterators/__init__.pyi +0 -22
  247. freestyle/functions/__init__.pyi +0 -139
  248. freestyle/predicates/__init__.pyi +0 -51
  249. freestyle/shaders/__init__.pyi +0 -65
  250. freestyle/types/__init__.pyi +139 -777
  251. freestyle/utils/ContextFunctions/__init__.pyi +0 -23
  252. freestyle/utils/__init__.pyi +0 -6
  253. gpu/capabilities/__init__.pyi +0 -21
  254. gpu/matrix/__init__.pyi +1 -10
  255. gpu/platform/__init__.pyi +0 -5
  256. gpu/shader/__init__.pyi +22 -6
  257. gpu/state/__init__.pyi +59 -38
  258. gpu/texture/__init__.pyi +0 -2
  259. gpu/types/__init__.pyi +84 -152
  260. gpu_extras/batch/__init__.pyi +0 -4
  261. gpu_extras/presets/__init__.pyi +6 -8
  262. idprop/types/__init__.pyi +6 -6
  263. imbuf/__init__.pyi +2 -9
  264. imbuf/types/__init__.pyi +5 -25
  265. keyingsets_builtins/__init__.pyi +1 -45
  266. mathutils/__init__.pyi +106 -2168
  267. mathutils/bvhtree/__init__.pyi +3 -25
  268. mathutils/geometry/__init__.pyi +41 -133
  269. mathutils/interpolate/__init__.pyi +3 -4
  270. mathutils/kdtree/__init__.pyi +0 -11
  271. mathutils/noise/__init__.pyi +0 -62
  272. fake_bpy_module-20250828.dist-info/RECORD +0 -370
  273. {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
  274. {animsys_refactor → _animsys_refactor}/py.typed +0 -0
  275. {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
  276. {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
  277. {bl_console_utils → _bl_console_utils}/py.typed +0 -0
  278. {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
  279. {bl_i18n_utils → _bl_i18n_utils}/py.typed +0 -0
  280. {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +0 -0
  281. {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
  282. {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
  283. {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
  284. {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
  285. {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
  286. {bl_previews_utils → _bl_previews_utils}/py.typed +0 -0
  287. {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
  288. {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
  289. {bl_rna_utils → _bl_rna_utils}/py.typed +0 -0
  290. {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
  291. {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
  292. {bl_text_utils → _bl_text_utils}/py.typed +0 -0
  293. {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
  294. {bl_ui_utils → _bl_ui_utils}/py.typed +0 -0
  295. /_bpy_internal/{freedesktop → platform/freedesktop}/__init__.pyi +0 -0
  296. {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
  297. {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
  298. {console_python → _console_python}/__init__.pyi +0 -0
  299. {console_python → _console_python}/py.typed +0 -0
  300. {console_shell → _console_shell}/__init__.pyi +0 -0
  301. {console_shell → _console_shell}/py.typed +0 -0
  302. {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
  303. {graphviz_export → _graphviz_export}/py.typed +0 -0
  304. {keyingsets_utils → _keyingsets_utils}/__init__.pyi +0 -0
  305. {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
  306. {rna_info → _rna_info}/py.typed +0 -0
  307. {rna_xml → _rna_xml}/__init__.pyi +0 -0
  308. {rna_xml → _rna_xml}/py.typed +0 -0
  309. {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/WHEEL +0 -0
bpy/utils/__init__.pyi CHANGED
@@ -23,7 +23,6 @@ def app_template_paths(*, path: str | None = None) -> None:
23
23
  """Returns valid application template paths.
24
24
 
25
25
  :param path: Optional subdir.
26
- :type path: str | None
27
26
  :return: App template paths.
28
27
  """
29
28
 
@@ -33,31 +32,23 @@ def blend_paths(
33
32
  """Returns a list of paths to external files referenced by the loaded .blend file.
34
33
 
35
34
  :param absolute: When true the paths returned are made absolute.
36
- :type absolute: bool
37
- :param packed: When true skip file paths for packed data.
38
- :type packed: bool
35
+ :param packed: When true include file paths for packed data.
39
36
  :param local: When true skip linked library paths.
40
- :type local: bool
41
37
  :return: path list.
42
- :rtype: list[str]
43
38
  """
44
39
 
45
40
  def escape_identifier(string: str) -> str:
46
41
  """Simple string escaping function used for animation paths.
47
42
 
48
43
  :param string: text
49
- :type string: str
50
44
  :return: The escaped string.
51
- :rtype: str
52
45
  """
53
46
 
54
47
  def execfile(filepath: str, *, mod: None | None = None) -> None:
55
48
  """Execute a file path as a Python script.
56
49
 
57
50
  :param filepath: Path of the script to execute.
58
- :type filepath: str
59
51
  :param mod: Optional cached module, the result of a previous execution.
60
- :type mod: None | None
61
52
  :return: The module which can be passed back in as mod.
62
53
  """
63
54
 
@@ -72,13 +63,9 @@ def extension_path_user(package: str, *, path: str = "", create: bool = False) -
72
63
  """Return a user writable directory associated with an extension.
73
64
 
74
65
  :param package: The __package__ of the extension.
75
- :type package: str
76
66
  :param path: Optional subdirectory.
77
- :type path: str
78
67
  :param create: Treat the path as a directory and create it if its not existing.
79
- :type create: bool
80
68
  :return: a path.
81
- :rtype: str
82
69
  """
83
70
 
84
71
  def flip_name(name: str, *, strip_digits: bool = False) -> str:
@@ -86,27 +73,20 @@ def flip_name(name: str, *, strip_digits: bool = False) -> str:
86
73
  mirroring bone names.
87
74
 
88
75
  :param name: Bone name to flip.
89
- :type name: str
90
76
  :param strip_digits: Whether to remove .### suffix.
91
- :type strip_digits: bool
92
77
  :return: The flipped name.
93
- :rtype: str
94
78
  """
95
79
 
96
80
  def is_path_builtin(path: str) -> bool:
97
81
  """Returns True if the path is one of the built-in paths used by Blender.
98
82
 
99
83
  :param path: Path you want to check if it is in the built-in settings directory
100
- :type path: str
101
- :rtype: bool
102
84
  """
103
85
 
104
86
  def is_path_extension(path: str) -> bool:
105
87
  """Returns True if the path is from an extensions repository.
106
88
 
107
89
  :param path: Path to check if it is within an extension repository.
108
- :type path: str
109
- :rtype: bool
110
90
  """
111
91
 
112
92
  def keyconfig_init() -> None: ...
@@ -121,12 +101,9 @@ def load_scripts(
121
101
 
122
102
  :param reload_scripts: Causes all scripts to have their unregister method
123
103
  called before loading.
124
- :type reload_scripts: bool
125
104
  :param refresh_scripts: only load scripts which are not already loaded
126
105
  as modules.
127
- :type refresh_scripts: bool
128
106
  :param extensions: Loads additional scripts (add-ons & app-templates).
129
- :type extensions: bool
130
107
  """
131
108
 
132
109
  def load_scripts_extensions(*, reload_scripts: bool = False) -> None:
@@ -134,7 +111,6 @@ def load_scripts_extensions(*, reload_scripts: bool = False) -> None:
134
111
 
135
112
  :param reload_scripts: Causes all scripts to have their unregister method
136
113
  called before loading.
137
- :type reload_scripts: bool
138
114
  """
139
115
 
140
116
  def make_rna_paths(
@@ -143,15 +119,11 @@ def make_rna_paths(
143
119
  """Create RNA "paths" from given names.
144
120
 
145
121
  :param struct_name: Name of a RNA struct (like e.g. "Scene").
146
- :type struct_name: str
147
122
  :param prop_name: Name of a RNA structs property.
148
- :type prop_name: str
149
123
  :param enum_name: Name of a RNA enum identifier.
150
- :type enum_name: str
151
124
  :return: A triple of three "RNA paths"
152
125
  (most_complete_path, "struct.prop", "struct.prop:enum").
153
126
  If no enum_name is given, the third element will always be void.
154
- :rtype: tuple[str, str, str]
155
127
  """
156
128
 
157
129
  def manual_language_code(default="en") -> str:
@@ -159,19 +131,16 @@ def manual_language_code(default="en") -> str:
159
131
 
160
132
  :return: The language code used for user manual URL component based on the current language user-preference,
161
133
  falling back to the default when unavailable.
162
- :rtype: str
163
134
  """
164
135
 
165
136
  def manual_map() -> None: ...
166
- def modules_from_path(path: str, loaded_modules) -> list:
137
+ def modules_from_path(path: str, loaded_modules: set) -> list:
167
138
  """Load all modules in a path and return them as a list.
168
139
 
169
140
  :param path: this path is scanned for scripts and packages.
170
- :type path: str
171
141
  :param loaded_modules: already loaded module names, files matching these
172
142
  names will be ignored.
173
143
  :return: all loaded modules.
174
- :rtype: list
175
144
  """
176
145
 
177
146
  def preset_find(name, preset_path, *, display_name=False, ext=".py") -> None: ...
@@ -179,9 +148,7 @@ def preset_paths(subdir: str) -> list[str]:
179
148
  """Returns a list of paths for a specific preset.
180
149
 
181
150
  :param subdir: preset subdirectory (must not be an absolute path).
182
- :type subdir: str
183
151
  :return: Script paths.
184
- :rtype: list[str]
185
152
  """
186
153
 
187
154
  def refresh_script_paths() -> None:
@@ -208,7 +175,6 @@ def register_class(
208
175
  """Register a subclass of a Blender type class.
209
176
 
210
177
  :param cls: Registerable Blender class type.
211
- :type cls: type[bpy.types.Panel | bpy.types.UIList | bpy.types.Menu | bpy.types.Header | bpy.types.Operator | bpy.types.KeyingSetInfo | bpy.types.RenderEngine | bpy.types.AssetShelf | bpy.types.FileHandler | bpy.types.PropertyGroup | bpy.types.AddonPreferences | bpy.types.NodeTree | bpy.types.Node | bpy.types.NodeSocket]
212
178
  """
213
179
 
214
180
  def register_classes_factory(classes) -> None:
@@ -225,11 +191,9 @@ def register_cli_command(id: str, execute: collections.abc.Callable) -> None:
225
191
  :param id: The command identifier (must pass an str.isidentifier check).
226
192
 
227
193
  If the id is already registered, a warning is printed and the command is inaccessible to prevent accidents invoking the wrong command.
228
- :type id: str
229
194
  :param execute: Callback, taking a single list of strings and returns an int.
230
195
  The arguments are built from all command-line arguments following the command id.
231
196
  The return value should be 0 for success, 1 on failure (specific error codes from the os module can also be used).
232
- :type execute: collections.abc.Callable
233
197
  :return: The command handle which can be passed to `unregister_cli_command`.
234
198
 
235
199
  This uses Pythons capsule type however the result should be considered an opaque handle only used for unregistering.
@@ -247,9 +211,7 @@ def register_preset_path(path: str) -> bool:
247
211
  When the __init__.py is in the same location as a presets directory.
248
212
  For example an operators preset would be located under: presets/operator/{operator.id}/
249
213
  where operator.id is the bl_idname of the operator.
250
- :type path: str
251
214
  :return: success
252
- :rtype: bool
253
215
  """
254
216
 
255
217
  def register_submodule_factory(
@@ -260,45 +222,34 @@ def register_submodule_factory(
260
222
  calling their register & unregister functions.
261
223
 
262
224
  :param module_name: The module name, typically __name__.
263
- :type module_name: str
264
225
  :param submodule_names: List of submodule names to load and unload.
265
- :type submodule_names: list[str]
266
226
  :return: register and unregister functions.
267
- :rtype: tuple[collections.abc.Callable[None], collections.abc.Callable[None]]
268
227
  """
269
228
 
270
229
  def register_tool(
271
230
  tool_cls: type[bpy.types.WorkSpaceTool],
272
231
  *,
273
- after: None | collections.abc.Sequence[str] | None = None,
232
+ after: None | collections.abc.Sequence[str] | set[str] | None = None,
274
233
  separator: bool = False,
275
234
  group: bool = False,
276
235
  ) -> None:
277
236
  """Register a tool in the toolbar.
278
237
 
279
238
  :param tool_cls: A tool subclass.
280
- :type tool_cls: type[bpy.types.WorkSpaceTool]
281
239
  :param after: Optional identifiers this tool will be added after.
282
- :type after: None | collections.abc.Sequence[str] | None
283
240
  :param separator: When true, add a separator before this tool.
284
- :type separator: bool
285
241
  :param group: When true, add a new nested group of tools.
286
- :type group: bool
287
242
  """
288
243
 
289
244
  def resource_path(
290
- type: str, *, major: int = bpy.app.version[0], minor: str = bpy.app.version[1]
245
+ type: str, *, major: int = bpy.app.version[0], minor: int = bpy.app.version[1]
291
246
  ) -> str:
292
247
  """Return the base path for storing system files.
293
248
 
294
249
  :param type: string in [USER, LOCAL, SYSTEM].
295
- :type type: str
296
250
  :param major: major version, defaults to current.
297
- :type major: int
298
251
  :param minor: minor version, defaults to current.
299
- :type minor: str
300
252
  :return: the resource path (not necessarily existing).
301
- :rtype: str
302
253
  """
303
254
 
304
255
  def script_path_user() -> None:
@@ -315,17 +266,11 @@ def script_paths(
315
266
  """Returns a list of valid script paths.
316
267
 
317
268
  :param subdir: Optional subdir.
318
- :type subdir: str | None
319
269
  :param user_pref: Include the user preference script paths.
320
- :type user_pref: bool
321
270
  :param check_all: Include local, user and system paths rather just the paths Blender uses.
322
- :type check_all: bool
323
271
  :param use_user: Include user paths
324
- :type use_user: bool
325
272
  :param use_system_environment: Include BLENDER_SYSTEM_SCRIPTS variable path
326
- :type use_system_environment: bool
327
273
  :return: script paths.
328
- :rtype: list[str]
329
274
  """
330
275
 
331
276
  def script_paths_pref() -> None:
@@ -339,9 +284,7 @@ def smpte_from_frame(frame: float, *, fps=None, fps_base=None) -> str:
339
284
  HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
340
285
 
341
286
  :param frame: frame number.
342
- :type frame: float
343
287
  :return: the frame string.
344
- :rtype: str
345
288
  """
346
289
 
347
290
  def smpte_from_seconds(time: float, *, fps=None, fps_base=None) -> str:
@@ -349,16 +292,13 @@ def smpte_from_seconds(time: float, *, fps=None, fps_base=None) -> str:
349
292
  HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
350
293
 
351
294
  :param time: time in seconds.
352
- :type time: float
353
295
  :return: the frame string.
354
- :rtype: str
355
296
  """
356
297
 
357
298
  def time_from_frame(frame: float, *, fps=None, fps_base=None) -> None:
358
299
  """Returns the time from a frame number .If fps and fps_base are not given the current scene is used.
359
300
 
360
301
  :param frame: number.
361
- :type frame: float
362
302
  :return: the time in seconds.
363
303
  """
364
304
 
@@ -367,9 +307,7 @@ def time_to_frame(time: float, *, fps=None, fps_base=None) -> float:
367
307
  as a datetime.timedelta object.If fps and fps_base are not given the current scene is used.
368
308
 
369
309
  :param time: time in seconds.
370
- :type time: float
371
310
  :return: The frame.
372
- :rtype: float
373
311
  """
374
312
 
375
313
  def unescape_identifier(string: str) -> str:
@@ -377,9 +315,7 @@ def unescape_identifier(string: str) -> str:
377
315
  This performs the reverse of `escape_identifier`.
378
316
 
379
317
  :param string: text
380
- :type string: str
381
318
  :return: The un-escaped string.
382
- :rtype: str
383
319
  """
384
320
 
385
321
  def unregister_class(
@@ -405,7 +341,6 @@ def unregister_class(
405
341
  :param cls: Blender type class,
406
342
  see `bpy.utils.register_class` for classes which can
407
343
  be registered.
408
- :type cls: type[bpy.types.Panel | bpy.types.UIList | bpy.types.Menu | bpy.types.Header | bpy.types.Operator | bpy.types.KeyingSetInfo | bpy.types.RenderEngine | bpy.types.AssetShelf | bpy.types.FileHandler | bpy.types.PropertyGroup | bpy.types.AddonPreferences | bpy.types.NodeTree | bpy.types.Node | bpy.types.NodeSocket]
409
344
  """
410
345
 
411
346
  def unregister_cli_command(handle) -> None:
@@ -421,9 +356,7 @@ def unregister_preset_path(path: str) -> bool:
421
356
  :param path: preset directory (must be an absolute path).
422
357
 
423
358
  This must match the registered path exactly.
424
- :type path: str
425
359
  :return: success
426
- :rtype: bool
427
360
  """
428
361
 
429
362
  def unregister_tool(tool_cls) -> None: ...
@@ -431,11 +364,7 @@ def user_resource(resource_type: str, *, path: str = "", create: bool = False) -
431
364
  """Return a user resource path (normally from the users home directory).
432
365
 
433
366
  :param resource_type: Resource type in [DATAFILES, CONFIG, SCRIPTS, EXTENSIONS].
434
- :type resource_type: str
435
367
  :param path: Optional subdirectory.
436
- :type path: str
437
368
  :param create: Treat the path as a directory and create it if its not existing.
438
- :type create: bool
439
369
  :return: a path.
440
- :rtype: str
441
370
  """
@@ -40,36 +40,27 @@ class ImagePreviewCollection(dict[str, bpy.types.ImagePreview]):
40
40
  """Generate a new preview from given file path.
41
41
 
42
42
  :param name: The name (unique id) identifying the preview.
43
- :type name: str | None
44
43
  :param filepath: The file path to generate the preview from.
45
- :type filepath: bytes | str | None
46
- :param filetype: The type of file, needed to generate the preview in [IMAGE, MOVIE, BLEND, FONT].
47
- :type filetype: str | None
44
+ :param filetype: The type of file, needed to generate the preview in [IMAGE, MOVIE, BLEND, FONT, OBJECT_IO].
48
45
  :param force_reload: If True, force running thumbnail manager even if preview already exists in cache.
49
- :type force_reload: bool | None
50
46
  :return: The Preview matching given name, or a new empty one.
51
- :rtype: bpy.types.ImagePreview
52
47
  """
53
48
 
54
49
  def new(self, name: str | None) -> bpy.types.ImagePreview:
55
50
  """Generate a new empty preview.
56
51
 
57
52
  :param name: The name (unique id) identifying the preview.
58
- :type name: str | None
59
53
  :return: The Preview matching given name, or a new empty one.
60
- :rtype: bpy.types.ImagePreview
61
54
  """
62
55
 
63
56
  def new() -> ImagePreviewCollection:
64
57
  """
65
58
 
66
59
  :return: a new preview collection.
67
- :rtype: ImagePreviewCollection
68
60
  """
69
61
 
70
62
  def remove(pcoll: ImagePreviewCollection | None) -> None:
71
63
  """Remove the specified previews collection.
72
64
 
73
65
  :param pcoll: Preview collection to close.
74
- :type pcoll: ImagePreviewCollection | None
75
66
  """
@@ -20,20 +20,13 @@ def to_string(
20
20
  """Convert a given input float value into a string with units.
21
21
 
22
22
  :param unit_system: The unit system, from `bpy.utils.units.systems`.
23
- :type unit_system: str | None
24
23
  :param unit_category: The category of data we are converting (length, area, rotation, etc.),
25
24
  from `bpy.utils.units.categories`.
26
- :type unit_category: str | None
27
25
  :param value: The value to convert to a string.
28
- :type value: float | None
29
26
  :param precision: Number of digits after the comma.
30
- :type precision: int | None
31
27
  :param split_unit: Whether to use several units if needed (1m1cm), or always only one (1.01m).
32
- :type split_unit: bool | None
33
28
  :param compatible_unit: Whether to use keyboard-friendly units (1m2) or nicer UTF8 ones (1m).
34
- :type compatible_unit: bool | None
35
29
  :return: The converted string.
36
- :rtype: str
37
30
  """
38
31
 
39
32
  def to_value(
@@ -46,16 +39,11 @@ def to_value(
46
39
  """Convert a given input string into a float value.
47
40
 
48
41
  :param unit_system: The unit system, from `bpy.utils.units.systems`.
49
- :type unit_system: str | None
50
42
  :param unit_category: The category of data we are converting (length, area, rotation, etc.),
51
43
  from `bpy.utils.units.categories`.
52
- :type unit_category: str | None
53
44
  :param str_input: The string to convert to a float value.
54
- :type str_input: str | None
55
45
  :param str_ref_unit: A reference string from which to extract a default unit, if none is found in str_input.
56
- :type str_ref_unit: None | str | None
57
46
  :return: The converted/interpreted value.
58
- :rtype: float
59
47
  """
60
48
 
61
49
  categories: typing.Any
@@ -4,6 +4,9 @@ import typing_extensions
4
4
  import numpy.typing as npt
5
5
  import bpy.types
6
6
 
7
+ class AutoKeying:
8
+ """Auto-keying support.Retrieve the lock status for 4D rotation."""
9
+
7
10
  class BakeOptions:
8
11
  """BakeOptions(only_selected: bool, do_pose: bool, do_object: bool, do_visual_keying: bool, do_constraint_clear: bool, do_parents_clear: bool, do_clean: bool, do_location: bool, do_rotation: bool, do_scale: bool, do_bbone: bool, do_custom_props: bool)"""
9
12
 
@@ -40,30 +43,31 @@ class KeyframesCo:
40
43
  """
41
44
 
42
45
  def insert_keyframes_into_existing_action(
43
- self, lookup_fcurves, total_new_keys, action, action_slot
46
+ self, lookup_fcurves, total_new_keys, channelbag
44
47
  ) -> None:
45
48
  """Assumes the action already exists, that it might already have F-curves. Otherwise, the
46
49
  only difference between versions is performance and implementation simplicity.
47
50
 
48
51
  :param lookup_fcurves: : This is only used for efficiency.
49
- Its a substitute for action.fcurves.find() which is a potentially expensive linear search.
52
+ Its a substitute for channelbag.fcurves.find() which is a potentially expensive linear search.
50
53
  :param total_new_keys:
51
- :param action:
52
- :param action_slot:
54
+ :param channelbag:
53
55
  """
54
56
 
55
57
  def insert_keyframes_into_new_action(
56
- self, total_new_keys, action, action_group_name: str
58
+ self, total_new_keys, channelbag, group_name
57
59
  ) -> None:
58
60
  """Assumes the action is new, that it has no F-curves. Otherwise, the only difference between versions is
59
61
  performance and implementation simplicity.
60
62
 
61
63
  :param total_new_keys:
62
- :param action:
63
- :param action_group_name: Name of Action Group that F-curves are added to.
64
- :type action_group_name: str
64
+ :param channelbag:
65
+ :param group_name: Name of the Group that F-curves are added to.
65
66
  """
66
67
 
68
+ def action_ensure_channelbag_for_slot(action, slot) -> None:
69
+ """Ensure a layer and a keyframe strip exists, then ensure that strip has a channelbag for the slot."""
70
+
67
71
  def action_get_channelbag_for_slot(action, slot) -> None:
68
72
  """Returns the first channelbag found for the slot.
69
73
  In case there are multiple layers or strips they are iterated until a
@@ -71,21 +75,29 @@ def action_get_channelbag_for_slot(action, slot) -> None:
71
75
 
72
76
  """
73
77
 
78
+ def action_get_first_suitable_slot(action, target_id_type) -> None:
79
+ """Return the first Slot of the given Action thats suitable for the given ID type.Typically you should not need this function; when an Action is assigned to a
80
+ data-block, just use the slot that was assigned along with it.
81
+
82
+ """
83
+
84
+ def animdata_get_channelbag_for_assigned_slot(anim_data) -> None:
85
+ """Return the channelbag used in the given anim_data or None if there is no Action
86
+ + Slot combination defined.
87
+
88
+ """
89
+
74
90
  def bake_action(
75
91
  obj: bpy.types.Object, *, action: None | bpy.types.Action, frames: int, bake_options
76
92
  ) -> None | bpy.types.Action:
77
93
  """
78
94
 
79
95
  :param obj: Object to bake.
80
- :type obj: bpy.types.Object
81
96
  :param action: An action to bake the data into, or None for a new action
82
97
  to be created.
83
- :type action: None | bpy.types.Action
84
98
  :param frames: Frames to bake.
85
- :type frames: int
86
99
  :param bake_options: Options for baking.
87
100
  :return: Action or None.
88
- :rtype: None | bpy.types.Action
89
101
  """
90
102
 
91
103
  def bake_action_iter(
@@ -94,13 +106,10 @@ def bake_action_iter(
94
106
  """An coroutine that bakes action for a single object.
95
107
 
96
108
  :param obj: Object to bake.
97
- :type obj: bpy.types.Object
98
109
  :param action: An action to bake the data into, or None for a new action
99
110
  to be created.
100
- :type action: None | bpy.types.Action
101
111
  :param bake_options: Boolean options of what to include into the action bake.
102
112
  :return: an action or None
103
- :rtype: bpy.types.Action
104
113
  """
105
114
 
106
115
  def bake_action_objects(
@@ -111,7 +120,6 @@ def bake_action_objects(
111
120
  :param frames: Frames to bake.
112
121
  :param bake_options: Options for baking.
113
122
  :return: A sequence of Action or None types (aligned with object_action_pairs)
114
- :rtype: collections.abc.Sequence[bpy.types.Action]
115
123
  """
116
124
 
117
125
  def bake_action_objects_iter(object_action_pairs, bake_options) -> None:
@@ -9,7 +9,6 @@ def bmesh_linked_uv_islands(bm, uv_layer) -> list[list[int]]:
9
9
  :param bm: the bmesh used to group with.
10
10
  :param uv_layer: the UV layer to source UVs from.
11
11
  :return: list of lists containing polygon indices
12
- :rtype: list[list[int]]
13
12
  """
14
13
 
15
14
  def match_uv(face, vert, uv, uv_layer) -> None: ...
@@ -2,12 +2,20 @@ import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
4
  import numpy.typing as npt
5
+ import bpy.types
5
6
 
6
- def get_all_referenced_ids(id, ref_map) -> None:
7
- """Return a set of IDs directly or indirectly referenced by id."""
7
+ def get_all_referenced_ids(
8
+ id: bpy.types.ID, ref_map: dict[bpy.types.ID, set[bpy.types.ID]]
9
+ ) -> set[bpy.types.ID]:
10
+ """Return a set of IDs directly or indirectly referenced by id.
8
11
 
9
- def get_id_reference_map() -> None:
10
- """Return a dictionary of direct data-block references for every data-block in the blend file."""
12
+ :param id: Datablock whose references were interested in.
13
+ :param ref_map: The global ID reference map, retrieved from get_id_reference_map()
14
+ :return: Set of datablocks referenced by id.
15
+ """
11
16
 
12
- def recursive_get_referenced_ids(ref_map, id, referenced_ids, visited) -> None:
13
- """Recursively populate referenced_ids with IDs referenced by id."""
17
+ def get_id_reference_map() -> dict[bpy.types.ID, set[bpy.types.ID]]:
18
+ """Return a dictionary of direct data-block references for every data-block in the blend file.
19
+
20
+ :return: Each datablock of the .blend file mapped to the set of IDs they directly reference.
21
+ """
@@ -21,32 +21,23 @@ def load_image(
21
21
 
22
22
  :param dirname: is the directory where the image may be located - any file at
23
23
  the end will be ignored.
24
- :type dirname: str
25
24
  :param place_holder: if True a new place holder image will be created.
26
25
  this is useful so later you can relink the image to its original data.
27
- :type place_holder: bool
28
26
  :param recursive: If True, directories will be recursively searched.
29
27
  Be careful with this if you have files in your root directory because
30
28
  it may take a long time.
31
- :type recursive: bool
32
29
  :param ncase_cmp: on non windows systems, find the correct case for the file.
33
- :type ncase_cmp: bool
34
30
  :param convert_callback: a function that takes an existing path and returns
35
31
  a new one. Use this when loading image formats blender may not support,
36
32
  the CONVERT_CALLBACK can take the path for a GIF (for example),
37
33
  convert it to a PNG and return the PNGs path.
38
34
  For formats blender can read, simply return the path that is given.
39
- :type convert_callback: typing.Any | None
40
35
  :param relpath: If not None, make the file relative to this path.
41
- :type relpath: None | str | None
42
36
  :param check_existing: If true,
43
37
  returns already loaded image data-block if possible
44
38
  (based on file path).
45
- :type check_existing: bool
46
39
  :param force_reload: If true,
47
40
  force reloading of image (only useful when check_existing
48
41
  is also enabled).
49
- :type force_reload: bool
50
42
  :return: an image or None
51
- :rtype: None | bpy.types.Image
52
43
  """
@@ -41,8 +41,9 @@ class ImportHelper:
41
41
  """
42
42
 
43
43
  def axis_conversion(from_forward="Y", from_up="Z", to_forward="Y", to_up="Z") -> None:
44
- """Each argument us an axis in [X, Y, Z, -X, -Y, -Z]
44
+ """Each argument is an axis in [X, Y, Z, -X, -Y, -Z]
45
45
  where the first 2 are a source and the second 2 are the target.
46
+ :rtype: `mathutils.Matrix`
46
47
 
47
48
  """
48
49
 
@@ -53,13 +54,9 @@ def axis_conversion_ensure(
53
54
  to be used from `bpy.types.Operator.check`.
54
55
 
55
56
  :param operator: the operator to access axis attributes from.
56
- :type operator: bpy.types.Operator
57
57
  :param forward_attr: attribute storing the forward axis
58
- :type forward_attr: str
59
58
  :param up_attr: attribute storing the up axis
60
- :type up_attr: str
61
59
  :return: True if the value was modified.
62
- :rtype: bool
63
60
  """
64
61
 
65
62
  def create_derived_objects(
@@ -68,12 +65,9 @@ def create_derived_objects(
68
65
  """This function takes a sequence of objects, returning their instances.
69
66
 
70
67
  :param depsgraph: The evaluated depsgraph.
71
- :type depsgraph: bpy.types.Depsgraph
72
68
  :param objects: A sequencer of objects.
73
- :type objects: collections.abc.Sequence[bpy.types.Object]
74
69
  :return: A dictionary where each key is an object from objects,
75
70
  values are lists of (object, matrix) tuples representing instances.
76
- :rtype: dict[bpy.types.Object, list[tuple[bpy.types.Object, mathutils.Matrix]]]
77
71
  """
78
72
 
79
73
  def orientation_helper(axis_forward="Y", axis_up="Z") -> None:
@@ -88,7 +82,7 @@ def path_reference(
88
82
  base_dst: str,
89
83
  mode: str = "AUTO",
90
84
  copy_subdir: str = "",
91
- copy_set=None,
85
+ copy_set: set[tuple[str, str]] | None = None,
92
86
  library: None | bpy.types.Library | None = None,
93
87
  ) -> str:
94
88
  """Return a filepath relative to a destination directory, for use with
@@ -96,34 +90,26 @@ def path_reference(
96
90
 
97
91
  :param filepath: the file path to return,
98
92
  supporting blenders relative // prefix.
99
- :type filepath: str
100
93
  :param base_src: the directory the filepath is relative too
101
94
  (normally the blend file).
102
- :type base_src: str
103
95
  :param base_dst: the directory the filepath will be referenced from
104
96
  (normally the export path).
105
- :type base_dst: str
106
97
  :param mode: the method used get the path in
107
98
  [AUTO, ABSOLUTE, RELATIVE, MATCH, STRIP, COPY]
108
- :type mode: str
109
99
  :param copy_subdir: the subdirectory of base_dst to use when mode=COPY.
110
- :type copy_subdir: str
111
100
  :param copy_set: collect from/to pairs when mode=COPY,
112
101
  pass to path_reference_copy when exporting is done.
113
102
  :param library: The library this path is relative to.
114
- :type library: None | bpy.types.Library | None
115
103
  :return: the new filepath.
116
- :rtype: str
117
104
  """
118
105
 
119
106
  def path_reference_copy(
120
- copy_set, report: collections.abc.Callable[str, None] = print
107
+ copy_set: set[tuple[str, str]], report: collections.abc.Callable[str, None] = print
121
108
  ) -> None:
122
109
  """Execute copying files of path_reference
123
110
 
124
111
  :param copy_set: set of (from, to) pairs to copy.
125
112
  :param report: function used for reporting warnings, takes a string argument.
126
- :type report: collections.abc.Callable[str, None]
127
113
  """
128
114
 
129
115
  def poll_file_object_drop(context) -> None:
@@ -147,18 +133,13 @@ def unique_name(
147
133
  when available.
148
134
  This can be the object, mesh, material, etc instance itself.
149
135
  Any hashable object associated with the name.
150
- :type key: typing.Any
151
136
  :param name: The name used to create a unique value in name_dict.
152
- :type name: str
153
137
  :param name_dict: This is used to cache namespace to ensure no collisions
154
138
  occur, this should be an empty dict initially and only modified by this
155
139
  function.
156
- :type name_dict: dict
157
140
  :param clean_func: Function to call on name before creating a unique value.
158
- :type clean_func: typing.Any | None
159
141
  :param sep: Separator to use when between the name and a number when a
160
142
  duplicate name is found.
161
- :type sep: str
162
143
  """
163
144
 
164
145
  def unpack_face_list(list_of_tuples) -> None: ...
@@ -4,7 +4,7 @@ import typing_extensions
4
4
  import numpy.typing as npt
5
5
 
6
6
  def addon_keymap_register(keymap_data) -> None:
7
- """Register a set of keymaps for addons using a list of keymaps.See blender_defaults.py for examples of the format this takes."""
7
+ """Register a set of keymaps for addons using a list of keymaps.See blender_default.py for examples of the format this takes."""
8
8
 
9
9
  def addon_keymap_unregister(keymap_data) -> None:
10
10
  """Unregister a set of keymaps for addons."""