fake-bpy-module 20240713__py3-none-any.whl → 20240715__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.
- bgl/__init__.pyi +0 -558
- bpy/path/__init__.pyi +0 -182
- bpy/types/__init__.pyi +37 -1
- bpy/utils/__init__.pyi +0 -215
- bpy/utils/previews/__init__.pyi +9 -80
- bpy_extras/anim_utils/__init__.pyi +0 -55
- bpy_extras/asset_utils/__init__.pyi +1 -14
- bpy_extras/id_map_utils/__init__.pyi +0 -10
- bpy_extras/image_utils/__init__.pyi +0 -49
- bpy_extras/io_utils/__init__.pyi +0 -131
- bpy_extras/keyconfig_utils/__init__.pyi +0 -11
- bpy_extras/mesh_utils/__init__.pyi +0 -88
- bpy_extras/node_utils/__init__.pyi +0 -1
- bpy_extras/object_utils/__init__.pyi +0 -96
- bpy_extras/view3d_utils/__init__.pyi +0 -94
- {fake_bpy_module-20240713.dist-info → fake_bpy_module-20240715.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240713.dist-info → fake_bpy_module-20240715.dist-info}/RECORD +20 -20
- freestyle/utils/__init__.pyi +1 -1
- {fake_bpy_module-20240713.dist-info → fake_bpy_module-20240715.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240713.dist-info → fake_bpy_module-20240715.dist-info}/top_level.txt +0 -0
bpy/path/__init__.pyi
CHANGED
|
@@ -30,33 +30,6 @@ def abspath(
|
|
|
30
30
|
|
|
31
31
|
...
|
|
32
32
|
|
|
33
|
-
def abspath(
|
|
34
|
-
path, *, start: bytes | str | None = None, library: bpy.types.Library | None = None
|
|
35
|
-
) -> str:
|
|
36
|
-
"""Returns the absolute path relative to the current blend file
|
|
37
|
-
using the "//" prefix.
|
|
38
|
-
|
|
39
|
-
:param start: Relative to this path,
|
|
40
|
-
when not set the current filename is used.
|
|
41
|
-
:type start: bytes | str | None
|
|
42
|
-
:param library: The library this path is from. This is only included for
|
|
43
|
-
convenience, when the library is not None its path replaces start.
|
|
44
|
-
:type library: bpy.types.Library | None
|
|
45
|
-
:return: The absolute path.
|
|
46
|
-
:rtype: str
|
|
47
|
-
"""
|
|
48
|
-
|
|
49
|
-
...
|
|
50
|
-
|
|
51
|
-
def basename(path) -> str:
|
|
52
|
-
"""Equivalent to os.path.basename, but skips a "//" prefix.Use for Windows compatibility.
|
|
53
|
-
|
|
54
|
-
:return: The base name of the given path.
|
|
55
|
-
:rtype: str
|
|
56
|
-
"""
|
|
57
|
-
|
|
58
|
-
...
|
|
59
|
-
|
|
60
33
|
def basename(path) -> str:
|
|
61
34
|
"""Equivalent to os.path.basename, but skips a "//" prefix.Use for Windows compatibility.
|
|
62
35
|
|
|
@@ -82,40 +55,6 @@ def clean_name(name: bytes | str | None, *, replace: str | None = "_") -> str:
|
|
|
82
55
|
|
|
83
56
|
...
|
|
84
57
|
|
|
85
|
-
def clean_name(name: bytes | str | None, *, replace: str | None = "_") -> str:
|
|
86
|
-
"""Returns a name with characters replaced that
|
|
87
|
-
may cause problems under various circumstances,
|
|
88
|
-
such as writing to a file.All characters besides A-Z/a-z, 0-9 are replaced with "_"
|
|
89
|
-
or the replace argument if defined.
|
|
90
|
-
|
|
91
|
-
:param name: The path name.
|
|
92
|
-
:type name: bytes | str | None
|
|
93
|
-
:param replace: The replacement for non-valid characters.
|
|
94
|
-
:type replace: str | None
|
|
95
|
-
:return: The cleaned name.
|
|
96
|
-
:rtype: str
|
|
97
|
-
"""
|
|
98
|
-
|
|
99
|
-
...
|
|
100
|
-
|
|
101
|
-
def display_name(
|
|
102
|
-
name: str | None, *, has_ext: bool | None = True, title_case: bool | None = True
|
|
103
|
-
) -> str:
|
|
104
|
-
"""Creates a display string from name to be used menus and the user interface.
|
|
105
|
-
Intended for use with filenames and module names.
|
|
106
|
-
|
|
107
|
-
:param name: The name to be used for displaying the user interface.
|
|
108
|
-
:type name: str | None
|
|
109
|
-
:param has_ext: Remove file extension from name.
|
|
110
|
-
:type has_ext: bool | None
|
|
111
|
-
:param title_case: Convert lowercase names to title case.
|
|
112
|
-
:type title_case: bool | None
|
|
113
|
-
:return: The display string.
|
|
114
|
-
:rtype: str
|
|
115
|
-
"""
|
|
116
|
-
|
|
117
|
-
...
|
|
118
|
-
|
|
119
58
|
def display_name(
|
|
120
59
|
name: str | None, *, has_ext: bool | None = True, title_case: bool | None = True
|
|
121
60
|
) -> str:
|
|
@@ -146,30 +85,6 @@ def display_name_from_filepath(name: str | None) -> str:
|
|
|
146
85
|
|
|
147
86
|
...
|
|
148
87
|
|
|
149
|
-
def display_name_from_filepath(name: str | None) -> str:
|
|
150
|
-
"""Returns the path stripped of directory and extension,
|
|
151
|
-
ensured to be utf8 compatible.
|
|
152
|
-
|
|
153
|
-
:param name: The file path to convert.
|
|
154
|
-
:type name: str | None
|
|
155
|
-
:return: The display name.
|
|
156
|
-
:rtype: str
|
|
157
|
-
"""
|
|
158
|
-
|
|
159
|
-
...
|
|
160
|
-
|
|
161
|
-
def display_name_to_filepath(name: str | None) -> str:
|
|
162
|
-
"""Performs the reverse of display_name using literal versions of characters
|
|
163
|
-
which aren't supported in a filepath.
|
|
164
|
-
|
|
165
|
-
:param name: The display name to convert.
|
|
166
|
-
:type name: str | None
|
|
167
|
-
:return: The file path.
|
|
168
|
-
:rtype: str
|
|
169
|
-
"""
|
|
170
|
-
|
|
171
|
-
...
|
|
172
|
-
|
|
173
88
|
def display_name_to_filepath(name: str | None) -> str:
|
|
174
89
|
"""Performs the reverse of display_name using literal versions of characters
|
|
175
90
|
which aren't supported in a filepath.
|
|
@@ -200,36 +115,6 @@ def ensure_ext(
|
|
|
200
115
|
|
|
201
116
|
...
|
|
202
117
|
|
|
203
|
-
def ensure_ext(
|
|
204
|
-
filepath: str | None, ext: str | None, *, case_sensitive: bool | None = False
|
|
205
|
-
) -> str:
|
|
206
|
-
"""Return the path with the extension added if it is not already set.
|
|
207
|
-
|
|
208
|
-
:param filepath: The file path.
|
|
209
|
-
:type filepath: str | None
|
|
210
|
-
:param ext: The extension to check for, can be a compound extension. Should
|
|
211
|
-
start with a dot, such as '.blend' or '.tar.gz'.
|
|
212
|
-
:type ext: str | None
|
|
213
|
-
:param case_sensitive: Check for matching case when comparing extensions.
|
|
214
|
-
:type case_sensitive: bool | None
|
|
215
|
-
:return: The file path with the given extension.
|
|
216
|
-
:rtype: str
|
|
217
|
-
"""
|
|
218
|
-
|
|
219
|
-
...
|
|
220
|
-
|
|
221
|
-
def is_subdir(path: bytes | str | None, directory) -> bool:
|
|
222
|
-
"""Returns true if path in a subdirectory of directory.
|
|
223
|
-
Both paths must be absolute.
|
|
224
|
-
|
|
225
|
-
:param path: An absolute path.
|
|
226
|
-
:type path: bytes | str | None
|
|
227
|
-
:return: Whether or not the path is a subdirectory.
|
|
228
|
-
:rtype: bool
|
|
229
|
-
"""
|
|
230
|
-
|
|
231
|
-
...
|
|
232
|
-
|
|
233
118
|
def is_subdir(path: bytes | str | None, directory) -> bool:
|
|
234
119
|
"""Returns true if path in a subdirectory of directory.
|
|
235
120
|
Both paths must be absolute.
|
|
@@ -259,34 +144,6 @@ def module_names(
|
|
|
259
144
|
|
|
260
145
|
...
|
|
261
146
|
|
|
262
|
-
def module_names(
|
|
263
|
-
path: str | None, *, recursive: bool | None = False, package: str | None = ""
|
|
264
|
-
) -> list[str]:
|
|
265
|
-
"""Return a list of modules which can be imported from path.
|
|
266
|
-
|
|
267
|
-
:param path: a directory to scan.
|
|
268
|
-
:type path: str | None
|
|
269
|
-
:param recursive: Also return submodule names for packages.
|
|
270
|
-
:type recursive: bool | None
|
|
271
|
-
:param package: Optional string, used as the prefix for module names (without the trailing ".").
|
|
272
|
-
:type package: str | None
|
|
273
|
-
:return: a list of string pairs (module_name, module_file).
|
|
274
|
-
:rtype: list[str]
|
|
275
|
-
"""
|
|
276
|
-
|
|
277
|
-
...
|
|
278
|
-
|
|
279
|
-
def native_pathsep(path: str | None) -> str:
|
|
280
|
-
"""Replace the path separator with the systems native os.sep.
|
|
281
|
-
|
|
282
|
-
:param path: The path to replace.
|
|
283
|
-
:type path: str | None
|
|
284
|
-
:return: The path with system native separators.
|
|
285
|
-
:rtype: str
|
|
286
|
-
"""
|
|
287
|
-
|
|
288
|
-
...
|
|
289
|
-
|
|
290
147
|
def native_pathsep(path: str | None) -> str:
|
|
291
148
|
"""Replace the path separator with the systems native os.sep.
|
|
292
149
|
|
|
@@ -311,19 +168,6 @@ def reduce_dirs(dirs: list[str] | None) -> list[str]:
|
|
|
311
168
|
|
|
312
169
|
...
|
|
313
170
|
|
|
314
|
-
def reduce_dirs(dirs: list[str] | None) -> list[str]:
|
|
315
|
-
"""Given a sequence of directories, remove duplicates and
|
|
316
|
-
any directories nested in one of the other paths.
|
|
317
|
-
(Useful for recursive path searching).
|
|
318
|
-
|
|
319
|
-
:param dirs: Sequence of directory paths.
|
|
320
|
-
:type dirs: list[str] | None
|
|
321
|
-
:return: A unique list of paths.
|
|
322
|
-
:rtype: list[str]
|
|
323
|
-
"""
|
|
324
|
-
|
|
325
|
-
...
|
|
326
|
-
|
|
327
171
|
def relpath(path: bytes | str | None, *, start: bytes | str | None = None) -> str:
|
|
328
172
|
"""Returns the path relative to the current blend file using the "//" prefix.
|
|
329
173
|
|
|
@@ -338,32 +182,6 @@ def relpath(path: bytes | str | None, *, start: bytes | str | None = None) -> st
|
|
|
338
182
|
|
|
339
183
|
...
|
|
340
184
|
|
|
341
|
-
def relpath(path: bytes | str | None, *, start: bytes | str | None = None) -> str:
|
|
342
|
-
"""Returns the path relative to the current blend file using the "//" prefix.
|
|
343
|
-
|
|
344
|
-
:param path: An absolute path.
|
|
345
|
-
:type path: bytes | str | None
|
|
346
|
-
:param start: Relative to this path,
|
|
347
|
-
when not set the current filename is used.
|
|
348
|
-
:type start: bytes | str | None
|
|
349
|
-
:return: The relative path.
|
|
350
|
-
:rtype: str
|
|
351
|
-
"""
|
|
352
|
-
|
|
353
|
-
...
|
|
354
|
-
|
|
355
|
-
def resolve_ncase(path: str | None) -> str:
|
|
356
|
-
"""Resolve a case insensitive path on a case sensitive system,
|
|
357
|
-
returning a string with the path if found else return the original path.
|
|
358
|
-
|
|
359
|
-
:param path: The path name to resolve.
|
|
360
|
-
:type path: str | None
|
|
361
|
-
:return: The resolved path.
|
|
362
|
-
:rtype: str
|
|
363
|
-
"""
|
|
364
|
-
|
|
365
|
-
...
|
|
366
|
-
|
|
367
185
|
def resolve_ncase(path: str | None) -> str:
|
|
368
186
|
"""Resolve a case insensitive path on a case sensitive system,
|
|
369
187
|
returning a string with the path if found else return the original path.
|
bpy/types/__init__.pyi
CHANGED
|
@@ -122321,6 +122321,24 @@ class CompositorNodeColorBalance(CompositorNode, NodeInternal, Node, bpy_struct)
|
|
|
122321
122321
|
:type: mathutils.Color
|
|
122322
122322
|
"""
|
|
122323
122323
|
|
|
122324
|
+
input_temperature: float
|
|
122325
|
+
""" Color temperature of the input's white point
|
|
122326
|
+
|
|
122327
|
+
:type: float
|
|
122328
|
+
"""
|
|
122329
|
+
|
|
122330
|
+
input_tint: float
|
|
122331
|
+
""" Color tint of the input's white point (the default of 10 matches daylight)
|
|
122332
|
+
|
|
122333
|
+
:type: float
|
|
122334
|
+
"""
|
|
122335
|
+
|
|
122336
|
+
input_whitepoint: mathutils.Color
|
|
122337
|
+
""" The color which gets mapped to white (automatically converted to/from temperature and tint)
|
|
122338
|
+
|
|
122339
|
+
:type: mathutils.Color
|
|
122340
|
+
"""
|
|
122341
|
+
|
|
122324
122342
|
lift: mathutils.Color
|
|
122325
122343
|
""" Correction for shadows
|
|
122326
122344
|
|
|
@@ -122339,6 +122357,24 @@ class CompositorNodeColorBalance(CompositorNode, NodeInternal, Node, bpy_struct)
|
|
|
122339
122357
|
:type: float
|
|
122340
122358
|
"""
|
|
122341
122359
|
|
|
122360
|
+
output_temperature: float
|
|
122361
|
+
""" Color temperature of the output's white point
|
|
122362
|
+
|
|
122363
|
+
:type: float
|
|
122364
|
+
"""
|
|
122365
|
+
|
|
122366
|
+
output_tint: float
|
|
122367
|
+
""" Color tint of the output's white point (the default of 10 matches daylight)
|
|
122368
|
+
|
|
122369
|
+
:type: float
|
|
122370
|
+
"""
|
|
122371
|
+
|
|
122372
|
+
output_whitepoint: mathutils.Color
|
|
122373
|
+
""" The color which gets white gets mapped to (automatically converted to/from temperature and tint)
|
|
122374
|
+
|
|
122375
|
+
:type: mathutils.Color
|
|
122376
|
+
"""
|
|
122377
|
+
|
|
122342
122378
|
power: mathutils.Color
|
|
122343
122379
|
""" Correction for midtones
|
|
122344
122380
|
|
|
@@ -134519,7 +134555,7 @@ Utility function for (tail - head)(readonly)"""
|
|
|
134519
134555
|
scale: bool | None = True,
|
|
134520
134556
|
roll: bool | None = True,
|
|
134521
134557
|
):
|
|
134522
|
-
"""Transform the
|
|
134558
|
+
"""Transform the bones head, tail, roll and envelope
|
|
134523
134559
|
(when the matrix has a scale component).
|
|
134524
134560
|
|
|
134525
134561
|
:param matrix: 3x3 or 4x4 transformation matrix.
|
bpy/utils/__init__.pyi
CHANGED
|
@@ -19,16 +19,6 @@ from . import units
|
|
|
19
19
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
20
20
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
21
21
|
|
|
22
|
-
def app_template_paths(*, path: str | None = None):
|
|
23
|
-
"""Returns valid application template paths.
|
|
24
|
-
|
|
25
|
-
:param path: Optional subdir.
|
|
26
|
-
:type path: str | None
|
|
27
|
-
:return: app template paths.
|
|
28
|
-
"""
|
|
29
|
-
|
|
30
|
-
...
|
|
31
|
-
|
|
32
22
|
def app_template_paths(*, path: str | None = None):
|
|
33
23
|
"""Returns valid application template paths.
|
|
34
24
|
|
|
@@ -80,17 +70,6 @@ def execfile(filepath: str | None, *, mod=None):
|
|
|
80
70
|
|
|
81
71
|
...
|
|
82
72
|
|
|
83
|
-
def execfile(filepath: str | None, *, mod=None):
|
|
84
|
-
"""Execute a file path as a Python script.
|
|
85
|
-
|
|
86
|
-
:param filepath: Path of the script to execute.
|
|
87
|
-
:type filepath: str | None
|
|
88
|
-
:param mod: Optional cached module, the result of a previous execution.
|
|
89
|
-
:return: The module which can be passed back in as mod.
|
|
90
|
-
"""
|
|
91
|
-
|
|
92
|
-
...
|
|
93
|
-
|
|
94
73
|
def extension_path_user(
|
|
95
74
|
package: str | None, *, path: str | None = "", create: bool | None = False
|
|
96
75
|
) -> str:
|
|
@@ -133,8 +112,6 @@ def is_path_builtin(path: str | None) -> bool:
|
|
|
133
112
|
...
|
|
134
113
|
|
|
135
114
|
def keyconfig_init(): ...
|
|
136
|
-
def keyconfig_init(): ...
|
|
137
|
-
def keyconfig_set(filepath, *, report=None): ...
|
|
138
115
|
def keyconfig_set(filepath, *, report=None): ...
|
|
139
116
|
def load_scripts(
|
|
140
117
|
*,
|
|
@@ -156,26 +133,6 @@ def load_scripts(
|
|
|
156
133
|
|
|
157
134
|
...
|
|
158
135
|
|
|
159
|
-
def load_scripts(
|
|
160
|
-
*,
|
|
161
|
-
reload_scripts: bool | None = False,
|
|
162
|
-
refresh_scripts: bool | None = False,
|
|
163
|
-
extensions: bool | None = True,
|
|
164
|
-
):
|
|
165
|
-
"""Load scripts and run each modules register function.
|
|
166
|
-
|
|
167
|
-
:param reload_scripts: Causes all scripts to have their unregister method
|
|
168
|
-
called before loading.
|
|
169
|
-
:type reload_scripts: bool | None
|
|
170
|
-
:param refresh_scripts: only load scripts which are not already loaded
|
|
171
|
-
as modules.
|
|
172
|
-
:type refresh_scripts: bool | None
|
|
173
|
-
:param extensions: Loads additional scripts (add-ons & app-templates).
|
|
174
|
-
:type extensions: bool | None
|
|
175
|
-
"""
|
|
176
|
-
|
|
177
|
-
...
|
|
178
|
-
|
|
179
136
|
def load_scripts_extensions(*, reload_scripts: bool | None = False):
|
|
180
137
|
"""Load extensions scripts (add-ons and app-templates)
|
|
181
138
|
|
|
@@ -204,24 +161,6 @@ def make_rna_paths(
|
|
|
204
161
|
|
|
205
162
|
...
|
|
206
163
|
|
|
207
|
-
def make_rna_paths(
|
|
208
|
-
struct_name: str | None, prop_name: str | None, enum_name: str | None
|
|
209
|
-
):
|
|
210
|
-
"""Create RNA "paths" from given names.
|
|
211
|
-
|
|
212
|
-
:param struct_name: Name of a RNA struct (like e.g. "Scene").
|
|
213
|
-
:type struct_name: str | None
|
|
214
|
-
:param prop_name: Name of a RNA struct's property.
|
|
215
|
-
:type prop_name: str | None
|
|
216
|
-
:param enum_name: Name of a RNA enum identifier.
|
|
217
|
-
:type enum_name: str | None
|
|
218
|
-
:return: A triple of three "RNA paths"
|
|
219
|
-
(most_complete_path, "struct.prop", "struct.prop:'enum'").
|
|
220
|
-
If no enum_name is given, the third element will always be void.
|
|
221
|
-
"""
|
|
222
|
-
|
|
223
|
-
...
|
|
224
|
-
|
|
225
164
|
def manual_language_code(default="en") -> str:
|
|
226
165
|
"""
|
|
227
166
|
|
|
@@ -232,17 +171,6 @@ def manual_language_code(default="en") -> str:
|
|
|
232
171
|
|
|
233
172
|
...
|
|
234
173
|
|
|
235
|
-
def manual_language_code(default="en") -> str:
|
|
236
|
-
"""
|
|
237
|
-
|
|
238
|
-
:return: The language code used for user manual URL component based on the current language user-preference,
|
|
239
|
-
falling back to the default when unavailable.
|
|
240
|
-
:rtype: str
|
|
241
|
-
"""
|
|
242
|
-
|
|
243
|
-
...
|
|
244
|
-
|
|
245
|
-
def manual_map(): ...
|
|
246
174
|
def manual_map(): ...
|
|
247
175
|
def modules_from_path(path: str | None, loaded_modules: set | None) -> list:
|
|
248
176
|
"""Load all modules in a path and return them as a list.
|
|
@@ -258,21 +186,6 @@ def modules_from_path(path: str | None, loaded_modules: set | None) -> list:
|
|
|
258
186
|
|
|
259
187
|
...
|
|
260
188
|
|
|
261
|
-
def modules_from_path(path: str | None, loaded_modules: set | None) -> list:
|
|
262
|
-
"""Load all modules in a path and return them as a list.
|
|
263
|
-
|
|
264
|
-
:param path: this path is scanned for scripts and packages.
|
|
265
|
-
:type path: str | None
|
|
266
|
-
:param loaded_modules: already loaded module names, files matching these
|
|
267
|
-
names will be ignored.
|
|
268
|
-
:type loaded_modules: set | None
|
|
269
|
-
:return: all loaded modules.
|
|
270
|
-
:rtype: list
|
|
271
|
-
"""
|
|
272
|
-
|
|
273
|
-
...
|
|
274
|
-
|
|
275
|
-
def preset_find(name, preset_path, *, display_name=False, ext=".py"): ...
|
|
276
189
|
def preset_find(name, preset_path, *, display_name=False, ext=".py"): ...
|
|
277
190
|
def preset_paths(subdir: str | None) -> list:
|
|
278
191
|
"""Returns a list of paths for a specific preset.
|
|
@@ -285,22 +198,6 @@ def preset_paths(subdir: str | None) -> list:
|
|
|
285
198
|
|
|
286
199
|
...
|
|
287
200
|
|
|
288
|
-
def preset_paths(subdir: str | None) -> list:
|
|
289
|
-
"""Returns a list of paths for a specific preset.
|
|
290
|
-
|
|
291
|
-
:param subdir: preset subdirectory (must not be an absolute path).
|
|
292
|
-
:type subdir: str | None
|
|
293
|
-
:return: script paths.
|
|
294
|
-
:rtype: list
|
|
295
|
-
"""
|
|
296
|
-
|
|
297
|
-
...
|
|
298
|
-
|
|
299
|
-
def refresh_script_paths():
|
|
300
|
-
"""Run this after creating new script paths to update sys.path"""
|
|
301
|
-
|
|
302
|
-
...
|
|
303
|
-
|
|
304
201
|
def refresh_script_paths():
|
|
305
202
|
"""Run this after creating new script paths to update sys.path"""
|
|
306
203
|
|
|
@@ -327,14 +224,6 @@ def register_classes_factory(classes):
|
|
|
327
224
|
|
|
328
225
|
...
|
|
329
226
|
|
|
330
|
-
def register_classes_factory(classes):
|
|
331
|
-
"""Utility function to create register and unregister functions
|
|
332
|
-
which simply registers and unregisters a sequence of classes.
|
|
333
|
-
|
|
334
|
-
"""
|
|
335
|
-
|
|
336
|
-
...
|
|
337
|
-
|
|
338
227
|
def register_cli_command(id: str | None, execute: collections.abc.Callable | None):
|
|
339
228
|
"""Register a command, accessible via the (-c / --command) command-line argument.Custom CommandsRegistering commands makes it possible to conveniently expose command line
|
|
340
229
|
functionality via commands passed to (-c / --command).Using Python Argument ParsingThis example shows how the Python argparse module can be used with a custom command.Using argparse is generally recommended as it has many useful utilities and
|
|
@@ -353,7 +242,6 @@ def register_cli_command(id: str | None, execute: collections.abc.Callable | Non
|
|
|
353
242
|
|
|
354
243
|
...
|
|
355
244
|
|
|
356
|
-
def register_manual_map(manual_hook): ...
|
|
357
245
|
def register_manual_map(manual_hook): ...
|
|
358
246
|
def register_submodule_factory(
|
|
359
247
|
module_name: str | None, submodule_names: list[str] | None
|
|
@@ -371,37 +259,6 @@ def register_submodule_factory(
|
|
|
371
259
|
|
|
372
260
|
...
|
|
373
261
|
|
|
374
|
-
def register_submodule_factory(
|
|
375
|
-
module_name: str | None, submodule_names: list[str] | None
|
|
376
|
-
):
|
|
377
|
-
"""Utility function to create register and unregister functions
|
|
378
|
-
which simply load submodules,
|
|
379
|
-
calling their register & unregister functions.
|
|
380
|
-
|
|
381
|
-
:param module_name: The module name, typically __name__.
|
|
382
|
-
:type module_name: str | None
|
|
383
|
-
:param submodule_names: List of submodule names to load and unload.
|
|
384
|
-
:type submodule_names: list[str] | None
|
|
385
|
-
:return: register and unregister functions.
|
|
386
|
-
"""
|
|
387
|
-
|
|
388
|
-
...
|
|
389
|
-
|
|
390
|
-
def register_tool(
|
|
391
|
-
tool_cls, *, after=None, separator: bool | None = False, group: bool | None = False
|
|
392
|
-
):
|
|
393
|
-
"""Register a tool in the toolbar.
|
|
394
|
-
|
|
395
|
-
:param tool_cls: A tool subclass.
|
|
396
|
-
:param after: Optional identifiers this tool will be added after.
|
|
397
|
-
:param separator: When true, add a separator before this tool.
|
|
398
|
-
:type separator: bool | None
|
|
399
|
-
:param group: When true, add a new nested group of tools.
|
|
400
|
-
:type group: bool | None
|
|
401
|
-
"""
|
|
402
|
-
|
|
403
|
-
...
|
|
404
|
-
|
|
405
262
|
def register_tool(
|
|
406
263
|
tool_cls, *, after=None, separator: bool | None = False, group: bool | None = False
|
|
407
264
|
):
|
|
@@ -439,37 +296,6 @@ def script_path_user():
|
|
|
439
296
|
|
|
440
297
|
...
|
|
441
298
|
|
|
442
|
-
def script_path_user():
|
|
443
|
-
"""returns the env var and falls back to home dir or None"""
|
|
444
|
-
|
|
445
|
-
...
|
|
446
|
-
|
|
447
|
-
def script_paths(
|
|
448
|
-
*,
|
|
449
|
-
subdir: str | None = None,
|
|
450
|
-
user_pref: bool | None = True,
|
|
451
|
-
check_all: bool | None = False,
|
|
452
|
-
use_user: bool | None = True,
|
|
453
|
-
use_system_environment: bool | None = True,
|
|
454
|
-
) -> list:
|
|
455
|
-
"""Returns a list of valid script paths.
|
|
456
|
-
|
|
457
|
-
:param subdir: Optional subdir.
|
|
458
|
-
:type subdir: str | None
|
|
459
|
-
:param user_pref: Include the user preference script paths.
|
|
460
|
-
:type user_pref: bool | None
|
|
461
|
-
:param check_all: Include local, user and system paths rather just the paths Blender uses.
|
|
462
|
-
:type check_all: bool | None
|
|
463
|
-
:param use_user: Include user paths
|
|
464
|
-
:type use_user: bool | None
|
|
465
|
-
:param use_system_environment: Include BLENDER_SYSTEM_SCRIPTS variable path
|
|
466
|
-
:type use_system_environment: bool | None
|
|
467
|
-
:return: script paths.
|
|
468
|
-
:rtype: list
|
|
469
|
-
"""
|
|
470
|
-
|
|
471
|
-
...
|
|
472
|
-
|
|
473
299
|
def script_paths(
|
|
474
300
|
*,
|
|
475
301
|
subdir: str | None = None,
|
|
@@ -518,30 +344,6 @@ def smpte_from_frame(frame: int | None, *, fps=None, fps_base=None) -> str:
|
|
|
518
344
|
|
|
519
345
|
...
|
|
520
346
|
|
|
521
|
-
def smpte_from_frame(frame: int | None, *, fps=None, fps_base=None) -> str:
|
|
522
|
-
"""Returns an SMPTE formatted string from the frame:
|
|
523
|
-
HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
|
|
524
|
-
|
|
525
|
-
:param frame: frame number.
|
|
526
|
-
:type frame: int | None
|
|
527
|
-
:return: the frame string.
|
|
528
|
-
:rtype: str
|
|
529
|
-
"""
|
|
530
|
-
|
|
531
|
-
...
|
|
532
|
-
|
|
533
|
-
def smpte_from_seconds(time: float | int | None, *, fps=None, fps_base=None) -> str:
|
|
534
|
-
"""Returns an SMPTE formatted string from the time:
|
|
535
|
-
HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
|
|
536
|
-
|
|
537
|
-
:param time: time in seconds.
|
|
538
|
-
:type time: float | int | None
|
|
539
|
-
:return: the frame string.
|
|
540
|
-
:rtype: str
|
|
541
|
-
"""
|
|
542
|
-
|
|
543
|
-
...
|
|
544
|
-
|
|
545
347
|
def smpte_from_seconds(time: float | int | None, *, fps=None, fps_base=None) -> str:
|
|
546
348
|
"""Returns an SMPTE formatted string from the time:
|
|
547
349
|
HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
|
|
@@ -605,25 +407,8 @@ def unregister_cli_command(handle):
|
|
|
605
407
|
|
|
606
408
|
...
|
|
607
409
|
|
|
608
|
-
def unregister_manual_map(manual_hook): ...
|
|
609
410
|
def unregister_manual_map(manual_hook): ...
|
|
610
411
|
def unregister_tool(tool_cls): ...
|
|
611
|
-
def unregister_tool(tool_cls): ...
|
|
612
|
-
def user_resource(
|
|
613
|
-
resource_type, *, path: str | None = "", create: bool | None = False
|
|
614
|
-
) -> str:
|
|
615
|
-
"""Return a user resource path (normally from the users home directory).
|
|
616
|
-
|
|
617
|
-
:param path: Optional subdirectory.
|
|
618
|
-
:type path: str | None
|
|
619
|
-
:param create: Treat the path as a directory and create it if its not existing.
|
|
620
|
-
:type create: bool | None
|
|
621
|
-
:return: a path.
|
|
622
|
-
:rtype: str
|
|
623
|
-
"""
|
|
624
|
-
|
|
625
|
-
...
|
|
626
|
-
|
|
627
412
|
def user_resource(
|
|
628
413
|
resource_type, *, path: str | None = "", create: bool | None = False
|
|
629
414
|
) -> str:
|
bpy/utils/previews/__init__.pyi
CHANGED
|
@@ -34,39 +34,21 @@ class ImagePreviewCollection:
|
|
|
34
34
|
"""Close the collection and clear all previews."""
|
|
35
35
|
...
|
|
36
36
|
|
|
37
|
-
def copy(self):
|
|
38
|
-
"""D.copy() -> a shallow copy of D"""
|
|
39
|
-
...
|
|
40
|
-
|
|
41
|
-
def fromkeys(self):
|
|
42
|
-
"""Create a new dictionary with keys from iterable and values set to value."""
|
|
43
|
-
...
|
|
44
|
-
|
|
45
|
-
def get(self, key, default=None):
|
|
46
|
-
"""Return the value for key if key is in the dictionary, else default.
|
|
47
|
-
|
|
48
|
-
:param key:
|
|
49
|
-
:param default:
|
|
50
|
-
"""
|
|
51
|
-
...
|
|
52
|
-
|
|
53
|
-
def items(self):
|
|
54
|
-
"""D.items() -> a set-like object providing a view on D's items"""
|
|
55
|
-
...
|
|
56
|
-
|
|
57
|
-
def keys(self):
|
|
58
|
-
"""D.keys() -> a set-like object providing a view on D's keys"""
|
|
59
|
-
...
|
|
60
|
-
|
|
61
37
|
def load(
|
|
62
|
-
self,
|
|
38
|
+
self,
|
|
39
|
+
name: str | None,
|
|
40
|
+
filepath: bytes | str | None,
|
|
41
|
+
filetype: str | None,
|
|
42
|
+
force_reload: bool | None = False,
|
|
63
43
|
) -> bpy.types.ImagePreview:
|
|
64
44
|
"""Generate a new preview from given file path.
|
|
65
45
|
|
|
66
46
|
:param name: The name (unique id) identifying the preview.
|
|
67
47
|
:type name: str | None
|
|
68
|
-
:param path
|
|
69
|
-
:
|
|
48
|
+
:param filepath: The file path to generate the preview from.
|
|
49
|
+
:type filepath: bytes | str | None
|
|
50
|
+
:param filetype: The type of file, needed to generate the preview in ['IMAGE', 'MOVIE', 'BLEND', 'FONT'].
|
|
51
|
+
:type filetype: str | None
|
|
70
52
|
:param force_reload: If True, force running thumbnail manager even if preview already exists in cache.
|
|
71
53
|
:type force_reload: bool | None
|
|
72
54
|
:return: The Preview matching given name, or a new empty one.
|
|
@@ -84,50 +66,6 @@ class ImagePreviewCollection:
|
|
|
84
66
|
"""
|
|
85
67
|
...
|
|
86
68
|
|
|
87
|
-
def pop(self):
|
|
88
|
-
"""D.pop(k[,d]) -> v, remove specified key and return the corresponding value.If the key is not found, return the default if given; otherwise,
|
|
89
|
-
raise a KeyError.
|
|
90
|
-
|
|
91
|
-
"""
|
|
92
|
-
...
|
|
93
|
-
|
|
94
|
-
def popitem(self):
|
|
95
|
-
"""Remove and return a (key, value) pair as a 2-tuple.Pairs are returned in LIFO (last-in, first-out) order.
|
|
96
|
-
Raises KeyError if the dict is empty.
|
|
97
|
-
|
|
98
|
-
"""
|
|
99
|
-
...
|
|
100
|
-
|
|
101
|
-
def setdefault(self, key, default=None):
|
|
102
|
-
"""Insert key with a value of default if key is not in the dictionary.Return the value for key if key is in the dictionary, else default.
|
|
103
|
-
|
|
104
|
-
:param key:
|
|
105
|
-
:param default:
|
|
106
|
-
"""
|
|
107
|
-
...
|
|
108
|
-
|
|
109
|
-
def update(self):
|
|
110
|
-
"""D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
|
|
111
|
-
If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
|
|
112
|
-
If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
|
|
113
|
-
In either case, this is followed by: for k in F: D[k] = F[k]
|
|
114
|
-
|
|
115
|
-
"""
|
|
116
|
-
...
|
|
117
|
-
|
|
118
|
-
def values(self):
|
|
119
|
-
"""D.values() -> an object providing a view on D's values"""
|
|
120
|
-
...
|
|
121
|
-
|
|
122
|
-
def new() -> ImagePreviewCollection:
|
|
123
|
-
"""
|
|
124
|
-
|
|
125
|
-
:return: a new preview collection.
|
|
126
|
-
:rtype: ImagePreviewCollection
|
|
127
|
-
"""
|
|
128
|
-
|
|
129
|
-
...
|
|
130
|
-
|
|
131
69
|
def new() -> ImagePreviewCollection:
|
|
132
70
|
"""
|
|
133
71
|
|
|
@@ -145,12 +83,3 @@ def remove(pcoll: ImagePreviewCollection | None):
|
|
|
145
83
|
"""
|
|
146
84
|
|
|
147
85
|
...
|
|
148
|
-
|
|
149
|
-
def remove(pcoll: ImagePreviewCollection | None):
|
|
150
|
-
"""Remove the specified previews collection.
|
|
151
|
-
|
|
152
|
-
:param pcoll: Preview collection to close.
|
|
153
|
-
:type pcoll: ImagePreviewCollection | None
|
|
154
|
-
"""
|
|
155
|
-
|
|
156
|
-
...
|