fake-bpy-module 20240420__py3-none-any.whl → 20240422__py3-none-any.whl

bpy/utils/__init__.pyi

@@ -16,11 +16,11 @@ from . import units
 
 GenericType = typing.TypeVar("GenericType")
 
-def app_template_paths(path: str = None):
+def app_template_paths(path: typing.Optional[str] = None):
     """Returns valid application template paths.
 
     :param path: Optional subdir.
-    :type path: str
+    :type path: typing.Optional[str]
     :return: app template paths.
     """
 
@@ -32,38 +32,40 @@ def app_template_paths(path):
     ...
 
 def blend_paths(
-    absolute: bool = False, packed: bool = False, local: bool = False
+    absolute: typing.Optional[bool] = False,
+    packed: typing.Optional[bool] = False,
+    local: typing.Optional[bool] = False,
 ) -> typing.List[str]:
     """Returns a list of paths to external files referenced by the loaded .blend file.
 
     :param absolute: When true the paths returned are made absolute.
-    :type absolute: bool
+    :type absolute: typing.Optional[bool]
     :param packed: When true skip file paths for packed data.
-    :type packed: bool
+    :type packed: typing.Optional[bool]
     :param local: When true skip linked library paths.
-    :type local: bool
+    :type local: typing.Optional[bool]
     :return: path list.
     :rtype: typing.List[str]
     """
 
     ...
 
-def escape_identifier(string: str) -> str:
+def escape_identifier(string: typing.Optional[str]) -> str:
     """Simple string escaping function used for animation paths.
 
     :param string: text
-    :type string: str
+    :type string: typing.Optional[str]
     :return: The escaped string.
     :rtype: str
     """
 
     ...
 
-def execfile(filepath: str, mod=None):
+def execfile(filepath: typing.Optional[str], mod=None):
     """Execute a file path as a Python script.
 
     :param filepath: Path of the script to execute.
-    :type filepath: str
+    :type filepath: typing.Optional[str]
     :param mod: Optional cached module, the result of a previous execution.
     :return: The module which can be passed back in as mod.
     """
@@ -75,14 +77,16 @@ def execfile(filepath, mod):
 
     ...
 
-def flip_name(name: str, strip_digits: bool = False) -> str:
+def flip_name(
+    name: typing.Optional[str], strip_digits: typing.Optional[bool] = False
+) -> str:
     """Flip a name between left/right sides, useful for
     mirroring bone names.
 
         :param name: Bone name to flip.
-        :type name: str
+        :type name: typing.Optional[str]
         :param strip_digits: Whether to remove .### suffix.
-        :type strip_digits: bool
+        :type strip_digits: typing.Optional[bool]
         :return: The flipped name.
         :rtype: str
     """
@@ -115,18 +119,20 @@ def keyconfig_set(filepath, report):
     ...
 
 def load_scripts(
-    reload_scripts: bool = False, refresh_scripts: bool = False, extensions: bool = True
+    reload_scripts: typing.Optional[bool] = False,
+    refresh_scripts: typing.Optional[bool] = False,
+    extensions: typing.Optional[bool] = True,
 ):
     """Load scripts and run each modules register function.
 
         :param reload_scripts: Causes all scripts to have their unregister method
     called before loading.
-        :type reload_scripts: bool
+        :type reload_scripts: typing.Optional[bool]
         :param refresh_scripts: only load scripts which are not already loaded
     as modules.
-        :type refresh_scripts: bool
+        :type refresh_scripts: typing.Optional[bool]
         :param extensions: Loads additional scripts (add-ons & app-templates).
-        :type extensions: bool
+        :type extensions: typing.Optional[bool]
     """
 
     ...
@@ -141,15 +147,19 @@ def load_scripts_extensions(reload_scripts):
 
     ...
 
-def make_rna_paths(struct_name: str, prop_name: str, enum_name: str):
+def make_rna_paths(
+    struct_name: typing.Optional[str],
+    prop_name: typing.Optional[str],
+    enum_name: typing.Optional[str],
+):
     """Create RNA "paths" from given names.
 
         :param struct_name: Name of a RNA struct (like e.g. "Scene").
-        :type struct_name: str
+        :type struct_name: typing.Optional[str]
         :param prop_name: Name of a RNA struct's property.
-        :type prop_name: str
+        :type prop_name: typing.Optional[str]
         :param enum_name: Name of a RNA enum identifier.
-        :type enum_name: str
+        :type enum_name: typing.Optional[str]
         :return: A triple of three "RNA paths"
     (most_complete_path, "struct.prop", "struct.prop:'enum'").
     If no enum_name is given, the third element will always be void.
@@ -187,14 +197,16 @@ def manual_map():
 
     ...
 
-def modules_from_path(path: str, loaded_modules: set) -> list:
+def modules_from_path(
+    path: typing.Optional[str], loaded_modules: typing.Optional[set]
+) -> list:
     """Load all modules in a path and return them as a list.
 
         :param path: this path is scanned for scripts and packages.
-        :type path: str
+        :type path: typing.Optional[str]
         :param loaded_modules: already loaded module names, files matching these
     names will be ignored.
-        :type loaded_modules: set
+        :type loaded_modules: typing.Optional[set]
         :return: all loaded modules.
         :rtype: list
     """
@@ -216,11 +228,11 @@ def preset_find(name, preset_path, display_name, ext):
 
     ...
 
-def preset_paths(subdir: str) -> list:
+def preset_paths(subdir: typing.Optional[str]) -> list:
     """Returns a list of paths for a specific preset.
 
     :param subdir: preset subdirectory (must not be an absolute path).
-    :type subdir: str
+    :type subdir: typing.Optional[str]
     :return: script paths.
     :rtype: list
     """
@@ -268,7 +280,9 @@ def register_classes_factory(classes):
 
     ...
 
-def register_cli_command(id: str, execute: typing.Callable):
+def register_cli_command(
+    id: typing.Optional[str], execute: typing.Optional[typing.Callable]
+):
     """Register a command, accessible via the (-c / --command) command-line argument.Custom CommandsRegistering commands makes it possible to conveniently expose command line
     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
     generates a --help message for your command.
@@ -276,11 +290,11 @@ def register_cli_command(id: str, execute: typing.Callable):
         :param id: The command identifier (must pass an str.isidentifier check).
 
     If the id is already registered, a warning is printed and the command is inaccessible to prevent accidents invoking the wrong command.
-        :type id: str
+        :type id: typing.Optional[str]
         :param execute: Callback, taking a single list of strings and returns an int.
     The arguments are built from all command-line arguments following the command id.
     The return value should be 0 for success, 1 on failure (specific error codes from the os module can also be used).
-        :type execute: typing.Callable
+        :type execute: typing.Optional[typing.Callable]
         :return: The command handle which can be passed to `unregister_cli_command`.
     """
 
@@ -296,15 +310,18 @@ def register_manual_map(manual_hook):
 
     ...
 
-def register_submodule_factory(module_name: str, submodule_names: typing.List[str]):
+def register_submodule_factory(
+    module_name: typing.Optional[str],
+    submodule_names: typing.Optional[typing.List[str]],
+):
     """Utility function to create register and unregister functions
     which simply load submodules,
     calling their register & unregister functions.
 
         :param module_name: The module name, typically __name__.
-        :type module_name: str
+        :type module_name: typing.Optional[str]
         :param submodule_names: List of submodule names to load and unload.
-        :type submodule_names: typing.List[str]
+        :type submodule_names: typing.Optional[typing.List[str]]
         :return: register and unregister functions.
     """
 
@@ -315,14 +332,19 @@ def register_submodule_factory(module_name, submodule_names):
 
     ...
 
-def register_tool(tool_cls, after=None, separator: bool = False, group: bool = False):
+def register_tool(
+    tool_cls,
+    after=None,
+    separator: typing.Optional[bool] = False,
+    group: typing.Optional[bool] = False,
+):
     """Register a tool in the toolbar.
 
     :param after: Optional identifiers this tool will be added after.
     :param separator: When true, add a separator before this tool.
-    :type separator: bool
+    :type separator: typing.Optional[bool]
     :param group: When true, add a new nested group of tools.
-    :type group: bool
+    :type group: typing.Optional[bool]
     """
 
     ...
@@ -332,15 +354,19 @@ def register_tool(tool_cls, after, separator, group):
 
     ...
 
-def resource_path(type: str, major: int = None[0], minor: str = None[1]) -> str:
+def resource_path(
+    type: typing.Optional[str],
+    major: typing.Optional[int] = None[0],
+    minor: typing.Optional[str] = None[1],
+) -> str:
     """Return the base path for storing system files.
 
     :param type: string in ['USER', 'LOCAL', 'SYSTEM'].
-    :type type: str
+    :type type: typing.Optional[str]
     :param major: major version, defaults to current.
-    :type major: int
+    :type major: typing.Optional[int]
     :param minor: minor version, defaults to current.
-    :type minor: str
+    :type minor: typing.Optional[str]
     :return: the resource path (not necessarily existing).
     :rtype: str
     """
@@ -358,16 +384,19 @@ def script_path_user():
     ...
 
 def script_paths(
-    subdir: str = None, user_pref: bool = True, check_all: bool = False, use_user=True
+    subdir: typing.Optional[str] = None,
+    user_pref: typing.Optional[bool] = True,
+    check_all: typing.Optional[bool] = False,
+    use_user=True,
 ) -> list:
     """Returns a list of valid script paths.
 
     :param subdir: Optional subdir.
-    :type subdir: str
+    :type subdir: typing.Optional[str]
     :param user_pref: Include the user preference script paths.
-    :type user_pref: bool
+    :type user_pref: typing.Optional[bool]
     :param check_all: Include local, user and system paths rather just the paths Blender uses.
-    :type check_all: bool
+    :type check_all: typing.Optional[bool]
     :return: script paths.
     :rtype: list
     """
@@ -384,12 +413,12 @@ def script_paths_pref():
 
     ...
 
-def smpte_from_frame(frame: int, fps=None, fps_base=None) -> str:
+def smpte_from_frame(frame: typing.Optional[int], fps=None, fps_base=None) -> str:
     """Returns an SMPTE formatted string from the frame:
     HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
 
         :param frame: frame number.
-        :type frame: int
+        :type frame: typing.Optional[int]
         :return: the frame string.
         :rtype: str
     """
@@ -401,12 +430,14 @@ def smpte_from_frame(frame, fps, fps_base):
 
     ...
 
-def smpte_from_seconds(time: typing.Union[int, float], fps=None, fps_base=None) -> str:
+def smpte_from_seconds(
+    time: typing.Optional[typing.Union[int, float]], fps=None, fps_base=None
+) -> str:
     """Returns an SMPTE formatted string from the time:
     HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
 
         :param time: time in seconds.
-        :type time: typing.Union[int, float]
+        :type time: typing.Optional[typing.Union[int, float]]
         :return: the frame string.
         :rtype: str
     """
@@ -428,12 +459,12 @@ def time_to_frame(time, fps, fps_base):
 
     ...
 
-def unescape_identifier(string: str) -> str:
+def unescape_identifier(string: typing.Optional[str]) -> str:
     """Simple string un-escape function used for animation paths.
     This performs the reverse of escape_identifier.
 
         :param string: text
-        :type string: str
+        :type string: typing.Optional[str]
         :return: The un-escaped string.
         :rtype: str
     """
@@ -478,14 +509,18 @@ def unregister_tool(tool_cls):
 
     ...
 
-def user_resource(resource_type, path: str = "", create: bool = False) -> str:
+def user_resource(
+    resource_type,
+    path: typing.Optional[str] = "",
+    create: typing.Optional[bool] = False,
+) -> str:
     """Return a user resource path (normally from the users home directory).
 
         :param path: Optional subdirectory.
-        :type path: str
+        :type path: typing.Optional[str]
         :param create: Treat the path as a directory and create
     it if its not existing.
-        :type create: bool
+        :type create: typing.Optional[bool]
         :return: a path.
         :rtype: str
     """

bpy/utils/previews/__init__.pyi

@@ -108,11 +108,11 @@ def new():
 
     ...
 
-def remove(pcoll: ImagePreviewCollection):
+def remove(pcoll: typing.Optional[ImagePreviewCollection]):
     """Remove the specified previews collection.
 
     :param pcoll: Preview collection to close.
-    :type pcoll: ImagePreviewCollection
+    :type pcoll: typing.Optional[ImagePreviewCollection]
     """
 
     ...

bpy/utils/units/__init__.pyi

@@ -8,28 +8,28 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 def to_string(
-    unit_system: str,
-    unit_category: str,
-    value: float,
-    precision: int = 3,
-    split_unit: bool = False,
-    compatible_unit: bool = False,
+    unit_system: typing.Optional[str],
+    unit_category: typing.Optional[str],
+    value: typing.Optional[float],
+    precision: typing.Optional[int] = 3,
+    split_unit: typing.Optional[bool] = False,
+    compatible_unit: typing.Optional[bool] = False,
 ) -> str:
     """Convert a given input float value into a string with units.
 
         :param unit_system: The unit system, from `bpy.utils.units.systems`.
-        :type unit_system: str
+        :type unit_system: typing.Optional[str]
         :param unit_category: The category of data we are converting (length, area, rotation, etc.),
     from `bpy.utils.units.categories`.
-        :type unit_category: str
+        :type unit_category: typing.Optional[str]
         :param value: The value to convert to a string.
-        :type value: float
+        :type value: typing.Optional[float]
         :param precision: Number of digits after the comma.
-        :type precision: int
+        :type precision: typing.Optional[int]
         :param split_unit: Whether to use several units if needed (1m1cm), or always only one (1.01m).
-        :type split_unit: bool
+        :type split_unit: typing.Optional[bool]
         :param compatible_unit: Whether to use keyboard-friendly units (1m2) or nicer utf-8 ones (1m²).
-        :type compatible_unit: bool
+        :type compatible_unit: typing.Optional[bool]
         :return: The converted string.
         :rtype: str
     """
@@ -37,19 +37,22 @@ def to_string(
     ...
 
 def to_value(
-    unit_system: str, unit_category: str, str_input: str, str_ref_unit: str = None
+    unit_system: typing.Optional[str],
+    unit_category: typing.Optional[str],
+    str_input: typing.Optional[str],
+    str_ref_unit: typing.Optional[str] = None,
 ) -> float:
     """Convert a given input string into a float value.
 
         :param unit_system: The unit system, from `bpy.utils.units.systems`.
-        :type unit_system: str
+        :type unit_system: typing.Optional[str]
         :param unit_category: The category of data we are converting (length, area, rotation, etc.),
     from `bpy.utils.units.categories`.
-        :type unit_category: str
+        :type unit_category: typing.Optional[str]
         :param str_input: The string to convert to a float value.
-        :type str_input: str
+        :type str_input: typing.Optional[str]
         :param str_ref_unit: A reference string from which to extract a default unit, if none is found in str_input.
-        :type str_ref_unit: str
+        :type str_ref_unit: typing.Optional[str]
         :return: The converted/interpreted value.
         :rtype: float
     """

bpy_extras/anim_utils/__init__.pyi

@@ -4,7 +4,10 @@ import bpy.types
 GenericType = typing.TypeVar("GenericType")
 
 def bake_action(
-    obj: bpy.types.Object, action, frames, bake_options
+    obj: bpy.types.Object,
+    action: typing.Optional[bpy.types.Action],
+    frames,
+    bake_options,
 ) -> bpy.types.Action:
     """
 
@@ -12,6 +15,7 @@ def bake_action(
         :type obj: bpy.types.Object
         :param action: An action to bake the data into, or None for a new action
     to be created.
+        :type action: typing.Optional[bpy.types.Action]
         :param frames: Frames to bake.
         :return: an action or None
         :rtype: bpy.types.Action
@@ -19,13 +23,16 @@ def bake_action(
 
     ...
 
-def bake_action_iter(obj: bpy.types.Object, action, bake_options) -> bpy.types.Action:
+def bake_action_iter(
+    obj: bpy.types.Object, action: typing.Optional[bpy.types.Action], bake_options
+) -> bpy.types.Action:
     """An coroutine that bakes action for a single object.
 
         :param obj: Object to bake.
         :type obj: bpy.types.Object
         :param action: An action to bake the data into, or None for a new action
     to be created.
+        :type action: typing.Optional[bpy.types.Action]
         :param bake_options: Boolean options of what to include into the action bake.
         :return: an action or None
         :rtype: bpy.types.Action

bpy_extras/io_utils/__init__.pyi

@@ -104,7 +104,7 @@ def path_reference(
     mode: str = "AUTO",
     copy_subdir: str = "",
     copy_set: set = None,
-    library=None,
+    library: typing.Optional[bpy.types.Library] = None,
 ) -> str:
     """Return a filepath relative to a destination directory, for use with
     exporters.
@@ -127,6 +127,7 @@ def path_reference(
     pass to path_reference_copy when exporting is done.
         :type copy_set: set
         :param library: The library this path is relative to.
+        :type library: typing.Optional[bpy.types.Library]
         :return: the new filepath.
         :rtype: str
     """

bpy_extras/view3d_utils/__init__.pyi

@@ -55,7 +55,7 @@ def region_2d_to_origin_3d(
     region: bpy.types.Region,
     rv3d: bpy.types.RegionView3D,
     coord: mathutils.Vector,
-    clamp=None,
+    clamp: typing.Optional[float] = None,
 ) -> mathutils.Vector:
     """Return the 3d view origin from the region relative 2d coords.
 
@@ -68,6 +68,7 @@ def region_2d_to_origin_3d(
         :type coord: mathutils.Vector
         :param clamp: Clamp the maximum far-clip value used.
     (negative value will move the offset away from the view_location)
+        :type clamp: typing.Optional[float]
         :return: The origin of the viewpoint in 3d space.
         :rtype: mathutils.Vector
     """