fake-bpy-module 20231225__tar.gz → 20231227__tar.gz

{fake-bpy-module-20231225 → fake-bpy-module-20231227}/PKG-INFO

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

{fake-bpy-module-20231225 → fake-bpy-module-20231227}/bpy/props/__init__.pyi

@@ -1,22 +1,20 @@
 import sys
 import typing
-import bpy.types
 
 GenericType = typing.TypeVar("GenericType")
 
 
-def BoolProperty(
-        name: typing.Optional[str] = "",
-        description: typing.Optional[str] = "",
-        translation_context: typing.Optional[str] = "*",
-        default=False,
-        options: typing.Optional[typing.Set] = {'ANIMATABLE'},
-        override: typing.Optional[typing.Set] = 'set()',
-        tags: typing.Optional[typing.Set] = 'set()',
-        subtype: typing.Optional[str] = 'NONE',
-        update: typing.Optional[typing.Any] = None,
-        get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None) -> 'bpy.types.BoolProperty':
+def BoolProperty(name: typing.Optional[str] = "",
+                 description: typing.Optional[str] = "",
+                 translation_context: typing.Optional[str] = "*",
+                 default=False,
+                 options: typing.Optional[typing.Set] = {'ANIMATABLE'},
+                 override: typing.Optional[typing.Set] = 'set()',
+                 tags: typing.Optional[typing.Set] = 'set()',
+                 subtype: typing.Optional[str] = 'NONE',
+                 update: typing.Optional[typing.Any] = None,
+                 get: typing.Optional[typing.Any] = None,
+                 set: typing.Optional[typing.Any] = None):
     ''' Returns a new boolean property definition.
 
     :param name: Name used in the user interface.
@@ -39,7 +37,6 @@ def BoolProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: 'bpy.types.BoolProperty'
     '''
 
     ...
@@ -57,8 +54,7 @@ def BoolVectorProperty(
         size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
         update: typing.Optional[typing.Any] = None,
         get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None
-) -> typing.Union[typing.List, 'bpy.types.BoolProperty']:
+        set: typing.Optional[typing.Any] = None):
     ''' Returns a new vector boolean property definition.
 
     :param name: Name used in the user interface.
@@ -85,7 +81,6 @@ def BoolVectorProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: typing.Union[typing.List, 'bpy.types.BoolProperty']
     '''
 
     ...
@@ -97,8 +92,7 @@ def CollectionProperty(type: typing.Optional[typing.Any] = None,
                        translation_context: typing.Optional[str] = "*",
                        options: typing.Optional[typing.Set] = {'ANIMATABLE'},
                        override: typing.Optional[typing.Set] = 'set()',
-                       tags: typing.Optional[typing.Set] = 'set()'
-                       ) -> 'bpy.types.CollectionProperty':
+                       tags: typing.Optional[typing.Set] = 'set()'):
     ''' Returns a new collection property definition.
 
     :param type: `bpy.types.PropertyGroup`.
@@ -115,25 +109,24 @@ def CollectionProperty(type: typing.Optional[typing.Any] = None,
     :type override: typing.Optional[typing.Set]
     :param tags: Enumerator of tags that are defined by parent class.
     :type tags: typing.Optional[typing.Set]
-    :rtype: 'bpy.types.CollectionProperty'
     '''
 
     ...
 
 
-def EnumProperty(
-        items: typing.Optional[typing.Union[typing.Iterable[
-            typing.Iterable[str]], typing.Callable]],
-        name: typing.Optional[str] = "",
-        description: typing.Optional[str] = "",
-        translation_context: typing.Optional[str] = "*",
-        default: typing.Optional[typing.Union[str, typing.Set]] = None,
-        options: typing.Optional[typing.Set] = {'ANIMATABLE'},
-        override: typing.Optional[typing.Set] = 'set()',
-        tags: typing.Optional[typing.Set] = 'set()',
-        update: typing.Optional[typing.Any] = None,
-        get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None) -> 'bpy.types.EnumProperty':
+def EnumProperty(items: typing.Optional[
+        typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable]],
+                 name: typing.Optional[str] = "",
+                 description: typing.Optional[str] = "",
+                 translation_context: typing.Optional[str] = "*",
+                 default: typing.Optional[typing.Union[str, typing.
+                                                       Set]] = None,
+                 options: typing.Optional[typing.Set] = {'ANIMATABLE'},
+                 override: typing.Optional[typing.Set] = 'set()',
+                 tags: typing.Optional[typing.Set] = 'set()',
+                 update: typing.Optional[typing.Any] = None,
+                 get: typing.Optional[typing.Any] = None,
+                 set: typing.Optional[typing.Any] = None):
     ''' Returns a new enumerator property definition.
 
     :param items: ``[(identifier, name, description, icon, number), ...]``. The first three elements of the tuples are mandatory. :identifier: The identifier is used for Python access. :name: Name for the interface. :description: Used for documentation and tooltips. :icon: An icon string identifier or integer icon value (e.g. returned by `bpy.types.UILayout.icon`) :number: Unique value used as the identifier for this item (stored in file data). Use when the identifier may need to change. If the *ENUM_FLAG* option is used, the values are bit-masks and should be powers of two. When an item only contains 4 items they define ``(identifier, name, description, number)``. Separators may be added using None instead of a tuple. For dynamic values a callback can be passed which returns a list in the same format as the static list. This function must take 2 arguments ``(self, context)``, **context may be None**. .. warning:: There is a known bug with using a callback, Python must keep a reference to the strings returned by the callback or Blender will misbehave or even crash.
@@ -158,31 +151,29 @@ def EnumProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: 'bpy.types.EnumProperty'
     '''
 
     ...
 
 
-def FloatProperty(
-        name: typing.Optional[str] = "",
-        description: typing.Optional[str] = "",
-        translation_context: typing.Optional[str] = "*",
-        default=0.0,
-        min: typing.Optional[float] = -3.402823e+38,
-        max: typing.Optional[float] = 3.402823e+38,
-        soft_min: typing.Optional[float] = -3.402823e+38,
-        soft_max: typing.Optional[float] = 3.402823e+38,
-        step: typing.Optional[int] = 3,
-        precision: typing.Optional[int] = 2,
-        options: typing.Optional[typing.Set] = {'ANIMATABLE'},
-        override: typing.Optional[typing.Set] = 'set()',
-        tags: typing.Optional[typing.Set] = 'set()',
-        subtype: typing.Optional[str] = 'NONE',
-        unit: typing.Optional[str] = 'NONE',
-        update: typing.Optional[typing.Any] = None,
-        get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None) -> 'bpy.types.FloatProperty':
+def FloatProperty(name: typing.Optional[str] = "",
+                  description: typing.Optional[str] = "",
+                  translation_context: typing.Optional[str] = "*",
+                  default=0.0,
+                  min: typing.Optional[float] = -3.402823e+38,
+                  max: typing.Optional[float] = 3.402823e+38,
+                  soft_min: typing.Optional[float] = -3.402823e+38,
+                  soft_max: typing.Optional[float] = 3.402823e+38,
+                  step: typing.Optional[int] = 3,
+                  precision: typing.Optional[int] = 2,
+                  options: typing.Optional[typing.Set] = {'ANIMATABLE'},
+                  override: typing.Optional[typing.Set] = 'set()',
+                  tags: typing.Optional[typing.Set] = 'set()',
+                  subtype: typing.Optional[str] = 'NONE',
+                  unit: typing.Optional[str] = 'NONE',
+                  update: typing.Optional[typing.Any] = None,
+                  get: typing.Optional[typing.Any] = None,
+                  set: typing.Optional[typing.Any] = None):
     ''' Returns a new float (single precision) property definition.
 
     :param name: Name used in the user interface.
@@ -219,7 +210,6 @@ def FloatProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: 'bpy.types.FloatProperty'
     '''
 
     ...
@@ -244,8 +234,7 @@ def FloatVectorProperty(
         size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
         update: typing.Optional[typing.Any] = None,
         get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None
-) -> typing.Union[typing.List, 'bpy.types.FloatProperty']:
+        set: typing.Optional[typing.Any] = None):
     ''' Returns a new vector float property definition.
 
     :param name: Name used in the user interface.
@@ -286,29 +275,27 @@ def FloatVectorProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: typing.Union[typing.List, 'bpy.types.FloatProperty']
     '''
 
     ...
 
 
-def IntProperty(
-        name: typing.Optional[str] = "",
-        description: typing.Optional[str] = "",
-        translation_context: typing.Optional[str] = "*",
-        default=0,
-        min: typing.Optional[int] = -2**31,
-        max: typing.Optional[int] = 2**31 - 1,
-        soft_min: typing.Optional[int] = -2**31,
-        soft_max: typing.Optional[int] = 2**31 - 1,
-        step: typing.Optional[int] = 1,
-        options: typing.Optional[typing.Set] = {'ANIMATABLE'},
-        override: typing.Optional[typing.Set] = 'set()',
-        tags: typing.Optional[typing.Set] = 'set()',
-        subtype: typing.Optional[str] = 'NONE',
-        update: typing.Optional[typing.Any] = None,
-        get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None) -> 'bpy.types.IntProperty':
+def IntProperty(name: typing.Optional[str] = "",
+                description: typing.Optional[str] = "",
+                translation_context: typing.Optional[str] = "*",
+                default=0,
+                min: typing.Optional[int] = -2**31,
+                max: typing.Optional[int] = 2**31 - 1,
+                soft_min: typing.Optional[int] = -2**31,
+                soft_max: typing.Optional[int] = 2**31 - 1,
+                step: typing.Optional[int] = 1,
+                options: typing.Optional[typing.Set] = {'ANIMATABLE'},
+                override: typing.Optional[typing.Set] = 'set()',
+                tags: typing.Optional[typing.Set] = 'set()',
+                subtype: typing.Optional[str] = 'NONE',
+                update: typing.Optional[typing.Any] = None,
+                get: typing.Optional[typing.Any] = None,
+                set: typing.Optional[typing.Any] = None):
     ''' Returns a new int property definition.
 
     :param name: Name used in the user interface.
@@ -341,7 +328,6 @@ def IntProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: 'bpy.types.IntProperty'
     '''
 
     ...
@@ -364,8 +350,7 @@ def IntVectorProperty(
         size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
         update: typing.Optional[typing.Any] = None,
         get: typing.Optional[typing.Any] = None,
-        set: typing.Optional[typing.Any] = None
-) -> typing.Union[typing.List, 'bpy.types.IntProperty']:
+        set: typing.Optional[typing.Any] = None):
     ''' Returns a new vector int property definition.
 
     :param name: Name used in the user interface.
@@ -402,7 +387,6 @@ def IntVectorProperty(
     :type get: typing.Optional[typing.Any]
     :param set: Function to be called when this value is 'written', This function must take 2 values (self, value) and return None.
     :type set: typing.Optional[typing.Any]
-    :rtype: typing.Union[typing.List, 'bpy.types.IntProperty']
     '''
 
     ...
@@ -416,8 +400,7 @@ def PointerProperty(type: typing.Optional[typing.Any] = None,
                     override: typing.Optional[typing.Set] = 'set()',
                     tags: typing.Optional[typing.Set] = 'set()',
                     poll: typing.Optional[typing.Any] = None,
-                    update: typing.Optional[typing.Any] = None
-                    ) -> 'bpy.types.PointerProperty':
+                    update: typing.Optional[typing.Any] = None):
     ''' Returns a new pointer property definition.
 
     :param type: `bpy.types.ID`.
@@ -438,7 +421,6 @@ def PointerProperty(type: typing.Optional[typing.Any] = None,
     :type poll: typing.Optional[typing.Any]
     :param update: Function to be called when this value is modified, This function must take 2 values (self, context) and return None. *Warning* there are no safety checks to avoid infinite recursion.
     :type update: typing.Optional[typing.Any]
-    :rtype: 'bpy.types.PointerProperty'
     '''
 
     ...
@@ -457,22 +439,21 @@ def RemoveProperty(cls: typing.Optional[typing.Any],
     ...
 
 
-def StringProperty(name: typing.Optional[str] = "",
-                   description: typing.Optional[str] = "",
-                   translation_context: typing.Optional[str] = "*",
-                   default: typing.Optional[str] = "",
-                   maxlen: typing.Optional[int] = 0,
-                   options: typing.Optional[typing.Set] = {'ANIMATABLE'},
-                   override: typing.Optional[typing.Set] = 'set()',
-                   tags: typing.Optional[typing.Set] = 'set()',
-                   subtype: typing.Optional[str] = 'NONE',
-                   update: typing.Optional[typing.Any] = None,
-                   get: typing.Optional[typing.Any] = None,
-                   set: typing.Optional[typing.Any] = None,
-                   search: typing.Optional[typing.Any] = None,
-                   search_options: typing.Optional[typing.Set] = {
-                       'SUGGESTION'
-                   }) -> 'bpy.types.StringProperty':
+def StringProperty(
+        name: typing.Optional[str] = "",
+        description: typing.Optional[str] = "",
+        translation_context: typing.Optional[str] = "*",
+        default: typing.Optional[str] = "",
+        maxlen: typing.Optional[int] = 0,
+        options: typing.Optional[typing.Set] = {'ANIMATABLE'},
+        override: typing.Optional[typing.Set] = 'set()',
+        tags: typing.Optional[typing.Set] = 'set()',
+        subtype: typing.Optional[str] = 'NONE',
+        update: typing.Optional[typing.Any] = None,
+        get: typing.Optional[typing.Any] = None,
+        set: typing.Optional[typing.Any] = None,
+        search: typing.Optional[typing.Any] = None,
+        search_options: typing.Optional[typing.Set] = {'SUGGESTION'}):
     ''' Returns a new string property definition.
 
     :param name: Name used in the user interface.
@@ -503,7 +484,6 @@ def StringProperty(name: typing.Optional[str] = "",
     :type search: typing.Optional[typing.Any]
     :param search_options: - 'SORT' sorts the resulting items. - 'SUGGESTION' lets the user enter values not found in search candidates. **WARNING** disabling this flag causes the search callback to run on redraw, so only disable this flag if it's not likely to cause performance issues.
     :type search_options: typing.Optional[typing.Set]
-    :rtype: 'bpy.types.StringProperty'
     '''
 
     ...