fake-bpy-module 20241206__py3-none-any.whl → 20241208__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 (40) hide show
  1. addon_utils/__init__.pyi +2 -1
  2. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +5 -2
  3. bl_console_utils/autocomplete/complete_import/__init__.pyi +6 -3
  4. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -1
  5. bl_console_utils/autocomplete/intellisense/__init__.pyi +8 -2
  6. blf/__init__.pyi +2 -1
  7. bmesh/ops/__init__.pyi +110 -53
  8. bmesh/types/__init__.pyi +18 -10
  9. bmesh/utils/__init__.pyi +14 -4
  10. bpy/app/icons/__init__.pyi +4 -1
  11. bpy/app/translations/__init__.pyi +4 -1
  12. bpy/msgbus/__init__.pyi +8 -5
  13. bpy/path/__init__.pyi +4 -2
  14. bpy/types/__init__.pyi +80 -36
  15. bpy/utils/__init__.pyi +18 -9
  16. bpy_extras/bmesh_utils/__init__.pyi +2 -1
  17. bpy_extras/io_utils/__init__.pyi +7 -2
  18. bpy_extras/mesh_utils/__init__.pyi +19 -7
  19. bpy_extras/view3d_utils/__init__.pyi +2 -2
  20. {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/METADATA +1 -1
  21. {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/RECORD +40 -40
  22. freestyle/functions/__init__.pyi +16 -4
  23. freestyle/types/__init__.pyi +60 -23
  24. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  25. freestyle/utils/__init__.pyi +1 -1
  26. gpu/capabilities/__init__.pyi +2 -1
  27. gpu/state/__init__.pyi +2 -2
  28. gpu/types/__init__.pyi +2 -2
  29. gpu_extras/batch/__init__.pyi +6 -3
  30. idprop/types/__init__.pyi +4 -3
  31. imbuf/__init__.pyi +2 -1
  32. imbuf/types/__init__.pyi +5 -2
  33. mathutils/__init__.pyi +25 -14
  34. mathutils/bvhtree/__init__.pyi +8 -7
  35. mathutils/geometry/__init__.pyi +38 -17
  36. mathutils/interpolate/__init__.pyi +2 -1
  37. mathutils/kdtree/__init__.pyi +11 -6
  38. mathutils/noise/__init__.pyi +2 -1
  39. {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/WHEEL +0 -0
  40. {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/top_level.txt +0 -0
bmesh/types/__init__.pyi CHANGED
@@ -29,7 +29,7 @@ class BMDeformVert:
29
29
  def clear(self):
30
30
  """Clears all weights."""
31
31
 
32
- def get(self, key: int, default=None):
32
+ def get(self, key: int, default: typing.Any | None = None):
33
33
  """Returns the deform weight matching the key or default
34
34
  when not found (matches Python's dictionary function of the same name).
35
35
 
@@ -37,27 +37,31 @@ class BMDeformVert:
37
37
  :type key: int
38
38
  :param default: Optional argument for the value to return if
39
39
  key is not found.
40
+ :type default: typing.Any | None
40
41
  """
41
42
 
42
- def items(self):
43
+ def items(self) -> list[tuple[int, float]]:
43
44
  """Return (group, weight) pairs for this vertex
44
45
  (matching Python's dict.items() functionality).
45
46
 
46
47
  :return: (key, value) pairs for each deform weight of this vertex.
48
+ :rtype: list[tuple[int, float]]
47
49
  """
48
50
 
49
- def keys(self):
51
+ def keys(self) -> list[int]:
50
52
  """Return the group indices used by this vertex
51
53
  (matching Python's dict.keys() functionality).
52
54
 
53
55
  :return: the deform group this vertex uses
56
+ :rtype: list[int]
54
57
  """
55
58
 
56
- def values(self):
59
+ def values(self) -> list[float]:
57
60
  """Return the weights of the deform vertex
58
61
  (matching Python's dict.values() functionality).
59
62
 
60
63
  :return: The weights that influence this vertex
64
+ :rtype: list[float]
61
65
  """
62
66
 
63
67
  class BMEdge:
@@ -153,20 +157,22 @@ class BMEdge:
153
157
  :type: BMElemSeq[BMVert]
154
158
  """
155
159
 
156
- def calc_face_angle(self, fallback=None) -> float:
160
+ def calc_face_angle(self, fallback: typing.Any | None = None) -> float:
157
161
  """
158
162
 
159
163
  :param fallback: return this when the edge doesn't have 2 faces
160
164
  (instead of raising a `ValueError`).
165
+ :type fallback: typing.Any | None
161
166
  :return: The angle between 2 connected faces in radians.
162
167
  :rtype: float
163
168
  """
164
169
 
165
- def calc_face_angle_signed(self, fallback=None) -> float:
170
+ def calc_face_angle_signed(self, fallback: typing.Any | None = None) -> float:
166
171
  """
167
172
 
168
173
  :param fallback: return this when the edge doesn't have 2 faces
169
174
  (instead of raising a `ValueError`).
175
+ :type fallback: typing.Any | None
170
176
  :return: The angle between 2 connected faces in radians (negative for concave join).
171
177
  :rtype: float
172
178
  """
@@ -959,11 +965,12 @@ class BMLayerCollection[_GenericType1]:
959
965
  :rtype: list[str, BMLayerItem[_GenericType1]]
960
966
  """
961
967
 
962
- def keys(self):
968
+ def keys(self) -> list[str]:
963
969
  """Return the identifiers of collection members
964
970
  (matching Python's dict.keys() functionality).
965
971
 
966
972
  :return: the identifiers for each member of this collection.
973
+ :rtype: list[str]
967
974
  """
968
975
 
969
976
  def new(self, name: str | None = "") -> BMLayerItem[_GenericType1]:
@@ -1308,11 +1315,12 @@ class BMVert:
1308
1315
  :type: bool
1309
1316
  """
1310
1317
 
1311
- def calc_edge_angle(self, fallback=None) -> float:
1318
+ def calc_edge_angle(self, fallback: typing.Any | None = None) -> float:
1312
1319
  """Return the angle between this vert's two connected edges.
1313
1320
 
1314
1321
  :param fallback: return this when the vert doesn't have 2 edges
1315
1322
  (instead of raising a `ValueError`).
1323
+ :type fallback: typing.Any | None
1316
1324
  :return: Angle between edges in radians.
1317
1325
  :rtype: float
1318
1326
  """
@@ -1529,11 +1537,11 @@ class BMesh:
1529
1537
  :type: BMVertSeq
1530
1538
  """
1531
1539
 
1532
- def calc_loop_triangles(self) -> BMLoop:
1540
+ def calc_loop_triangles(self) -> list[tuple[BMLoop, BMLoop, BMLoop]]:
1533
1541
  """Calculate triangle tessellation from quads/ngons.
1534
1542
 
1535
1543
  :return: The triangulated faces.
1536
- :rtype: BMLoop
1544
+ :rtype: list[tuple[BMLoop, BMLoop, BMLoop]]
1537
1545
  """
1538
1546
 
1539
1547
  def calc_volume(self, signed: bool = False) -> float:
bmesh/utils/__init__.pyi CHANGED
@@ -20,7 +20,9 @@ def edge_rotate(edge: bmesh.types.BMEdge, ccw: bool = False) -> bmesh.types.BMEd
20
20
  :rtype: bmesh.types.BMEdge
21
21
  """
22
22
 
23
- def edge_split(edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac: float):
23
+ def edge_split(
24
+ edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac: float
25
+ ) -> tuple[bmesh.types.BMEdge, bmesh.types.BMVert]:
24
26
  """Split an edge, return the newly created data.
25
27
 
26
28
  :param edge: The edge to split.
@@ -30,6 +32,7 @@ def edge_split(edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac: float):
30
32
  :param fac: The point on the edge where the new vert will be created [0 - 1].
31
33
  :type fac: float
32
34
  :return: The newly created (edge, vert) pair.
35
+ :rtype: tuple[bmesh.types.BMEdge, bmesh.types.BMVert]
33
36
  """
34
37
 
35
38
  def face_flip(faces):
@@ -53,7 +56,7 @@ def face_split(
53
56
  coords=(),
54
57
  use_exist: bool = True,
55
58
  example: bmesh.types.BMEdge | None = None,
56
- ):
59
+ ) -> tuple[bmesh.types.BMFace, bmesh.types.BMLoop]:
57
60
  """Face split with optional intermediate points.
58
61
 
59
62
  :param face: The face to cut.
@@ -68,15 +71,19 @@ def face_split(
68
71
  :param example: Newly created edge will copy settings from this one.
69
72
  :type example: bmesh.types.BMEdge | None
70
73
  :return: The newly created face or None on failure.
74
+ :rtype: tuple[bmesh.types.BMFace, bmesh.types.BMLoop]
71
75
  """
72
76
 
73
- def face_split_edgenet(face: bmesh.types.BMFace, edgenet):
77
+ def face_split_edgenet(
78
+ face: bmesh.types.BMFace, edgenet
79
+ ) -> tuple[bmesh.types.BMFace, int]:
74
80
  """Splits a face into any number of regions defined by an edgenet.
75
81
 
76
82
  :param face: The face to split.The face to split.
77
83
  :type face: bmesh.types.BMFace
78
84
  :param edgenet: Sequence of edges.
79
85
  :return: The newly created faces.
86
+ :rtype: tuple[bmesh.types.BMFace, int]
80
87
  """
81
88
 
82
89
  def face_vert_separate(
@@ -140,7 +147,9 @@ def vert_dissolve(vert: bmesh.types.BMVert) -> bool:
140
147
  :rtype: bool
141
148
  """
142
149
 
143
- def vert_separate(vert: bmesh.types.BMVert, edges: bmesh.types.BMEdge):
150
+ def vert_separate(
151
+ vert: bmesh.types.BMVert, edges: bmesh.types.BMEdge
152
+ ) -> tuple[bmesh.types.BMVert, int]:
144
153
  """Separate this vertex at every edge.
145
154
 
146
155
  :param vert: The vert to be separated.
@@ -148,6 +157,7 @@ def vert_separate(vert: bmesh.types.BMVert, edges: bmesh.types.BMEdge):
148
157
  :param edges: The edges to separated.
149
158
  :type edges: bmesh.types.BMEdge
150
159
  :return: The newly separated verts (including the vertex passed).
160
+ :rtype: tuple[bmesh.types.BMVert, int]
151
161
  """
152
162
 
153
163
  def vert_splice(vert: bmesh.types.BMVert, vert_target: bmesh.types.BMVert):
@@ -2,10 +2,13 @@ import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
4
 
5
- def new_triangles(range, coords: bytes | None, colors: bytes | None) -> int:
5
+ def new_triangles(
6
+ range: tuple[int, int] | None, coords: bytes | None, colors: bytes | None
7
+ ) -> int:
6
8
  """Create a new icon from triangle geometry.
7
9
 
8
10
  :param range: Pair of ints.
11
+ :type range: tuple[int, int] | None
9
12
  :param coords: Sequence of bytes (6 floats for one triangle) for (X, Y) coordinates.
10
13
  :type coords: bytes | None
11
14
  :param colors: Sequence of bytes (12 for one triangles) for RGBA.
@@ -127,13 +127,16 @@ def pgettext_tip(msgid: str | None, msgctxt: str | None = None):
127
127
  :return: The translated string (or msgid if no translation was found).
128
128
  """
129
129
 
130
- def register(module_name: str | None, translations_dict):
130
+ def register(
131
+ module_name: str | None, translations_dict: dict[str, dict[str, str]] | None
132
+ ):
131
133
  """Registers an addon's UI translations.
132
134
 
133
135
  :param module_name: The name identifying the addon.
134
136
  :type module_name: str | None
135
137
  :param translations_dict: A dictionary built like that:
136
138
  {locale: {msg_key: msg_translation, ...}, ...}
139
+ :type translations_dict: dict[str, dict[str, str]] | None
137
140
  """
138
141
 
139
142
  def unregister(module_name: str | None):
bpy/msgbus/__init__.pyi CHANGED
@@ -52,7 +52,9 @@ import bpy.types
52
52
  def clear_by_owner(owner):
53
53
  """Clear all subscribers using this owner."""
54
54
 
55
- def publish_rna(key: bpy.types.Property | bpy.types.Struct | None):
55
+ def publish_rna(
56
+ key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None,
57
+ ):
56
58
  """Notify subscribers of changes to this property
57
59
  (this typically doesn't need to be called explicitly since changes will automatically publish updates).
58
60
  In some cases it may be useful to publish changes explicitly using more general keys.
@@ -63,12 +65,12 @@ def publish_rna(key: bpy.types.Property | bpy.types.Struct | None):
63
65
  - A property instance.
64
66
  - A struct type.
65
67
  - A tuple representing a (struct, property name) pair.
66
- :type key: bpy.types.Property | bpy.types.Struct | None
68
+ :type key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None
67
69
  """
68
70
 
69
71
  def subscribe_rna(
70
- key: bpy.types.Property | bpy.types.Struct | None,
71
- owner,
72
+ key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None,
73
+ owner: typing.Any | None,
72
74
  args,
73
75
  notify,
74
76
  options=set(),
@@ -82,8 +84,9 @@ def subscribe_rna(
82
84
  - A property instance.
83
85
  - A struct type.
84
86
  - A tuple representing a (struct, property name) pair.
85
- :type key: bpy.types.Property | bpy.types.Struct | None
87
+ :type key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None
86
88
  :param owner: Handle for this subscription (compared by identity).
89
+ :type owner: typing.Any | None
87
90
  :param options: Change the behavior of the subscriber.
88
91
 
89
92
  PERSISTENT when set, the subscriber will be kept when remapping ID data.
bpy/path/__init__.pyi CHANGED
@@ -104,7 +104,7 @@ def is_subdir(path: bytes | str, directory) -> bool:
104
104
  :rtype: bool
105
105
  """
106
106
 
107
- def module_names(path: str, *, recursive: bool = False, package: str = ""):
107
+ def module_names(path: str, *, recursive: bool = False, package: str = "") -> list[str]:
108
108
  """Return a list of modules which can be imported from path.
109
109
 
110
110
  :param path: a directory to scan.
@@ -114,6 +114,7 @@ def module_names(path: str, *, recursive: bool = False, package: str = ""):
114
114
  :param package: Optional string, used as the prefix for module names (without the trailing ".").
115
115
  :type package: str
116
116
  :return: a list of string pairs (module_name, module_file).
117
+ :rtype: list[str]
117
118
  """
118
119
 
119
120
  def native_pathsep(path: str) -> str:
@@ -125,13 +126,14 @@ def native_pathsep(path: str) -> str:
125
126
  :rtype: str
126
127
  """
127
128
 
128
- def reduce_dirs(dirs):
129
+ def reduce_dirs(dirs) -> list[str]:
129
130
  """Given a sequence of directories, remove duplicates and
130
131
  any directories nested in one of the other paths.
131
132
  (Useful for recursive path searching).
132
133
 
133
134
  :param dirs: Sequence of directory paths.
134
135
  :return: A unique list of paths.
136
+ :rtype: list[str]
135
137
  """
136
138
 
137
139
  def relpath(path: bytes | str, *, start: bytes | str | None = None) -> str: