class documentation

class _SummaryWriter: (source)

View In Hierarchy

Undocumented

Method __call__ Undocumented
Method __init__ Undocumented
Instance Variable jargon Undocumented
Method _child_prefix Undocumented
Method _filter_unecessary Undocumented
Method _handle_list Undocumented
Method _handle_simple_dict Undocumented
Method _inline_attrs Undocumented
Method _is_property Check if the given path can correspond to an arbitrarily named property
Method _is_unecessary Undocumented
Method _jargon Undocumented
Method _label Undocumented
Method _value Undocumented
Constant _IGNORE Undocumented
Instance Variable _guess_inline_defs Undocumented
Instance Variable _terms Undocumented
def __call__(self, schema: Union[dict, List[dict]], prefix: str = '', *, _path: Sequence[str] = ()) -> str: (source)

Undocumented

def __init__(self, jargon: Optional[Dict[str, str]] = None): (source)

Undocumented

Undocumented

def _child_prefix(self, parent_prefix: str, child_prefix: str) -> str: (source)

Undocumented

def _filter_unecessary(self, schema: dict, path: Sequence[str]): (source)

Undocumented

def _handle_list(self, schemas: list, prefix: str = '', path: Sequence[str] = ()) -> str: (source)

Undocumented

def _handle_simple_dict(self, value: dict, path: Sequence[str]) -> Optional[str]: (source)

Undocumented

def _inline_attrs(self, schema: dict, path: Sequence[str]) -> Iterator[str]: (source)

Undocumented

def _is_property(self, path: Sequence[str]): (source)

Check if the given path can correspond to an arbitrarily named property

def _is_unecessary(self, path: Sequence[str]) -> bool: (source)

Undocumented

def _jargon(self, term: Union[str, List[str]]) -> Union[str, List[str]]: (source)

Undocumented

def _label(self, path: Sequence[str]) -> str: (source)

Undocumented

def _value(self, value: Any, path: Sequence[str]) -> str: (source)

Undocumented

Undocumented

Value
set(['description', 'default', 'title', 'examples'])
_guess_inline_defs: list[str] = (source)

Undocumented

Undocumented