o NEg@spdZddlZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlmZddlmZmZmZmZmZmZmZmZmZmZddlmZdedefd d Z dedefd d Z!dedefd dZ"dedefddZ#dedefddZ$Gddde%Z&GdddZ' dxdedeeeefdejfddZ(dedefdd Z)d!edefd"d#Z*d$edefd%d&Z+d'eedeefd(d)Z,d*edee-effd+d,Z.d*edeee-effd-d.Z/d'eedeefd/d0Z0d1eed2eeddfd3d4Z1d1eed5eeddfd6d7Z2d8edefd9d:Z3d1eeddfd;d<Z4deefd=d>Z5e j6fd?edeefd@dAZ7e j6fdBeedeefdCdDZ8dEedeefdFdGZ9GdHdIdIZ:GdJdKdKZ;GdLdMdMZdRedSedTe-dUe-dVedeef dWdXZ?GdYdZdZeZ@d[dd\d]d^dRed_e@d`edaee-dbe-dcedefdddeZAd[dd\d]d^dRed`edaee-dbe-dcedef dfdgZBd[dd\d]d^dRed`edaee-dbe-dcedef dhdiZCd[dd\d]d^dRed`edaee-dbe-dcedef djdkZDd\dldSedme-dbe-defdndoZEdRedee-effdpdqZFdreeeefdseddfdtduZGdefdvdwZHdS)yzShared utility functionsN)Enum) IOAnyCallableDictIterableListOptionalTextIOTypeUnion) constantsargreturncCs*t|dko|d|dko|dtjvS)z Checks if a string is quoted :param arg: the string being checked for quotes :return: True if a string is quoted r r)lenrQUOTESrrd/var/www/eduai.edurigo.com/doc_train/edurigo_ai/Puru/venv/lib/python3.10/site-packages/cmd2/utils.py is_quoted%s*rcCsd|vrd}nd}|||S)zQuote a string"'r)rquoterrr quote_string/s rcCst|sd|vr |St|S)z=Quote a string if it contains spaces and isn't already quoted )rrrrrrquote_string_if_needed9srcCst|r |dd}|S)zStrip outer quotes from a string. Applies to both single and double quotes. :param arg: string to strip outer quotes from :return: same string with potentially outer quotes stripped r r)rrrrr strip_quotesAs rvalcCs:t|tr|tdkrdS|tdkrdStd)zConverts a string to a boolean based on its value. :param val: string being converted :return: boolean value expressed in the string :raises: ValueError if the string does not contain a value corresponding to a boolean value TFz(must be True or False (case-insensitive)) isinstancestr capitalize ValueError)rrrr str_to_boolNs r$cs,eZdZdZdddeffddZZS)CompletionErrora* Raised during tab completion operations to report any sort of error you want printed. This can also be used just to display a message, even if it's not an error. For instance, ArgparseCompleter raises CompletionErrors to display tab completion hints and sets apply_style to False so hints aren't colored like error text. Example use cases - Reading a database to retrieve a tab completion data set failed - A previous command line argument that determines the data set being completed is invalid - Tab completion hints T) apply_styler&cs||_tj|i|dS)a4 Initializer for CompletionError :param apply_style: If True, then ansi.style_error will be applied to the message text when printed. Set to False in cases where the message text already has the desired style. Defaults to True. N)r&super__init__)selfr&argskwargs __class__rrr(iszCompletionError.__init__)__name__ __module__ __qualname____doc__boolr( __classcell__rrr,rr%]s r%c@sleZdZdZddddddddedededeeeegefded eed eed eed eefd dZ dS)SettablezVUsed to configure a cmd2 instance member to be settable via the set command in the CLIN) onchange_cbchoiceschoices_functionchoices_methodcompleter_functioncompleter_methodnameval_type descriptionr5r6r7r8r9r:c CsN|tkr t}ddg}||_||_||_||_||_||_||_||_ | |_ dS)aN Settable Initializer :param name: name of the instance attribute being made settable :param val_type: callable used to cast the string value from the command line into its proper type and even validate its value. Setting this to bool provides tab completion for true/false and validation using str_to_bool(). The val_type function should raise an exception if it fails. This exception will be caught and printed by Cmd.do_set(). :param description: string describing this setting :param onchange_cb: optional function or method to call when the value of this settable is altered by the set command. (e.g. onchange_cb=self.debug_changed) Cmd.do_set() passes the following 3 arguments to onchange_cb: param_name: str - name of the changed parameter old_value: Any - the value before being changed new_value: Any - the value after being changed The following optional settings provide tab completion for a parameter's values. They correspond to the same settings in argparse-based tab completion. A maximum of one of these should be provided. :param choices: iterable of accepted values :param choices_function: function that provides choices for this argument :param choices_method: cmd2-app method that provides choices for this argument (See note below) :param completer_function: tab completion function that provides choices for this argument :param completer_method: cmd2-app tab completion method that provides choices for this argument (See note below) Note: For choices_method and completer_method, do not set them to a bound method. This is because ArgparseCompleter passes the self argument explicitly to these functions. Therefore instead of passing something like self.path_complete, pass cmd2.Cmd.path_complete. truefalseN) r2r$r;r<r=r5r6r7r8r9r:) r)r;r<r=r5r6r7r8r9r:rrrr(xs( zSettable.__init__) r.r/r0r1r!rrrr r(rrrrr4vs*r4rtypename field_namesdefault_valuescCsRt||}dt|j|j_t|tjr|di|}n||}t ||j_|S)a Convenience function for defining a namedtuple with default values From: https://stackoverflow.com/questions/11351032/namedtuple-and-default-values-for-optional-keyword-arguments Examples: >>> Node = namedtuple_with_defaults('Node', 'val left right') >>> Node() Node(val=None, left=None, right=None) >>> Node = namedtuple_with_defaults('Node', 'val left right', [1, 2, 3]) >>> Node() Node(val=1, left=2, right=3) >>> Node = namedtuple_with_defaults('Node', 'val left right', {'right':7}) >>> Node() Node(val=None, left=None, right=7) >>> Node(4) Node(val=4, left=None, right=7) NNr) collections namedtupler_fields__new__ __defaults__r collections_abcMappingtuple)r@rArBT prototyperrrnamedtuple_with_defaultss   rN file_pathc Cs2ddl}tjtj|}d}z3|j|ddd }tdd|Ddkr2d }WdW|SWdW|S1s>wYW|StyOY|St yz-|j|d dd}td d|Ddkrld }Wdn 1svwYWY|SWY|StyYY|St yYY|Sww) zReturns if a file contains only ASCII or UTF-8 encoded text. :param file_path: path to the file being checked :return: True if the file is a text file, False if it is binary. rNFasciistrictencodingerrorscs|]}dVqdSr Nr.0linerrr zis_text_file..Tutf-8csrUrVrrWrrrrZr[) codecsospathabspath expanduserstripopensumOSErrorUnicodeDecodeError)rOr] expanded_pathvalid_text_filefrrr is_text_filesF        rj list_to_prunecCs&t}|D]}d||<qt|S)zRemoves duplicates from a list while preserving order of the items. :param list_to_prune: the list being pruned of duplicates :return: The pruned list N)rD OrderedDictlistkeys)rk temp_dictitemrrrremove_duplicatess  rqastrcCstd|S)zNormalize and casefold Unicode strings for saner comparisons. :param astr: input unicode string :return: a normalized and case-folded version of the input string NFC) unicodedata normalizecasefold)rrrrr norm_foldsrw list_to_sortcC t|tdS)a)Sorts a list of strings alphabetically. For example: ['a1', 'A11', 'A2', 'a22', 'a3'] To sort a list in place, don't call this method, which makes a copy. Instead, do this: my_list.sort(key=norm_fold) :param list_to_sort: the list being sorted :return: the sorted list key)sortedrwrxrrralphabetical_sort s r~ input_strcCs&zt|WStyt|YSw)z Tries to convert the passed-in string to an integer. If that fails, it converts it to lower case using norm_fold. :param input_str: string to convert :return: the string as an integer or a lower case version of the string )intr#rwrrrrtry_int_or_force_to_lower_cases    rcCsddtd|DS)a Converts a string into a list of integers and strings to support natural sorting (see natural_sort). For example: natural_keys('abc123def') -> ['abc', '123', 'def'] :param input_str: string to convert :return: list of strings and integers cSsg|]}t|qSr)r)rXsubstrrrr ,sz natural_keys..z(\d+))resplitrrrr natural_keys$srcCry)aV Sorts a list of strings case insensitively as well as numerically. For example: ['a1', 'A2', 'a3', 'A11', 'a22'] To sort a list in place, don't call this method, which makes a copy. Instead, do this: my_list.sort(key=natural_keys) :param list_to_sort: the list being sorted :return: the list sorted naturally rz)r|rr}rrr natural_sort/s rtokenstokens_to_quotecCs*t|D]\}}||vrt|||<qdS)z Quote specific tokens in a list :param tokens: token list being edited :param tokens_to_quote: the tokens, which if present in tokens, to quote N) enumerater)rritokenrrrquote_specific_tokens?s  rtokens_to_unquotecCs.t|D]\}}t|}||vr|||<qdS)z Unquote specific tokens in a list :param tokens: token list being edited :param tokens_to_unquote: the tokens, which if present in tokens, to unquote N)rr)rrrrunquoted_tokenrrrunquote_specific_tokensKs rrcCsB|rt|r|d}t|}nd}tj|}|r|||}|S)zn Wrap os.expanduser() to support expanding ~ in quoted strings :param token: the string to expand r)rrr^r_ra)r quote_charrrr expand_userXs   rcCs&t|D] \}}t||||<qdS)zc Call expand_user() on all tokens in a list of strings :param tokens: tokens to expand N)rr)rindex_rrrexpand_user_in_tokensmsrcCstjd}|s^tjdddkrgd}ngd}ddtd tjjD}t ||D],\}}tj ||}tj |r[t |tjr[tjdddkrXtj|d }|Sq/d}|S) z Used to set cmd2.Cmd.DEFAULT_EDITOR. If EDITOR env variable is set, that will be used. Otherwise the function will look for a known editor in directories specified by PATH env variable. :return: Default editor or None EDITORNwin)zcode.cmdz notepad++.exez notepad.exe) vimviemacsnanopicojoecodesublatomgeditgeanykatecSg|] }tj|s|qSrr^r_islinkrXprrrrzfind_editor..PATHr)r^environgetsysplatformgetenvrr_pathsep itertoolsproductjoinisfileaccessX_OKsplitext)editoreditorspathsr_ editor_pathrrr find_editorvs  rpatterncsfddt|DS)avReturn a list of file paths based on a glob pattern. Only files are returned, not directories, and optionally only files for which the user has a specified access to. :param pattern: file name or glob pattern :param access: file access type to verify (os.* where * is F_OK, R_OK, W_OK, or X_OK) :return: list of files matching the name or glob pattern cs(g|]}tj|rt|r|qSr)r^r_rr)rXrirrrrs(z+files_from_glob_pattern..)glob)rrrrrfiles_from_glob_patterns rpatternscCs(g}|D] }t||d}||q|S)aReturn a list of file paths based on a list of glob patterns. Only files are returned, not directories, and optionally only files for which the user has a specified access to. :param patterns: list of file names and/or glob patterns :param access: file access type to verify (os.* where * is F_OK, R_OK, W_OK, or X_OK) :return: list of files matching the names and/or glob patterns r)rextend)rrfilesrmatchesrrrfiles_from_glob_patternss    r starts_withc Csddg}|D] }||vrgSqddtdtjjD}t}|D] }tj||}t|dtjd}|D] }| tj |q9q%t |S)zReturns names of executables in a user's path :param starts_with: what the exes should start with. leave blank for all exes in path. :return: a list of matching exe names *?cSrrrrrrrrrz$get_exes_in_path..rr) r^rrr_rsetrrraddbasenamerm) r wildcardswildcardrexes_setr_ full_pathrmatchrrrget_exes_in_pathsrc @seZdZdZdddddededed d fd d Zd ed d fddZd efddZd e fddZ d#de e d efddZ d e fddZd$ddZd efddZed efddZd efd!d"Zd S)%StdSimz Class to simulate behavior of sys.stdout or sys.stderr. Stores contents in internal buffer and optionally echos to the inner stream it is simulating. Fr\replace)echorSrTrrSrTrNcCs,||_||_||_||_d|_t||_dS)am StdSim Initializer :param inner_stream: the wrapped stream. Should be a TextIO or StdSim instance. :param echo: if True, then all input will be echoed to inner_stream :param encoding: codec for encoding/decoding strings (defaults to utf-8) :param errors: how to handle encoding/decoding errors (defaults to replace) FN) inner_streamrrSrT pause_storageByteBufbuffer)r)rrrSrTrrrr(s  zStdSim.__init__scCsZt|tstdt||js |jj|j|j |j d7_|j r+|j |dSdS)zSAdd str to internal bytes buffer and if echo is True, echo contents to inner streamz$write() argument must be str, not {}rRN)r r! TypeErrorformattyperrbyte_bufencoderSrTrrwrite)r)rrrrrs z StdSim.writecCs|jjj|j|jdS)z"Get the internal contents as a strrR)rrdecoderSrTr)rrrgetvalueszStdSim.getvaluecCs t|jjS)z"Get the internal contents as bytes)bytesrrrrrrgetbytess zStdSim.getbytesrsizecCsZ|dus|dkr|}||S|jjd|j|j|jd}|jj|d|j_|S)z@Read from the internal contents as a str and then clear them outNrrR)rclearrrrrSrT)r)rresultrrrreadsz StdSim.readcCs|}||S)z@Read from the internal contents as bytes and then clear them out)rr)r)rrrr readbytesszStdSim.readbytescCs|jjdS)zClear the internal contentsN)rrrrrrrrsz StdSim.clearcCs|jr|jSdS)z[StdSim only considered an interactive stream if `echo` is True and `inner_stream` is a tty.F)rrisattyrrrrrs z StdSim.isattycCs z|jjWStyYdSw)z Handle when the inner stream doesn't have a line_buffering attribute which is the case when running unit tests because pytest sets stdout to a pytest EncodedFile object. F)rline_bufferingAttributeErrorrrrrr s   zStdSim.line_bufferingrpcCs ||jvr |j|St|j|SrC)__dict__getattrr)r)rprrr __getattr__s   zStdSim.__getattr__)rrN)r.r/r0r1r2r!r(rrrrr rrrrrpropertyrrrrrrrs*     rc@s<eZdZdZddgZdeddfddZd eddfd d ZdS) rzQ Used by StdSim to write binary data and stores the actual bytes written   std_sim_instancerNcCst|_||_dSrC) bytearrayrr)r)rrrrr(&s zByteBuf.__init__bcsttstdt|jjs|j7_|jjr<|jj j |jj r>t fddtjDr@|jdSdSdSdS)zVAdd bytes to internal bytes buffer and if echo is True, echo contents to inner stream.z'a bytes-like object is required, not {}c3s|]}|vVqdSrCr)rXnewlinerrrrZ8sz ByteBuf.write..N)r rrrrrrrrrrrranyrNEWLINESflush)r)rrrrr*s z ByteBuf.write) r.r/r0r1rrr(rrrrrrrs rc@seZdZdZdejdeeefdeeefddfddZ dd d Z dd d Z dd dZ de ddfddZedeeefdeddfddZdS) ProcReaderz Used to capture stdout and stderr from a Popen process if any of those were set to subprocess.PIPE. If neither are pipes, then the process will run normally and no output will be captured. procstdoutstderrrNcCsv||_||_||_tjd|jddid|_tjd|jddid|_|jjdur,|j |jj dur9|j dSdS)z ProcReader initializer :param proc: the Popen process being read from :param stdout: the stream to write captured stdout :param stderr: the stream to write captured stderr out_thread read_stdoutT)r;targetr+FN) _proc_stdout_stderr threadingThread_reader_thread_func _out_thread _err_threadrstartr)r)rrrrrrr(As     zProcReader.__init__cCs^ddl}tjdr|j|jdSzt|jj }t ||j WdSt y.YdSw)z@Send a SIGINT to the process similar to if +C were pressedrNr) signalrr startswithr send_signalCTRL_BREAK_EVENTr^getpgidpidkillpgSIGINTProcessLookupError)r)rgroup_idrrr send_sigintYs  zProcReader.send_sigintcCs|jdS)zTerminate the processN)r terminaterrrrriszProcReader.terminatecCsb|jr |j|jr|j|j\}}|r$||j||r/||j|dSdS)zWait for the process to finishN) r is_aliverr r communicate _write_bytesrr)r)outerrrrrwaitms    zProcReader.waitrcCsx|r |jj}|j}n|jj}|j}|dusJ|jdur:|}|r1|t|| |||jdusdSdS)z Thread function that reads a stream from the process :param read_stdout: if True, then this thread deals with stdout. Otherwise it deals with stderr. N) rrrrrpollpeekrrr)r)r read_stream write_stream availablerrrr }s  zProcReader._reader_thread_funcstreamto_writecCs(z |j|WdStyYdSw)z Write bytes to a stream :param stream: the stream being written to :param to_write: the bytes being written N)rrBrokenPipeError)r&r'rrrrs  zProcReader._write_bytesr)r.r/r0r1 subprocessPopenr rr r(rrr r2r  staticmethodrrrrrrr<s    $rc@s<eZdZdZd ddZdefddZd dd Zd d d ZdS) ContextFlaga{A context manager which is also used as a boolean flag value within the default sigint handler. Its main use is as a flag to prevent the SIGINT handler in cmd2 from raising a KeyboardInterrupt while a critical code section has set the flag to True. Because signal handling is always done on the main thread, this class is not thread-safe since there is no need. rNcCs d|_dSNr_ContextFlag__countrrrrr(s zContextFlag.__init__cCs |jdkSr-r.rrrr__bool__s zContextFlag.__bool__cCs|jd7_dS)Nr r.rrrr __enter__szContextFlag.__enter__cGs$|jd8_|jdkrtddS)Nr rzcount has gone below 0)r/r#)r)r*rrr__exit__s zContextFlag.__exit__r) r.r/r0r1r(r2r0r1r2rrrrr,s   r,c @sJeZdZdZdeeeefdeeeefdee de ddf dd Z dS) RedirectionSavedStatezXCreated by each command to store information required to restore state after redirection self_stdout sys_stdoutpipe_proc_readersaved_redirectingrNcCs"d|_||_||_||_||_dS)a* RedirectionSavedState initializer :param self_stdout: saved value of Cmd.stdout :param sys_stdout: saved value of sys.stdout :param pipe_proc_reader: saved value of Cmd._cur_pipe_proc_reader :param saved_redirecting: saved value of Cmd._redirecting FN) redirectingsaved_self_stdoutsaved_sys_stdoutsaved_pipe_proc_readerr7)r)r4r5r6r7rrrr(s   zRedirectionSavedState.__init__) r.r/r0r1r rrr!r rr2r(rrrrr3s"r3textrYbegidxendidx match_againstcsfdd|DS)a^ Basic tab completion function that matches against a list of strings without considering line contents or cursor position. The args required by this function are defined in the header of Python's cmd.py. :param text: the string prefix we are attempting to match (all matches must begin with it) :param line: the current input line with leading whitespace removed :param begidx: the beginning index of the prefix text :param endidx: the ending index of the prefix text :param match_against: the strings being matched against :return: a list of possible tab completions csg|] }|r|qSr)r)rX cur_matchr<rrrsz"basic_complete..r)r<rYr=r>r?rrArbasic_completes rBc@seZdZdZdZdZdZdS) TextAlignmentzHorizontal text alignmentr rN)r.r/r0r1LEFTCENTERRIGHTrrrrrCs rCrF fill_charwidth tab_widthtruncate alignmentrJrKrLrMcCsdddl}ddl}ddlm}|dur|j}|dkrtd|dd|}|dd}t| |dkr:t d| |} | d krGtd |rN| } nd g} | } d } t|} d }d}|t|kr|| vrx|| |7}|t| |7}n|d7}|d7}|t|kset| D]\}}|dkr| d |rt||}| |}|d krtd t|}||krd}n||}|tjkrd}|}n|tjkr|d}||}n|}d}|| |}|| |}|||| |7}|||| |7}| s| s|r|r|j|}||j7}|r|j|}||j7}| || ||| d |7} q| S)u Align text for display within a given width. Supports characters with display widths greater than 1. ANSI style sequences do not count toward the display width. If text has line breaks, then each line is aligned independently. There are convenience wrappers around this function: align_left(), align_center(), and align_right() :param text: text to align (can contain multiple lines) :param alignment: how to align the text :param fill_char: character that fills the alignment gap. Defaults to space. (Cannot be a line breaking character) :param width: display width of the aligned text. Defaults to width of the terminal. :param tab_width: any tabs in the text will be replaced with this many spaces. if fill_char is a tab, then it will be converted to one space. :param truncate: if True, then each line will be shortened to fit within the display width. The truncated portions are replaced by a '…' character. Defaults to False. :return: aligned text :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if text or fill_char contains an unprintable character :raises: ValueError if width is less than 1 rNr ansizwidth must be at least 1 rz1Fill character must be exactly one character longrz*Fill character is an unprintable characterr z/Text to align contains an unprintable characterrD)ioshutilrrPget_terminal_sizecolumnsr#rr strip_stylerstyle_aware_wcswidth splitlinesStringIOget_styles_in_textrr truncate_linerCrErF RESET_ALLrvaluesr)r<rNrJrKrLrMrSrTrPfill_char_widthlinestext_bufaggregate_stylesfill_char_styles styled_space char_indexrrY line_width line_stylestotal_fill_widthleft_fill_widthright_fill_width left_fill right_fillrrr align_texts~                     rmcCt|tj||||dS)uo Left align text for display within a given width. Supports characters with display widths greater than 1. ANSI style sequences do not count toward the display width. If text has line breaks, then each line is aligned independently. :param text: text to left align (can contain multiple lines) :param fill_char: character that fills the alignment gap. Defaults to space. (Cannot be a line breaking character) :param width: display width of the aligned text. Defaults to width of the terminal. :param tab_width: any tabs in the text will be replaced with this many spaces. if fill_char is a tab, then it will be converted to one space. :param truncate: if True, then text will be shortened to fit within the display width. The truncated portion is replaced by a '…' character. Defaults to False. :return: left-aligned text :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if text or fill_char contains an unprintable character :raises: ValueError if width is less than 1 rI)rmrCrEr<rJrKrLrMrrr align_leftm rpcCrn)uc Center text for display within a given width. Supports characters with display widths greater than 1. ANSI style sequences do not count toward the display width. If text has line breaks, then each line is aligned independently. :param text: text to center (can contain multiple lines) :param fill_char: character that fills the alignment gap. Defaults to space. (Cannot be a line breaking character) :param width: display width of the aligned text. Defaults to width of the terminal. :param tab_width: any tabs in the text will be replaced with this many spaces. if fill_char is a tab, then it will be converted to one space. :param truncate: if True, then text will be shortened to fit within the display width. The truncated portion is replaced by a '…' character. Defaults to False. :return: centered text :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if text or fill_char contains an unprintable character :raises: ValueError if width is less than 1 rI)rmrCrFrorrr align_centerrqrrcCrn)ur Right align text for display within a given width. Supports characters with display widths greater than 1. ANSI style sequences do not count toward the display width. If text has line breaks, then each line is aligned independently. :param text: text to right align (can contain multiple lines) :param fill_char: character that fills the alignment gap. Defaults to space. (Cannot be a line breaking character) :param width: display width of the aligned text. Defaults to width of the terminal. :param tab_width: any tabs in the text will be replaced with this many spaces. if fill_char is a tab, then it will be converted to one space. :param truncate: if True, then text will be shortened to fit within the display width. The truncated portion is replaced by a '…' character. Defaults to False. :return: right-aligned text :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if text or fill_char contains an unprintable character :raises: ValueError if width is less than 1 rI)rmrCrGrorrr align_rightrqrs)rL max_widthc Csddl}ddlm}|dd|}||dkrtd|dkr%td |||kr.|St|}d }d}d}|} |s||vrY| ||t ||} | ||| 7}q<||} || } | ||krrt j } || } d }|| 7}| | |d7}|r>| d || S) u Truncate a single line to fit within a given display width. Any portion of the string that is truncated is replaced by a '…' character. Supports characters with display widths greater than 1. ANSI style sequences do not count toward the display width. If there are ANSI style sequences in the string after where truncation occurs, this function will append them to the returned string. This is done to prevent issues caused in cases like: truncate_string(fg.blue + hello + fg.reset, 3) In this case, "hello" would be truncated before fg.reset resets the color from blue. Appending the remaining style sequences makes sure the style is in the same state had the entire string been printed. align_text() relies on this behavior when preserving style over multiple lines. :param line: text to truncate :param max_width: the maximum display width the resulting string is allowed to have :param tab_width: any tabs in the text will be replaced with this many spaces :return: line that has a display width less than or equal to width :raises: ValueError if text contains an unprintable character like a newline :raises: ValueError if max_width is less than 1 rNr rOrQrrz&text contains an unprintable characterzmax_width must be at least 1FTr)rSrrPrrXr#r[rZrrpoprHORIZONTAL_ELLIPSISrr^r) rYrtrLrSrPstylesdoner total_width truncated_buf style_lenchar char_widthrrrr\sB       r\cCsXddlm}d}t} |j||}|dur |S|||<|t|7}q )a8 Return an OrderedDict containing all ANSI style sequences found in a string The structure of the dictionary is: key: index where sequences begins value: ANSI style sequence found at index in text Keys are in ascending order :param text: text to search for style sequences r rOrTN) rrPrDrl ANSI_STYLE_REsearchgrouprr)r<rPrrwrrrrr[s r[funccategorycCsVt|tr|D] }t|tj|qdSt|r"t|jtj|dSt|tj|dS)a=Categorize a function. The help command output will group the passed function under the specified category heading :param func: function or list of functions to categorize :param category: category to put it in :Example: >>> import cmd2 >>> class MyApp(cmd2.Cmd): >>> def do_echo(self, arglist): >>> self.poutput(' '.join(arglist) >>> >>> cmd2.utils.categorize(do_echo, "Text Processing") For an alternative approach to categorizing commands using a decorator, see :func:`~cmd2.decorators.with_category` N)r rsetattrrCMD_ATTR_HELP_CATEGORYinspectismethod__func__)rrrprrr categorizes  rcCst|tjr t|jSt|s"t|rr r. __objclass__)r functoolspartialget_defining_classrrr isbuiltinrrgetmror-r.r isfunction getmoduler0rrsplitr)methclsrrrr5s$         r)r)Ir1rDcollections.abcabcrIrrrrr^rr)rr rtenumrtypingrrrrrrr r r r rrr!r2rrrrr$ Exceptionr%r4rNrjrqrwr~rrrrrrrrrF_OKrrrrrrr,r3rBrCrmrprrrsr\r[rrrrrrs  0    : %        Uf&    I"