PyDoc: clarify which classes support custom properties #120424

Sybren A. Stüvel · 2024-04-09T13:30:44+02:00

Sybren A. Stüvel commented

2024-04-09 13:30:44 +02:00

Update the list of classes that support custom properties. Instead of
presenting it as an exhaustive list (which by now has been quite
outdated), just list a few classes as example.

Update the list of classes that support custom properties. Instead of presenting it as an exhaustive list (which by now has been quite outdated), just list a few classes as example.

Sybren A. Stüvel added the

Module

Core

label 2024-04-09 13:30:44 +02:00

Sybren A. Stüvel added 1 commit 2024-04-09 13:30:52 +02:00

b840bd50ef PyDoc: clarify which classes support custom properties

Update the list of classes that support custom properties. Instead of
presenting it as an exhaustive list (which by now has been quite
outdated), just list a few classes as example.

Sybren A. Stüvel requested review from Campbell Barton 2024-04-09 13:31:14 +02:00

Campbell Barton commented

2024-04-09 15:22:38 +02:00

Since it's useful to know which types support ID properties, I think it might be more helpful to have a complete list of all classes that support ID properties & link to it. What do you think?

Sybren A. Stüvel commented

2024-04-09 16:41:59 +02:00

I agree that this would be nice, I'm just worried that it'll be outdated soon. Do you think there is a way to make the API doc generator aware of this, so that this can be automated?

Campbell Barton commented

2024-04-10 03:04:51 +02:00

This can be done by checking bpy.types.bpy_struct_meta_idprop which supports __getitem__/__setitem__ access.

import bpy
bpy_struct_meta_idprop = bpy.types.bpy_struct_meta_idprop


def isinstance_direct(ty, ty_test):
    """
    Return true only when ``ty`` is a direct instance of ``ty_test``.
    """
    if not isinstance(ty, ty_test):
        return False
    for ty_base in ty.__bases__:
        # No need check `ty_base.__bases__` since `isinstance` does this.
        if isinstance(ty_base, ty_test):
            return False
    return True


for ty_name in dir(bpy.types):
    ty = getattr(bpy.types, ty_name)
    if not isinstance_direct(ty, bpy_struct_meta_idprop):
        continue

    print("bpy.types." + ty.__name__)

A list of these types can be added to generated docs, e.g. https://docs.blender.org/api/4.2/idprop.types.html then linked from methods that deal with id-properties as well as https://docs.blender.org/api/4.2/info_quickstart.html#custom-properties.

This can be done by checking `bpy.types.bpy_struct_meta_idprop` which supports `__getitem__/__setitem__` access. ```python import bpy bpy_struct_meta_idprop = bpy.types.bpy_struct_meta_idprop def isinstance_direct(ty, ty_test): """ Return true only when ``ty`` is a direct instance of ``ty_test``. """ if not isinstance(ty, ty_test): return False for ty_base in ty.__bases__: # No need check `ty_base.__bases__` since `isinstance` does this. if isinstance(ty_base, ty_test): return False return True for ty_name in dir(bpy.types): ty = getattr(bpy.types, ty_name) if not isinstance_direct(ty, bpy_struct_meta_idprop): continue print("bpy.types." + ty.__name__) ``` A list of these types can be added to generated docs, e.g. https://docs.blender.org/api/4.2/idprop.types.html then linked from methods that deal with id-properties as well as https://docs.blender.org/api/4.2/info_quickstart.html#custom-properties.

👍 1

Merge conflict checking is in progress. Try again in few moments.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u pr/pydoc-customprop-support:dr.sybren-pr/pydoc-customprop-support

git checkout dr.sybren-pr/pydoc-customprop-support

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

PyDoc: clarify which classes support custom properties #120424

Checkout