griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

PyDoc: Add base class of bpy_prop_collection_idprop

Browse Source 
`bpy_prop_collection_idprop` is inherited from `bpy_prop_collection`.
Python API doc does not reflect this specification now.

Ref !136382
This commit is contained in:
nutti
2025-04-04 15:58:57 +11:00
committed by Campbell Barton
parent f1fb9d25ff
commit 07e6f78ac1
1 changed files with 21 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/python_api/sphinx_doc_gen.py
View File

@@ -1823,7 +1823,15 @@ def pyrna2sphinx(basepath):
continue
write_struct(struct)
def fake_bpy_type(class_module_name, class_value, class_name, descr_str, use_subclasses=True):
def fake_bpy_type(
class_module_name,
class_value,
class_name,
descr_str,
*,
use_subclasses, # `bool`
base_class, # `str | None`
):
filepath = os.path.join(basepath, "{:s}.{:s}.rst".format(class_module_name, class_name))
file = open(filepath, "w", encoding="utf-8")
fw = file.write
@@ -1832,6 +1840,9 @@ def pyrna2sphinx(basepath):
fw(".. currentmodule:: {:s}\n\n".format(class_module_name))
if base_class is not None:
fw("base classes --- :class:`{:s}`\n\n".format(base_class))
if use_subclasses:
subclass_ids = [
s.identifier for s in structs.values()
@@ -1868,21 +1879,27 @@ def pyrna2sphinx(basepath):
class_value = bpy_struct
fake_bpy_type(
"bpy.types", class_value, _BPY_STRUCT_FAKE,
"built-in base class for all classes in bpy.types.", use_subclasses=True,
"built-in base class for all classes in bpy.types.",
use_subclasses=True,
base_class=None,
)
if _BPY_PROP_COLLECTION_FAKE:
class_value = bpy.types.bpy_prop_collection
fake_bpy_type(
"bpy.types", class_value, _BPY_PROP_COLLECTION_FAKE,
"built-in class used for all collections.", use_subclasses=False,
"built-in class used for all collections.",
use_subclasses=False,
base_class=None,
)
if _BPY_PROP_COLLECTION_IDPROP_FAKE:
class_value = bpy.types.bpy_prop_collection_idprop
fake_bpy_type(
"bpy.types", class_value, _BPY_PROP_COLLECTION_IDPROP_FAKE,
"built-in class used for user defined collections.", use_subclasses=False,
"built-in class used for user defined collections.",
use_subclasses=False,
base_class=_BPY_PROP_COLLECTION_FAKE,
)
# Operators.