pydoc_fork.reporter.format_class
index
../../pydoc_fork/reporter/format_class.py

Roughly a UI component for classes

 
Modules
 
builtins
pydoc_fork.reporter.inline_styles
inspect
pydoc_fork.settings
sys

 
`from` Modules
 
pydoc_fork.inspector.custom_types
pydoc_fork.inspector.utils
pydoc_fork.reporter.format_other
pydoc_fork.reporter.format_data
pydoc_fork.reporter.formatter_html
collections

 
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.
classlink(the_object: Union[pydoc_fork.inspector.custom_types.TypeLike, type], modname: str) -> str
Make a link for a class.
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.
docclass(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '', mod: str = '', funcs: Optional[Dict[str, str]] = None, classes: Optional[Dict[str, str]] = None) -> str
Produce HTML documentation for a class object.
docother(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '') -> str
Produce HTML documentation for a data object.
document_data(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '') -> str
Produce html documentation for a data descriptor.
format_tree(tree: List[Any], modname: str, parent: Optional[Any] = None) -> str
Creates a representation of class inheritance.
getdoc(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
Get the doc string or comments for an object.
markup(text: str, funcs: Optional[Dict[str, str]] = None, classes: Optional[Dict[str, str]] = None, methods: Optional[Dict[str, str]] = None) -> str
Replace all linkable things with links of appropriate syntax.
 
Handle either an adhoc markup language, or RST or Markdown.
funcs, classes, methods are name/symbol to URL maps.
section(title: str, fgcol: str, bgcol: str, contents: str, width: int = 6, prelude: str = '', marginalia: str = '', gap: str = ' ') -> str
Format a section with a heading.
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.