How do I pretty print the source code of functions contained in a class instance's attributes?

[bzm3r]

I would like to use rich to pretty print a Python class like so:

from dataclasses import dataclass
import inspect
from typing import Any, Callable
from rich import print as rprint
import rich.repr
from rich.syntax import Syntax


@dataclass
class MyClass:
    fs: list[Callable[..., Any]]

    def __rich_repr__(self) -> rich.repr.Result:
        for f in self.fs:
            yield (
                f.__name__,
                rprint(
                    Syntax(
                        inspect.getsource(f), lexer="python", theme="lightbulb"
                    ),
                ),
            )


def g(x: int, y: str) -> list[str]:
    return [y] * x


def h(y: str, zs: list[str]) -> str:
    return " ".join([y + z for z in zs])


my_class = MyClass([g, h])

rprint(my_class)

Which produces as output, roughly:

def g(x: int, y: str) -> list[str]:                                                                                
    return [y] * x                                                                                                 
                                                                                                                   
def h(y: str, zs: list[str]) -> str:                                                                               
    return " ".join([y + z for z in zs])                                                                           
                                                                                                                   
MyClass(g=None, h=None)

How do I get rich to pretty print the source strings of the functions within the pretty-printing for MyClass? I figured that Pretty has something to do with it, but couldn't quite get it to work.

[willmcgugan]

It's not a rich repr you need. Repr strings should be simple text. You can build a renderable that yields a Syntax object or any other builtin renderable.

Have a read though the following page in the docs:

https://rich.readthedocs.io/en/latest/protocol.html

[bzm3r]

@willmcgugan Thank you so much for the hint: Console Protocol is indeed very relevant. Do you think it should be linked to in the Pretty Printing section of the docs, under a final header of "Custom Formatting of Objects"? I would not have figured out "Console Protocol" is the right thing for me to look at just by looking at the documentation headers for various sections...

[willmcgugan]

Pretty printing typically refers the formatting a data structure, building a custom renderable is something different entirely.

In all honesty reading headers is a poor substitute for reading the docs, which would take barely 15 minutes start to finish.