fake-bpy-module 20240421__py3-none-any.whl → 20240423__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.
- bl_operators/add_mesh_torus/__init__.pyi +2 -1
- bl_operators/assets/__init__.pyi +12 -12
- bl_operators/geometry_nodes/__init__.pyi +256 -238
- bl_operators/node/__init__.pyi +262 -260
- bl_operators/object_quick_effects/__init__.pyi +19 -19
- bl_operators/presets/__init__.pyi +371 -368
- bl_operators/wm/__init__.pyi +4 -4
- bl_ui/__init__.pyi +3 -3
- bl_ui/anim/__init__.pyi +1 -1
- bl_ui/asset_shelf/__init__.pyi +1 -1
- bl_ui/generic_ui_list/__init__.pyi +3 -3
- bl_ui/node_add_menu/__init__.pyi +1 -1
- bl_ui/node_add_menu_compositor/__init__.pyi +18 -18
- bl_ui/node_add_menu_geometry/__init__.pyi +50 -48
- bl_ui/node_add_menu_shader/__init__.pyi +10 -10
- bl_ui/node_add_menu_texture/__init__.pyi +9 -9
- bl_ui/properties_collection/__init__.pyi +39 -25
- bl_ui/properties_constraint/__init__.pyi +1257 -1041
- bl_ui/properties_data_armature/__init__.pyi +120 -96
- bl_ui/properties_data_bone/__init__.pyi +36 -29
- bl_ui/properties_data_camera/__init__.pyi +32 -14
- bl_ui/properties_data_curve/__init__.pyi +143 -116
- bl_ui/properties_data_curves/__init__.pyi +30 -25
- bl_ui/properties_data_empty/__init__.pyi +21 -21
- bl_ui/properties_data_gpencil/__init__.pyi +297 -260
- bl_ui/properties_data_grease_pencil/__init__.pyi +228 -205
- bl_ui/properties_data_lattice/__init__.pyi +25 -22
- bl_ui/properties_data_light/__init__.pyi +44 -31
- bl_ui/properties_data_lightprobe/__init__.pyi +54 -32
- bl_ui/properties_data_mesh/__init__.pyi +579 -570
- bl_ui/properties_data_metaball/__init__.pyi +29 -24
- bl_ui/properties_data_modifier/__init__.pyi +55 -43
- bl_ui/properties_data_pointcloud/__init__.pyi +146 -139
- bl_ui/properties_data_shaderfx/__init__.pyi +13 -13
- bl_ui/properties_data_speaker/__init__.pyi +27 -24
- bl_ui/properties_data_volume/__init__.pyi +75 -68
- bl_ui/properties_freestyle/__init__.pyi +407 -284
- bl_ui/properties_grease_pencil_common/__init__.pyi +13 -13
- bl_ui/properties_mask_common/__init__.pyi +7 -7
- bl_ui/properties_material/__init__.pyi +186 -162
- bl_ui/properties_material_gpencil/__init__.pyi +111 -87
- bl_ui/properties_object/__init__.pyi +102 -84
- bl_ui/properties_output/__init__.pyi +255 -228
- bl_ui/properties_paint_common/__init__.pyi +9 -9
- bl_ui/properties_particle/__init__.pyi +341 -254
- bl_ui/properties_physics_cloth/__init__.pyi +54 -33
- bl_ui/properties_physics_common/__init__.pyi +20 -20
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +231 -193
- bl_ui/properties_physics_field/__init__.pyi +52 -36
- bl_ui/properties_physics_fluid/__init__.pyi +119 -96
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +1 -1
- bl_ui/properties_physics_rigidbody/__init__.pyi +36 -20
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +51 -25
- bl_ui/properties_physics_softbody/__init__.pyi +62 -34
- bl_ui/properties_render/__init__.pyi +275 -187
- bl_ui/properties_scene/__init__.pyi +173 -154
- bl_ui/properties_texture/__init__.pyi +251 -205
- bl_ui/properties_view_layer/__init__.pyi +126 -93
- bl_ui/properties_workspace/__init__.pyi +82 -76
- bl_ui/properties_world/__init__.pyi +31 -26
- bl_ui/space_clip/__init__.pyi +495 -433
- bl_ui/space_console/__init__.pyi +6 -6
- bl_ui/space_dopesheet/__init__.pyi +209 -174
- bl_ui/space_filebrowser/__init__.pyi +691 -679
- bl_ui/space_graph/__init__.pyi +25 -20
- bl_ui/space_image/__init__.pyi +959 -845
- bl_ui/space_info/__init__.pyi +6 -6
- bl_ui/space_nla/__init__.pyi +26 -17
- bl_ui/space_node/__init__.pyi +49 -36
- bl_ui/space_outliner/__init__.pyi +14 -14
- bl_ui/space_properties/__init__.pyi +3 -3
- bl_ui/space_sequencer/__init__.pyi +510 -444
- bl_ui/space_spreadsheet/__init__.pyi +1 -1
- bl_ui/space_statusbar/__init__.pyi +1 -1
- bl_ui/space_text/__init__.pyi +16 -16
- bl_ui/space_time/__init__.pyi +27 -23
- bl_ui/space_toolsystem_common/__init__.pyi +1 -1
- bl_ui/space_toolsystem_toolbar/__init__.pyi +52 -4
- bl_ui/space_topbar/__init__.pyi +26 -26
- bl_ui/space_userpref/__init__.pyi +795 -658
- bl_ui/space_view3d/__init__.pyi +1460 -1428
- bl_ui/space_view3d_toolbar/__init__.pyi +2968 -2657
- bl_ui/temp_anim_layers/__init__.pyi +1 -1
- bmesh/types/__init__.pyi +13 -6
- bpy/app/__init__.pyi +4 -4
- bpy/app/icons/__init__.pyi +8 -6
- bpy/app/timers/__init__.pyi +10 -8
- bpy/app/translations/__init__.pyi +22 -20
- bpy/msgbus/__init__.pyi +4 -2
- bpy/ops/action/__init__.pyi +319 -316
- bpy/ops/anim/__init__.pyi +428 -428
- bpy/ops/armature/__init__.pyi +359 -358
- bpy/ops/asset/__init__.pyi +146 -146
- bpy/ops/boid/__init__.pyi +50 -50
- bpy/ops/brush/__init__.pyi +72 -72
- bpy/ops/buttons/__init__.pyi +128 -128
- bpy/ops/cachefile/__init__.pyi +124 -124
- bpy/ops/camera/__init__.pyi +22 -22
- bpy/ops/clip/__init__.pyi +773 -768
- bpy/ops/cloth/__init__.pyi +10 -10
- bpy/ops/collection/__init__.pyi +64 -64
- bpy/ops/console/__init__.pyi +150 -150
- bpy/ops/constraint/__init__.pyi +150 -150
- bpy/ops/curve/__init__.pyi +475 -472
- bpy/ops/curves/__init__.pyi +247 -244
- bpy/ops/cycles/__init__.pyi +18 -18
- bpy/ops/dpaint/__init__.pyi +34 -34
- bpy/ops/ed/__init__.pyi +122 -122
- bpy/ops/export_anim/__init__.pyi +18 -18
- bpy/ops/export_mesh/__init__.pyi +26 -26
- bpy/ops/export_scene/__init__.pyi +333 -307
- bpy/ops/file/__init__.pyi +340 -340
- bpy/ops/fluid/__init__.pyi +88 -88
- bpy/ops/font/__init__.pyi +252 -252
- bpy/ops/geometry/__init__.pyi +86 -86
- bpy/ops/gizmogroup/__init__.pyi +22 -22
- bpy/ops/gpencil/__init__.pyi +1459 -1444
- bpy/ops/graph/__init__.pyi +645 -642
- bpy/ops/grease_pencil/__init__.pyi +580 -436
- bpy/ops/image/__init__.pyi +614 -612
- bpy/ops/import_anim/__init__.pyi +26 -26
- bpy/ops/import_curve/__init__.pyi +6 -6
- bpy/ops/import_mesh/__init__.pyi +20 -18
- bpy/ops/import_scene/__init__.pyi +92 -86
- bpy/ops/info/__init__.pyi +60 -60
- bpy/ops/lattice/__init__.pyi +64 -64
- bpy/ops/marker/__init__.pyi +106 -106
- bpy/ops/mask/__init__.pyi +321 -318
- bpy/ops/material/__init__.pyi +18 -18
- bpy/ops/mball/__init__.pyi +71 -70
- bpy/ops/mesh/__init__.pyi +1997 -1990
- bpy/ops/nla/__init__.pyi +331 -330
- bpy/ops/node/__init__.pyi +867 -852
- bpy/ops/object/__init__.pyi +2433 -2430
- bpy/ops/outliner/__init__.pyi +498 -498
- bpy/ops/paint/__init__.pyi +554 -544
- bpy/ops/paintcurve/__init__.pyi +64 -64
- bpy/ops/palette/__init__.pyi +48 -48
- bpy/ops/particle/__init__.pyi +266 -264
- bpy/ops/pose/__init__.pyi +336 -336
- bpy/ops/poselib/__init__.pyi +70 -70
- bpy/ops/preferences/__init__.pyi +338 -336
- bpy/ops/ptcache/__init__.pyi +46 -46
- bpy/ops/render/__init__.pyi +114 -114
- bpy/ops/rigidbody/__init__.pyi +102 -102
- bpy/ops/scene/__init__.pyi +270 -270
- bpy/ops/screen/__init__.pyi +378 -378
- bpy/ops/script/__init__.pyi +18 -18
- bpy/ops/sculpt/__init__.pyi +411 -405
- bpy/ops/sculpt_curves/__init__.pyi +42 -40
- bpy/ops/sequencer/__init__.pyi +1053 -1040
- bpy/ops/sound/__init__.pyi +208 -208
- bpy/ops/spreadsheet/__init__.pyi +30 -30
- bpy/ops/surface/__init__.pyi +108 -108
- bpy/ops/text/__init__.pyi +382 -382
- bpy/ops/text_editor/__init__.pyi +10 -10
- bpy/ops/texture/__init__.pyi +26 -26
- bpy/ops/transform/__init__.pyi +826 -790
- bpy/ops/ui/__init__.pyi +216 -216
- bpy/ops/uilist/__init__.pyi +20 -20
- bpy/ops/uv/__init__.pyi +605 -600
- bpy/ops/view2d/__init__.pyi +156 -156
- bpy/ops/view3d/__init__.pyi +578 -576
- bpy/ops/wm/__init__.pyi +2418 -2376
- bpy/ops/workspace/__init__.pyi +42 -42
- bpy/ops/world/__init__.pyi +6 -6
- bpy/path/__init__.pyi +48 -33
- bpy/props/__init__.pyi +263 -261
- bpy/types/__init__.pyi +105733 -102298
- bpy/utils/__init__.pyi +87 -52
- bpy/utils/previews/__init__.pyi +2 -2
- bpy/utils/units/__init__.pyi +21 -18
- bpy_extras/anim_utils/__init__.pyi +9 -2
- bpy_extras/io_utils/__init__.pyi +2 -1
- bpy_extras/view3d_utils/__init__.pyi +2 -1
- bpy_types/__init__.pyi +236 -236
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/RECORD +187 -187
- freestyle/chainingiterators/__init__.pyi +7 -2
- freestyle/types/__init__.pyi +8 -3
- gpu_extras/presets/__init__.pyi +14 -2
- keyingsets_builtins/__init__.pyi +92 -92
- mathutils/__init__.pyi +9 -5
- mathutils/geometry/__init__.pyi +8 -4
- nodeitems_builtins/__init__.pyi +7 -7
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/top_level.txt +0 -0
bmesh/types/__init__.pyi
CHANGED
|
@@ -223,12 +223,13 @@ class BMEdge:
|
|
|
223
223
|
"""Update normals of all connected faces and the edge verts."""
|
|
224
224
|
...
|
|
225
225
|
|
|
226
|
-
def other_vert(self, vert: BMVert):
|
|
226
|
+
def other_vert(self, vert: BMVert) -> BMVert:
|
|
227
227
|
"""Return the other vertex on this edge or None if the vertex is not used by this edge.
|
|
228
228
|
|
|
229
229
|
:param vert: a vert in this edge.
|
|
230
230
|
:type vert: BMVert
|
|
231
231
|
:return: The edges other vert.
|
|
232
|
+
:rtype: BMVert
|
|
232
233
|
"""
|
|
233
234
|
...
|
|
234
235
|
|
|
@@ -287,12 +288,13 @@ class BMEdgeSeq:
|
|
|
287
288
|
"""
|
|
288
289
|
...
|
|
289
290
|
|
|
290
|
-
def sort(self, key=None, reverse=False):
|
|
291
|
+
def sort(self, key=None, reverse: bool = False):
|
|
291
292
|
"""Sort the elements of this sequence, using an optional custom sort key.
|
|
292
293
|
Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.
|
|
293
294
|
|
|
294
295
|
:param key: The key that sets the ordering of the elements.
|
|
295
296
|
:param reverse: Reverse the order of the elements
|
|
297
|
+
:type reverse: bool
|
|
296
298
|
"""
|
|
297
299
|
...
|
|
298
300
|
|
|
@@ -659,8 +661,11 @@ class BMFace:
|
|
|
659
661
|
class BMFaceSeq:
|
|
660
662
|
""" """
|
|
661
663
|
|
|
662
|
-
active:
|
|
663
|
-
""" active face.
|
|
664
|
+
active: BMFace
|
|
665
|
+
""" active face.
|
|
666
|
+
|
|
667
|
+
:type: BMFace
|
|
668
|
+
"""
|
|
664
669
|
|
|
665
670
|
layers: BMLayerAccessFace
|
|
666
671
|
""" custom-data layers (read-only).
|
|
@@ -706,12 +711,13 @@ class BMFaceSeq:
|
|
|
706
711
|
"""
|
|
707
712
|
...
|
|
708
713
|
|
|
709
|
-
def sort(self, key=None, reverse=False):
|
|
714
|
+
def sort(self, key=None, reverse: bool = False):
|
|
710
715
|
"""Sort the elements of this sequence, using an optional custom sort key.
|
|
711
716
|
Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.
|
|
712
717
|
|
|
713
718
|
:param key: The key that sets the ordering of the elements.
|
|
714
719
|
:param reverse: Reverse the order of the elements
|
|
720
|
+
:type reverse: bool
|
|
715
721
|
"""
|
|
716
722
|
...
|
|
717
723
|
|
|
@@ -1379,12 +1385,13 @@ class BMVertSeq:
|
|
|
1379
1385
|
"""
|
|
1380
1386
|
...
|
|
1381
1387
|
|
|
1382
|
-
def sort(self, key=None, reverse=False):
|
|
1388
|
+
def sort(self, key=None, reverse: bool = False):
|
|
1383
1389
|
"""Sort the elements of this sequence, using an optional custom sort key.
|
|
1384
1390
|
Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.
|
|
1385
1391
|
|
|
1386
1392
|
:param key: The key that sets the ordering of the elements.
|
|
1387
1393
|
:param reverse: Reverse the order of the elements
|
|
1394
|
+
:type reverse: bool
|
|
1388
1395
|
"""
|
|
1389
1396
|
...
|
|
1390
1397
|
|
bpy/app/__init__.pyi
CHANGED
|
@@ -19,20 +19,20 @@ from . import translations
|
|
|
19
19
|
|
|
20
20
|
GenericType = typing.TypeVar("GenericType")
|
|
21
21
|
|
|
22
|
-
def help_text(all: bool = False):
|
|
22
|
+
def help_text(all: typing.Optional[bool] = False):
|
|
23
23
|
"""Return the help text as a string.
|
|
24
24
|
|
|
25
25
|
:param all: Return all arguments, even those which aren't available for the current platform.
|
|
26
|
-
:type all: bool
|
|
26
|
+
:type all: typing.Optional[bool]
|
|
27
27
|
"""
|
|
28
28
|
|
|
29
29
|
...
|
|
30
30
|
|
|
31
|
-
def is_job_running(job_type: str):
|
|
31
|
+
def is_job_running(job_type: typing.Optional[str]):
|
|
32
32
|
"""Check whether a job of the given type is running.
|
|
33
33
|
|
|
34
34
|
:param job_type: job type in `rna_enum_wm_job_type_items`.
|
|
35
|
-
:type job_type: str
|
|
35
|
+
:type job_type: typing.Optional[str]
|
|
36
36
|
:return: Whether a job of the given type is currently running.
|
|
37
37
|
"""
|
|
38
38
|
|
bpy/app/icons/__init__.pyi
CHANGED
|
@@ -3,27 +3,29 @@ import typing
|
|
|
3
3
|
GenericType = typing.TypeVar("GenericType")
|
|
4
4
|
|
|
5
5
|
def new_triangles(
|
|
6
|
-
range:
|
|
6
|
+
range: typing.Optional[tuple],
|
|
7
|
+
coords: typing.Optional[typing.Sequence[bytes]],
|
|
8
|
+
colors: typing.Optional[typing.Sequence[bytes]],
|
|
7
9
|
) -> int:
|
|
8
10
|
"""Create a new icon from triangle geometry.
|
|
9
11
|
|
|
10
12
|
:param range: Pair of ints.
|
|
11
|
-
:type range: tuple
|
|
13
|
+
:type range: typing.Optional[tuple]
|
|
12
14
|
:param coords: Sequence of bytes (6 floats for one triangle) for (X, Y) coordinates.
|
|
13
|
-
:type coords: typing.Sequence[bytes]
|
|
15
|
+
:type coords: typing.Optional[typing.Sequence[bytes]]
|
|
14
16
|
:param colors: Sequence of ints (12 for one triangles) for RGBA.
|
|
15
|
-
:type colors: typing.Sequence[bytes]
|
|
17
|
+
:type colors: typing.Optional[typing.Sequence[bytes]]
|
|
16
18
|
:return: Unique icon value (pass to interface icon_value argument).
|
|
17
19
|
:rtype: int
|
|
18
20
|
"""
|
|
19
21
|
|
|
20
22
|
...
|
|
21
23
|
|
|
22
|
-
def new_triangles_from_file(filepath: str) -> int:
|
|
24
|
+
def new_triangles_from_file(filepath: typing.Optional[str]) -> int:
|
|
23
25
|
"""Create a new icon from triangle geometry.
|
|
24
26
|
|
|
25
27
|
:param filepath: File path.
|
|
26
|
-
:type filepath: str
|
|
28
|
+
:type filepath: typing.Optional[str]
|
|
27
29
|
:return: Unique icon value (pass to interface icon_value argument).
|
|
28
30
|
:rtype: int
|
|
29
31
|
"""
|
bpy/app/timers/__init__.pyi
CHANGED
|
@@ -34,11 +34,11 @@ import typing
|
|
|
34
34
|
|
|
35
35
|
GenericType = typing.TypeVar("GenericType")
|
|
36
36
|
|
|
37
|
-
def is_registered(function: int) -> bool:
|
|
37
|
+
def is_registered(function: typing.Optional[int]) -> bool:
|
|
38
38
|
"""Check if this function is registered as a timer.
|
|
39
39
|
|
|
40
40
|
:param function: Function to check.
|
|
41
|
-
:type function: int
|
|
41
|
+
:type function: typing.Optional[int]
|
|
42
42
|
:return: True when this function is registered, otherwise False.
|
|
43
43
|
:rtype: bool
|
|
44
44
|
"""
|
|
@@ -46,7 +46,9 @@ def is_registered(function: int) -> bool:
|
|
|
46
46
|
...
|
|
47
47
|
|
|
48
48
|
def register(
|
|
49
|
-
function: typing.Callable,
|
|
49
|
+
function: typing.Optional[typing.Callable],
|
|
50
|
+
first_interval: typing.Optional[float] = 0,
|
|
51
|
+
persistent: typing.Optional[bool] = False,
|
|
50
52
|
):
|
|
51
53
|
"""Add a new function that will be called after the specified amount of seconds.
|
|
52
54
|
The function gets no arguments and is expected to return either None or a float.
|
|
@@ -55,20 +57,20 @@ def register(
|
|
|
55
57
|
functools.partial can be used to assign some parameters.
|
|
56
58
|
|
|
57
59
|
:param function: The function that should called.
|
|
58
|
-
:type function: typing.Callable
|
|
60
|
+
:type function: typing.Optional[typing.Callable]
|
|
59
61
|
:param first_interval: Seconds until the callback should be called the first time.
|
|
60
|
-
:type first_interval: float
|
|
62
|
+
:type first_interval: typing.Optional[float]
|
|
61
63
|
:param persistent: Don't remove timer when a new file is loaded.
|
|
62
|
-
:type persistent: bool
|
|
64
|
+
:type persistent: typing.Optional[bool]
|
|
63
65
|
"""
|
|
64
66
|
|
|
65
67
|
...
|
|
66
68
|
|
|
67
|
-
def unregister(function: typing.Any):
|
|
69
|
+
def unregister(function: typing.Optional[typing.Any]):
|
|
68
70
|
"""Unregister timer.
|
|
69
71
|
|
|
70
72
|
:param function: Function to unregister.
|
|
71
|
-
:type function: typing.Any
|
|
73
|
+
:type function: typing.Optional[typing.Any]
|
|
72
74
|
"""
|
|
73
75
|
|
|
74
76
|
...
|
|
@@ -69,83 +69,85 @@ def locale_explode(locale):
|
|
|
69
69
|
|
|
70
70
|
...
|
|
71
71
|
|
|
72
|
-
def pgettext(msgid: str, msgctxt: str = None):
|
|
72
|
+
def pgettext(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
|
|
73
73
|
"""Try to translate the given msgid (with optional msgctxt).
|
|
74
74
|
|
|
75
75
|
:param msgid: The string to translate.
|
|
76
|
-
:type msgid: str
|
|
76
|
+
:type msgid: typing.Optional[str]
|
|
77
77
|
:param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
|
|
78
|
-
:type msgctxt: str
|
|
78
|
+
:type msgctxt: typing.Optional[str]
|
|
79
79
|
:return: The translated string (or msgid if no translation was found).
|
|
80
80
|
"""
|
|
81
81
|
|
|
82
82
|
...
|
|
83
83
|
|
|
84
|
-
def pgettext_data(msgid: str, msgctxt: str = None):
|
|
84
|
+
def pgettext_data(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
|
|
85
85
|
"""Try to translate the given msgid (with optional msgctxt), if new data name's translation is enabled.
|
|
86
86
|
|
|
87
87
|
:param msgid: The string to translate.
|
|
88
|
-
:type msgid: str
|
|
88
|
+
:type msgid: typing.Optional[str]
|
|
89
89
|
:param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
|
|
90
|
-
:type msgctxt: str
|
|
90
|
+
:type msgctxt: typing.Optional[str]
|
|
91
91
|
:return: The translated string (or msgid if no translation was found).
|
|
92
92
|
"""
|
|
93
93
|
|
|
94
94
|
...
|
|
95
95
|
|
|
96
|
-
def pgettext_iface(msgid: str, msgctxt: str = None):
|
|
96
|
+
def pgettext_iface(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
|
|
97
97
|
"""Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.
|
|
98
98
|
|
|
99
99
|
:param msgid: The string to translate.
|
|
100
|
-
:type msgid: str
|
|
100
|
+
:type msgid: typing.Optional[str]
|
|
101
101
|
:param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
|
|
102
|
-
:type msgctxt: str
|
|
102
|
+
:type msgctxt: typing.Optional[str]
|
|
103
103
|
:return: The translated string (or msgid if no translation was found).
|
|
104
104
|
"""
|
|
105
105
|
|
|
106
106
|
...
|
|
107
107
|
|
|
108
|
-
def pgettext_rpt(msgid: str, msgctxt: str = None):
|
|
108
|
+
def pgettext_rpt(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
|
|
109
109
|
"""Try to translate the given msgid (with optional msgctxt), if reports' translation is enabled.
|
|
110
110
|
|
|
111
111
|
:param msgid: The string to translate.
|
|
112
|
-
:type msgid: str
|
|
112
|
+
:type msgid: typing.Optional[str]
|
|
113
113
|
:param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
|
|
114
|
-
:type msgctxt: str
|
|
114
|
+
:type msgctxt: typing.Optional[str]
|
|
115
115
|
:return: The translated string (or msgid if no translation was found).
|
|
116
116
|
"""
|
|
117
117
|
|
|
118
118
|
...
|
|
119
119
|
|
|
120
|
-
def pgettext_tip(msgid: str, msgctxt: str = None):
|
|
120
|
+
def pgettext_tip(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
|
|
121
121
|
"""Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.
|
|
122
122
|
|
|
123
123
|
:param msgid: The string to translate.
|
|
124
|
-
:type msgid: str
|
|
124
|
+
:type msgid: typing.Optional[str]
|
|
125
125
|
:param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
|
|
126
|
-
:type msgctxt: str
|
|
126
|
+
:type msgctxt: typing.Optional[str]
|
|
127
127
|
:return: The translated string (or msgid if no translation was found).
|
|
128
128
|
"""
|
|
129
129
|
|
|
130
130
|
...
|
|
131
131
|
|
|
132
|
-
def register(
|
|
132
|
+
def register(
|
|
133
|
+
module_name: typing.Optional[str], translations_dict: typing.Optional[dict]
|
|
134
|
+
):
|
|
133
135
|
"""Registers an addon's UI translations.
|
|
134
136
|
|
|
135
137
|
:param module_name: The name identifying the addon.
|
|
136
|
-
:type module_name: str
|
|
138
|
+
:type module_name: typing.Optional[str]
|
|
137
139
|
:param translations_dict: A dictionary built like that:
|
|
138
140
|
{locale: {msg_key: msg_translation, ...}, ...}
|
|
139
|
-
:type translations_dict: dict
|
|
141
|
+
:type translations_dict: typing.Optional[dict]
|
|
140
142
|
"""
|
|
141
143
|
|
|
142
144
|
...
|
|
143
145
|
|
|
144
|
-
def unregister(module_name: str):
|
|
146
|
+
def unregister(module_name: typing.Optional[str]):
|
|
145
147
|
"""Unregisters an addon's UI translations.
|
|
146
148
|
|
|
147
149
|
:param module_name: The name identifying the addon.
|
|
148
|
-
:type module_name: str
|
|
150
|
+
:type module_name: typing.Optional[str]
|
|
149
151
|
"""
|
|
150
152
|
|
|
151
153
|
...
|
bpy/msgbus/__init__.pyi
CHANGED
|
@@ -68,7 +68,9 @@ def publish_rna(key):
|
|
|
68
68
|
|
|
69
69
|
...
|
|
70
70
|
|
|
71
|
-
def subscribe_rna(
|
|
71
|
+
def subscribe_rna(
|
|
72
|
+
key, owner: typing.Optional[typing.Any], args, notify, options=None()
|
|
73
|
+
):
|
|
72
74
|
"""Register a message bus subscription. It will be cleared when another blend file is
|
|
73
75
|
loaded, or can be cleared explicitly via `bpy.msgbus.clear_by_owner`.
|
|
74
76
|
|
|
@@ -79,7 +81,7 @@ def subscribe_rna(key, owner: typing.Any, args, notify, options=None()):
|
|
|
79
81
|
- `bpy.types.Struct` type.
|
|
80
82
|
- (`bpy.types.Struct`, str) type and property name.
|
|
81
83
|
:param owner: Handle for this subscription (compared by identity).
|
|
82
|
-
:type owner: typing.Any
|
|
84
|
+
:type owner: typing.Optional[typing.Any]
|
|
83
85
|
:param options: Change the behavior of the subscriber.
|
|
84
86
|
|
|
85
87
|
PERSISTENT when set, the subscriber will be kept when remapping ID data.
|