rN0dZdZddlZddlZddlmZddlmZGddZGdd Z Gd d eZ Gd d e Z GddZ Gdde eZ Gdde e ZGddZGddeZGddeZGddeZGddeZGddeZGd d!eZGd"d#eZGd$d%eZGd&d'eZGd(d)eZGd*d+eZd,d-ej8d.fd/Zd0Zy)1a A finite state machine specialized for regular-expression-based text filters, this module defines the following classes: - `StateMachine`, a state machine - `State`, a state superclass - `StateMachineWS`, a whitespace-sensitive version of `StateMachine` - `StateWS`, a state superclass for use with `StateMachineWS` - `SearchStateMachine`, uses `re.search()` instead of `re.match()` - `SearchStateMachineWS`, uses `re.search()` instead of `re.match()` - `ViewList`, extends standard Python lists. - `StringList`, string-specific ViewList. Exception classes: - `StateMachineError` - `UnknownStateError` - `DuplicateStateError` - `UnknownTransitionError` - `DuplicateTransitionError` - `TransitionPatternNotFound` - `TransitionMethodNotFound` - `UnexpectedIndentationError` - `TransitionCorrection`: Raised to switch to another transition. - `StateCorrection`: Raised to switch to another state & transition. Functions: - `string2lines()`: split a multi-line string into a list of one-line strings How To Use This Module ====================== (See the individual classes, methods, and attributes for details.) 1. Import it: ``import statemachine`` or ``from statemachine import ...``. You will also need to ``import re``. 2. Derive a subclass of `State` (or `StateWS`) for each state in your state machine:: class MyState(statemachine.State): Within the state's class definition: a) Include a pattern for each transition, in `State.patterns`:: patterns = {'atransition': r'pattern', ...} b) Include a list of initial transitions to be set up automatically, in `State.initial_transitions`:: initial_transitions = ['atransition', ...] c) Define a method for each transition, with the same name as the transition pattern:: def atransition(self, match, context, next_state): # do something result = [...] # a list return context, next_state, result # context, next_state may be altered Transition methods may raise an `EOFError` to cut processing short. d) You may wish to override the `State.bof()` and/or `State.eof()` implicit transition methods, which handle the beginning- and end-of-file. e) In order to handle nested processing, you may wish to override the attributes `State.nested_sm` and/or `State.nested_sm_kwargs`. If you are using `StateWS` as a base class, in order to handle nested indented blocks, you may wish to: - override the attributes `StateWS.indent_sm`, `StateWS.indent_sm_kwargs`, `StateWS.known_indent_sm`, and/or `StateWS.known_indent_sm_kwargs`; - override the `StateWS.blank()` method; and/or - override or extend the `StateWS.indent()`, `StateWS.known_indent()`, and/or `StateWS.firstknown_indent()` methods. 3. Create a state machine object:: sm = StateMachine(state_classes=[MyState, ...], initial_state='MyState') 4. Obtain the input text, which needs to be converted into a tab-free list of one-line strings. For example, to read text from a file called 'inputfile':: with open('inputfile', encoding='utf-8') as fp: input_string = fp.read() input_lines = statemachine.string2lines(input_string) 5. Run the state machine on the input text and collect the results, a list:: results = sm.run(input_lines) 6. Remove any lingering circular references:: sm.unlink() restructuredtextN)east_asian_width)utilsceZdZdZddZdZ ddZddZddZdZ d Z d Z dd Z d Z d ZdZdZddZdZddZddZdZdZdZdZdZdZdZy) StateMachinea A finite state machine for text filters using regular expressions. The input is provided in the form of a list of one-line strings (no newlines). States are subclasses of the `State` class. Transitions consist of regular expression patterns and transition methods, and are defined in each state. The state machine is started with the `run()` method, which returns the results of processing in a list. cd|_ d|_ d|_ d|_ ||_ ||_ ||_ i|_ |j|g|_ y)a+ Initialize a `StateMachine` object; add state objects. Parameters: - `state_classes`: a list of `State` (sub)classes. - `initial_state`: a string, the class name of the initial state. - `debug`: a boolean; produce verbose output if true (nonzero). Nr) input_lines input_offsetline line_offsetdebug initial_state current_statestates add_states observers)self state_classesrrs :/usr/lib/python3.12/site-packages/docutils/statemachine.py__init__zStateMachine.__init__su  #J !M $*C*C 4  & *cp|jjD]}|jd|_yz9Remove circular references to objects no longer required.N)rvaluesunlinkrstates rrzStateMachine.unlinks)[['')E LLN* rNc|jt|tr||_nt|||_||_d|_|xs |j |_|jrDtd|j ddj|jtjd}g}|j} |jrtdtj|j|\}} |j|  |j!|jrV|jj#|j \} } td | d | d|j$tj|j'|||\}} } |j|  d}|j| }#t($rd|jr2td |j*j,ztj|j/|} |j| Yn wxYw#t0$rp} |j3| j4d f}|jr9td |j*j,d|d dtjYd} ~ d} ~ wt6$r} |j3| j4d } t9| j4dk(rd}n| j4df}|jr%td| d|d dtjYd} ~ d} ~ wwxYwn"#|jr|j;xYwg|_|S)a Run the state machine on `input_lines`. Return results (a list). Reset `self.line_offset` and `self.current_state`. Run the beginning-of-file transition. Input one line at a time and check for a matching transition. If a match is found, call the transition method and possibly change the state. Store the context returned by the transition method to be passed on to the next transition matched. Accumulate the results returned by the transition methods in a list. Run the end-of-file transition. Finally, return the accumulated results. Parameters: - `input_lines`: a list of strings without newlines, or `StringList`. - `input_offset`: the line offset of `input_lines` from the beginning of the file. - `context`: application-specific storage. - `input_source`: name or path of source of `input_lines`. - `initial_state`: name of initial state. )sourcer z, StateMachine.run: input_lines (line_offset=z): | z | fileNz! StateMachine.run: bof transitionz StateMachine.run: line (source=z , offset=z$ StateMachine.run: %s.eof transitionrz2 StateMachine.run: TransitionCorrection to state "z", transition .z- StateMachine.run: StateCorrection to state ") runtime_init isinstance StringListr r r rrrprintjoinsysstderr get_statebofextend next_lineinfor check_lineEOFError __class____name__eofTransitionCorrection previous_lineargsStateCorrectionlenerrorr)rr r context input_sourcer transitionsresultsrresultr offset next_state exceptions rrunzStateMachine.runs.  k: .*D )+lKD (*@d.@.@ :: %%v{{43C3C'DFzz #  4 zz:L#ii0OGV NN6 ")'/(::-1-=-=-B-B $ 0 0.2NFF!%--3JizJ''+yyk#39<E7;oo#UK793V v.,#'Kz2W$::!"I$)OO$<$<#=CF::O!&7!3v. ,&&(#,>>!#4"6Kzz((-(@(@'AB,,7N+;1>$'::/& /&&(!*!2J9>>*a/&* '0~~a'8&: zz"",^KN;K1N#&::/ /4 zz sqA L;B GH1-L;A)H.*H1+L;-H..H11 L7:A%J%L;% L71A;L2,L;2L77L;;Mc <|r_|jrL||jk7r=td|jd|d|jdtj ||_ |j |jS#t$rt|jwxYw)z Return current state object; set it first if `next_state` given. Parameter `next_state`: a string, the name of the next state. Exception: `UnknownStateError` raised if `next_state` unknown. z. StateMachine.get_state: Changing state from "z" to "z" (input line z).r!) rrr(abs_line_numberr*r+rKeyErrorUnknownStateError)rrBs rr,zStateMachine.get_states zzjD,>,>>++Z--/18;zzC",D  8;;t112 2 8#D$6$67 7 8s #A<<Bc |xj|z c_|j|j|_|j|j S#t$rd|_twxYw#|j wxYw)z9Load `self.line` with the `n`'th next line and return it.N)r r r IndexErrorr2notify_observersrns rr/zStateMachine.next_line&sv $   A%  ,,T-=-=> 99  ! ! #       ! ! #s3A A,A))A,,A>cx |j|jdzj S#t$rYywxYw)z6Return True if the next line is blank or non-existent.r$)r r striprJrs ris_next_line_blankzStateMachine.is_next_line_blank3sA ''(8(81(<=CCEE E  s *- 99cL|jt|jdz k\S)z0Return 1 if the input is at or past end-of-file.r$)r r:r rPs rat_eofzStateMachine.at_eof:s#3t'7'7#81#<<s1$$rc|xj|zc_|jdkrd|_n|j|j|_|j|jS)z=Load `self.line` with the `n`'th previous line and return it.rN)r r r rKrLs rr7zStateMachine.previous_lineBsV A   a DI(()9)9:DI yyrc ||jz |_|j|j|_|j|j S#t$rd|_t wxYw#|j wxYw)z?Jump to absolute line offset `line_offset`, load and return it.N)r r r r rJr2rKrr s r goto_linezStateMachine.goto_lineLsx $ #.1B1B#B  ,,T-=-=> 99  ! ! #       ! ! #s2A A+A((A++A=cR|jj||jz S)z%%Fd///!3F &!--226:NC!mGG| $33FT=N=N4NOLC! # # &%LCG|  &s#A 1B= BBc8|jj|jdzdd|zt||jj|jdzdd|zd|jj|jdzt ||y)Nr$zinternal padding after )r rAzinternal padding before r )r insertr r:r')rr r s r insert_inputzStateMachine.insert_inputs  0 01 4b'@'G'*;'7  9  0 01 4b'A&'H')  +  0 01 4 *; ? Arc  |jj|j|}|jt |dz |S#t $r2}|j d}|jt |dz d}~wwxYw) Return a contiguous block of text. If `flush_left` is true, raise `UnexpectedIndentationError` if an indented line is encountered before the text block ends (with a blank line). r$rN)r get_text_blockr r/r:UnexpectedIndentationErrorr8)r flush_leftblockerrs rrozStateMachine.get_text_blocksv $$33D4D4D4>@E NN3u:> *L) HHQKE NN3u:> *  sAA B-A==BcL| |j}|jr6td|jjd|dt j |D]}|j|\}}}|j|j}|s4|jr6td|d|jjdt j ||||cS|jr2td|jjzt j |j||S) a Examine one line of input for a transition match & execute its method. Parameters: - `context`: application-dependent storage. - `state`: a `State` object, the current state. - `transitions`: an optional ordered list of transition names to try, instead of ``state.transition_order``. Return the values returned by the transition method: - context: possibly modified from the parameter `context`; - next state name (`State` subclass name); - the result output of the transition, a list. When there is no match, ``state.no_match()`` is called and its return value is returned. z! StateMachine.check_line: state="z", transitions=r#r!z. StateMachine.check_line: Matched transition "z " in state "z".z1 StateMachine.check_line: No match in state "%s".) transition_orderrr(r3r4r*r+r>matchr no_match) rr<rr>namepatternmethodrBrvs rr1zStateMachine.check_lines(  00K :: __--{>';7 7rc|j}||jvr t||||j|j|<y)z Initialize & add a `state_class` (`State` subclass) object. Exception: `DuplicateStateError` raised if `state_class` was already added. N)r4rDuplicateStateErrorr)r state_class statenames r add_statezStateMachine.add_states? ((  #%i0 0!,T4::!> Irc4|D]}|j|y)zE Add `state_classes` (a list of `State` subclasses). N)r)rrr}s rrzStateMachine.add_statess)K NN; ')rcb|jjD]}|jy)z+ Initialize `self.states`. N)rrr%rs rr%zStateMachine.runtime_inits'[['')E    *rct\}}}}}t|d|tjtd|j ztjtd|d|d|tjy)zReport error details.z: r!z input line %szmodule z, line z , function N)_exception_datar(r*r+rF)rtypevaluemoduler functions rr;zStateMachine.errors\.=.?+eVT8 $&SZZ8 o!5!5!78szzJ 64J:: rc:|jj|y)z The `observer` parameter is a function or bound method which takes two arguments, the source and offset of the current line. N)rappendrobservers rattach_observerzStateMachine.attach_observers h'rc:|jj|yN)rremovers rdetach_observerzStateMachine.detach_observers h'rc|jD]-} |jj|j}||/y#t$rd}YwxYw)Nra)rr r0r rJ)rrr0s rrKzStateMachine.notify_observerssPH $'',,T-=-=> dO ' $# $s%> A  A F)rNNNrr$)r4 __module__ __qualname____doc__rrrDr,r/rQrSrUr7rYr[r^rFrcrlror1rrr%r;rrrKrrrrus )*V 8<-1\|8( $=% $H486A$&8P ?(!((rrczeZdZdZdZ dZ dZ dZ ddZdZ dZ dZ dZ dZ d Zdd Zd Zd Zd ZdZdZy)Stateaw State superclass. Contains a list of transitions, and transition methods. Transition methods all have the same signature. They take 3 parameters: - An `re` match object. ``match.string`` contains the matched input line, ``match.start()`` gives the start index of the match, and ``match.end()`` gives the end index. - A context object, whose meaning is application-defined (initial value ``None``). It can be used to store any information required by the state machine, and the returned context is passed on to the next transition method unchanged. - The name of the next state, a string, taken from the transitions list; normally it is returned unchanged, but it may be altered by the transition method if necessary. Transition methods all return a 3-tuple: - A context object, as (potentially) modified by the transition method. - The next state name (a return value of ``None`` means no state change). - The processing result, a list, which is accumulated by the state machine. Transition methods may raise an `EOFError` to cut processing short. There are two implicit transitions, and corresponding transition methods are defined: `bof()` handles the beginning-of-file, and `eof()` handles the end-of-file. These methods have non-standard signatures and return values. `bof()` returns the initial context and results, and may be used to return a header string, or do any other processing needed. `eof()` should handle any remaining context and wrap things up; it returns the final processing result. Typical applications need only subclass `State` (or a subclass), set the `patterns` and `initial_transitions` class attributes, and provide corresponding transition methods. The default object initialization will take care of constructing the list of transitions. Ncg|_ i|_ |j||_ ||_ |j |jj |_|j*|j g|j jd|_yy)z Initialize a `State` object; make & add initial transitions. Parameters: - `statemachine`: the controlling `StateMachine` object. - `debug`: a boolean; produce verbose output if true. N)rr) rur>add_initial_transitions state_machiner nested_smr3nested_sm_kwargsr4rrrs rrzState.__init__Fs!#9  $$&*C $ >> !!//99DN  (7;~~6F6:nn6M6M%OD ! )rcy)z{ Initialize this `State` before running the state machine; called from `self.state_machine.run()`. NrrPs rr%zState.runtime_initjs rcd|_yr)rrPs rrz State.unlinkqs !rc~|jr1|j|j\}}|j||yy)z>Make and add transitions listed in `self.initial_transitions`.N)initial_transitionsmake_transitionsadd_transitionsrnamesr>s rrzState.add_initial_transitionsus>  # #!%!6!6%)%=%="? E;   4 $rc|D]*}||jvr t|||vs!t|||jdd|jj |y)a" Add a list of transitions to the start of the transition list. Parameters: - `names`: a list of transition names. - `transitions`: a mapping of names to transition tuples. Exceptions: `DuplicateTransitionError`, `UnknownTransitionError`. Nr)r>DuplicateTransitionErrorUnknownTransitionErrorruupdate)rrr>rxs rrzState.add_transitions|sbDt'''.t44;&,T22  %*bq!  ,rct||jvr t||g|jdd||j|<y)z Add a transition to the start of the transition list. Parameter `transition`: a ready-made transition 3-tuple. Exception: `DuplicateTransitionError`. Nr)r>rru)rrx transitions radd_transitionzState.add_transitionsA 4## #*40 0%)Fbq!!+rcv |j|=|jj|y#t|xYw)z^ Remove a transition by `name`. Exception: `UnknownTransitionError`. N)r>rurr)rrxs rremove_transitionzState.remove_transitions;  /  &  ! ! ( ( . /(. .s(+ 8c||jj} |j|}t|ds$t j |x}|j|< t||}|||fS#t $r&t|jjd|dwxYw#t$r%t|jjd|wxYw)a Make & return a transition tuple based on `name`. This is a convenience function to simplify transition creation. Parameters: - `name`: a string, the name of the transition pattern & method. This `State` object must have a method called '`name`', and a dictionary `self.patterns` containing a key '`name`'. - `next_state`: a string, the name of the next `State` object for this transition. A value of ``None`` (or absent) implies no state change (i.e., continue with the same state). Exceptions: `TransitionPatternNotFound`, `TransitionMethodNotFound`. rvz .patterns[]r#) r3r4patternshasattrrecompilerGTransitionPatternNotFoundgetattrAttributeErrorTransitionMethodNotFound)rrxrBryrzs rmake_transitionzState.make_transitions"  00J GmmD)G7G,02 70CC$--- =T4(F ** G+'+~~'>'>EG G G  =*!^^44d;= = =s?A+ B+/B.C cg}i}|D]a}t|tr&|j|||<|j|9|j|||d<|j|dc||fS)z Return a list of transition names and a transition mapping. Parameter `name_list`: a list, where each entry is either a transition name string, or a 1- or 2-tuple (transition name, optional next state name). r)r&strrr)r name_listrr> namestates rrzState.make_transitionss{ "I)S))-)=)=i)H I& Y',@D,@,@),L IaL) Yq\* #k!!rc |dgfS)a' Called when there is no match from `StateMachine.check_line()`. Return the same values returned by transition methods: - context: unchanged; - next state name: ``None``; - empty result list. Override in subclasses to catch this event. Nr)rr<r>s rrwzState.no_matchsb  rc |gfS)z Handle beginning-of-file. Return unchanged `context`, empty result. Override in subclasses. Parameter `context`: application-defined storage. rrr<s rr-z State.bofs{rcgS)z Handle end-of-file. Return empty result. Override in subclasses. Parameter `context`: application-defined storage. rrs rr5z State.eofs  rc ||gfS)z A "do nothing" transition method. Return unchanged `context` & `next_state`, empty result. Useful for simple state changes (actionless transitions). rrrvr<rBs rnopz State.nops B&&rrr)r4rrrrrrrrr%rrrrrrrrwr-r5rrrrrrs~%NH  I "OH "5-& , /+B"& !'rrc,eZdZdZddZddZ ddZy)StateMachineWSaq `StateMachine` subclass specialized for whitespace recognition. There are three methods provided for extracting indented text blocks: - `get_indented()`: use when the indent is unknown. - `get_known_indented()`: use when the indent is known for all lines. - `get_first_known_indented()`: use when only the first line's indent is known. cB|j}|jj|j||\}}}|r|j t |dz |r>|dj s+|j|dz }|r|dj s+||||fS)a Return a block of indented lines of text, and info. Extract an indented block where the indent is unknown for all lines. :Parameters: - `until_blank`: Stop collecting at the first blank line if true. - `strip_indent`: Strip common leading indent if true (default). :Return: - the indented block (a list of lines of text), - its indent, - its first line offset from BOF, and - whether or not it finished with a blank line. r$rr^r get_indentedr r/r:rO trim_start)r until_blank strip_indentrAindentedindent blank_finishs rrzStateMachineWS.get_indenteds %%')-)9)9)F)F \*;&&,  NN3x=1, -x{002    ! aKFx{00255rc@|j}|jj|j|||\}}}|j t |dz |r>|dj s+|j|dz }|r|dj s+|||fS)a Return an indented block and info. Extract an indented block where the indent is known for all lines. Starting with the current line, extract the entire text block with at least `indent` indentation (which must be whitespace, except for the first line). :Parameters: - `indent`: The number of indent columns/characters. - `until_blank`: Stop collecting at the first blank line if true. - `strip_indent`: Strip `indent` characters of indentation if true (default). :Return: - the indented block, - its first line offset from BOF, and - whether or not it finished with a blank line. ) block_indentr$rr)rrrrrArrs rget_known_indentedz!StateMachineWS.get_known_indented/s(%%')-)9)9)F)F \!*G*#&&, s8}q()x{002    ! aKFx{002--rcF|j}|jj|j|||\}}}|j t |dz |r@|r>|dj s+|j|dz }|r|dj s+||||fS)a Return an indented block and info. Extract an indented block where the indent is known for the first line and unknown for all other lines. :Parameters: - `indent`: The first line's indent (# of columns/characters). - `until_blank`: Stop collecting at the first blank line if true (1). - `strip_indent`: Strip `indent` characters of indentation if true (1, default). - `strip_top`: Strip blank lines from the beginning of the block. :Return: - the indented block, - its indent, - its first line offset from BOF, and - whether or not it finished with a blank line. ) first_indentr$rr)rrrr strip_toprArrs rget_first_known_indentedz'StateMachineWS.get_first_known_indentedMs,%%')-)9)9)F)F \!*G*#&&, s8}q() 8A;#4#4#6##%! 8A;#4#4#655rN)FT)FTT)r4rrrrrrrrrrrs 64.<B6rrceZdZdZdZ dZ dZ dZ ejdejddZ dZ d dZ dZ dZd Zd Zd Zy) StateWSa State superclass specialized for whitespace (blank lines & indents). Use this class with `StateMachineWS`. The transitions 'blank' (for blank lines) and 'indent' (for indented text blocks) are added automatically, before any other transitions. The transition method `blank()` handles blank lines and `indent()` handles nested indented blocks. Indented blocks trigger a new state machine to be created by `indent()` and run. The class of the state machine to be created is in `indent_sm`, and the constructor keyword arguments are in the dictionary `indent_sm_kwargs`. The methods `known_indent()` and `firstknown_indent()` are provided for indented blocks where the indent (all lines' and first line's only, respectively) is known to the transition method, along with the attributes `known_indent_sm` and `known_indent_sm_kwargs`. Neither transition method is triggered automatically. Nz *$z +)blankrctj||||j|j|_|j|j |_|j |j|_|j|j|_yy)z Initialize a `StateSM` object; extends `State.__init__()`. Check for indent state machine attributes, set defaults if not set. N)rr indent_smrindent_sm_kwargsrknown_indent_smknown_indent_sm_kwargsrs rrzStateWS.__init__sz t]E2 >> !!^^DN  ($($9$9D !    '#'>>D  & & .*.*?*?D ' /rctj||ji|_|jj|j|j |j \}}|j||y)z Add whitespace-specific transitions before those defined in subclass. Extends `State.add_initial_transitions()`. N)rrrr ws_patternsrws_initial_transitionsrrs rrzStateWS.add_initial_transitionssi %%d+ == DM T--.!22  ' '){ UK0rc(|j|||S)z9Handle blank lines. Does nothing. Override in subclasses.)rrs rrz StateWS.blanksxxw 33rc|jj\}}}}|jdd|ji|j}|j ||} ||| fS)z Handle an indented text block. Extend or override in subclasses. Recursively run the registered state machine for indented blocks (`self.indent_sm`). rr r)rrrrrrD) rrvr<rBrrr rsmr?s rrzStateWS.indentsd   , , . 6; T^^ F$** F0E0E F&& &< G++rc|jj|j\}}}|jdd|ji|j }|j ||}|||fS)a Handle a known-indent text block. Extend or override in subclasses. Recursively run the registered state machine for known-indent indented blocks (`self.known_indent_sm`). The indent is the length of the match, ``match.end()``. rrr)rrendrrrrD rrvr<rBrr rrr?s r known_indentzStateWS.known_indentsv   2 2599; ? ; !T ! !A A$($?$?A&& &< G++rc|jj|j\}}}|jdd|ji|j }|j ||}|||fS)a0 Handle an indented text block (first line's indent known). Extend or override in subclasses. Recursively run the registered state machine for known-indent indented blocks (`self.known_indent_sm`). The indent is the length of the match, ``match.end()``. rrr)rrrrrrrDrs rfirst_known_indentzStateWS.first_known_indentsv   8 8 E ; !T ! !A A$($?$?A&& &< G++rr)r4rrrrrrrrrrrrrrrrrrrrrros$IO"'BJJu-'RZZ-/K1F@ 14 , ,,rrceZdZdZdZy)_SearchOverridea Mix-in class to override `StateMachine` regular expression behavior. Changes regular expression matching, from the default `re.match()` (succeeds only if the pattern matches at the start of `self.line`) to `re.search()` (succeeds if the pattern matches anywhere in `self.line`). When subclassing a `StateMachine`, list this class **first** in the inheritance list of the class definition. c8|j|jS)z Return the result of a regular expression search. Overrides `StateMachine.match()`. Parameter `pattern`: `re` compiled regular expression. )searchr )rrys rrvz_SearchOverride.matchs~~dii((rN)r4rrrrvrrrrrs )rrceZdZdZy)SearchStateMachinez@`StateMachine` which uses `re.search()` instead of `re.match()`.Nr4rrrrrrrrsJrrceZdZdZy)SearchStateMachineWSzB`StateMachineWS` which uses `re.search()` instead of `re.match()`.NrrrrrrsLrrceZdZdZ d(dZdZdZdZdZdZ d Z d Z d Z d Z d ZdZdZdZdZdZdZdZdZeZdZdZd)dZd)dZd*dZd+dZd+dZdZdZ dZ!d Z"d!Z#d"Z$d#Z%d$Z&d%Z'd&Z(d'Z)y),ViewLista> List with extended functionality: slices of ViewList objects are child lists, linked to their parents. Changes made to a child list also affect the parent list. A child list is effectively a "view" (in the SQL sense) of the parent list. Changes to parent lists, however, do *not* affect active child lists. If a parent list is changed, any active child lists should be recreated. The start and end of the slice can be trimmed using the `trim_start()` and `trim_end()` methods, without affecting the parent list. The link between child and parent lists can be broken by calling `disconnect()` on the child list. Also, ViewList objects keep track of the source & offset of each item. This information is accessible via the `source()`, `offset()`, and `info()` methods. Ncg|_ g|_ ||_ ||_ t |t r)|jdd|_|jdd|_nE|Ct ||_|r||_n)tt|Dcgc]}||fc}|_t|jt|jk(sJdycc}w)N data mismatch) dataitemsparent parent_offsetr&rlistranger:)rinitlistr rrris rrzViewList.__init__1s F   *H h ) a(DI!*DJ  !XDI" 38X3GH3Gavqk3GH 499~TZZ0A/A0Is Cc,t|jSr)rrrPs r__str__zViewList.__str__L499~rch|jjd|jd|jdS)N(z, items=))r3r4rrrPs r__repr__zViewList.__repr__Os...))*!DII;htzzl!LLrc>|j|j|kSrr_ViewList__castrothers r__lt__zViewList.__lt__RDII E0B$BBrc>|j|j|kSrr r s r__le__zViewList.__le__SDIIU1C$CCrc>|j|j|k(Srr r s r__eq__zViewList.__eq__Trrc>|j|j|k7Srr r s r__ne__zViewList.__ne__Urrc>|j|j|kDSrr r s r__gt__zViewList.__gt__Vrrc>|j|j|k\Srr r s r__ge__zViewList.__ge__Wrrc>t|tr |jS|Sr)r&rrr s r__castzViewList.__castYs eX &:: Lrc||jvSrrritems r __contains__zViewList.__contains___styy  rc,t|jSr)r:rrPs r__len__zViewList.__len__brrc4t|trz|jdvsJd|j|j|j |j |j|j |j ||j xsdS|j|S)NNr$cannot handle slice with strider)rrr)r&slicestepr3rstartstoprrrs r __getitem__zViewList.__getitem__is a 66Y& I(I I&>>$))AGGAFF";(, 177166(B)-QWW\"K K99Q< rct|tr|jdvsJdt|ts t d|j |j |j |j|j|j|j |jt|j t|jk(sJd|jrS|j xsd|jz}|jxs t||jz}||j||yy||j |<|jr||j||jz<yy)Nr&r'z(assigning non-ViewList to ViewList slicerr) r&r(r)rrbrr*r+rr:rr)rrr!krMs r __setitem__zViewList.__setitem__rs a 66Y& I(I I&dH- JKK(, DIIaggaff %)-DJJqwwqvv &tyy>S_4 Eo E4{{WW\T%7%77VV(s4yD,>,>>#' Aa   DIIaL{{6: A 2 223rc |j|=|j|=|jr|j||jz=yy#t$r|j Jd|j|j |j=|j|j |j=|jrT|j xsd|jz}|jxs t||jz}|j||=YyYywxYw)Nr'r) rrrrrbr)r*r+r:)rrr/rMs r __delitem__zViewList.__delitem__s % !  1 {{KKD$6$6 67 %66> D#D D> !''!&&.) 177166>*{{WW\T%7%77VV(s4yD,>,>>KK!$  %sAACD D ct|trA|j|j|jz|j|jzSt d)Nrz!adding non-ViewList to a ViewListr&rr3rrrbr s r__add__zViewList.__add__sQ eX &>>$))ejj"8)-ekk)A"D D?@ @rct|trA|j|j|jz|j|jzSt d)Nr4z!adding ViewList to a non-ViewListr5r s r__radd__zViewList.__radd__sQ eX &>>%**tyy"8).tzz)A"D D?@ @rczt|tr!|xj|jz c_|Std)Nz!argument to += must be a ViewList)r&rrrbr s r__iadd__zViewList.__iadd__s3 eX & II #I ?@ @rc\|j|j|z|j|zS)Nr4)r3rrrLs r__mul__zViewList.__mul__s%~~dii!mDJJN~DDrcZ|xj|zc_|xj|zc_|Sr)rrrLs r__imul__zViewList.__imul__s! Q  a  rc^t|ts td|jr<|jj t |j |jz||j j|j |jj|jy)Nz(extending a ViewList with a non-ViewList) r&rrbrrkr:rrr.rr s rr.zViewList.extendsr%*FG G ;; KK  s499~0B0BBE J $ %++&rc0||j|y|jr>|jjt|j|j z||||jj ||jj ||fyr)r.rrkr:rrrr)rr!r rAs rrzViewList.appendsq > KK {{ ""3tyy>D4F4F#F#)63 II  T " JJ  vv. /rc|t|ts td|j|j|||j|j|||j rXt |j|zt |jz}|j j||jz|yy|jj|||jj|||f|j rZt |j|zt |jz}|j j||jz|||yy)Nz+inserting non-ViewList with no source given) r&rrbrrrr:rkr)rrr!r rAindexs rrkzViewList.inserts  >dH- MNN!YYDIIaN"jjDJJqO{{TYY!+s499~= ""54+=+=#=tD II  Q % JJ  a&&!1 2{{TYY!+s499~= ""54+=+=#=t#)63rc2|jrVt|j|zt|jz}|jj||jz|j j||jj|Sr)rr:rpoprr)rrrBs rrDz ViewList.popsf ;;^a'3tyy>9E KKOOED$6$66 7 qyy}}Qrc|t|jkDr%td|dt|jd|dkr td|jd|=|jd|=|jr|xj |z c_yy)zW Remove items from the start of the list, without touching the parent. #Size of trim too large; can't trim  items from a list of size r#rTrim size must be >= 0.N)r:rrJrrrrLs rrzViewList.trim_starts s499~ :;S^MN N U67 7 IIbqbM JJrrN ;;   ! #  rc|t|jkDr%td|dt|jd|dkr td|j| d=|j| d=y)zU Remove items from the end of the list, without touching the parent. rFrGr#rrHN)r:rrJrrLs rtrim_endzViewList.trim_endsg s499~ :;S^MN N U67 7 IIqbcN JJrsOrc,|j|}||=yr)rB)rr!rBs rrzViewList.removes 4  Krc8|jj|Sr)rcountr s rrMzViewList.countyyt$$rc8|jj|Sr)rrBr s rrBzViewList.indexrNrcz|jj|jjd|_yr)rreverserrrPs rrQzViewList.reverses)   rctt|j|jg|}|Dcgc]}|d c}|_|Dcgc]}|d c}|_d|_ycc}wcc}w)Nrr$)sortedziprrr)rr8tmpentrys rsortz ViewList.sortscSDJJ/7$7+./3%U1X3/ ,/0C5eAhC0  00s A# A(c |j|S#t$r3|t|jk(r|j|dz ddfcYSwxYw)z%Return source & offset for index `i`.r$rN)rrJr:rr,s rr0z ViewList.info sT ::a=  C N"zz!a%(+T11  s8A  A c*|j|dS)zReturn source for index `i`.rr0r,s rr zViewList.sourceyy|Arc*|j|dS)zReturn offset for index `i`.r$rZr,s rrAzViewList.offsetr[rcd|_y)z-Break link between this list and parent list.N)rrPs r disconnectzViewList.disconnects  rc#pKt|j|jD]\}\}}|||fyw)z8Return iterator yielding (source, offset, value) tuples.N)rTrr)rrr rAs rxitemszViewList.xitems s7),TYY )C %U$VV&%' '*Ds46cJ|jD]}td|zy)z=Print the list in `grep` format (`source:offset:value` lines)z%s:%d:%sN)r`r()rr s rpprintzViewList.pprint%sKKMD *t# $"r)NNNNNNr)r r)*r4rrrrrr rrrrrrr r"r$r-r0r2r6r8r:r<__rmul__r>r.rrkrDrrJrrMrBrQrWr0r rAr^r`rbrrrrrs$:>,0B6MCCCCBC ! ;" %AAEH '03"  $ %%  ( %rrcXeZdZdZdej fdZd dZ d dZd dZ dZ d Z y) r'z*A `ViewList` with string-specific methods.rch|j||Dcgc]}||d c}|j||ycc}w)z Trim `length` characters off the beginning of each item, in-place, from index `start` to `end`. No whitespace-checking is done on the trimmed text. Does not affect slice parent. Nr)rlengthr*rr s r trim_leftzStringList.trim_left/sE-1IIeC,@ B,@D!%VW ,@ B % Bs /c|}t|j}||kr\|j|}|jsn<|r/|ddk(r'|j|\}}t |||||dz|dz }||kr\|||S)rnr r$)r:rrOr0rp)rr*rqrlastr r rAs rrozStringList.get_text_block8s499~Dj99S>D::<tAw#~!%30eC&17!== 1HCDjE#rNc6|}|}|||}||dz }t|j}||kr|j|} | rF| ddk7s|<| d|jr)||kDxr!|j|dz j } nN| j} | s|r-d} n7|(t| t| z } || }n t || }|dz }||krd} |||} |!| r| jd|d| jd<|r|r| j ||du| |xsd| fS)a Extract and return a StringList of indented lines of text. Collect all lines with indentation, determine the minimum indentation, remove the minimum indentation from all indented lines (unless `strip_indent` is false), and return them. All lines up to but not including the first unindented line will be returned. :Parameters: - `start`: The index of the first line to examine. - `until_blank`: Stop collecting at the first blank line if true. - `strip_indent`: Strip common leading indent if true (default). - `block_indent`: The indent of the entire block, if known. - `first_indent`: The indent of the first line, if known. :Return: - a StringList of indented lines with minimum indent removed; - the amount of the indent; - a boolean: did the indented block finish with a blank line or EOF? Nr$rrj)r*)r:rrOlstripminrh)rr*rrrrrrrkr rstripped line_indentrrs rrzStringList.get_indentedMsa,  # (<'L  # 1HC499~Dj99S>DaC)5!%m|!4!:!:!<"%u!C(, #'(:(@(@(B$B{{}H#$L%!$i#h-7 >(F 5F 1HC+Dj.LU3  #!JJqM,-8EJJqM l OOFrs eN# (AAH L'L'^d6\d6NJ,eJ,Z)). ,  ?N K%K%\E:E:P) (0)02+25.57078 187079!299i%&%&BJJx0L,r