pip._vendor.rich.repr Namespace Reference

Data Structures
class	Foo
class	ReprError

Functions
Type[T]	auto (Optional[Type[T]] cls)
Callable[[Type[T]], Type[T]]	auto (*bool angular=False)
Union[Type[T], Callable[[Type[T]], Type[T]]]	auto (Optional[Type[T]] cls=None, *Optional[bool] angular=None)
Type[T]	rich_repr (Optional[Type[T]] cls)
Callable[[Type[T]], Type[T]]	rich_repr (*bool angular=False)
Union[Type[T], Callable[[Type[T]], Type[T]]]	rich_repr (Optional[Type[T]] cls=None, *bool angular=False)

Variables
	T = TypeVar("T")
	Result = Iterable[Union[Any, Tuple[Any], Tuple[str, Any], Tuple[str, Any, Any]]]
	RichReprResult = Result
	foo
	console = Console()
	width
	angular

Function Documentation

auto() [1/3]

Callable[[Type[T]], Type[T]] auto

(

*bool

angular = False

)

Definition at line 33 of file repr.py.

def auto(*, angular: bool = False) -> Callable[[Type[T]], Type[T]]:
    ...
 
 

auto() [2/3]

Type[T] auto

(

Optional[Type[T]]

cls

)

Definition at line 28 of file repr.py.

def auto(cls: Optional[Type[T]]) -> Type[T]:
    ...
 
 
@overload

Referenced by pip._vendor.rich.repr.rich_repr().

Here is the caller graph for this function:

auto() [3/3]

Union[Type[T], Callable[[Type[T]], Type[T]]] auto	(	Optional[Type[T]]	cls = None,
		*Optional[bool]	angular = None
	)

Class decorator to create __repr__ from __rich_repr__

Definition at line 37 of file repr.py.

) -> 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 == 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

References i.

rich_repr() [1/3]

Callable[[Type[T]], Type[T]] rich_repr

(

*bool

angular = False

)

Definition at line 110 of file repr.py.

def rich_repr(*, angular: bool = False) -> Callable[[Type[T]], Type[T]]:
    ...
 
 

rich_repr() [2/3]

Type[T] rich_repr

(

Optional[Type[T]]

cls

)

Definition at line 105 of file repr.py.

def rich_repr(cls: Optional[Type[T]]) -> Type[T]:
    ...
 
 
@overload

rich_repr() [3/3]

Union[Type[T], Callable[[Type[T]], Type[T]]] rich_repr	(	Optional[Type[T]]	cls = None,
		*bool	angular = False
	)

Definition at line 114 of file repr.py.

) -> Union[Type[T], Callable[[Type[T]], Type[T]]]:
    if cls is None:
        return auto(angular=angular)
    else:
        return auto(cls)
 
 

References pip._vendor.rich.repr.auto().

Here is the call graph for this function:

Variable Documentation

angular

angular

Definition at line 144 of file repr.py.

console

console = Console()

Definition at line 135 of file repr.py.

foo

foo

Definition at line 132 of file repr.py.

Result

Result = Iterable[Union[Any, Tuple[Any], Tuple[str, Any], Tuple[str, Any, Any]]]

Definition at line 19 of file repr.py.

RichReprResult

RichReprResult = Result

Definition at line 20 of file repr.py.

T

T = TypeVar("T")

Definition at line 16 of file repr.py.

width

width

Definition at line 140 of file repr.py.