inspectors

The functionalities related to inspecting and analyzing objects.

Functions

Member	Description
get_mro	Get the mro of a class.
get_obj_slang	Get the full slang of a function/class/variable in a module.
is_user_defined_method	Check whether a member is defined in a class.
get_members_defined_in_class	Get all members (attributes) defined in a class.
get_members_defined_in_enum	Get all members (attributes) defined in an enum class.
get_field_docstrings	Capture the docstrings of each assignment item in a class by its source code.
get_arg_default_name	Format the given value as a string that can be used as the default field of a function argument (`DocFunction`).
get_lambda_source	Get the source definition of a lambda function expression.
get_func_signature	Attempt to get the signature of a potential function.
get_field_default	Format the given value as a string that can be used as the default field of a field (`DocField`).
is_multival_tuple	Check whether the given annotation is a multi-variable tuple such as.
is_member_abstract	Check whether a value is an abstract member of a class.
is_func_yield	Check whether the given object is a function returning an iterator.
unwrap_annotated_annotation	Given an annotation, remove the `Annotated[...]` wrapper recursively if it appears.
unpack_annotation	Unpack the annotation wrapper.
strip_annotation_name	Convert an annotation to string, and strip its name by removing the module prefix.
get_short_descr	Get the short description from the long description.
get_slug	Get the URL slug from the slang prototype.
relative_url_path	Solve the relative path.