Get tooltips data from python?

Question

I am writing an addon popup that shows all the current shortcuts. This is context sensitive and I have it mostly done. However, I am not able to get much information from the other python addons.

Below is some of CoDEManX's code that collects a lot of the info I need. However, it does not seem to collect anything for Python addons.

Is there a way to collect the same info that the tooltips do from within python?

mod, opname = idname.split(".")
idname_c = "{!s}_OT_{!s}".format(mod.upper(), opname)
idtype = getattr(bpy.types, idname_c)
description = idtype.bl_rna.description

Answer 1

Wow Blender/Python is really like an onion ( a rather large on at that ) and my eyes have been watering like made getting through the layers :)

Ok I finally ran grep in the scripts directory as I should have when pink vertex first sugessted it. Duh. Line 340 in bl_extract_messages.py gives it up (code below). So it looks to me that if it doesn't have a bl_rna.description (or bl_description) then it uses the __doc__ part. In the process I realised that the bulk of what I need is directly in the keymaps them selves as .name attribute of the individual keymap. This is derived from the bl_label that is in the op that is called by the new keymap definition line.

So I went round in circles when it was right under my nose. Thanks again everyone.

    if bl_rna.description:
        process_msg(msgs, default_context, bl_rna.description, msgsrc, reports, check_ctxt_rna_tip, settings)
    elif cls.__doc__:  # XXX Some classes (like KeyingSetInfo subclasses) have void description... :(
        process_msg(msgs, default_context, cls.__doc__, msgsrc, reports, check_ctxt_rna_tip, settings)

Answer 2

Tooltips appear to display the __doc__ string from the operator class. The simple operator template also hints that this is the tooltip.

There is nothing in place to force an operator to have a __doc__ string so you may want to fall back to the bl_label which must be defined. In the rare event that is an empty string I would fall back to the idname.

mod, opname = idname.split(".")
idname_c = "{!s}_OT_{!s}".format(mod.upper(), opname)
idtype = getattr(bpy.types, idname_c)

if len(idtype.__doc__) > 0:
    description = idtype.__doc__
else:
    if len(idtype.bl_label) > 0:
        description = idtype.bl_label
    else:
        description = " ".join(opname.split("_"))

Answer 3

I assume you have the operator's bl_idname at hand. Lets say your operator's bl_idname is "avastar.shape_type_bone_hint"

Now you can do this:

# I assume you got the operator's bl_idname from somewhere.

idname = "avastar.shape_type_bone_hint"
op = eval("bpy.ops."+idname)
idtype=getattr(bpy.types, op.idname())

# Now you can get the operator's bl_* declarations as follows:

bl_idname      = getattr(idtype,"bl_idname",      None)
bl_label       = getattr(idtype,"bl_label",       None)
bl_description = getattr(idtype,"bl_description", None)
bl_options     = getattr(idtype,"bl_options",     None)

I am still unsure if this is exactly what you have asked for. but this will give you the operator's bl_description. However, maybe there is a more elegant way to get the idtype from the operator.