o ADi^@sdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z mZmZmZmZmZmZmZmZdd lmZdd lmZdd l mZmZmZmZzddlZWn eyedZYnwzddl Z Wn eywdZ Ynwzddl!Z!dd l"m#Z#dd l$m%Z%Wn eydZ!YnwgdZ&ej'dkZ(dZ)dZ*dEddZ+edurej,j-Z-ej,j.Z.ej,j/Z/ej0j1Z1ej0j2Z2ej0j3Z3ej0j4Z4ej0j5Z5ej0j6Z6ej7j1Z8ndZ-dZ.dZ/dZ1dZ2dZ3dZ4d Z5d!Z6d"Z8e( peduZ9e9Z:Gd#d$d$eZ;ee;ee;fZGd)d*d*eZ?eGd+d,d,Z@eGd-d.d.ZAGd/d0d0ZBeCZDdFd6d7ZEeGd8d9d9ZFeFZG dFd:d;ZHe!durSeGZIn e dur[eHZIneEZIGd4z2LogLevelColumnFormatter.__init__..rLrJ)rdr%r&keysr[rY)rOrdrYr[r(r(r)__init__)s  z LogLevelColumnFormatter.__init__rLrMrNcCsDtt|}|jdur dn|j|d}d|t||j|jdS)NrJ[])rr rdgetr*r[rY)rOrLrMlevelstyler(r(r)rP;s   z LogLevelColumnFormatter.__call__ri)rdrerYr r[rfr#rgrQ)r9r:r;rRr<rqrPr(r(r(r)rbs  rbrar exc_inforrgcCs|dt|dS)a "Pretty"-print *exc_info* to *sio* using our own plain formatter. To be passed into `ConsoleRenderer`'s ``exception_formatter`` argument. Used by default if neither Rich nor *better-exceptions* are present. .. versionadded:: 21.2.0  N)r_rrarwr(r(r)rIs rc@seZdZUdZdZded<dZded<dZd ed <d Zd ed <dZ ded<dZ d ed<dZ d ed<dZ ded<dZ d ed<dZd ed<dZded<dZded<dZded<d%d#d$Zd S)&rag A Rich traceback renderer with the given options. Pass an instance as `ConsoleRenderer`'s ``exception_formatter`` argument. See :class:`rich.traceback.Traceback` for details on the arguments. If a *width* of -1 is passed, the terminal width is used. If the width can't be determined, fall back to 80. .. versionadded:: 23.2.0 truecolorz:Literal['auto', 'standard', '256', 'truecolor', 'windows'] color_systemTbool show_localsdr" max_framesNrVthemeF word_wrap extra_linesr[ indent_guides locals_max_lengthPlocals_max_stringlocals_hide_dunderlocals_hide_sunderr(zSequence[str | ModuleType]suppressrar rwrr#rgcCsz|jdkr td\|_}|dt||j|jdtj||j |j |j |j |j |j|j|j|j|j|j|jd dS)N)rrrx)filer{r[) r}rrrrr[rrrrrr)r[shutilget_terminal_sizer_rr{printrfrom_exceptionr}rrrrrrrrrr)rOrarw_r(r(r)rPus.   zRichTracebackFormatter.__call__rar rwrr#rg)r9r:r;rRr{r<r}rrrrr[rrrrrrrPr(r(r(r)rVs"             rcCs|ddtj|dS)a  Pretty-print *exc_info* to *sio* using the *better-exceptions* package. To be passed into `ConsoleRenderer`'s ``exception_formatter`` argument. Used by default if *better-exceptions* is installed and Rich is absent. .. versionadded:: 21.2.0 rxrJN)r_joinbetter_exceptionsformat_exceptionryr(r(r)rs rc @sVeZdZdZeedddedddddf d)ddZd*ddZd+d$d%Z e d,d-d'd(Z dS).ra Render ``event_dict`` nicely aligned, possibly in colors, and ordered. If ``event_dict`` contains a true-ish ``exc_info`` key, it will be rendered *after* the log line. If Rich_ or better-exceptions_ are present, in colors and with extra context. Args: columns: A list of `Column` objects defining both the order and format of the key-value pairs in the output. If passed, most other arguments become meaningless. **Must** contain a column with ``key=''`` that defines the default formatter. .. seealso:: `columns-config` pad_event: Pad the event to this many characters. Ignored if *columns* are passed. colors: Use colors for a nicer output. `True` by default. On Windows only if Colorama_ is installed. Ignored if *columns* are passed. force_colors: Force colors even for non-tty destinations. Use this option if your logs are stored in a file that is meant to be streamed to the console. Only meaningful on Windows. Ignored if *columns* are passed. repr_native_str: When `True`, `repr` is also applied to ``str``\ s. The ``event`` key is *never* `repr` -ed. Ignored if *columns* are passed. level_styles: When present, use these styles for colors. This must be a dict from level names (strings) to terminal sequences (for example, Colorama) styles. The default can be obtained by calling `ConsoleRenderer.get_default_level_styles`. Ignored when *columns* are passed. exception_formatter: A callable to render ``exc_infos``. If Rich_ or better-exceptions_ are installed, they are used for pretty-printing by default (rich_ taking precedence). You can also manually set it to `plain_traceback`, `better_traceback`, an instance of `RichTracebackFormatter` like `rich_traceback`, or implement your own. sort_keys: Whether to sort keys when formatting. `True` by default. Ignored if *columns* are passed. event_key: The key to look for the main log message. Needed when you rename it e.g. using `structlog.processors.EventRenamer`. Ignored if *columns* are passed. timestamp_key: The key to look for timestamp of the log message. Needed when you rename it e.g. using `structlog.processors.EventRenamer`. Ignored if *columns* are passed. pad_level: Whether to pad log level with blanks to the longest amongst all level label. Requires the Colorama_ package if *colors* is `True` **on Windows**. Raises: ValueError: If there's not exactly one default column formatter. .. _Colorama: https://pypi.org/project/colorama/ .. _better-exceptions: https://pypi.org/project/better-exceptions/ .. _Rich: https://pypi.org/project/rich/ .. versionadded:: 16.0.0 .. versionadded:: 16.1.0 *colors* .. versionadded:: 17.1.0 *repr_native_str* .. versionadded:: 18.1.0 *force_colors* .. versionadded:: 18.1.0 *level_styles* .. versionchanged:: 19.2.0 Colorama now initializes lazily to avoid unwanted initializations as ``ConsoleRenderer`` is used by default. .. versionchanged:: 19.2.0 Can be pickled now. .. versionchanged:: 20.1.0 Colorama does not initialize lazily on Windows anymore because it breaks rendering. .. versionchanged:: 21.1.0 It is additionally possible to set the logger name using the ``logger_name`` key in the ``event_dict``. .. versionadded:: 21.2.0 *exception_formatter* .. versionchanged:: 21.2.0 `ConsoleRenderer` now handles the ``exc_info`` event dict key itself. Do **not** use the `structlog.processors.format_exc_info` processor together with `ConsoleRenderer` anymore! It will keep working, but you can't have customize exception formatting and a warning will be raised if you ask for it. .. versionchanged:: 21.2.0 The colors keyword now defaults to True on non-Windows systems, and either True or False in Windows depending on whether Colorama is installed. .. versionadded:: 21.3.0 *sort_keys* .. versionadded:: 22.1.0 *event_key* .. versionadded:: 23.2.0 *timestamp_key* .. versionadded:: 23.3.0 *columns* .. versionadded:: 24.2.0 *pad_level* FNTeventr5 pad_eventr"colorsr| force_colorsrepr_native_strrdrcexception_formatterr sort_keys event_keyr timestamp_keycolumnslist[Column] | None pad_levelc  sX||_||_| dur~gd+fdd } |tkr| d|tkr#| d|d ur+| d |d ur3| d |dur;| d |d krC| d| dkrK| dD] } tj| ddqMdd| D}|sdtdt|dkrntd|dj|_ dd| D|_ dS|rt rt dur|j j}ttj|ddd|rt t jd dnt t}nt}||_|dur||n|}|D] }|||j7<qtt|ddd |_||_t|j|j |j!|j"dd!|_ td|j|j#|j!t$d"d#d$}| sdnd}t%| td|j&|j!t$d%t%d&t'||j!|d't%|td|j|j!t$|d(t%d)|t%d*|g|_ dS),Nargr r#rgcsd|ddS)NzThe `z-` argument is ignored when passing `columns`.)append)rto_warnr(r)add_meaningless_arg6s z5ConsoleRenderer.__init__..add_meaningless_argrrFrrrdrrr5r stacklevelcSsg|] }|jdkr|qS)rJro.0colr(r(r) Ssz,ConsoleRenderer.__init__..z>Must pass a default column formatter (a column with `key=''`).rz*Only one default column formatter allowed.rcSsg|]}|jr|qSr(rorr(r(r)r\sz with `colors=True`colorama)whopackage)stripcSrhrirjrkr(r(r)rmrnz*ConsoleRenderer.__init__..ro)rZr[rrrs)rWrXrYrZr\r])rWrXrYrZru)rYr[)rWrXrYrZr[loggerr6)rr r#rg)(_exception_formatter _sort_keys _EVENT_WIDTH _has_colorswarningswarn ValueErrorr%rT_default_column_formatter_columns _IS_WINDOWSr __class__r9 SystemError_MISSINGformatdeinitinitr=rI_stylesget_default_level_stylescopyr-r&rp_longest_level_repr_native_strrUr7r8r,_reprr6r rSr5rb)rOrrrrrdrrrrrrrwdefaults classnamestyleslevel_to_colorrLlogger_name_formatter level_widthr(rr)rq"s        zConsoleRenderer.__init__valrr#cCs@|jdur t|St|trt|hd@rt|S|St|S)zj Determine representation of *val* depending on its type & self._repr_native_str. T>rx  r$"'r^)rrepr isinstancer set)rOrr(r(r)rs  zConsoleRenderer._reprrrname event_dictrc sdd}dd}dd}fddjDfddjr)tnD}t}|ddd |Dd|durW|d ||sR|durW|d t|}|rg ||| S|dur~j t urwt j d d d|d || S)Nstack exceptionrwcs0g|]}|jttur||jqSr()poprL_NOTHINGrTr)rrr(r)rs  z,ConsoleRenderer.__call__..csg|] }||qSr()r)rrL)rrOr(r)rsr$css|]}|r|VqdSrir()rkvr(r(r) sz+ConsoleRenderer.__call__..rxzR =============================================================================== zQRemove `format_exc_info` from your processor chain if you want pretty exceptions.rr)rrrsortedrr_rrstriprrrrrr`) rOrrrrexcrwkvsrar()rrOrr)rPs8           zConsoleRenderer.__call__rec Cs2|rtnt}|j|j|j|j|j|j|j|jdS)a Get the default styles for log levels This is intended to be used with `ConsoleRenderer`'s ``level_styles`` parameter. For example, if you are adding custom levels in your home-grown :func:`~structlog.stdlib.add_log_level` you could do:: my_styles = ConsoleRenderer.get_default_level_styles() my_styles["EVERYTHING_IS_ON_FIRE"] = my_styles["critical"] renderer = ConsoleRenderer(level_styles=my_styles) Args: colors: Whether to use colorful styles. This must match the *colors* parameter to `ConsoleRenderer`. Default: `True`. )criticalrerrorrwarninginfodebugnotset) r=rIr.r/r0r1r2r3r4)rrr(r(r)rs z(ConsoleRenderer.get_default_level_styles)rr"rr|rr|rr|rdrcrrrr|rr rr rrrr|)rrr#r )rrrr rrr#r )T)rr|r#re) r9r:r;rRrrdefault_exception_formatterrqrrP staticmethodrr(r(r(r)rs&q   'rrr method_namerrcCs(|dks |dttur|Sd|d<|S)z Set ``event_dict["exc_info"] = True`` if *method_name* is ``"exception"``. Do nothing if the name is different or ``exc_info`` is already set. rrwT)rt _SENTINEL)rrrr(r(r) set_exc_infos  r)rr r!r"r#r r)rrrr rrr#r)MrR __future__rrsysr dataclassesriortypesrtypingrrrr r r r r r_framesr processorsrrrrrr ImportErrorrrich rich.consolerrich.tracebackr__all__platformrrrr*Styler>r?rDForer@rErFrGrArBBackrCr _use_colorsr+Stylesr=rIrKrSrUrbrNrrrrrrrrrr(r(r(r)s    ,           ;8  9  `