Ij DDdZddlZddlZddlmZddlmZddlmZm Z m Z ddl m Z m Z mZmZmZddlmZddlmZdd lmZdd lmZdd lmZmZdd lmZdd lmZddl m!Z!ddl"m#Z#ej$dZ%GddeZ&e&j'Z(defdZ)d-dee*efdzddfdZ+e)a,Gdde dZ-Gdde Z.Gdde.Z/Gd d!e.Z0Gd"d#e.Z1de2fd$Z3d%ede*fd&Z4d'ed(e2defd)Z5d*e de6e d+ffd,Z7dS).zEProvides common utilities to support Rich in cmd2-based applications.N)Mapping)Enum)IOAny TypedDict)ConsoleConsoleRenderable JustifyMethodOverflowMethodRenderableType)Padding) is_expandable) rich_cast) StyleType)ColumnTable)Text)Theme)RichHelpFormatter)DEFAULT_CMD2_STYLESz\x1b\[[0-9;]*mc6eZdZdZdZdZdZdefdZdefdZ dS) AllowStylez+Values for ``cmd2.rich_utils.ALLOW_STYLE``.AlwaysNeverTerminalreturnc*t|jS)zEReturn value instead of enum name for printing in cmd2's set command.)strvalueselfs g/home/jenkins/jenkins/workspace/simtester-sanitize/venv/lib/python3.11/site-packages/cmd2/rich_utils.py__str__zAllowStyle.__str__0s4:c*t|jS)zSReturn quoted value instead of enum description for printing in cmd2's set command.)reprr r!s r#__repr__zAllowStyle.__repr__4sDJr%N) __name__ __module__ __qualname____doc__ALWAYSNEVERTERMINALrr$r(r%r#rr)s_55 F EH #      r%rrctj}|tjt |dS)zCreate a default theme for the application. This theme combines the default styles from cmd2, rich-argparse, and Rich. T)inherit)rcopyupdaterstylesr) app_styless r#_create_default_themer7=sI %)++J'.3355666 T * * **r%r5c`i}|tj|||t|at jtjzD]!}tj|t j|<"dS)zSet the Rich theme used by cmd2. Call set_theme() with no arguments to reset to the default theme. This will clear any custom styles that were previously applied. :param styles: optional mapping of style names to styles N)r4r7r5r APP_THEMErkeys)r5r6names r# set_themer<Gs(*J+--4555&!!!j!!I"(--//)2B2G2G2I2II@@)2)9$)? &&@@r%cxeZdZUdZedzed<edzed<edzed<edzed<edzed<eed<eed <dS) RichPrintKwargsaKeyword arguments that can be passed to rich.console.Console.print() via cmd2's print methods. See Rich's Console.print() documentation for full details on these parameters. https://rich.readthedocs.io/en/stable/reference/console.html#rich.console.Console.print Note: All fields are optional (total=False). If a key is not present in the dictionary, Rich's default behavior for that argument will apply. Njustifyoverflowno_wrapwidthheightcropnew_line_start) r)r*r+r,r __annotations__r boolintr0r%r#r>r>dsT !!!!t#### D[ : $J JJJr%r>F)totalc!eZdZdZdddeedzdeddffdZd%dZ d&d ed e dzd e dzd e dzdede f fd Z ddddddddddddddddededede dzde dzdedzde dzd e dzd e dzd e dzdedzdedzde de dzde ddf fdZddddddddd d! dededede dzde dzd e dzd e dzd e dzd"e d#eddffd$ZxZS)'Cmd2BaseConsolezBase class for all cmd2 Rich consoles. This class handles the core logic for managing Rich behavior based on cmd2's global settings, such as `ALLOW_STYLE` and `APP_THEME`. NfilerMkwargsrc d|vrtdd|vrtdd|vrtdd|vrtdd }d }d }ttjkrd }d }t | }|j}nDttjkrt | }|j}nttjkrd }tj d||rd nd ||td|tj |_d S)a5Cmd2BaseConsole initializer. :param file: optional file object where the console should write to. Defaults to sys.stdout. :param kwargs: keyword arguments passed to the parent Console class. :raises TypeError: if disallowed keyword argument is passed in. color_systemz_Passing 'color_system' is not allowed. Its behavior is controlled by the 'ALLOW_STYLE' setting.force_terminalzaPassing 'force_terminal' is not allowed. Its behavior is controlled by the 'ALLOW_STYLE' setting.force_interactivezdPassing 'force_interactive' is not allowed. Its behavior is controlled by the 'ALLOW_STYLE' setting.themezcPassing 'theme' is not allowed. Its behavior is controlled by the global APP_THEME and set_theme().NFTrL truecolor)rMrPrQrRrSr0) TypeError ALLOW_STYLErr-ris_interactiver/ is_terminalr.super__init__r9 threadinglocal _thread_local)r"rMrNrQrR allow_style tmp_console __class__s r#rZzCmd2BaseConsole.__init__~se V # #}~~ ~ v % %s  & ( (v  f  u '+)- *+ + +!NK"t,,,K + :   J/ / /!t,,,K%1KK J, , ,"N (3=)/       '_..r%cd|_t)z>E >T/4@@F   2KFFI!uww!$b)FRWbb[abbbr%  TFsependstyler?r@rArhrgrfrBrCrD soft_wraprEobjectsrorprqr?r@rArBrCrDrrrEcJt|}||j_||j_| |j_ t j|||||||||| | | | | |dd|j_d|j_d|j_dS#d|j_d|j_d|j_wxYw)a7Override to support ANSI sequences and address a bug in Rich. This method calls [cmd2.rich_utils.prepare_objects_for_rendering][] on the objects being printed. This ensures that strings containing ANSI style sequences are converted to Rich Text objects, so that Rich can correctly calculate their display width. Additionally, it works around a bug in Rich where complex renderables (like Table and Rule) may not receive formatting settings passed to print(). By temporarily injecting these settings into thread-local storage, we ensure that all internal rendering calls within the print() operation respect the requested overrides. There is an issue on Rich to fix the latter: https://github.com/Textualize/rich/issues/4028 rnN)prepare_objects_for_renderingr]rhrgrfrYprint)r"rorprqr?r@rArhrgrfrBrCrDrrrErsprepared_objectsr`s r#rvzCmd2BaseConsole.printsD9'B$) $*!'0$ 0 EGGM!!##-    &(,D  $(,D  %+/D  ( ( ((,D  $(,D  %+/D  ( / / / /s &A<<&B"r rorprqr?rhrgrf log_locals _stack_offsetryrzc Ft| } ||j_||j_||j_ t j| ||||||||| dzd d|j_d|j_d|j_dS#d|j_d|j_d|j_wxYw)a2Override to support ANSI sequences and address a bug in Rich. This method calls [cmd2.rich_utils.prepare_objects_for_rendering][] on the objects being logged. This ensures that strings containing ANSI style sequences are converted to Rich Text objects, so that Rich can correctly calculate their display width. Additionally, it works around a bug in Rich where complex renderables (like Table and Rule) may not receive formatting settings passed to log(). By temporarily injecting these settings into thread-local storage, we ensure that all internal rendering calls within the log() operation respect the requested overrides. There is an issue on Rich to fix the latter: https://github.com/Textualize/rich/issues/4028 rrxN)rur]rhrgrfrYlog) r"rorprqr?rhrgrfryrzrsrwr`s r#r|zCmd2BaseConsole.logs:9'B$) $*!'0$ 0 EGGK!#%+a/    (,D  $(,D  %+/D  ( ( ((,D  $(,D  %+/D  ( / / / /s $A::&B )rN)NNN)r)r*r+r,rrrrZrdrGrrkrr r rHrvr| __classcell__r`s@r#rKrKws $:/:/:/gn:/ :/  :/:/:/:/:/:/x"&"! ccc$;ct c d{ c  c cccccc*"&(,*.#!"!% !!%$!?0?0?0?0?0 ?0 4 ?0 % ?0!4'?0?0d{?0t ?0$;?0Tz?0d ?0?0$;?0 !?0" #?0?0?0?0?0?0H"&(,!"!% 6060606060 60 4 60 % 60d{60t 60$;606060 60606060606060606060r%rKcDeZdZdZdddeedzddffdZxZS)Cmd2GeneralConsolezRich console for general-purpose printing. It enables soft wrap and disables Rich's automatic detection for markup, emoji, and highlighting. These defaults can be overridden in calls to the console's or cmd2's print methods. NrLrMrcTt|dddddS)zCmd2GeneralConsole initializer. :param file: optional file object where the console should write to. Defaults to sys.stdout. TFrMrrrgrhrfNrYrZr"rMr`s r#rZzCmd2GeneralConsole.__init__Ss?       r%r)r*r+r,rrrZr}r~s@r#rrKl26    3$  $           r%rcDeZdZdZdddeedzddffdZxZS)Cmd2RichArgparseConsolea/Rich console for rich-argparse output. Ensures long lines in help text are not truncated by disabling soft_wrap, which conflicts with rich-argparse's explicit no_wrap and overflow settings. Since this console is used to print error messages which may not be intended for Rich formatting, it disables Rich's automatic detection for markup, emoji, and highlighting. Because rich-argparse does markup and highlighting without involving the console, disabling these settings does not affect the library's internal functionality. NrLrMrcTt|dddddS)zCmd2RichArgparseConsole initializer. :param file: optional file object where the console should write to. Defaults to sys.stdout. FrNrrs r#rZz Cmd2RichArgparseConsole.__init__o?       r%rr~s@r#rrbsl  26    3$  $           r%rcDeZdZdZdddeedzddffdZxZS)Cmd2ExceptionConsolezRich console for printing exceptions and Rich Tracebacks. Ensures that output is always word-wrapped for readability and disables Rich's automatic detection for markup, emoji, and highlighting to prevent interference with raw error data. NrLrMrcTt|dddddS)zCmd2ExceptionConsole initializer. :param file: optional file object where the console should write to. Defaults to sys.stdout. FrNrrs r#rZzCmd2ExceptionConsole.__init__rr%rr~s@r#rr~rr%rc(tjS)z Return the width of the console.)rrBr0r%r# console_widthrs 99?r%rectddddt}|5}||ddddn #1swxYwY|S)avConvert a Rich Text object to a string. This function's purpose is to render a Rich Text object, including any styles (e.g., color, bold), to a plain Python string with ANSI style sequences. It differs from `text.plain`, which strips all formatting. :param text: the text object to convert :return: the resulting string with ANSI styles preserved. TrTF)rQrPrrno_colorrS)rpN)rr9capturervget)reconsolers r#rich_text_to_stringrs  G   $g d ###$$$$$$$$$$$$$$$ ;;==sAAA renderablelevelct|ttfr9tjt d}|||}tj||S)apIndent a Rich renderable. When soft-wrapping is enabled, a Rich console is unable to properly print a Padding object of indented text, as it truncates long strings instead of wrapping them. This function provides a workaround for this issue, ensuring that indented text is printed correctly regardless of the soft-wrap setting. For non-text objects, this function merely serves as a convenience wrapper around Padding.indent(). :param renderable: a Rich renderable to indent. :param level: number of characters to indent. :return: a Padding object containing the indented content. fold)r@) isinstancerrrgridradd_rowr indent)rr text_grids r#rrs_*sDk**Jvv66677 *%%% >*e , ,,r%rs.cPt|}t|D]y\}}t|}t|tst |r9t |}t|rtj |||<zt|S)aPrepare a tuple of objects for printing by Rich's Console.print(). This function processes objects to ensure they are rendered correctly by Rich. It inspects each object and, if its string representation contains ANSI style sequences, it converts the object to a Rich Text object. This ensures Rich can properly parse the non-printing codes for accurate display width calculation. Objects that already implement the Rich console protocol or are expandable by its pretty printer are left untouched, as they can be handled directly by Rich's native renderers. :param objects: objects to prepare :return: a tuple containing the processed objects. ) list enumeraterrr rrANSI_STYLE_SEQUENCE_REsearchr from_ansituple)rs object_listiobjrrenderable_as_strs r#rurusw--KK(( ? ?3s^^  j"3 4 4  j8Q8Q   OO ! ( (): ; ; ?!^,=>>KN   r%)N)8r,rer[collections.abcrenumrtypingrrr rich.consolerr r r r rich.paddingr rich.prettyr rich.protocolr rich.styler rich.tablerr rich.textr rich.themer rich_argparserr5rcompilerrr/rVr7rr<r9r>rKrrrrHrrrrrur0r%r#rsKK ###### ! %%%%%%###### ++++++'''''' $$566          "! +u++++@@gc9n-4@@@@@4 " ! # # iu&Q0Q0Q0Q0Q0gQ0Q0Q0h        .     o   8     ?   .s ds,-~-c-g----0CE#s(Or%