import inspect from functools import partial from typing import ( Any, Callable, Iterable, List, Optional, Tuple, Type, TypeVar, Union, overload, ) T = TypeVar("T") Result = Iterable[Union[Any, Tuple[Any], Tuple[str, Any], Tuple[str, Any, Any]]] RichReprResult = Result class ReprError(Exception): """An error occurred when attempting to build a repr.""" @overload def auto(cls: Optional[Type[T]]) -> Type[T]: ... @overload def auto(*, angular: bool = False) -> Callable[[Type[T]], Type[T]]: ... def auto( cls: Optional[Type[T]] = None, *, angular: Optional[bool] = None ) -> Union[Type[T], Callable[[Type[T]], Type[T]]]: """Class decorator to create __repr__ from __rich_repr__""" def do_replace(cls: Type[T], angular: Optional[bool] = None) -> Type[T]: def auto_repr(self: T) -> str: """Create repr string from __rich_repr__""" repr_str: List[str] = [] append = repr_str.append angular: bool = getattr(self.__rich_repr__, "angular", False) # type: ignore[attr-defined] for arg in self.__rich_repr__(): # type: ignore[attr-defined] if isinstance(arg, tuple): if len(arg) == 1: append(repr(arg[0])) else: key, value, *default = arg if key is None: append(repr(value)) else: if default and default[0] == value: continue append(f"{key}={value!r}") else: append(repr(arg)) if angular: return f"<{self.__class__.__name__} {' '.join(repr_str)}>" else: return f"{self.__class__.__name__}({', '.join(repr_str)})" def auto_rich_repr(self: Type[T]) -> Result: """Auto generate __rich_rep__ from signature of __init__""" try: signature = inspect.signature(self.__init__) for name, param in signature.parameters.items(): if param.kind == param.POSITIONAL_ONLY: yield getattr(self, name) elif param.kind in ( param.POSITIONAL_OR_KEYWORD, param.KEYWORD_ONLY, ): if param.default is param.empty: yield getattr(self, param.name) else: yield param.name, getattr(self, param.name), param.default except Exception as error: raise ReprError( f"Failed to auto generate __rich_repr__; {error}" ) from None if not hasattr(cls, "__rich_repr__"): auto_rich_repr.__doc__ = "Build a rich repr" cls.__rich_repr__ = auto_rich_repr # type: ignore[attr-defined] auto_repr.__doc__ = "Return repr(self)" cls.__repr__ = auto_repr # type: ignore[assignment] if angular is not None: cls.__rich_repr__.angular = angular # type: ignore[attr-defined] return cls if cls is None: return partial(do_replace, angular=angular) else: return do_replace(cls, angular=angular) @overload def rich_repr(cls: Optional[Type[T]]) -> Type[T]: ... @overload def rich_repr(*, angular: bool = False) -> Callable[[Type[T]], Type[T]]: ... def rich_repr( cls: Optional[Type[T]] = None, *, angular: bool = False ) -> Union[Type[T], Callable[[Type[T]], Type[T]]]: if cls is None: return auto(angular=angular) else: return auto(cls) if __name__ == "__main__": @auto class Foo: def __rich_repr__(self) -> Result: yield "foo" yield "bar", {"shopping": ["eggs", "ham", "pineapple"]} yield "buy", "hand sanitizer" foo = Foo() from pip._vendor.rich.console import Console console = Console() console.rule("Standard repr") console.print(foo) console.print(foo, width=60) console.print(foo, width=30) console.rule("Angular repr") Foo.__rich_repr__.angular = True # type: ignore[attr-defined] console.print(foo) console.print(foo, width=60) console.print(foo, width=30)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 5.95 KB | 0644 |
|
__main__.py | File | 8.28 KB | 0644 |
|
_cell_widths.py | File | 9.97 KB | 0644 |
|
_emoji_codes.py | File | 136.95 KB | 0644 |
|
_emoji_replace.py | File | 1.04 KB | 0644 |
|
_export_format.py | File | 2.08 KB | 0644 |
|
_extension.py | File | 265 B | 0644 |
|
_fileno.py | File | 799 B | 0644 |
|
_inspect.py | File | 9.47 KB | 0644 |
|
_log_render.py | File | 3.15 KB | 0644 |
|
_loop.py | File | 1.21 KB | 0644 |
|
_null_file.py | File | 1.35 KB | 0644 |
|
_palettes.py | File | 6.9 KB | 0644 |
|
_pick.py | File | 423 B | 0644 |
|
_ratio.py | File | 5.34 KB | 0644 |
|
_spinners.py | File | 19.45 KB | 0644 |
|
_stack.py | File | 351 B | 0644 |
|
_timer.py | File | 417 B | 0644 |
|
_win32_console.py | File | 22.29 KB | 0644 |
|
_windows.py | File | 1.88 KB | 0644 |
|
_windows_renderer.py | File | 2.72 KB | 0644 |
|
_wrap.py | File | 3.32 KB | 0644 |
|
abc.py | File | 890 B | 0644 |
|
align.py | File | 10.13 KB | 0644 |
|
ansi.py | File | 6.74 KB | 0644 |
|
bar.py | File | 3.19 KB | 0644 |
|
box.py | File | 10.58 KB | 0644 |
|
cells.py | File | 4.67 KB | 0644 |
|
color.py | File | 17.8 KB | 0644 |
|
color_triplet.py | File | 1.03 KB | 0644 |
|
columns.py | File | 6.96 KB | 0644 |
|
console.py | File | 96.85 KB | 0644 |
|
constrain.py | File | 1.26 KB | 0644 |
|
containers.py | File | 5.37 KB | 0644 |
|
control.py | File | 6.47 KB | 0644 |
|
default_styles.py | File | 7.89 KB | 0644 |
|
diagnose.py | File | 972 B | 0644 |
|
emoji.py | File | 2.44 KB | 0644 |
|
errors.py | File | 642 B | 0644 |
|
file_proxy.py | File | 1.64 KB | 0644 |
|
filesize.py | File | 2.45 KB | 0644 |
|
highlighter.py | File | 9.36 KB | 0644 |
|
json.py | File | 4.91 KB | 0644 |
|
jupyter.py | File | 3.18 KB | 0644 |
|
layout.py | File | 13.68 KB | 0644 |
|
live.py | File | 13.94 KB | 0644 |
|
live_render.py | File | 3.58 KB | 0644 |
|
logging.py | File | 11.62 KB | 0644 |
|
markup.py | File | 8.25 KB | 0644 |
|
measure.py | File | 5.18 KB | 0644 |
|
padding.py | File | 4.85 KB | 0644 |
|
pager.py | File | 828 B | 0644 |
|
palette.py | File | 3.32 KB | 0644 |
|
panel.py | File | 10.45 KB | 0644 |
|
pretty.py | File | 35.01 KB | 0644 |
|
progress.py | File | 58.32 KB | 0644 |
|
progress_bar.py | File | 7.97 KB | 0644 |
|
prompt.py | File | 11.04 KB | 0644 |
|
protocol.py | File | 1.36 KB | 0644 |
|
py.typed | File | 0 B | 0644 |
|
region.py | File | 166 B | 0644 |
|
repr.py | File | 4.33 KB | 0644 |
|
rule.py | File | 4.49 KB | 0644 |
|
scope.py | File | 2.78 KB | 0644 |
|
screen.py | File | 1.55 KB | 0644 |
|
segment.py | File | 23.68 KB | 0644 |
|
spinner.py | File | 4.24 KB | 0644 |
|
status.py | File | 4.32 KB | 0644 |
|
style.py | File | 26.44 KB | 0644 |
|
styled.py | File | 1.23 KB | 0644 |
|
syntax.py | File | 34.64 KB | 0644 |
|
table.py | File | 38.75 KB | 0644 |
|
terminal_theme.py | File | 3.29 KB | 0644 |
|
text.py | File | 46.2 KB | 0644 |
|
theme.py | File | 3.69 KB | 0644 |
|
themes.py | File | 102 B | 0644 |
|
traceback.py | File | 28.91 KB | 0644 |
|
tree.py | File | 8.95 KB | 0644 |
|