fake-bpy-module 20240210__py3-none-any.whl → 20240326__py3-none-any.whl

bmesh/utils/__init__.pyi

@@ -1,199 +1,193 @@
-import sys
 import typing
 import bmesh.types
 
 GenericType = typing.TypeVar("GenericType")
 
-def edge_rotate(edge: "bmesh.types.BMEdge", ccw: bool = False) -> "bmesh.types.BMEdge":
-    """Rotate the edge and return the newly created edge. If rotating the edge fails, None will be returned.
+def edge_rotate(edge: bmesh.types.BMEdge, ccw: bool = False) -> bmesh.types.BMEdge:
+    """Rotate the edge and return the newly created edge.
+    If rotating the edge fails, None will be returned.
 
-    :param edge: The edge to rotate.
-    :type edge: 'bmesh.types.BMEdge'
-    :param ccw: When True the edge will be rotated counter clockwise.
-    :type ccw: bool
-    :rtype: 'bmesh.types.BMEdge'
-    :return: The newly rotated edge.
+        :param edge: The edge to rotate.
+        :type edge: bmesh.types.BMEdge
+        :param ccw: When True the edge will be rotated counter clockwise.
+        :type ccw: bool
+        :return: The newly rotated edge.
+        :rtype: bmesh.types.BMEdge
     """
 
     ...
 
 def edge_split(
-    edge: "bmesh.types.BMEdge", vert: "bmesh.types.BMVert", fac: float
+    edge: bmesh.types.BMEdge, vert: bmesh.types.BMVert, fac: float
 ) -> typing.Tuple:
     """Split an edge, return the newly created data.
 
     :param edge: The edge to split.
-    :type edge: 'bmesh.types.BMEdge'
+    :type edge: bmesh.types.BMEdge
     :param vert: One of the verts on the edge, defines the split direction.
-    :type vert: 'bmesh.types.BMVert'
+    :type vert: bmesh.types.BMVert
     :param fac: The point on the edge where the new vert will be created [0 - 1].
     :type fac: float
-    :rtype: typing.Tuple
     :return: The newly created (edge, vert) pair.
+    :rtype: typing.Tuple
     """
 
     ...
 
 def face_flip(faces):
-    """Flip the faces direction.
-
-    :param face: Face to flip.
-    :type face: 'bmesh.types.BMFace'
-    """
+    """Flip the faces direction."""
 
     ...
 
-def face_join(faces: "bmesh.types.BMFace", remove: bool = True) -> "bmesh.types.BMFace":
+def face_join(faces: bmesh.types.BMFace, remove: bool = True) -> bmesh.types.BMFace:
     """Joins a sequence of faces.
 
     :param faces: Sequence of faces.
-    :type faces: 'bmesh.types.BMFace'
+    :type faces: bmesh.types.BMFace
     :param remove: Remove the edges and vertices between the faces.
     :type remove: bool
-    :rtype: 'bmesh.types.BMFace'
     :return: The newly created face or None on failure.
+    :rtype: bmesh.types.BMFace
     """
 
     ...
 
 def face_split(
-    face: "bmesh.types.BMFace",
-    vert_a: "bmesh.types.BMVert",
-    vert_b: "bmesh.types.BMVert",
+    face: bmesh.types.BMFace,
+    vert_a: bmesh.types.BMVert,
+    vert_b: bmesh.types.BMVert,
     coords: typing.List[float] = (),
     use_exist: bool = True,
-    example: "bmesh.types.BMEdge" = None,
-) -> typing.Tuple["bmesh.types.BMFace", "bmesh.types.BMLoop"]:
+    example: bmesh.types.BMEdge = None,
+) -> typing.Tuple[bmesh.types.BMFace, bmesh.types.BMLoop]:
     """Face split with optional intermediate points.
 
     :param face: The face to cut.
-    :type face: 'bmesh.types.BMFace'
+    :type face: bmesh.types.BMFace
     :param vert_a: First vertex to cut in the face (face must contain the vert).
-    :type vert_a: 'bmesh.types.BMVert'
+    :type vert_a: bmesh.types.BMVert
     :param vert_b: Second vertex to cut in the face (face must contain the vert).
-    :type vert_b: 'bmesh.types.BMVert'
-    :param coords: Optional argument to define points in between *vert_a* and *vert_b*.
+    :type vert_b: bmesh.types.BMVert
+    :param coords: Optional argument to define points in between vert_a and vert_b.
     :type coords: typing.List[float]
-    :param use_exist: .Use an existing edge if it exists (Only used when *coords* argument is empty or omitted)
+    :param use_exist: .Use an existing edge if it exists (Only used when coords argument is empty or omitted)
     :type use_exist: bool
     :param example: Newly created edge will copy settings from this one.
-    :type example: 'bmesh.types.BMEdge'
-    :rtype: typing.Tuple['bmesh.types.BMFace', 'bmesh.types.BMLoop']
+    :type example: bmesh.types.BMEdge
     :return: The newly created face or None on failure.
+    :rtype: typing.Tuple[bmesh.types.BMFace, bmesh.types.BMLoop]
     """
 
     ...
 
 def face_split_edgenet(
-    face: "bmesh.types.BMFace", edgenet: "bmesh.types.BMEdge"
-) -> typing.Tuple:
+    face: typing.Union[bmesh.types.BMFace, bmesh.types.BMFace],
+    edgenet: bmesh.types.BMEdge,
+):
     """Splits a face into any number of regions defined by an edgenet.
 
-    :param face: The face to split. The face to split.
-    :type face: 'bmesh.types.BMFace'
-    :param face: The face to split. The face to split.
-    :type face: 'bmesh.types.BMFace'
+    :param face: The face to split.The face to split.
+    :type face: typing.Union[bmesh.types.BMFace, bmesh.types.BMFace]
     :param edgenet: Sequence of edges.
-    :type edgenet: 'bmesh.types.BMEdge'
-    :rtype: typing.Tuple
+    :type edgenet: bmesh.types.BMEdge
     :return: The newly created faces.
     """
 
     ...
 
 def face_vert_separate(
-    face: "bmesh.types.BMFace", vert: "bmesh.types.BMVert"
-) -> "bmesh.types.BMVert":
+    face: bmesh.types.BMFace, vert: bmesh.types.BMVert
+) -> bmesh.types.BMVert:
     """Rip a vertex in a face away and add a new vertex.
 
     :param face: The face to separate.
-    :type face: 'bmesh.types.BMFace'
+    :type face: bmesh.types.BMFace
     :param vert: A vertex in the face to separate.
-    :type vert: 'bmesh.types.BMVert'
-    :rtype: 'bmesh.types.BMVert'
+    :type vert: bmesh.types.BMVert
     :return: The newly created vertex or None on failure.
+    :rtype: bmesh.types.BMVert
     """
 
     ...
 
-def loop_separate(loop: "bmesh.types.BMLoop") -> "bmesh.types.BMVert":
+def loop_separate(loop: bmesh.types.BMLoop) -> bmesh.types.BMVert:
     """Rip a vertex in a face away and add a new vertex.
 
     :param loop: The loop to separate.
-    :type loop: 'bmesh.types.BMLoop'
-    :rtype: 'bmesh.types.BMVert'
+    :type loop: bmesh.types.BMLoop
     :return: The newly created vertex or None on failure.
+    :rtype: bmesh.types.BMVert
     """
 
     ...
 
 def vert_collapse_edge(
-    vert: "bmesh.types.BMVert", edge: "bmesh.types.BMEdge"
-) -> "bmesh.types.BMEdge":
+    vert: bmesh.types.BMVert, edge: bmesh.types.BMEdge
+) -> bmesh.types.BMEdge:
     """Collapse a vertex into an edge.
 
     :param vert: The vert that will be collapsed.
-    :type vert: 'bmesh.types.BMVert'
+    :type vert: bmesh.types.BMVert
     :param edge: The edge to collapse into.
-    :type edge: 'bmesh.types.BMEdge'
-    :rtype: 'bmesh.types.BMEdge'
+    :type edge: bmesh.types.BMEdge
     :return: The resulting edge from the collapse operation.
+    :rtype: bmesh.types.BMEdge
     """
 
     ...
 
 def vert_collapse_faces(
-    vert: "bmesh.types.BMVert", edge: "bmesh.types.BMEdge", fac: float, join_faces: bool
-) -> "bmesh.types.BMEdge":
+    vert: bmesh.types.BMVert, edge: bmesh.types.BMEdge, fac: float, join_faces: bool
+) -> bmesh.types.BMEdge:
     """Collapses a vertex that has only two manifold edges onto a vertex it shares an edge with.
 
     :param vert: The vert that will be collapsed.
-    :type vert: 'bmesh.types.BMVert'
+    :type vert: bmesh.types.BMVert
     :param edge: The edge to collapse into.
-    :type edge: 'bmesh.types.BMEdge'
+    :type edge: bmesh.types.BMEdge
     :param fac: The factor to use when merging customdata [0 - 1].
     :type fac: float
     :param join_faces: When true the faces around the vertex will be joined otherwise collapse the vertex by merging the 2 edges this vertex connects to into one.
     :type join_faces: bool
-    :rtype: 'bmesh.types.BMEdge'
     :return: The resulting edge from the collapse operation.
+    :rtype: bmesh.types.BMEdge
     """
 
     ...
 
-def vert_dissolve(vert: "bmesh.types.BMVert") -> bool:
+def vert_dissolve(vert: bmesh.types.BMVert) -> bool:
     """Dissolve this vertex (will be removed).
 
     :param vert: The vert to be dissolved.
-    :type vert: 'bmesh.types.BMVert'
-    :rtype: bool
+    :type vert: bmesh.types.BMVert
     :return: True when the vertex dissolve is successful.
+    :rtype: bool
     """
 
     ...
 
 def vert_separate(
-    vert: "bmesh.types.BMVert", edges: "bmesh.types.BMEdge"
-) -> typing.Tuple["bmesh.types.BMVert"]:
+    vert: bmesh.types.BMVert, edges: bmesh.types.BMEdge
+) -> typing.Tuple[bmesh.types.BMVert]:
     """Separate this vertex at every edge.
 
     :param vert: The vert to be separated.
-    :type vert: 'bmesh.types.BMVert'
+    :type vert: bmesh.types.BMVert
     :param edges: The edges to separated.
-    :type edges: 'bmesh.types.BMEdge'
-    :rtype: typing.Tuple['bmesh.types.BMVert']
+    :type edges: bmesh.types.BMEdge
     :return: The newly separated verts (including the vertex passed).
+    :rtype: typing.Tuple[bmesh.types.BMVert]
     """
 
     ...
 
-def vert_splice(vert: "bmesh.types.BMVert", vert_target: "bmesh.types.BMVert"):
+def vert_splice(vert: bmesh.types.BMVert, vert_target: bmesh.types.BMVert):
     """Splice vert into vert_target.
 
     :param vert: The vertex to be removed.
-    :type vert: 'bmesh.types.BMVert'
+    :type vert: bmesh.types.BMVert
     :param vert_target: The vertex to use.
-    :type vert_target: 'bmesh.types.BMVert'
+    :type vert_target: bmesh.types.BMVert
     """
 
     ...

bpy/__init__.pyi

@@ -1,18 +1,17 @@
-import sys
 import typing
 import bpy.types
 
-from . import types
-from . import ops
-from . import utils
 from . import app
-from . import props
 from . import msgbus
+from . import ops
 from . import path
+from . import props
+from . import types
+from . import utils
 
 GenericType = typing.TypeVar("GenericType")
-context: "bpy.types.Context"
+context: bpy.types.Context
 
-data: "bpy.types.BlendData"
+data: bpy.types.BlendData
 """ Access to Blender's internal data
 """

bpy/app/__init__.pyi

@@ -1,46 +1,44 @@
-import sys
 import typing
-from . import timers
-from . import translations
 from . import handlers
 from . import icons
+from . import timers
+from . import translations
 
 GenericType = typing.TypeVar("GenericType")
 
-def help_text(all: typing.Optional[bool] = False):
+def help_text(all: bool = False):
     """Return the help text as a string.
 
     :param all: Return all arguments, even those which aren't available for the current platform.
-    :type all: typing.Optional[bool]
+    :type all: bool
     """
 
     ...
 
-def is_job_running(job_type: typing.Optional[str]) -> typing.Any:
+def is_job_running(job_type: str):
     """Check whether a job of the given type is running.
 
-    :param job_type: `rna_enum_wm_job_type_items`.
-    :type job_type: typing.Optional[str]
-    :rtype: typing.Any
+    :param job_type: job type in `rna_enum_wm_job_type_items`.
+    :type job_type: str
     :return: Whether a job of the given type is currently running.
     """
 
     ...
 
 alembic: typing.Any
-""" Constant value bpy.app.alembic(supported=True, version=(1, 8, 3), version_string=' 1, 8, 3')
+""" Constant value bpy.app.alembic(supported=True, version=(1, 8, 3), version_string=' 1,  8,  3')
 """
 
 autoexec_fail: typing.Any
-""" Undocumented, consider `contributing <https://developer.blender.org/>`__.
+""" Undocumented, consider contributing.
 """
 
 autoexec_fail_message: typing.Any
-""" Undocumented, consider `contributing <https://developer.blender.org/>`__.
+""" Undocumented, consider contributing.
 """
 
 autoexec_fail_quiet: typing.Any
-""" Undocumented, consider `contributing <https://developer.blender.org/>`__.
+""" Undocumented, consider contributing.
 """
 
 background: typing.Any
@@ -88,7 +86,7 @@ build_linkflags: typing.Any
 """
 
 build_options: typing.Any
-""" Constant value bpy.app.build_options(bullet=True, codec_avi=True, codec_ffmpeg=True, codec_sndfile=True, compositor_cpu=True, cycles=True, cycles_osl=True, freestyle=True, image_cineon=True, image_dds=True, image_hdr=True, image_openexr=True, image_openjpeg=True, image_tiff=True, input_ndof=True, audaspace=True, international=True, openal=True, opensubdiv=True, sdl=True, sdl_dynload=False, coreaudio=False, jack=False, pulseaudio=False, wasapi=False, libmv=True, mod_oceansim=True, mod_remesh=True, collada=True, io_wavefront_obj=True, io_ply=True, io_stl=True, io_gpencil=True, opencolorio=True, openmp=True, openvdb=True, alembic=True, usd=True, fluid=True, xr_openxr=True, potrace=True, pugixml=True, haru=True)
+""" Constant value bpy.app.build_options(bullet=True, codec_avi=False, codec_ffmpeg=True, codec_sndfile=True, compositor_cpu=True, cycles=True, cycles_osl=True, freestyle=True, image_cineon=True, image_dds=True, image_hdr=True, image_openexr=True, image_openjpeg=True, image_tiff=True, input_ndof=True, audaspace=True, international=True, openal=True, opensubdiv=True, sdl=True, sdl_dynload=False, coreaudio=False, jack=False, pulseaudio=False, wasapi=False, libmv=True, mod_oceansim=True, mod_remesh=True, collada=True, io_wavefront_obj=True, io_ply=True, io_stl=True, io_gpencil=True, opencolorio=True, openmp=True, openvdb=True, alembic=True, usd=True, fluid=True, xr_openxr=True, potrace=True, pugixml=True, haru=True)
 """
 
 build_platform: typing.Any
@@ -108,59 +106,59 @@ build_type: typing.Any
 """
 
 debug: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_depsgraph: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_depsgraph_build: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_depsgraph_eval: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_depsgraph_pretty: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_depsgraph_tag: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_depsgraph_time: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_events: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_ffmpeg: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_freestyle: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_handlers: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_io: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_python: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_simdata: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 debug_value: typing.Any
@@ -168,11 +166,11 @@ debug_value: typing.Any
 """
 
 debug_wm: typing.Any
-""" Boolean, for debug info (started with ``--debug`` / ``--debug-*`` matching this attribute name)
+""" Boolean, for debug info (started with --debug / --debug-* matching this attribute name)
 """
 
 driver_namespace: typing.Any
-""" Dictionary for drivers namespace, editable in-place, reset on file load (read-only) File Loading & Order of Initialization Since drivers may be evaluated immediately after loading a blend-file it is necessary to ensure the driver name-space is initialized beforehand. This can be done by registering text data-blocks to execute on startup, which executes the scripts before drivers are evaluated. See *Text -> Register* from Blender's text editor. .. hint:: You may prefer to use external files instead of Blender's text-blocks. This can be done using a text-block which executes an external file. This example runs ``driver_namespace.py`` located in the same directory as the text-blocks blend-file: .. code-block:: import os import bpy blend_dir = os.path.normalize(os.path.join(__file__, "..", "..")) bpy.utils.execfile(os.path.join(blend_dir, "driver_namespace.py")) Using ``__file__`` ensures the text resolves to the expected path even when library-linked from another file. Other methods of populating the drivers name-space can be made to work but tend to be error prone: Using The ``--python`` command line argument to populate name-space often fails to achieve the desired goal because the initial evaluation will lookup a function that doesn't exist yet, marking the driver as invalid - preventing further evaluation. Populating the driver name-space before the blend-file loads also doesn't work since opening a file clears the name-space. It is possible to run a script via the ``--python`` command line argument, before the blend file. This can register a load-post handler (:mod:`bpy.app.handlers.load_post`) that initialized the name-space. While this works for background tasks it has the downside that opening the file from the file selector won't setup the name-space.
+""" Dictionary for drivers namespace, editable in-place, reset on file load (read-only)
 """
 
 factory_startup: typing.Any
@@ -180,23 +178,23 @@ factory_startup: typing.Any
 """
 
 ffmpeg: typing.Any
-""" Constant value bpy.app.ffmpeg(supported=True, avcodec_version=(60, 31, 102), avcodec_version_string='60, 31, 102', avdevice_version=(60, 3, 100), avdevice_version_string='60, 3, 100', avformat_version=(60, 16, 100), avformat_version_string='60, 16, 100', avutil_version=(58, 29, 100), avutil_version_string='58, 29, 100', swscale_version=(7, 5, 100), swscale_version_string=' 7, 5, 100')
+""" Constant value bpy.app.ffmpeg(supported=True, avcodec_version=(60, 31, 102), avcodec_version_string='60, 31, 102', avdevice_version=(60, 3, 100), avdevice_version_string='60,  3, 100', avformat_version=(60, 16, 100), avformat_version_string='60, 16, 100', avutil_version=(58, 29, 100), avutil_version_string='58, 29, 100', swscale_version=(7, 5, 100), swscale_version_string=' 7,  5, 100')
 """
 
 ocio: typing.Any
-""" Constant value bpy.app.ocio(supported=True, version=(2, 3, 2), version_string=' 2, 3, 2')
+""" Constant value bpy.app.ocio(supported=True, version=(2, 3, 2), version_string=' 2,  3,  2')
 """
 
 oiio: typing.Any
-""" Constant value bpy.app.oiio(supported=True, version=(2, 5, 6), version_string=' 2, 5, 6')
+""" Constant value bpy.app.oiio(supported=True, version=(2, 5, 6), version_string=' 2,  5,  6')
 """
 
 opensubdiv: typing.Any
-""" Constant value bpy.app.opensubdiv(supported=True, version=(3, 6, 0), version_string=' 3, 6, 0')
+""" Constant value bpy.app.opensubdiv(supported=True, version=(3, 6, 0), version_string=' 3,  6,  0')
 """
 
 openvdb: typing.Any
-""" Constant value bpy.app.openvdb(supported=True, version=(11, 0, 0), version_string='11, 0, 0')
+""" Constant value bpy.app.openvdb(supported=True, version=(11, 0, 0), version_string='11,  0,  0')
 """
 
 render_icon_size: typing.Any
@@ -220,11 +218,11 @@ usd: typing.Any
 """
 
 use_event_simulate: typing.Any
-""" Boolean, for application behavior (started with ``--enable-*`` matching this attribute name)
+""" Boolean, for application behavior (started with --enable-* matching this attribute name)
 """
 
 use_userpref_skip_save_on_exit: typing.Any
-""" Boolean, for application behavior (started with ``--enable-*`` matching this attribute name)
+""" Boolean, for application behavior (started with --enable-* matching this attribute name)
 """
 
 version: typing.Any
@@ -236,7 +234,7 @@ version_cycle: typing.Any
 """
 
 version_file: typing.Any
-""" The Blender version, as a tuple, last used to save a .blend file, compatible with ``bpy.data.version``. This value should be used for handling compatibility changes between Blender versions
+""" The Blender version, as a tuple, last used to save a .blend file, compatible with bpy.data.version. This value should be used for handling compatibility changes between Blender versions
 """
 
 version_string: typing.Any