fake-bpy-module 20240516__py3-none-any.whl → 20240518__py3-none-any.whl

bpy/ops/workspace/__init__.pyi

@@ -4,119 +4,105 @@ import bpy.types
 GenericType = typing.TypeVar("GenericType")
 
 def add(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Add a new workspace by duplicating the current one or appending one from the user configuration
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...
 
 def append_activate(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
-    idname: typing.Union[str, typing.Any] = "",
-    filepath: typing.Union[str, typing.Any] = "",
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
+    idname: str | typing.Any = "",
+    filepath: str | typing.Any = "",
 ):
     """Append a workspace and make it the active one in the current window
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     :param idname: Identifier, Name of the workspace to append and activate
-    :type idname: typing.Union[str, typing.Any]
+    :type idname: str | typing.Any
     :param filepath: Filepath, Path to the library
-    :type filepath: typing.Union[str, typing.Any]
+    :type filepath: str | typing.Any
     """
 
     ...
 
 def delete(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Delete the active workspace
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...
 
 def duplicate(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Add a new workspace
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...
 
 def reorder_to_back(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Reorder workspace to be last in the list
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...
 
 def reorder_to_front(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Reorder workspace to be first in the list
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...
 
 def scene_pin_toggle(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Remember the last used scene for the current workspace and switch to it whenever this workspace is activated again
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...

bpy/ops/world/__init__.pyi

@@ -4,33 +4,29 @@ import bpy.types
 GenericType = typing.TypeVar("GenericType")
 
 def convert_volume_to_mesh(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Convert the volume of a world to a mesh.
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...
 
 def new(
-    override_context: typing.Optional[
-        typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
-    ] = None,
-    execution_context: typing.Optional[typing.Union[str, int]] = None,
-    undo: typing.Optional[bool] = None,
+    override_context: dict[str, typing.Any] | bpy.types.Context | None = None,
+    execution_context: str | int | None = None,
+    undo: bool | None = None,
 ):
     """Create a new world Data-Block
 
-    :type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
-    :type execution_context: typing.Optional[typing.Union[str, int]]
-    :type undo: typing.Optional[bool]
+    :type override_context: dict[str, typing.Any] | bpy.types.Context | None
+    :type execution_context: str | int | None
+    :type undo: bool | None
     """
 
     ...

bpy/path/__init__.pyi

@@ -10,27 +10,38 @@ import bpy.types
 GenericType = typing.TypeVar("GenericType")
 
 def abspath(
-    path,
-    start: typing.Optional[typing.Union[str, bytes]] = None,
-    library: typing.Optional[bpy.types.Library] = None,
+    path, start: str | bytes | None = None, library: bpy.types.Library | None = None
 ) -> str:
     """Returns the absolute path relative to the current blend file
     using the "//" prefix.
 
         :param start: Relative to this path,
     when not set the current filename is used.
-        :type start: typing.Optional[typing.Union[str, bytes]]
+        :type start: str | bytes | None
         :param library: The library this path is from. This is only included for
     convenience, when the library is not None its path replaces start.
-        :type library: typing.Optional[bpy.types.Library]
+        :type library: bpy.types.Library | None
         :return: The absolute path.
         :rtype: str
     """
 
     ...
 
-def abspath(path, start, library):
-    """ """
+def abspath(
+    path, start: str | bytes | None = None, library: bpy.types.Library | None = None
+) -> str:
+    """Returns the absolute path relative to the current blend file
+    using the "//" prefix.
+
+        :param start: Relative to this path,
+    when not set the current filename is used.
+        :type start: str | bytes | None
+        :param library: The library this path is from. This is only included for
+    convenience, when the library is not None its path replaces start.
+        :type library: bpy.types.Library | None
+        :return: The absolute path.
+        :rtype: str
+    """
 
     ...
 
@@ -43,228 +54,321 @@ def basename(path) -> str:
 
     ...
 
-def basename(path):
-    """ """
+def basename(path) -> str:
+    """Equivalent to os.path.basename, but skips a "//" prefix.Use for Windows compatibility.
+
+    :return: The base name of the given path.
+    :rtype: str
+    """
 
     ...
 
-def clean_name(
-    name: typing.Optional[typing.Union[str, bytes]], replace: typing.Optional[str] = "_"
-) -> str:
+def clean_name(name: str | bytes | None, replace: str | None = "_") -> str:
     """Returns a name with characters replaced that
     may cause problems under various circumstances,
     such as writing to a file.All characters besides A-Z/a-z, 0-9 are replaced with "_"
     or the replace argument if defined.
 
         :param name: The path name.
-        :type name: typing.Optional[typing.Union[str, bytes]]
+        :type name: str | bytes | None
         :param replace: The replacement for non-valid characters.
-        :type replace: typing.Optional[str]
+        :type replace: str | None
         :return: The cleaned name.
         :rtype: str
     """
 
     ...
 
-def clean_name(name, replace):
-    """ """
+def clean_name(name: str | bytes | None, replace: str | None = "_") -> str:
+    """Returns a name with characters replaced that
+    may cause problems under various circumstances,
+    such as writing to a file.All characters besides A-Z/a-z, 0-9 are replaced with "_"
+    or the replace argument if defined.
+
+        :param name: The path name.
+        :type name: str | bytes | None
+        :param replace: The replacement for non-valid characters.
+        :type replace: str | None
+        :return: The cleaned name.
+        :rtype: str
+    """
 
     ...
 
 def display_name(
-    name: typing.Optional[str],
-    has_ext: typing.Optional[bool] = True,
-    title_case: typing.Optional[bool] = True,
+    name: str | None, has_ext: bool | None = True, title_case: bool | None = True
 ) -> str:
     """Creates a display string from name to be used menus and the user interface.
     Intended for use with filenames and module names.
 
         :param name: The name to be used for displaying the user interface.
-        :type name: typing.Optional[str]
+        :type name: str | None
         :param has_ext: Remove file extension from name.
-        :type has_ext: typing.Optional[bool]
+        :type has_ext: bool | None
         :param title_case: Convert lowercase names to title case.
-        :type title_case: typing.Optional[bool]
+        :type title_case: bool | None
         :return: The display string.
         :rtype: str
     """
 
     ...
 
-def display_name(name, has_ext, title_case):
-    """ """
+def display_name(
+    name: str | None, has_ext: bool | None = True, title_case: bool | None = True
+) -> str:
+    """Creates a display string from name to be used menus and the user interface.
+    Intended for use with filenames and module names.
+
+        :param name: The name to be used for displaying the user interface.
+        :type name: str | None
+        :param has_ext: Remove file extension from name.
+        :type has_ext: bool | None
+        :param title_case: Convert lowercase names to title case.
+        :type title_case: bool | None
+        :return: The display string.
+        :rtype: str
+    """
 
     ...
 
-def display_name_from_filepath(name: typing.Optional[str]) -> str:
+def display_name_from_filepath(name: str | None) -> str:
     """Returns the path stripped of directory and extension,
     ensured to be utf8 compatible.
 
         :param name: The file path to convert.
-        :type name: typing.Optional[str]
+        :type name: str | None
         :return: The display name.
         :rtype: str
     """
 
     ...
 
-def display_name_from_filepath(name):
-    """ """
+def display_name_from_filepath(name: str | None) -> str:
+    """Returns the path stripped of directory and extension,
+    ensured to be utf8 compatible.
+
+        :param name: The file path to convert.
+        :type name: str | None
+        :return: The display name.
+        :rtype: str
+    """
 
     ...
 
-def display_name_to_filepath(name: typing.Optional[str]) -> str:
+def display_name_to_filepath(name: str | None) -> str:
     """Performs the reverse of display_name using literal versions of characters
     which aren't supported in a filepath.
 
         :param name: The display name to convert.
-        :type name: typing.Optional[str]
+        :type name: str | None
         :return: The file path.
         :rtype: str
     """
 
     ...
 
-def display_name_to_filepath(name):
-    """ """
+def display_name_to_filepath(name: str | None) -> str:
+    """Performs the reverse of display_name using literal versions of characters
+    which aren't supported in a filepath.
+
+        :param name: The display name to convert.
+        :type name: str | None
+        :return: The file path.
+        :rtype: str
+    """
 
     ...
 
 def ensure_ext(
-    filepath: typing.Optional[str],
-    ext: typing.Optional[str],
-    case_sensitive: typing.Optional[bool] = False,
+    filepath: str | None, ext: str | None, case_sensitive: bool | None = False
 ) -> str:
     """Return the path with the extension added if it is not already set.
 
         :param filepath: The file path.
-        :type filepath: typing.Optional[str]
+        :type filepath: str | None
         :param ext: The extension to check for, can be a compound extension. Should
     start with a dot, such as '.blend' or '.tar.gz'.
-        :type ext: typing.Optional[str]
+        :type ext: str | None
         :param case_sensitive: Check for matching case when comparing extensions.
-        :type case_sensitive: typing.Optional[bool]
+        :type case_sensitive: bool | None
         :return: The file path with the given extension.
         :rtype: str
     """
 
     ...
 
-def ensure_ext(filepath, ext, case_sensitive):
-    """ """
+def ensure_ext(
+    filepath: str | None, ext: str | None, case_sensitive: bool | None = False
+) -> str:
+    """Return the path with the extension added if it is not already set.
+
+        :param filepath: The file path.
+        :type filepath: str | None
+        :param ext: The extension to check for, can be a compound extension. Should
+    start with a dot, such as '.blend' or '.tar.gz'.
+        :type ext: str | None
+        :param case_sensitive: Check for matching case when comparing extensions.
+        :type case_sensitive: bool | None
+        :return: The file path with the given extension.
+        :rtype: str
+    """
 
     ...
 
-def is_subdir(path: typing.Optional[typing.Union[str, bytes]], directory) -> bool:
+def is_subdir(path: str | bytes | None, directory) -> bool:
     """Returns true if path in a subdirectory of directory.
     Both paths must be absolute.
 
         :param path: An absolute path.
-        :type path: typing.Optional[typing.Union[str, bytes]]
+        :type path: str | bytes | None
         :return: Whether or not the path is a subdirectory.
         :rtype: bool
     """
 
     ...
 
-def is_subdir(path, directory):
-    """ """
+def is_subdir(path: str | bytes | None, directory) -> bool:
+    """Returns true if path in a subdirectory of directory.
+    Both paths must be absolute.
+
+        :param path: An absolute path.
+        :type path: str | bytes | None
+        :return: Whether or not the path is a subdirectory.
+        :rtype: bool
+    """
 
     ...
 
 def module_names(
-    path: typing.Optional[str],
-    recursive: typing.Optional[bool] = False,
-    package: typing.Optional[str] = "",
-) -> typing.List[str]:
+    path: str | None, recursive: bool | None = False, package: str | None = ""
+) -> list[str]:
     """Return a list of modules which can be imported from path.
 
     :param path: a directory to scan.
-    :type path: typing.Optional[str]
+    :type path: str | None
     :param recursive: Also return submodule names for packages.
-    :type recursive: typing.Optional[bool]
+    :type recursive: bool | None
     :param package: Optional string, used as the prefix for module names (without the trailing ".").
-    :type package: typing.Optional[str]
+    :type package: str | None
     :return: a list of string pairs (module_name, module_file).
-    :rtype: typing.List[str]
+    :rtype: list[str]
     """
 
     ...
 
-def module_names(path, recursive, package):
-    """ """
+def module_names(
+    path: str | None, recursive: bool | None = False, package: str | None = ""
+) -> list[str]:
+    """Return a list of modules which can be imported from path.
+
+    :param path: a directory to scan.
+    :type path: str | None
+    :param recursive: Also return submodule names for packages.
+    :type recursive: bool | None
+    :param package: Optional string, used as the prefix for module names (without the trailing ".").
+    :type package: str | None
+    :return: a list of string pairs (module_name, module_file).
+    :rtype: list[str]
+    """
 
     ...
 
-def native_pathsep(path: typing.Optional[str]) -> str:
+def native_pathsep(path: str | None) -> str:
     """Replace the path separator with the systems native os.sep.
 
     :param path: The path to replace.
-    :type path: typing.Optional[str]
+    :type path: str | None
     :return: The path with system native separators.
     :rtype: str
     """
 
     ...
 
-def native_pathsep(path):
-    """ """
+def native_pathsep(path: str | None) -> str:
+    """Replace the path separator with the systems native os.sep.
+
+    :param path: The path to replace.
+    :type path: str | None
+    :return: The path with system native separators.
+    :rtype: str
+    """
 
     ...
 
-def reduce_dirs(dirs: typing.Optional[typing.List[str]]) -> typing.List[str]:
+def reduce_dirs(dirs: list[str] | None) -> list[str]:
     """Given a sequence of directories, remove duplicates and
     any directories nested in one of the other paths.
     (Useful for recursive path searching).
 
         :param dirs: Sequence of directory paths.
-        :type dirs: typing.Optional[typing.List[str]]
+        :type dirs: list[str] | None
         :return: A unique list of paths.
-        :rtype: typing.List[str]
+        :rtype: list[str]
     """
 
     ...
 
-def reduce_dirs(dirs):
-    """ """
+def reduce_dirs(dirs: list[str] | None) -> list[str]:
+    """Given a sequence of directories, remove duplicates and
+    any directories nested in one of the other paths.
+    (Useful for recursive path searching).
+
+        :param dirs: Sequence of directory paths.
+        :type dirs: list[str] | None
+        :return: A unique list of paths.
+        :rtype: list[str]
+    """
 
     ...
 
-def relpath(
-    path: typing.Optional[typing.Union[str, bytes]],
-    start: typing.Optional[typing.Union[str, bytes]] = None,
-) -> str:
+def relpath(path: str | bytes | None, start: str | bytes | None = None) -> str:
     """Returns the path relative to the current blend file using the "//" prefix.
 
         :param path: An absolute path.
-        :type path: typing.Optional[typing.Union[str, bytes]]
+        :type path: str | bytes | None
         :param start: Relative to this path,
     when not set the current filename is used.
-        :type start: typing.Optional[typing.Union[str, bytes]]
+        :type start: str | bytes | None
         :return: The relative path.
         :rtype: str
     """
 
     ...
 
-def relpath(path, start):
-    """ """
+def relpath(path: str | bytes | None, start: str | bytes | None = None) -> str:
+    """Returns the path relative to the current blend file using the "//" prefix.
+
+        :param path: An absolute path.
+        :type path: str | bytes | None
+        :param start: Relative to this path,
+    when not set the current filename is used.
+        :type start: str | bytes | None
+        :return: The relative path.
+        :rtype: str
+    """
 
     ...
 
-def resolve_ncase(path: typing.Optional[str]) -> str:
+def resolve_ncase(path: str | None) -> str:
     """Resolve a case insensitive path on a case sensitive system,
     returning a string with the path if found else return the original path.
 
         :param path: The path name to resolve.
-        :type path: typing.Optional[str]
+        :type path: str | None
         :return: The resolved path.
         :rtype: str
     """
 
     ...
 
-def resolve_ncase(path):
-    """ """
+def resolve_ncase(path: str | None) -> str:
+    """Resolve a case insensitive path on a case sensitive system,
+    returning a string with the path if found else return the original path.
+
+        :param path: The path name to resolve.
+        :type path: str | None
+        :return: The resolved path.
+        :rtype: str
+    """
 
     ...