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

bpy/app/handlers/__init__.pyi

@@ -1,81 +1,80 @@
-import sys
 import typing
 import bpy.types
 
 GenericType = typing.TypeVar("GenericType")
-animation_playback_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+animation_playback_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on ending animation playback
 """
 
-animation_playback_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+animation_playback_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on starting animation playback
 """
 
-annotation_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+annotation_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on drawing an annotation (after)
 """
 
-annotation_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+annotation_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on drawing an annotation (before)
 """
 
-composite_cancel: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+composite_cancel: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on a compositing background job (cancel)
 """
 
-composite_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+composite_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on a compositing background job (after)
 """
 
-composite_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+composite_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on a compositing background job (before)
 """
 
-depsgraph_update_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+depsgraph_update_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on depsgraph update (post)
 """
 
-depsgraph_update_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+depsgraph_update_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on depsgraph update (pre)
 """
 
-frame_change_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+frame_change_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ Called after frame change for playback and rendering, after the data has been evaluated for the new frame.
 """
 
-frame_change_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
-""" Called after frame change for playback and rendering, before any data is evaluated for the new frame. This makes it possible to change data and relations (for example swap an object to another mesh) for the new frame. Note that this handler is **not** to be used as 'before the frame changes' event. The dependency graph is not available in this handler, as data and relations may have been altered and the dependency graph has not yet been updated for that.
+frame_change_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
+""" Called after frame change for playback and rendering, before any data is evaluated for the new frame. This makes it possible to change data and relations (for example swap an object to another mesh) for the new frame. Note that this handler is not to be used as 'before the frame changes' event. The dependency graph is not available in this handler, as data and relations may have been altered and the dependency graph has not yet been updated for that.
 """
 
-load_factory_preferences_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+load_factory_preferences_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading factory preferences (after)
 """
 
-load_factory_startup_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+load_factory_startup_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading factory startup (after)
 """
 
-load_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+load_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading a new blend file (after). Accepts one argument: the file being loaded, an empty string for the startup-file.
 """
 
-load_post_fail: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+load_post_fail: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on failure to load a new blend file (after). Accepts one argument: the file being loaded, an empty string for the startup-file.
 """
 
-load_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+load_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading a new blend file (before).Accepts one argument: the file being loaded, an empty string for the startup-file.
 """
 
-object_bake_cancel: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+object_bake_cancel: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on canceling a bake job; will be called in the main thread
 """
 
-object_bake_complete: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+object_bake_complete: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on completing a bake job; will be called in the main thread
 """
 
-object_bake_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+object_bake_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ before starting a bake job
 """
 
@@ -83,70 +82,70 @@ persistent: typing.Any
 """ Function decorator for callback functions not to be removed when loading new files
 """
 
-redo_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+redo_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading a redo step (after)
 """
 
-redo_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+redo_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading a redo step (before)
 """
 
-render_cancel: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_cancel: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on canceling a render job
 """
 
-render_complete: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_complete: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on completion of render job
 """
 
-render_init: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_init: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on initialization of a render job
 """
 
-render_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on render (after)
 """
 
-render_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on render (before)
 """
 
-render_stats: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_stats: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on printing render statistics
 """
 
-render_write: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+render_write: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on writing a render frame (directly after the frame is written)
 """
 
-save_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+save_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on saving a blend file (after). Accepts one argument: the file being saved, an empty string for the startup-file.
 """
 
-save_post_fail: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+save_post_fail: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on failure to save a blend file (after). Accepts one argument: the file being saved, an empty string for the startup-file.
 """
 
-save_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+save_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on saving a blend file (before). Accepts one argument: the file being saved, an empty string for the startup-file.
 """
 
-translation_update_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+translation_update_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on translation settings update
 """
 
-undo_post: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+undo_post: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading an undo step (after)
 """
 
-undo_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+undo_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on loading an undo step (before)
 """
 
-version_update: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+version_update: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on ending the versioning code
 """
 
-xr_session_start_pre: typing.List[typing.Callable[["bpy.types.Scene"], None]]
+xr_session_start_pre: typing.List[typing.Callable[[bpy.types.Scene, None]]]
 """ on starting an xr session (before)
 """

bpy/app/icons/__init__.pyi

@@ -1,34 +1,31 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
 def new_triangles(
-    range: typing.Optional[typing.Tuple],
-    coords: typing.Optional[typing.Sequence[bytes]],
-    colors: typing.Optional[typing.Sequence[bytes]],
+    range: tuple, coords: typing.Sequence[bytes], colors: typing.Sequence[bytes]
 ) -> int:
     """Create a new icon from triangle geometry.
 
     :param range: Pair of ints.
-    :type range: typing.Optional[typing.Tuple]
+    :type range: tuple
     :param coords: Sequence of bytes (6 floats for one triangle) for (X, Y) coordinates.
-    :type coords: typing.Optional[typing.Sequence[bytes]]
+    :type coords: typing.Sequence[bytes]
     :param colors: Sequence of ints (12 for one triangles) for RGBA.
-    :type colors: typing.Optional[typing.Sequence[bytes]]
+    :type colors: typing.Sequence[bytes]
+    :return: Unique icon value (pass to interface icon_value argument).
     :rtype: int
-    :return: Unique icon value (pass to interface ``icon_value`` argument).
     """
 
     ...
 
-def new_triangles_from_file(filepath: typing.Optional[str]) -> int:
+def new_triangles_from_file(filepath: str) -> int:
     """Create a new icon from triangle geometry.
 
     :param filepath: File path.
-    :type filepath: typing.Optional[str]
+    :type filepath: str
+    :return: Unique icon value (pass to interface icon_value argument).
     :rtype: int
-    :return: Unique icon value (pass to interface ``icon_value`` argument).
     """
 
     ...

bpy/app/timers/__init__.pyi

@@ -1,41 +1,42 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def is_registered(function: typing.Optional[int]) -> bool:
+def is_registered(function: int) -> bool:
     """Check if this function is registered as a timer.
 
     :param function: Function to check.
-    :type function: typing.Optional[int]
-    :rtype: bool
+    :type function: int
     :return: True when this function is registered, otherwise False.
+    :rtype: bool
     """
 
     ...
 
 def register(
-    function: typing.Optional[typing.Callable],
-    first_interval: typing.Optional[float] = 0,
-    persistent: typing.Optional[bool] = False,
+    function: typing.Callable, first_interval: float = 0, persistent: bool = False
 ):
-    """Add a new function that will be called after the specified amount of seconds. The function gets no arguments and is expected to return either None or a float. If ``None`` is returned, the timer will be unregistered. A returned number specifies the delay until the function is called again. ``functools.partial`` can be used to assign some parameters.
-
-    :param function: The function that should called.
-    :type function: typing.Optional[typing.Callable]
-    :param first_interval: Seconds until the callback should be called the first time.
-    :type first_interval: typing.Optional[float]
-    :param persistent: Don't remove timer when a new file is loaded.
-    :type persistent: typing.Optional[bool]
+    """Add a new function that will be called after the specified amount of seconds.
+    The function gets no arguments and is expected to return either None or a float.
+    If None is returned, the timer will be unregistered.
+    A returned number specifies the delay until the function is called again.
+    functools.partial can be used to assign some parameters.
+
+        :param function: The function that should called.
+        :type function: typing.Callable
+        :param first_interval: Seconds until the callback should be called the first time.
+        :type first_interval: float
+        :param persistent: Don't remove timer when a new file is loaded.
+        :type persistent: bool
     """
 
     ...
 
-def unregister(function: typing.Optional[typing.Any]):
+def unregister(function: typing.Any):
     """Unregister timer.
 
     :param function: Function to unregister.
-    :type function: typing.Optional[typing.Any]
+    :type function: typing.Any
     """
 
     ...

bpy/app/translations/__init__.pyi

@@ -1,91 +1,93 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def locale_explode(locale: typing.Optional[typing.Any]):
-    """Return all components and their combinations of the given ISO locale string. >>> bpy.app.translations.locale_explode("sr_RS@latin") ("sr", "RS", "latin", "sr_RS", "sr@latin") For non-complete locales, missing elements will be None.
+def locale_explode(locale):
+    """Return all components and their combinations of the given ISO locale string.For non-complete locales, missing elements will be None.
 
-    :type msgid: typing.Optional[str]
-    :param locale:  The ISO locale string to explode.
-    :type locale: typing.Optional[typing.Any]
+    :param locale: The ISO locale string to explode.
+    :return: A tuple (language, country, variant, language_country, language@variant).
     """
 
     ...
 
-def pgettext(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
+def pgettext(msgid: str, msgctxt: str = None):
     """Try to translate the given msgid (with optional msgctxt).
 
     :param msgid: The string to translate.
-    :type msgid: typing.Optional[str]
+    :type msgid: str
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
-    :type msgctxt: typing.Optional[str]
+    :type msgctxt: str
+    :return: The translated string (or msgid if no translation was found).
     """
 
     ...
 
-def pgettext_data(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
+def pgettext_data(msgid: str, msgctxt: str = None):
     """Try to translate the given msgid (with optional msgctxt), if new data name's translation is enabled.
 
     :param msgid: The string to translate.
-    :type msgid: typing.Optional[str]
+    :type msgid: str
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
-    :type msgctxt: typing.Optional[str]
+    :type msgctxt: str
+    :return: The translated string (or msgid if no translation was found).
     """
 
     ...
 
-def pgettext_iface(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
+def pgettext_iface(msgid: str, msgctxt: str = None):
     """Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.
 
     :param msgid: The string to translate.
-    :type msgid: typing.Optional[str]
+    :type msgid: str
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
-    :type msgctxt: typing.Optional[str]
+    :type msgctxt: str
+    :return: The translated string (or msgid if no translation was found).
     """
 
     ...
 
-def pgettext_rpt(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
+def pgettext_rpt(msgid: str, msgctxt: str = None):
     """Try to translate the given msgid (with optional msgctxt), if reports' translation is enabled.
 
     :param msgid: The string to translate.
-    :type msgid: typing.Optional[str]
+    :type msgid: str
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
-    :type msgctxt: typing.Optional[str]
+    :type msgctxt: str
+    :return: The translated string (or msgid if no translation was found).
     """
 
     ...
 
-def pgettext_tip(msgid: typing.Optional[str], msgctxt: typing.Optional[str] = None):
+def pgettext_tip(msgid: str, msgctxt: str = None):
     """Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.
 
     :param msgid: The string to translate.
-    :type msgid: typing.Optional[str]
+    :type msgid: str
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
-    :type msgctxt: typing.Optional[str]
+    :type msgctxt: str
+    :return: The translated string (or msgid if no translation was found).
     """
 
     ...
 
-def register(
-    module_name: typing.Optional[str], translations_dict: typing.Optional[typing.Dict]
-):
+def register(module_name: str, translations_dict: dict):
     """Registers an addon's UI translations.
 
-    :param module_name: The name identifying the addon.
-    :type module_name: typing.Optional[str]
-    :param translations_dict: ``{locale: {msg_key: msg_translation, ...}, ...}``
-    :type translations_dict: typing.Optional[typing.Dict]
+        :param module_name: The name identifying the addon.
+        :type module_name: str
+        :param translations_dict: A dictionary built like that:
+    {locale: {msg_key: msg_translation, ...}, ...}
+        :type translations_dict: dict
     """
 
     ...
 
-def unregister(module_name: typing.Optional[str]):
+def unregister(module_name: str):
     """Unregisters an addon's UI translations.
 
     :param module_name: The name identifying the addon.
-    :type module_name: typing.Optional[str]
+    :type module_name: str
     """
 
     ...

bpy/msgbus/__init__.pyi

@@ -1,4 +1,3 @@
-import sys
 import typing
 
 GenericType = typing.TypeVar("GenericType")
@@ -8,30 +7,36 @@ def clear_by_owner(owner):
 
     ...
 
-def publish_rna(key: typing.Optional[typing.Any]):
-    """Notify subscribers of changes to this property (this typically doesn't need to be called explicitly since changes will automatically publish updates). In some cases it may be useful to publish changes explicitly using more general keys.
+def publish_rna(key):
+    """Notify subscribers of changes to this property
+    (this typically doesn't need to be called explicitly since changes will automatically publish updates).
+    In some cases it may be useful to publish changes explicitly using more general keys.
 
-    :param key: Represents the type of data being subscribed to Arguments include - `bpy.types.Property` instance. - `bpy.types.Struct` type. - (`bpy.types.Struct`, str) type and property name.
-    :type key: typing.Optional[typing.Any]
+        :param key: Represents the type of data being subscribed to
+
+    Arguments include
+    - `bpy.types.Property` instance.
+    - `bpy.types.Struct` type.
+    - (`bpy.types.Struct`, str) type and property name.
     """
 
     ...
 
-def subscribe_rna(
-    key: typing.Optional[typing.Any],
-    owner: typing.Optional[typing.Any],
-    args,
-    notify,
-    options: typing.Optional[typing.Set] = "set()",
-):
-    """Register a message bus subscription. It will be cleared when another blend file is loaded, or can be cleared explicitly via :func:`bpy.msgbus.clear_by_owner`.
-
-    :param key: Represents the type of data being subscribed to Arguments include - `bpy.types.Property` instance. - `bpy.types.Struct` type. - (`bpy.types.Struct`, str) type and property name.
-    :type key: typing.Optional[typing.Any]
-    :param owner: Handle for this subscription (compared by identity).
-    :type owner: typing.Optional[typing.Any]
-    :param options: Change the behavior of the subscriber. - ``PERSISTENT`` when set, the subscriber will be kept when remapping ID data.
-    :type options: typing.Optional[typing.Set]
+def subscribe_rna(key, owner: typing.Any, args, notify, options=None()):
+    """Register a message bus subscription. It will be cleared when another blend file is
+    loaded, or can be cleared explicitly via `bpy.msgbus.clear_by_owner`.
+
+        :param key: Represents the type of data being subscribed to
+
+    Arguments include
+    - `bpy.types.Property` instance.
+    - `bpy.types.Struct` type.
+    - (`bpy.types.Struct`, str) type and property name.
+        :param owner: Handle for this subscription (compared by identity).
+        :type owner: typing.Any
+        :param options: Change the behavior of the subscriber.
+
+    PERSISTENT when set, the subscriber will be kept when remapping ID data.
     """
 
     ...

bpy/ops/__init__.pyi

@@ -1,81 +1,80 @@
-import sys
 import typing
-from . import buttons
-from . import file
-from . import material
-from . import ed
-from . import fluid
-from . import curve
+from . import action
+from . import anim
 from . import armature
-from . import cachefile
-from . import gpencil
-from . import uilist
-from . import object
-from . import node
-from . import grease_pencil
-from . import sound
-from . import font
-from . import uv
-from . import texture
-from . import ui
-from . import mesh
-from . import script
+from . import asset
 from . import boid
-from . import view2d
-from . import graph
-from . import lattice
-from . import sequencer
-from . import collection
-from . import import_curve
+from . import brush
+from . import buttons
+from . import cachefile
+from . import camera
 from . import clip
-from . import export_mesh
-from . import screen
-from . import render
-from . import outliner
-from . import spreadsheet
-from . import particle
-from . import action
-from . import asset
-from . import mball
+from . import cloth
+from . import collection
+from . import console
+from . import constraint
+from . import curve
+from . import curves
+from . import cycles
 from . import dpaint
-from . import transform
-from . import anim
-from . import poselib
-from . import surface
-from . import sculpt_curves
+from . import ed
+from . import export_anim
+from . import export_mesh
+from . import export_scene
+from . import file
+from . import fluid
+from . import font
 from . import geometry
-from . import wm
 from . import gizmogroup
-from . import nla
+from . import gpencil
+from . import graph
+from . import grease_pencil
+from . import image
+from . import import_anim
+from . import import_curve
 from . import import_mesh
-from . import sculpt
-from . import brush
+from . import import_scene
 from . import info
+from . import lattice
+from . import marker
+from . import mask
+from . import material
+from . import mball
+from . import mesh
+from . import nla
+from . import node
+from . import object
+from . import outliner
+from . import paint
 from . import paintcurve
+from . import palette
+from . import particle
+from . import pose
+from . import poselib
+from . import preferences
+from . import ptcache
+from . import render
 from . import rigidbody
-from . import workspace
-from . import marker
+from . import scene
+from . import screen
+from . import script
+from . import sculpt
+from . import sculpt_curves
+from . import sequencer
+from . import sound
+from . import spreadsheet
+from . import surface
 from . import text
 from . import text_editor
-from . import import_anim
-from . import pose
-from . import export_anim
-from . import import_scene
-from . import camera
-from . import console
-from . import curves
+from . import texture
+from . import transform
+from . import ui
+from . import uilist
+from . import uv
+from . import view2d
 from . import view3d
-from . import cloth
-from . import preferences
-from . import constraint
-from . import paint
+from . import wm
+from . import workspace
 from . import world
-from . import export_scene
-from . import scene
-from . import mask
-from . import image
-from . import cycles
-from . import palette
-from . import ptcache
 
 GenericType = typing.TypeVar("GenericType")