fake-bpy-module 20240607__tar.gz → 20240608__tar.gz

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fake-bpy-module
-Version: 20240607
+Version: 20240608
 Summary: Collection of the fake Blender Python API module for the code completion.
 Author: nutti
 Author-email: nutti.metro@gmail.com

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/bl_ui/generic_ui_list/__init__.pyi

@@ -724,7 +724,7 @@ class UILIST_OT_entry_remove(GenericUIListOperator, bpy_types.Operator):
 
 def draw_ui_list(
     layout: bpy.types.UILayout,
-    context: bpy_types.Context,
+    context: bpy.types.Context,
     class_name: str = "UI_UL_list",
     unique_id: str = None,
     list_path: str = None,
@@ -739,7 +739,7 @@ def draw_ui_list(
         :param layout: UILayout to draw the list in.
         :type layout: bpy.types.UILayout
         :param context: Blender context to get the list data from.
-        :type context: bpy_types.Context
+        :type context: bpy.types.Context
         :param class_name: Name of the UIList class to draw. The default is the UIList class that ships with Blender.
         :type class_name: str
         :param unique_id: Unique identifier to differentiate this from other UI lists.

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/bl_ui/space_userpref/__init__.pyi

@@ -670,6 +670,276 @@ class USERPREF_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
         """
         ...
 
+class USERPREF_MT_extensions_active_repo(bpy_types.Menu, bpy_types._GenericUI):
+    bl_label: typing.Any
+    bl_rna: typing.Any
+    id_data: typing.Any
+
+    def append(self, draw_func):
+        """Append a draw function to this menu,
+        takes the same arguments as the menus draw function
+
+                :param draw_func:
+        """
+        ...
+
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
+        ...
+
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
+        ...
+
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
+        ...
+
+    def draw(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def draw_collapsible(self, context, layout):
+        """
+
+        :param context:
+        :param layout:
+        """
+        ...
+
+    def draw_preset(self, _context):
+        """Define these on the subclass:
+        - preset_operator (string)
+        - preset_subdir (string)Optionally:
+        - preset_add_operator (string)
+        - preset_extensions (set of strings)
+        - preset_operator_defaults (dict of keyword args)
+
+                :param _context:
+        """
+        ...
+
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
+
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
+        """
+        ...
+
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
+        ...
+
+    def get(self):
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
+        ...
+
+    def id_properties_clear(self):
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
+        ...
+
+    def id_properties_ensure(self):
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
+        ...
+
+    def id_properties_ui(self):
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
+        ...
+
+    def is_extended(self): ...
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
+        ...
+
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
+        ...
+
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
+        ...
+
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
+        ...
+
+    def items(self):
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
+        ...
+
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
+        ...
+
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
+        ...
+
+    def keys(self):
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
+        ...
+
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
+        ...
+
+    def path_menu(
+        self,
+        searchpaths: list[str],
+        operator: str,
+        props_default: dict = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
+        filter_path=None,
+        display_name: collections.abc.Callable | None = None,
+        add_operator=None,
+        add_operator_props=None,
+    ):
+        """Populate a menu from a list of paths.
+
+                :param searchpaths: Paths to scan.
+                :type searchpaths: list[str]
+                :param operator: The operator id to use with each file.
+                :type operator: str
+                :param props_default: Properties to assign to each operator.
+                :type props_default: dict
+                :param prop_filepath: Optional operator filepath property (defaults to "filepath").
+                :type prop_filepath: str | None
+                :param filter_ext: Optional callback that takes the file extensions.
+
+        Returning false excludes the file from the list.
+                :type filter_ext: collections.abc.Callable | None
+                :param filter_path:
+                :param display_name: Optional callback that takes the full path, returns the name to display.
+                :type display_name: collections.abc.Callable | None
+                :param add_operator:
+                :param add_operator_props:
+        """
+        ...
+
+    def path_resolve(self):
+        """Returns the property from the path, raise an exception when not found."""
+        ...
+
+    def pop(self):
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
+        ...
+
+    def prepend(self, draw_func):
+        """Prepend a draw function to this menu, takes the same arguments as
+        the menus draw function
+
+                :param draw_func:
+        """
+        ...
+
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
+        ...
+
+    def property_unset(self):
+        """Unset a property, will use default value afterward."""
+        ...
+
+    def remove(self, draw_func):
+        """Remove a draw function that has been added to this menu
+
+        :param draw_func:
+        """
+        ...
+
+    def type_recast(self):
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
+        ...
+
+    def values(self):
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
+        ...
+
 class USERPREF_MT_interface_theme_presets(bpy_types.Menu, bpy_types._GenericUI):
     bl_label: typing.Any
     bl_rna: typing.Any

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/bmesh/types/__init__.pyi

@@ -655,10 +655,10 @@ class BMFace:
         ...
 
 class BMFaceSeq:
-    active: BMFace | None
+    active: BMFace
     """ active face.
 
-    :type: BMFace | None
+    :type: BMFace
     """
 
     layers: BMLayerAccessFace

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/bpy/app/handlers/__init__.pyi

@@ -45,83 +45,79 @@ import bpy.types
 
 GenericType1 = typing.TypeVar("GenericType1")
 GenericType2 = typing.TypeVar("GenericType2")
-animation_playback_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+animation_playback_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on ending animation playback
 """
 
-animation_playback_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+animation_playback_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on starting animation playback
 """
 
-annotation_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+annotation_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on drawing an annotation (after)
 """
 
-annotation_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+annotation_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on drawing an annotation (before)
 """
 
-composite_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+composite_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on a compositing background job (cancel)
 """
 
-composite_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+composite_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on a compositing background job (after)
 """
 
-composite_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+composite_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on a compositing background job (before)
 """
 
-depsgraph_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+depsgraph_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on depsgraph update (post)
 """
 
-depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on depsgraph update (pre)
 """
 
-frame_change_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+frame_change_post: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+frame_change_pre: list[collections.abc.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: list[
-    collections.abc.Callable[[bpy.types.Scene], None]
-] | None
+load_factory_preferences_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on loading factory preferences (after)
 """
 
-load_factory_startup_post: list[
-    collections.abc.Callable[[bpy.types.Scene], None]
-] | None
+load_factory_startup_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on loading factory startup (after)
 """
 
-load_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+load_post: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+load_post_fail: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+load_pre: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+object_bake_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on canceling a bake job; will be called in the main thread
 """
 
-object_bake_complete: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+object_bake_complete: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on completing a bake job; will be called in the main thread
 """
 
-object_bake_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+object_bake_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ before starting a bake job
 """
 
@@ -129,70 +125,70 @@ persistent: typing.Any
 """ Function decorator for callback functions not to be removed when loading new files
 """
 
-redo_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+redo_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on loading a redo step (after)
 """
 
-redo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+redo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on loading a redo step (before)
 """
 
-render_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on canceling a render job
 """
 
-render_complete: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_complete: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on completion of render job
 """
 
-render_init: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_init: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on initialization of a render job
 """
 
-render_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on render (after)
 """
 
-render_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on render (before)
 """
 
-render_stats: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_stats: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on printing render statistics. Accepts one argument: the render stats (render/saving time plus in background mode frame/used [peak] memory).
 """
 
-render_write: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+render_write: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on writing a render frame (directly after the frame is written)
 """
 
-save_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+save_post: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+save_post_fail: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+save_pre: list[collections.abc.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: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+translation_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on translation settings update
 """
 
-undo_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+undo_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on loading an undo step (after)
 """
 
-undo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+undo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on loading an undo step (before)
 """
 
-version_update: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+version_update: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on ending the versioning code
 """
 
-xr_session_start_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
+xr_session_start_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on starting an xr session (before)
 """

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/bpy/ops/preferences/__init__.pyi

@@ -418,34 +418,6 @@ def extension_repo_remove(
 
     ...
 
-def extension_repo_sync(
-    override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
-    execution_context: int | str | None = None,
-    undo: bool | None = None,
-):
-    """Refresh the list of extensions for the active repository
-
-    :type override_context: bpy.types.Context | dict[str, typing.Any] | None
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-    ...
-
-def extension_repo_upgrade(
-    override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
-    execution_context: int | str | None = None,
-    undo: bool | None = None,
-):
-    """Upgrade all the extensions to their latest version for the active repository
-
-    :type override_context: bpy.types.Context | dict[str, typing.Any] | None
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-    ...
-
 def extension_url_drop(
     override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
     execution_context: int | str | None = None,

{fake_bpy_module-20240607 → fake_bpy_module-20240608}/bpy/ops/wm/__init__.pyi

@@ -5068,16 +5068,16 @@ def usd_export(
         :type export_normals: bool | typing.Any | None
         :param export_materials: Materials, Export viewport settings of materials as USD preview materials, and export material assignments as geometry subsets
         :type export_materials: bool | typing.Any | None
-        :param export_subdivision: Subdivision Scheme, Choose how subdivision modifiers will be mapped to the USD subdivision scheme during export
+        :param export_subdivision: Subdivision, Choose how subdivision modifiers will be mapped to the USD subdivision scheme during export
 
     IGNORE
-    Ignore -- Subdivision scheme = None, export base mesh without subdivision.
+    Ignore -- Scheme = None. Export base mesh without subdivision.
 
     TESSELLATE
-    Tessellate -- Subdivision scheme = None, export subdivided mesh.
+    Tessellate -- Scheme = None. Export subdivided mesh.
 
     BEST_MATCH
-    Best Match -- Subdivision scheme = Catmull-Clark, when possible. Reverts to exporting the subdivided mesh for the Simple subdivision type.
+    Best Match -- Scheme = Catmull-Clark, when possible. Reverts to exporting the subdivided mesh for the Simple subdivision type.
         :type export_subdivision: str | None
         :param export_armatures: Armatures, Export armatures and meshes with armature modifiers as USD skeletons and skinned meshes
         :type export_armatures: bool | typing.Any | None
@@ -5099,7 +5099,7 @@ def usd_export(
         :type generate_preview_surface: bool | typing.Any | None
         :param generate_materialx_network: MaterialX Network, Generate a MaterialX network representation of the materials
         :type generate_materialx_network: bool | typing.Any | None
-        :param convert_orientation: Convert Orientation, The USD exporter will convert scene orientation axis
+        :param convert_orientation: Convert Orientation, Convert orientation axis to a different convention to match other applications
         :type convert_orientation: bool | typing.Any | None
         :param export_global_forward_selection: Forward Axis
 
@@ -5261,7 +5261,7 @@ def usd_import(
     read_mesh_attributes: bool | typing.Any | None = True,
     prim_path_mask: str | typing.Any = "",
     import_guide: bool | typing.Any | None = False,
-    import_proxy: bool | typing.Any | None = True,
+    import_proxy: bool | typing.Any | None = False,
     import_render: bool | typing.Any | None = True,
     import_all_materials: bool | typing.Any | None = False,
     import_usd_preview: bool | typing.Any | None = True,
@@ -5356,11 +5356,11 @@ def usd_import(
         :type import_meshes: bool | typing.Any | None
         :param import_volumes: Volumes
         :type import_volumes: bool | typing.Any | None
-        :param import_shapes: Shapes
+        :param import_shapes: USD Shapes
         :type import_shapes: bool | typing.Any | None
-        :param import_skeletons: Skeletons
+        :param import_skeletons: Armatures
         :type import_skeletons: bool | typing.Any | None
-        :param import_blendshapes: Blend Shapes
+        :param import_blendshapes: Shape Keys
         :type import_blendshapes: bool | typing.Any | None
         :param import_points: Point Clouds
         :type import_points: bool | typing.Any | None
@@ -5438,7 +5438,7 @@ def usd_import(
         :type validate_meshes: bool | typing.Any | None
         :param create_world_material: Create World Material, Convert the first discovered USD dome light to a world background shader
         :type create_world_material: bool | typing.Any | None
-        :param import_defined_only: Import only defined USD primitives, When disabled this allows importing USD primitives which are not defined,such as those with an override specifier
+        :param import_defined_only: Defined Primitives Only, Import only defined USD primitives. When disabled this allows importing USD primitives which are not defined, such as those with an override specifier
         :type import_defined_only: bool | typing.Any | None
     """