Kind

class understand.Kind

Bases: object

The kind of an entity or reference.

Kinds are usually represented as strings. For example, an Understand entity kind might be “C Header File”. An Understand reference kind could be “Call.” Kindstrings and refkindstrings filters are built from these. A filter string may use the tilde “~” to indicate the absence of a token, and comma “,” to “or” filters together. Otherwise, filters are constructed with an “and” relationship. For a full list of available kinds, see Kind Filters.

Methods Summary

check	Return true if the kind matches the filter string kindstring.
inv	Return the logical inverse of a reference kind.
list_entity	Return the list of entity kinds that match the filter entkind.
list_reference	Return the list of reference kinds that match the filter refkind.
longname	Return the long form of the kind name.
name	Return the name of the kind.

Methods Documentation

check(kindstring) → bool

Return true if the kind matches the filter string kindstring.

Parameters:

kindstring (str) – a kindstring to match

Return type:

bool

Returns:

True if kind matches

inv() → understand.Kind

Return the logical inverse of a reference kind.

Raises:

understand.UnderstandError – if called with an entity kind

Return type:

understand.Kind

Returns:

the inverse reference kind

For example, the inverse of a “call” reference is a “callby” reference. This will throw an UnderstandError if called with an entity kind.

list_entity([entkind]) → list[understand.Kind]

Return the list of entity kinds that match the filter entkind.

Parameters:

entkind (str or None) – optional, a kindstring to match

Return type:

list[understand.Kind]

Returns:

a list of matching kinds

If no entkind is given, all entity kinds are returned. For example, to get the list of all c function entity kinds:

kinds = understand.Kind.list_entity(“c function”)

list_reference([refkind]) → list[understand.Kind]

Return the list of reference kinds that match the filter refkind.

Parameters:

refkind (str or None) – optional, a kindstring to match

Return type:

list[understand.Kind]

Returns:

a list of matching kinds

If no refkind is given, all reference kinds are returned. For example, to get the list of all ada declare reference kinds:

kinds = understand.Kind.list_entity(“ada declare”)

longname() → str

Return the long form of the kind name.

Return type:

str

Returns:

the long form of the kind name

This is usually more detailed than desired for human reading. It is the same as repr(kind)

name() → str

Return the name of the kind.

Return type:

str

Returns:

the name of the kind

This is the same as str(kind).