fake-bpy-module 20231205__py3-none-any.whl → 20231207__py3-none-any.whl

bpy/app/timers/__init__.pyi

@@ -0,0 +1,42 @@
+import sys
+import typing
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def is_registered(function: typing.Optional[int]) -> bool:
+    ''' Check if this function is registered as a timer.
+
+    :param function: Function to check.
+    :type function: typing.Optional[int]
+    :rtype: bool
+    :return: True when this function is registered, otherwise False.
+    '''
+
+    ...
+
+
+def register(function: typing.Optional[typing.Callable],
+             first_interval: typing.Optional[float] = 0,
+             persistent: typing.Optional[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]
+    '''
+
+    ...
+
+
+def unregister(function: typing.Optional[typing.Any]):
+    ''' Unregister timer.
+
+    :param function: Function to unregister.
+    :type function: typing.Optional[typing.Any]
+    '''
+
+    ...

bpy/app/translations/__init__.pyi

@@ -0,0 +1,107 @@
+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.
+
+    :type msgid: typing.Optional[str]
+    :param locale:  The ISO locale string to explode.
+    :type locale: typing.Optional[typing.Any]
+    '''
+
+    ...
+
+
+def pgettext(msgid: typing.Optional[str],
+             msgctxt: typing.Optional[str] = None):
+    ''' Try to translate the given msgid (with optional msgctxt).
+
+    :param msgid: The string to translate.
+    :type msgid: typing.Optional[str]
+    :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: typing.Optional[str]
+    '''
+
+    ...
+
+
+def pgettext_data(msgid: typing.Optional[str],
+                  msgctxt: typing.Optional[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]
+    :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: typing.Optional[str]
+    '''
+
+    ...
+
+
+def pgettext_iface(msgid: typing.Optional[str],
+                   msgctxt: typing.Optional[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]
+    :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: typing.Optional[str]
+    '''
+
+    ...
+
+
+def pgettext_tip(msgid: typing.Optional[str],
+                 msgctxt: typing.Optional[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]
+    :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: typing.Optional[str]
+    '''
+
+    ...
+
+
+def register(module_name: typing.Optional[str],
+             translations_dict: typing.Optional[typing.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]
+    '''
+
+    ...
+
+
+def unregister(module_name: typing.Optional[str]):
+    ''' Unregisters an addon's UI translations.
+
+    :param module_name: The name identifying the addon.
+    :type module_name: typing.Optional[str]
+    '''
+
+    ...
+
+
+contexts: typing.Any
+''' Constant value bpy.app.translations.contexts(default_real=None, default='*', operator_default='Operator', ui_events_keymaps='UI_Events_KeyMaps', plural='Plural', id_action='Action', id_armature='Armature', id_brush='Brush', id_cachefile='CacheFile', id_camera='Camera', id_collection='Collection', id_curves='Curves', id_curve='Curve', id_fs_linestyle='FreestyleLineStyle', id_gpencil='GPencil', id_id='ID', id_image='Image', id_lattice='Lattice', id_library='Library', id_light='Light', id_lightprobe='LightProbe', id_mask='Mask', id_material='Material', id_mesh='Mesh', id_metaball='Metaball', id_movieclip='MovieClip', id_nodetree='NodeTree', id_object='Object', id_paintcurve='PaintCurve', id_palette='Palette', id_particlesettings='ParticleSettings', id_pointcloud='PointCloud', id_scene='Scene', id_screen='Screen', id_sequence='Sequence', id_shapekey='Key', id_simulation='Simulation', id_sound='Sound', id_speaker='Speaker', id_text='Text', id_texture='Texture', id_vfont='VFont', id_volume='Volume', id_windowmanager='WindowManager', id_workspace='WorkSpace', id_world='World', editor_python_console='Python console', editor_filebrowser='File browser', editor_view3d='View3D', amount='Amount', color='Color', constraint='Constraint', time='Time', unit='Unit')
+'''
+
+contexts_C_to_py: typing.Any
+''' A readonly dict mapping contexts' C-identifiers to their py-identifiers.
+'''
+
+locale: typing.Any
+''' The actual locale currently in use (will always return a void string when Blender is built without internationalization support).
+'''
+
+locales: typing.Any
+''' All locales currently known by Blender (i.e. available as translations).
+'''

bpy/msgbus/__init__.pyi

@@ -0,0 +1,40 @@
+import sys
+import typing
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def clear_by_owner(owner):
+    ''' Clear all subscribers using this 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.
+
+    :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]
+    '''
+
+    ...
+
+
+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]
+    '''
+
+    ...

bpy/ops/__init__.pyi

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