utils

Function	`classify_class_attrs`	Wrap inspect.classify_class_attrs, with fixup for data descriptors.
Function	`classname`	Get a class name and qualify it with a module name if necessary.
Function	`describe`	Produce a short description of the given thing.
Function	`getdoc`	Get the doc string or comments for an object.
Function	`isdata`	Check if an object is of a type that probably means it's data.
Function	`resolve`	Given an object or a path to an object, get the object and its name.
Function	`sort_attributes`	Sort the attrs list in-place by _fields and then alphabetically by name
Function	`visiblename`	Decide whether to show documentation on a variable.
Variable	`LOGGER`	Undocumented
Function	`_find_class`	Find a Class
Function	`_find_doc_string`	Find doc string
Function	`_get_own_doc_string`	Get the documentation string for an object if it is not inherited from its class.
Function	`_getdoc`	Get the documentation string for an object.
Function	`_is_bound_method`	Returns True if fn is a bound method, regardless of whether fn was implemented in Python or in C.
Function	`_split_list`	Split sequence s via predicate, and return pair ([true], [false]).

def classify_class_attrs(the_object):

Wrap inspect.classify_class_attrs, with fixup for data descriptors.

Parameters
the_object:`TypeLike`	Undocumented
Returns
`List[Tuple[str, str, type, object]]`	Undocumented

def classname(the_object, modname):

Get a class name and qualify it with a module name if necessary.

Parameters
the_object:`TypeLike`	Undocumented
modname:`str`	Undocumented
Returns
`str`	Undocumented

def describe(thing):

Produce a short description of the given thing.

Parameters
thing:`TypeLike`	Undocumented
Returns
`str`	Undocumented

def getdoc(the_object):

Get the doc string or comments for an object.

Parameters
the_object:`TypeLike`	Undocumented
Returns
`str`	Undocumented

def isdata(the_object):

Check if an object is of a type that probably means it's data.

Parameters
the_object:`Any`	Undocumented
Returns
`bool`	Undocumented

def resolve(thing, force_load=False):

Given an object or a path to an object, get the object and its name.

Parameters
thing:`Union[str, Any]`	Undocumented
force_load:`bool`	Undocumented
Returns
`Tuple[Any, Any]`	Undocumented

def sort_attributes(attrs, the_object):

Sort the attrs list in-place by _fields and then alphabetically by name

Parameters
attrs:`List[Any]`	Undocumented
the_object:`Union[TypeLike, type]`	Undocumented

def visiblename(name, all_things=None, obj=None):

Decide whether to show documentation on a variable.

Parameters
name:`str`	Undocumented
all_things:`Optional[List[str]]`	Undocumented
obj:`Optional[Any]`	Undocumented
Returns
`bool`	Undocumented

LOGGER =

Undocumented

def _find_class(func):

Find a Class

Parameters
func:`TypeLike`	Undocumented
Returns
`Optional[Module]`	Undocumented

def _find_doc_string(obj):

Find doc string

Parameters
obj:`TypeLike`	Undocumented
Returns
`Optional[str]`	Undocumented

def _get_own_doc_string(obj):

Get the documentation string for an object if it is not inherited from its class.

Parameters
obj:`TypeLike`	Undocumented
Returns
`str`	Undocumented

def _getdoc(the_object):

Get the documentation string for an object.

All tabs are expanded to spaces. To clean up docstrings that are indented to line up with blocks of code, any whitespace than can be uniformly removed from the second line onwards is removed.

Parameters
the_object:`TypeLike`	Undocumented
Returns
`str`	Undocumented

def _is_bound_method(the_function):

Returns True if fn is a bound method, regardless of whether fn was implemented in Python or in C.

Parameters
the_function:`object`	Undocumented
Returns
`bool`	Undocumented

def _split_list(the_sequence, predicate):

Split sequence s via predicate, and return pair ([true], [false]).

The return value is a 2-tuple of lists, ([x for x in s if predicate(x)], [x for x in s if not predicate(x)])

Parameters
the_sequence:`Sequence[Any]`	Undocumented
predicate:`Callable[[Any], Any]`	Undocumented
Returns
`Tuple[List[Any], List[Any]]`	Undocumented