pydoc_fork.inspector.utils
index
../../pydoc_fork/inspector/utils.py

Unclassified utils

 
Modules
 
inspect
logging
re
sys

 
`from` Modules
 
pydoc_fork.inspector.module_utils
modulefinder
pydoc_fork.inspector.custom_types

 
Functions
 
cast(typ, val)
Cast a value to a type.
 
This returns the value unchanged.  To the type checker this
signals that the return value has the designated type, but at
runtime we intentionally don't check anything (we want this
to be as fast as possible).
classify_class_attrs(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> List[Tuple[str, str, type, object]]
Wrap inspect.classify_class_attrs, with fixup for data descriptors.
classname(the_object: pydoc_fork.inspector.custom_types.TypeLike, modname: str) -> str
Get a class name and qualify it with a module name if necessary.
describe(thing: pydoc_fork.inspector.custom_types.TypeLike) -> str
Produce a short description of the given thing.
getdoc(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
Get the doc string or comments for an object.
isdata(the_object: Any) -> bool
Check if an object is of a type that probably means it's data.
locate(path: str, force_load: bool = False) -> Any
Locate an object by name or dotted path, importing as necessary.
resolve(thing: Union[str, Any], force_load: bool = False) -> Tuple[Any, Any]
Given an object or a path to an object, get the object and its name.
sort_attributes(attrs: List[Any], the_object: Union[pydoc_fork.inspector.custom_types.TypeLike, type]) -> None
Sort the attrs list in-place by _fields and then alphabetically by name
visiblename(name: str, all_things: Optional[List[str]] = None, obj: Optional[Any] = None) -> bool
Decide whether to show documentation on a variable.

 
Data
  LOGGER = <Logger pydoc_fork.inspector.utils (WARNING)>