fake-bpy-module 20241102__py3-none-any.whl → 20241111__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 (57) hide show
  1. addon_utils/__init__.pyi +28 -13
  2. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +1 -2
  3. bl_console_utils/autocomplete/complete_import/__init__.pyi +3 -6
  4. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +1 -2
  5. bl_console_utils/autocomplete/intellisense/__init__.pyi +2 -6
  6. bl_operators/image_as_planes/__init__.pyi +12 -39
  7. bl_operators/uvcalc_transform/__init__.pyi +4 -42
  8. bl_operators/wm/__init__.pyi +8 -0
  9. bl_ui/generic_ui_list/__init__.pyi +2 -1
  10. bl_ui/properties_grease_pencil_common/__init__.pyi +0 -7
  11. bl_ui/space_userpref/__init__.pyi +2 -2
  12. blf/__init__.pyi +3 -5
  13. bmesh/ops/__init__.pyi +53 -110
  14. bmesh/types/__init__.pyi +22 -33
  15. bmesh/utils/__init__.pyi +6 -16
  16. bpy/app/icons/__init__.pyi +5 -11
  17. bpy/app/translations/__init__.pyi +7 -14
  18. bpy/msgbus/__init__.pyi +7 -8
  19. bpy/ops/curves/__init__.pyi +16 -0
  20. bpy/ops/nla/__init__.pyi +1 -1
  21. bpy/ops/sequencer/__init__.pyi +3 -0
  22. bpy/path/__init__.pyi +6 -16
  23. bpy/props/__init__.pyi +122 -135
  24. bpy/types/__init__.pyi +368 -606
  25. bpy/utils/__init__.pyi +30 -29
  26. bpy/utils/previews/__init__.pyi +1 -2
  27. bpy/utils/units/__init__.pyi +1 -2
  28. bpy_extras/anim_utils/__init__.pyi +8 -12
  29. bpy_extras/bmesh_utils/__init__.pyi +1 -2
  30. bpy_extras/image_utils/__init__.pyi +2 -5
  31. bpy_extras/io_utils/__init__.pyi +8 -14
  32. bpy_extras/mesh_utils/__init__.pyi +14 -29
  33. bpy_extras/object_utils/__init__.pyi +1 -1
  34. bpy_extras/view3d_utils/__init__.pyi +3 -10
  35. {fake_bpy_module-20241102.dist-info → fake_bpy_module-20241111.dist-info}/METADATA +1 -1
  36. {fake_bpy_module-20241102.dist-info → fake_bpy_module-20241111.dist-info}/RECORD +57 -57
  37. freestyle/chainingiterators/__init__.pyi +2 -7
  38. freestyle/functions/__init__.pyi +4 -16
  39. freestyle/types/__init__.pyi +29 -63
  40. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  41. freestyle/utils/__init__.pyi +1 -2
  42. gpu/__init__.pyi +19 -5
  43. gpu/matrix/__init__.pyi +2 -2
  44. gpu/state/__init__.pyi +16 -8
  45. gpu/types/__init__.pyi +14 -29
  46. gpu_extras/batch/__init__.pyi +9 -9
  47. gpu_extras/presets/__init__.pyi +4 -11
  48. idprop/types/__init__.pyi +1 -2
  49. imbuf/__init__.pyi +2 -4
  50. mathutils/__init__.pyi +30 -95
  51. mathutils/bvhtree/__init__.pyi +14 -18
  52. mathutils/geometry/__init__.pyi +39 -52
  53. mathutils/interpolate/__init__.pyi +2 -2
  54. mathutils/kdtree/__init__.pyi +13 -28
  55. rna_info/__init__.pyi +1 -2
  56. {fake_bpy_module-20241102.dist-info → fake_bpy_module-20241111.dist-info}/WHEEL +0 -0
  57. {fake_bpy_module-20241102.dist-info → fake_bpy_module-20241111.dist-info}/top_level.txt +0 -0
addon_utils/__init__.pyi CHANGED
@@ -21,7 +21,8 @@ def disable(
21
21
  module_name: str,
22
22
  *,
23
23
  default_set: bool = False,
24
- handle_error: typing.Any | None = None,
24
+ refresh_handled=False,
25
+ handle_error: collections.abc.Callable | None = None,
25
26
  ):
26
27
  """Disables an addon by name.
27
28
 
@@ -30,7 +31,7 @@ def disable(
30
31
  :param default_set: Set the user-preference.
31
32
  :type default_set: bool
32
33
  :param handle_error: Called in the case of an error, taking an exception argument.
33
- :type handle_error: typing.Any | None
34
+ :type handle_error: collections.abc.Callable | None
34
35
  """
35
36
 
36
37
  def disable_all(): ...
@@ -39,22 +40,36 @@ def enable(
39
40
  *,
40
41
  default_set: bool = False,
41
42
  persistent: bool = False,
42
- handle_error: typing.Any | None = None,
43
+ refresh_handled: bool = False,
44
+ handle_error: collections.abc.Callable | None = None,
43
45
  ):
44
46
  """Enables an addon by name.
45
47
 
46
- :param module_name: the name of the addon and module.
47
- :type module_name: str
48
- :param default_set: Set the user-preference.
49
- :type default_set: bool
50
- :param persistent: Ensure the addon is enabled for the entire session (after loading new files).
51
- :type persistent: bool
52
- :param handle_error: Called in the case of an error, taking an exception argument.
53
- :type handle_error: typing.Any | None
54
- :return: the loaded module or None on failure.
48
+ :param module_name: the name of the addon and module.
49
+ :type module_name: str
50
+ :param default_set: Set the user-preference.
51
+ :type default_set: bool
52
+ :param persistent: Ensure the addon is enabled for the entire session (after loading new files).
53
+ :type persistent: bool
54
+ :param refresh_handled: When true, `extensions_refresh` must have been called with module_name
55
+ included in addon_modules_pending.
56
+ This should be used to avoid many calls to refresh extensions when enabling multiple add-ons at once.
57
+ :type refresh_handled: bool
58
+ :param handle_error: Called in the case of an error, taking an exception argument.
59
+ :type handle_error: collections.abc.Callable | None
60
+ :return: the loaded module or None on failure.
61
+ """
62
+
63
+ def extensions_refresh(ensure_wheels: bool = True, addon_modules_pending=None):
64
+ """Ensure data relating to extensions is up to date.
65
+ This should be called after extensions on the file-system have changed.
66
+
67
+ :param ensure_wheels: When true, refresh installed wheels with wheels used by extensions.
68
+ :type ensure_wheels: bool
69
+ :param addon_modules_pending: Refresh these add-ons by listing their package names, as if they are enabled.
70
+ This is needed so wheels can be setup before the add-on is enabled.
55
71
  """
56
72
 
57
- def extensions_refresh(ensure_wheels=True, addon_modules_pending=None): ...
58
73
  def module_bl_info(mod, *, info_basis=None): ...
59
74
  def modules(*, module_cache={}, refresh=True): ...
60
75
  def modules_refresh(*, module_cache={}): ...
@@ -2,7 +2,7 @@ import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
4
 
5
- def complete(line: str, cursor: int, namespace: dict) -> str:
5
+ def complete(line: str, cursor: int, namespace) -> str:
6
6
  """Complete callable with call-tip.
7
7
 
8
8
  :param line: incomplete text line
@@ -10,7 +10,6 @@ def complete(line: str, cursor: int, namespace: dict) -> str:
10
10
  :param cursor: current character position
11
11
  :type cursor: int
12
12
  :param namespace: namespace
13
- :type namespace: dict
14
13
  :return: (matches, world, scrollback)
15
14
  :rtype: str
16
15
  """
@@ -2,7 +2,7 @@ import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
4
 
5
- def complete(line: str) -> list:
5
+ def complete(line: str):
6
6
  """Returns a list containing the completion possibilities for an import line.
7
7
 
8
8
  :param line: incomplete line which contains an import statement:
@@ -11,23 +11,20 @@ def complete(line: str) -> list:
11
11
  from xml.dom import
12
12
  :type line: str
13
13
  :return: list of completion possibilities
14
- :rtype: list
15
14
  """
16
15
 
17
- def get_root_modules() -> list:
16
+ def get_root_modules():
18
17
  """Returns a list containing the names of all the modules available in the
19
18
  folders of the python-path.
20
19
 
21
20
  :return: modules
22
- :rtype: list
23
21
  """
24
22
 
25
- def module_list(path: str) -> list:
23
+ def module_list(path: str):
26
24
  """Return the list containing the names of the modules available in
27
25
  the given folder.
28
26
 
29
27
  :param path: folder path
30
28
  :type path: str
31
29
  :return: modules
32
- :rtype: list
33
30
  """
@@ -32,13 +32,12 @@ def complete_indices(
32
32
  :rtype: list[str]
33
33
  """
34
34
 
35
- def complete_names(word: str, namespace: dict) -> list[str]:
35
+ def complete_names(word: str, namespace) -> list[str]:
36
36
  """Complete variable names or attributes
37
37
 
38
38
  :param word: word to be completed
39
39
  :type word: str
40
40
  :param namespace: namespace
41
- :type namespace: dict
42
41
  :return: completion matches
43
42
  :rtype: list[str]
44
43
  """
@@ -2,7 +2,7 @@ import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
4
 
5
- def complete(line: str, cursor: int, namespace: dict, private: bool) -> list | str:
5
+ def complete(line: str, cursor: int, namespace: dict, private: bool):
6
6
  """Returns a list of possible completions:
7
7
 
8
8
  :param line: incomplete text line
@@ -14,12 +14,9 @@ def complete(line: str, cursor: int, namespace: dict, private: bool) -> list | s
14
14
  :param private: whether private variables should be listed
15
15
  :type private: bool
16
16
  :return: list of completions, word
17
- :rtype: list | str
18
17
  """
19
18
 
20
- def expand(
21
- line: str, cursor: int, namespace: dict, *, private: bool = True
22
- ) -> int | str:
19
+ def expand(line: str, cursor: int, namespace, *, private: bool = True) -> int | str:
23
20
  """This method is invoked when the user asks auto-completion,
24
21
  e.g. when Ctrl+Space is clicked.
25
22
 
@@ -28,7 +25,6 @@ def expand(
28
25
  :param cursor: current character position
29
26
  :type cursor: int
30
27
  :param namespace: namespace
31
- :type namespace: dict
32
28
  :param private: whether private variables should be listed
33
29
  :type private: bool
34
30
  :return: current expanded line, updated cursor position and scrollback
@@ -76,7 +76,7 @@ class IMAGE_OT_import_as_mesh_planes(
76
76
  t: typing.Any
77
77
 
78
78
  def align_plane(self, context, plane):
79
- """Pick an axis and align the plane to it
79
+ """
80
80
 
81
81
  :param context:
82
82
  :param plane:
@@ -110,7 +110,7 @@ class IMAGE_OT_import_as_mesh_planes(
110
110
  """
111
111
 
112
112
  def compute_plane_size(self, context, img_spec):
113
- """Given the image size in pixels and location, determine size of plane
113
+ """
114
114
 
115
115
  :param context:
116
116
  :param img_spec:
@@ -169,7 +169,7 @@ class IMAGE_OT_import_as_mesh_planes(
169
169
  """
170
170
 
171
171
  def update_size_mode(self, _context):
172
- """If sizing relative to the camera, always face the camera
172
+ """
173
173
 
174
174
  :param _context:
175
175
  """
@@ -200,44 +200,17 @@ class TextureProperties_MixIn:
200
200
  """
201
201
 
202
202
  def apply_texture_options(self_, texture, img_spec): ...
203
- def auto_align_nodes(node_tree):
204
- """Given a shader node tree, arrange nodes neatly relative to the output node."""
205
-
206
- def center_in_camera(camera, ob, axis=(1, 1)):
207
- """Center object along specified axis of the camera"""
208
-
209
- def clean_node_tree(node_tree):
210
- """Clear all nodes in a shader node tree except the output.Returns the output node"""
211
-
212
- def compute_camera_size(context, center, fill_mode, aspect):
213
- """Determine how large an object needs to be to fit or fill the camera's field of view."""
214
-
203
+ def auto_align_nodes(node_tree): ...
204
+ def center_in_camera(camera, ob, axis=(1, 1)): ...
205
+ def clean_node_tree(node_tree): ...
206
+ def compute_camera_size(context, center, fill_mode, aspect): ...
215
207
  def create_cycles_material(self_, context, img_spec, name): ...
216
208
  def create_cycles_texnode(self_, node_tree, img_spec): ...
217
- def find_image_sequences(files):
218
- """From a group of files, detect image sequences.This returns a generator of tuples, which contain the filename,
219
- start frame, and length of the detected sequence
220
-
221
- """
222
-
223
- def get_input_nodes(node, links):
224
- """Get nodes that are a inputs to the given node"""
225
-
209
+ def find_image_sequences(files): ...
210
+ def get_input_nodes(node, links): ...
226
211
  def get_ref_object_space_coord(ob): ...
227
- def get_shadeless_node(dest_node_tree):
228
- """Return a "shadeless" cycles/EEVEE node, creating a node group if nonexistent"""
229
-
212
+ def get_shadeless_node(dest_node_tree): ...
230
213
  def load_images(
231
214
  filenames, directory, force_reload=False, frame_start=1, find_sequences=False
232
- ):
233
- """Wrapper for bpy_extras.image_utils.load_image.Loads a set of images, movies, or even image sequences
234
- Returns a generator of ImageSpec wrapper objects later used for texture setup
235
-
236
- """
237
-
238
- def offset_planes(planes, gap, axis):
239
- """Offset planes from each other by gap amount along a _local_ vector axisFor example, offset_planes([obj1, obj2], 0.5, Vector(0, 0, 1)) will place
240
- obj2 0.5 blender units away from obj1 along the local positive Z axis.This is in local space, not world space, so all planes should share
241
- a common scale and rotation.
242
-
243
- """
215
+ ): ...
216
+ def offset_planes(planes, gap, axis): ...
@@ -1,7 +1,6 @@
1
1
  import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
- import bmesh.types
5
4
  import bpy.types
6
5
 
7
6
  class AlignUVRotation(bpy.types.Operator):
@@ -90,47 +89,10 @@ def find_rotation_edge(bm, uv_layer, faces, aspect_y): ...
90
89
  def find_rotation_geometry(bm, uv_layer, faces, method, axis, aspect_y): ...
91
90
  def get_aspect_y(context): ...
92
91
  def get_random_transform(transform_params, entropy): ...
93
- def is_face_uv_selected(face: bmesh.types.BMFace, uv_layer, any_edge: bool) -> bool:
94
- """Returns True if the face is UV selected.
95
-
96
- :param face: the face to query.
97
- :type face: bmesh.types.BMFace
98
- :param uv_layer: the UV layer to source UVs from.
99
- :param any_edge: use edge selection instead of vertex selection.
100
- :type any_edge: bool
101
- :return: True if the face is UV selected.
102
- :rtype: bool
103
- """
104
-
105
- def is_island_uv_selected(island, uv_layer, any_edge: bool) -> bool:
106
- """Returns True if the island is UV selected.
107
-
108
- :param island: list of faces to query.
109
- :param uv_layer: the UV layer to source UVs from.
110
- :param any_edge: use edge selection instead of vertex selection.
111
- :type any_edge: bool
112
- :return: list of lists containing polygon indices.
113
- :rtype: bool
114
- """
115
-
116
- def island_uv_bounds(island, uv_layer) -> list:
117
- """The UV bounds of UV island.
118
-
119
- :param island: list of faces to query.
120
- :param uv_layer: the UV layer to source UVs from.
121
- :return: U-min, V-min, U-max, V-max.
122
- :rtype: list
123
- """
124
-
125
- def island_uv_bounds_center(island, uv_layer) -> tuple:
126
- """The UV bounds center of UV island.
127
-
128
- :param island: list of faces to query.
129
- :param uv_layer: the UV layer to source UVs from.
130
- :return: U, V center.
131
- :rtype: tuple
132
- """
133
-
92
+ def is_face_uv_selected(face, uv_layer, any_edge): ...
93
+ def is_island_uv_selected(island, uv_layer, any_edge): ...
94
+ def island_uv_bounds(island, uv_layer): ...
95
+ def island_uv_bounds_center(island, uv_layer): ...
134
96
  def randomize_uv_transform(context, transform_params): ...
135
97
  def randomize_uv_transform_bmesh(mesh, bm, transform_params): ...
136
98
  def randomize_uv_transform_island(bm, uv_layer, faces, transform_params): ...
@@ -1337,6 +1337,14 @@ class WM_OT_tool_set_by_id(bpy.types.Operator):
1337
1337
  :param context:
1338
1338
  """
1339
1339
 
1340
+ @staticmethod
1341
+ def space_type_from_operator(op, context):
1342
+ """
1343
+
1344
+ :param op:
1345
+ :param context:
1346
+ """
1347
+
1340
1348
  class WM_OT_tool_set_by_index(bpy.types.Operator):
1341
1349
  """Set the tool by index (for key-maps)"""
1342
1350
 
@@ -128,7 +128,7 @@ def draw_ui_list(
128
128
  move_operators: str = True,
129
129
  menu_class_name: str = "",
130
130
  **kwargs,
131
- ):
131
+ ) -> bpy.types.UILayout:
132
132
  """Draw a UIList with Add/Remove/Move buttons and a menu.Additional keyword arguments are passed to `UIList.template_list`.
133
133
 
134
134
  :param layout: UILayout to draw the list in.
@@ -151,4 +151,5 @@ def draw_ui_list(
151
151
  :param menu_class_name: Identifier of a Menu that should be drawn as a drop-down.
152
152
  :type menu_class_name: str
153
153
  :return: The right side column.
154
+ :rtype: bpy.types.UILayout
154
155
  """
@@ -433,10 +433,3 @@ class GreasePencilSimplifyPanel:
433
433
 
434
434
  :param context:
435
435
  """
436
-
437
- class GreasePencilVertexcolorPanel:
438
- def draw(self, context):
439
- """
440
-
441
- :param context:
442
- """
@@ -2398,10 +2398,10 @@ class USERPREF_PT_system_display_graphics(
2398
2398
  """
2399
2399
 
2400
2400
  @classmethod
2401
- def poll(cls, _context):
2401
+ def poll(cls, context):
2402
2402
  """
2403
2403
 
2404
- :param _context:
2404
+ :param context:
2405
2405
  """
2406
2406
 
2407
2407
  class USERPREF_PT_system_memory(CenterAlignMixIn, SystemPanel, bpy.types.Panel):
blf/__init__.pyi CHANGED
@@ -5,7 +5,7 @@ This module provides access to Blender's text drawing functions.
5
5
  --------------------
6
6
 
7
7
  Example of using the blf module. For this module to work we
8
- need to use the OpenGL wrapper ~bgl as well.
8
+ need to use the GPU module gpu as well.
9
9
 
10
10
  ```../examples/blf.py```
11
11
 
@@ -91,11 +91,10 @@ def enable(fontid: int, option: int):
91
91
  :type option: int
92
92
  """
93
93
 
94
- def load(filepath: bytes | str) -> int:
94
+ def load(filepath) -> int:
95
95
  """Load a new font.
96
96
 
97
97
  :param filepath: the filepath of the font.
98
- :type filepath: bytes | str
99
98
  :return: the new font's fontid or -1 if there was an error.
100
99
  :rtype: int
101
100
  """
@@ -159,11 +158,10 @@ def size(fontid: int, size: float):
159
158
  :type size: float
160
159
  """
161
160
 
162
- def unload(filepath: bytes | str):
161
+ def unload(filepath):
163
162
  """Unload an existing font.
164
163
 
165
164
  :param filepath: the filepath of the font.
166
- :type filepath: bytes | str
167
165
  """
168
166
 
169
167
  def word_wrap(fontid: int, wrap_width: int):