Inheritance diagram for RichPipStreamHandler:

[legend]

Collaboration diagram for RichPipStreamHandler:

[legend]

Public Member Functions
None	__init__ (self, Optional[TextIO] stream, bool no_color)

None	emit (self, logging.LogRecord record)

None	handleError (self, logging.LogRecord record)

Public Member Functions inherited from RichHandler
Text	get_level_text (self, LogRecord record)

"ConsoleRenderable"	render_message (self, LogRecord record, str message)

"ConsoleRenderable"	render (self, *LogRecord record, Optional[Traceback] traceback, "ConsoleRenderable" message_renderable)

Static Public Attributes
list	KEYWORDS = []

Static Public Attributes inherited from RichHandler
list	KEYWORDS

ClassVar	HIGHLIGHTER_CLASS = ReprHighlighter

Additional Inherited Members
Data Fields inherited from RichHandler
	console

	highlighter

	enable_link_path

	markup

	rich_tracebacks

	tracebacks_width

	tracebacks_extra_lines

	tracebacks_theme

	tracebacks_word_wrap

	tracebacks_show_locals

	tracebacks_suppress

	locals_max_length

	locals_max_string

	keywords

Protected Attributes inherited from RichHandler
	_log_render

Detailed Description

Definition at line 140 of file logging.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		Optional[TextIO]	stream,
		bool	no_color
	)

Reimplemented from RichHandler.

Definition at line 143 of file logging.py.

    def __init__(self, stream: Optional[TextIO], no_color: bool) -> None:
        super().__init__(
            console=Console(file=stream, no_color=no_color, soft_wrap=True),
            show_time=False,
            show_level=False,
            show_path=False,
            highlighter=NullHighlighter(),
        )
 

References RichPipStreamHandler.__init__(), and i.

Referenced by RichPipStreamHandler.__init__(), and Protocol.__init_subclass__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ emit()

None emit	(		self,
		logging.LogRecord	record
	)

Invoked by logging.

Reimplemented from RichHandler.

Definition at line 153 of file logging.py.

    def emit(self, record: logging.LogRecord) -> None:
        style: Optional[Style] = None
 
        # If we are given a diagnostic error to present, present it with indentation.
        assert isinstance(record.args, tuple)
        if record.msg == "[present-rich] %s" and len(record.args) == 1:
            rich_renderable = record.args[0]
            assert isinstance(
                rich_renderable, (ConsoleRenderable, RichCast, str)
            ), f"{rich_renderable} is not rich-console-renderable"
 
            renderable: RenderableType = IndentedRenderable(
                rich_renderable, indent=get_indentation()
            )
        else:
            message = self.format(record)
            renderable = self.render_message(record, message)
            if record.levelno is not None:
                if record.levelno >= logging.ERROR:
                    style = Style(color="red")
                elif record.levelno >= logging.WARNING:
                    style = Style(color="yellow")
 
        try:
            self.console.print(renderable, overflow="ignore", crop=False, style=style)
        except Exception:
            self.handleError(record)
 

References ThemeContext.console, ScreenContext.console, Live.console, RichHandler.console, Progress.console(), PromptBase.console, Status.console(), IndentingFormatter.format(), Formatter.format(), ImageFormatter.format(), NullFormatter.format(), RawTokenFormatter.format(), TestcaseFormatter.format(), TerminalFormatter.format(), Terminal256Formatter.format(), pip._internal.utils.logging.get_indentation(), RichPipStreamHandler.handleError(), i, and RichHandler.render_message().

Here is the call graph for this function:

◆ handleError()

None handleError	(		self,
		logging.LogRecord	record
	)

Called when logging is unable to log some output.

Definition at line 181 of file logging.py.

    def handleError(self, record: logging.LogRecord) -> None:
        """Called when logging is unable to log some output."""
 
        exc_class, exc = sys.exc_info()[:2]
        # If a broken pipe occurred while calling write() or flush() on the
        # stdout stream in logging's Handler.emit(), then raise our special
        # exception so we can handle it in main() instead of logging the
        # broken pipe error and continuing.
        if (
            exc_class
            and exc
            and self.console.file is sys.stdout
            and _is_broken_pipe_error(exc_class, exc)
        ):
            raise BrokenStdoutLoggingError()
 
        return super().handleError(record)
 
 