]j| v d Z dZddlZddlZddlmZ ddlmZ G d d Z G d d Z G d
d e Z
G d d
e Z G d d Z G d de e Z
G d de e
Z G d d Z G d de Z G d de Z G d de Z G d d e Z G d d e Z G d d!e Z G d" d#e Z G d$ d%e Z G d& d'e Z G d( d)e Z G d* d+e Zd,d- ej d. fd/Z d0 Z dS )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()
restructuredtext N)east_asian_width)utilsc e Zd ZdZd dZd Z d dZd dZd!d
Zd Z d Z
d
Z d!dZ d Z
d Zd Zd Zd dZd Zd dZd dZd Zd Zd Zd Zd Zd Zd ZdS )" 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.
Fc d| _ d| _ d| _ d| _ || _ || _ || _ i | _ | | g | _ dS )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_classesr r s u/builddir/build/BUILD/imunify360-venv-2.6.3/opt/imunify360/venv/lib/python3.11/site-packages/docutils/statemachine.py__init__zStateMachine.__init__ s # J ! M
$ *C *C 4
&&& * * c t | j D ]}| d| _ dS z9Remove circular references to objects no longer required.N)r valuesunlinkr states r r zStateMachine.unlink s9 ['')) E LLNNNN r r Nc | t |t r|| _ nt || | _ || _ d| _ |p| j | _ | j r>t d| j dd
| j t j d}g }|
} | j rt dt j | | \ }} | | | | j rK| j | j \ }
} t d
|
d | d| j t j | ||| \ }} } | | nj# t( $ r] | j r(t d |j j z t j | | } | | Y n w xY w d}n# t0 $ rf}
| |
j d
f}| j r2t d|j j d|d
dt j Y d}
~
sd}
~
wt6 $ r}
| |
j d
} t9 |
j dk rd}n|
j d f}| j r(t d| d|d
dt j Y d}
~
nd}
~
ww xY w|
| } n!# | j r| xY wg | _ |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 transitionTz
StateMachine.run: line (source=z , offset=z$
StateMachine.run: %s.eof transitionr z2
StateMachine.run: TransitionCorrection to state "z", transition . z-
StateMachine.run: StateCorrection to state ") runtime_init
isinstance
StringListr
r r
r r r printjoinsysstderr get_statebofextend next_lineinfor
check_lineEOFError __class____name__eofTransitionCorrection
previous_lineargsStateCorrectionlenerrorr )r r
r context input_sourcer transitionsresultsr resultr offset
next_state exceptions r runzStateMachine.run s* .
k: . . L *D )+l K K KD ( * @d.@ : # E%%%v{{43C'D'D'DFz
#
#
#
# 4 z
M:LLLL #ii 0 0OGV NN6 " " "+
3)'/ ((( : E-1-=-B-B $ 0.2 .2NFF ! #3-3#3 #3@F#3 #3'+y#3 #39< E E E E 7;oo #UK79 793V v.... $ : O !"I$)O$<#=CF: O O O O!&7!3!3 v...
/, #'KK+ , &&(((#,>!#4"6Kz / >(-(@ > >,7N > > > $':/ / / / HHHH&
/
/
/&&(((!* !2J9>**a//&* '0~a'8&: z / N", N N<GN N N N#&:/ / / /
/ z22W+
3$ 4 z
sq AL/ BF+ H +A#HH L/ HH L/
L#AJ>L/
LA9L
L/ LL/ / M
c |rU| j rG|| j k r<t d| j d|d| dt j || _ | j | j S # t $ r t | j w xY w)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! ) r r r( abs_line_numberr* r+ r KeyErrorUnknownStateError)r rB s r r, zStateMachine.get_state s ,z
CjD,> > > +++ZZZ --////1 8;zC C C C ",D 8;t 12 2 8 8 8#D$677 7 8s A+ + B
r$ c | xj |z
c_ | j | j | _ n # t $ r d| _ t w xY w| j | S # | w xY w)z9Load `self.line` with the `n`'th next line and return it.N)r
r
r
IndexErrorr2 notify_observersr ns r r/ zStateMachine.next_line& s $
A% ,T-= >
9 ! ! # # # #D ! ! # # # #s '+ A" A A" "A8c v | j | j dz S # t $ r Y dS w xY w)z6Return True if the next line is blank or non-existent.r$ )r
r
striprJ r s r is_next_line_blankz StateMachine.is_next_line_blank3 sN '(81(<=CCEEE E 11 s '*
88c B | j t | j dz
k S )z0Return 1 if the input is at or past end-of-file.r$ )r
r: r
rP s r at_eofzStateMachine.at_eof: s 3t'7#8#81#<<<r c | j dk S )z8Return 1 if the input is at or before beginning-of-file.r )r
rP s r at_bofzStateMachine.at_bof> s 1$$r c | xj |z c_ | j dk rd| _ n| j | j | _ | | j S )z=Load `self.line` with the `n`'th previous line and return it.r N)r
r r
rK rL s r r7 zStateMachine.previous_lineB sY A a DII ()9:DI yr c || j z
| _ | j | j | _ n # t $ r d| _ t
w xY w| j | S # | w xY w)z?Jump to absolute line offset `line_offset`, load and return it.N)r r
r
r rJ r2 rK r r
s r goto_linezStateMachine.goto_lineL s $
#.1B#B ,T-= >
9 ! ! # # # #D ! ! # # # #s &* A! A A! !A7c F | j || j z
S )z<Return source of line at absolute line offset `line_offset`.)r
r r rX s r
get_sourcezStateMachine.get_sourceY s! &&{T5F'FGGGr c | j | j z S )z;Return line offset of current line, from beginning of file.r
r rP s r abs_line_offsetz StateMachine.abs_line_offset] s $"333r c & | j | j z dz S )z5Return line number of current line (counting from 1).r$ r] rP s r rF z StateMachine.abs_line_numbera s $"33a77r c || j }n
|| j z
dz
} | j | \ }}|dz }nG# t $ r* | || j z \ }}||dz fcY S t $ r d\ }}Y nw xY w||fS )a\ Return (source, line) tuple for current or given line number.
Looks up the source and line number in the `self.input_lines`
StringList instance to count for included source files.
If the optional argument `lineno` is given, convert it from an
absolute line number to the corresponding (source, line) pair.
Nr$ NN)r
r r
r0 TypeErrorget_source_and_linerJ )r linenorA src srcoffsetsrclines r rc z StateMachine.get_source_and_linee s >%FFd //!3F & ! - 2 26 : :NC !mGG $ $ $ 33FT=N4NOOLC! # # # # & & &%LC &
G|s "< 1B /B ?B c & | j | j dz dd|z t | | j | j dz dd|z d | j | j dz t || d S )Nr$ zinternal padding after )r rA zinternal padding before r )r
insertr
r: r' )r r
r s r insert_inputzStateMachine.insert_input s 01 4b'@'G'*;'7'7 9 9 9
01 4b'A&'H') + + +
01 4 *; ? ? A A A A Ar c | j | j | }| t | dz
|S # t
$ r8}|j d }| t | dz
d}~ww xY w)
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$ r N)r
get_text_blockr
r/ r: UnexpectedIndentationErrorr8 )r
flush_leftblockerrs r ro zStateMachine.get_text_block s $33D4D4>@ @E NN3u::> * * *L) HQKE NN3u::> * * * s AA
B 3BB c ||j }| j r,t d|j j d|dt
j |D ]q}|j | \ }}}| | j }|rB| j r,t d| d|j j dt
j |||| c S r| j r(t d |j j z t
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.
Nz!
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_orderr r( r3 r4 r* r+ r> matchr no_match) r r< r r> namepatternmethodrB rv s r r1 zStateMachine.check_line s] ( 0K : N E_---{{{<BE*
N
N
N
N
8
8D*/*;D*A 'GVZMM$),,E
:: + M "M M050HM M M "z+ + + + veWj99999
: z
CJ 017:zC C C C>>';77 7r c v |j }|| j v rt | || | j | j |< dS )z
Initialize & add a `state_class` (`State` subclass) object.
Exception: `DuplicateStateError` raised if `state_class` was already
added.
N)r4 r DuplicateStateErrorr )r state_class statenames r add_statezStateMachine.add_state sG ( # #%i00 0!,T4:!>!> I r c : |D ]}| | dS )zE
Add `state_classes` (a list of `State` subclasses).
N)r )r r r} s r r zStateMachine.add_states s2 ) ( (K NN; ' ' ' ' ( (r c f | j D ]}| dS )z+
Initialize `self.states`.
N)r r r% r s r r% zStateMachine.runtime_init s@ ['')) ! !E ! !r c t \ }}}}}t |d|t j t d| z t j t d|d|d|t j dS )zReport error details.z: r! z
input line %szmodule z, line z , function N)_exception_datar( r* r+ rF )r typevaluemoduler functions r r; zStateMachine.error s .=.?.?+eVT8
$$$&SZ8888
o!5!5!7!78szJJJJ
666444J: r c : | j | dS )z
The `observer` parameter is a function or bound method which takes two
arguments, the source and offset of the current line.
N)r appendr observers r attach_observerz StateMachine.attach_observer s
h'''''r c : | j | d S N)r remover s r detach_observerz StateMachine.detach_observer s h'''''r c | j D ]:} | j | j }n# t $ r d}Y nw xY w || ;d S )Nra )r r
r0 r
rJ )r r r0 s r rK z StateMachine.notify_observers sn H
$',,T-=>>
$
$
$#
$ HdOOO s + ::F)r NNNr r$ ) r4
__module__ __qualname____doc__r r rD r, r/ rQ rS rU r7 rY r[ r^ rF rc rl ro r1 r r r% r; r r rK r r r r u s
)* )* )* )*V 8<-1\ \ \ \|8 8 8 8( $ $ $ $ = = =% % % $ $ $H H H4 4 48 8 8 6A A A $&8 &8 &8 &8P
?
?
?( ( (! ! ! ( ( (( ( ( r r c | e Zd ZdZdZ dZ dZ dZ ddZd Z d Z
d Z d Z d Z
d
Zdd Zd Zd
Zd Zd Zd ZdS )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.
NFc g | _ i | _ | || _ || _ | j | j j | _ | j | j g| j j d| _ dS dS )z
Initialize a `State` object; make & add initial transitions.
Parameters:
- `statemachine`: the controlling `StateMachine` object.
- `debug`: a boolean; produce verbose output if true.
N)r r ) ru r> add_initial_transitions
state_machiner nested_smr3 nested_sm_kwargsr4 r r r s r r zState.__init__F s !# 9
$$&&& *C
$ > ! ! / 9DN (7;~6F6:n6M%O %OD ! ! ! ) (r c dS )z{
Initialize this `State` before running the state machine; called from
`self.state_machine.run()`.
Nr rP s r r% zState.runtime_initj s
r c d| _ dS r )r rP s r r z State.unlinkq s !r c ~ | j r5| | j \ }}| || dS dS )z>Make and add transitions listed in `self.initial_transitions`.N)initial_transitionsmake_transitionsadd_transitionsr namesr> s r r z State.add_initial_transitionsu sS # 5!%!6!6%)%="? "? E; 4 4 4 4 4 5 5r c |D ]-}|| j v rt | ||vrt | .|| j dd< | j | dS )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> DuplicateTransitionErrorUnknownTransitionErrorru update)r r r> rx s r r zState.add_transitions| s{ 3 3Dt'''.t444;&&,T222 '$) bqb! ,,,,,r c d || j v rt | |g| j dd< || j |< dS )z
Add a transition to the start of the transition list.
Parameter `transition`: a ready-made transition 3-tuple.
Exception: `DuplicateTransitionError`.
Nr )r> r ru )r rx
transitions r add_transitionzState.add_transition sF 4# # #*400 0%)F bqb!!+ r c t | j |= | j | dS # t | xY w)z^
Remove a transition by `name`.
Exception: `UnknownTransitionError`.
N)r> ru r r )r rx s r remove_transitionzState.remove_transition sF / & ! ( ( . . . . . /(.. .s "& 7c x | | j j } | j | }t |d s t j | x}| j |< n-# t $ r t | j j d|d w xY w t | | }n,# t $ r t | j j d| w xY w|||fS )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`.
Nrv z
.patterns[]r# ) r3 r4 patternshasattrrecompilerG TransitionPatternNotFoundgetattrAttributeErrorTransitionMethodNotFound)r rx rB ry rz s r make_transitionzState.make_transition s " 0J GmD)G7G,,
D02
70C0CC$-- G G G+'+~'>'>'>EG G
G G = T4((FF = = =* !^ 4 4 4dd;= =
= =
**s ;A *A6:B )B4c g }i }|D ]s}t |t r.| | ||< | | E | j | ||d < | |d t||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& strr r )r name_listr r> namestates r r zState.make_transitions s " + +I)S))
+)-)=)=i)H)H I& Y'''',@D,@),L IaL) Yq\****k!!r c |dg fS )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 )r r< r> s r rw zState.no_match s b r c
|g fS )z
Handle beginning-of-file. Return unchanged `context`, empty result.
Override in subclasses.
Parameter `context`: application-defined storage.
r r r< s r r- z State.bof s {r c g S )z
Handle end-of-file. Return empty result.
Override in subclasses.
Parameter `context`: application-defined storage.
r r s r r5 z State.eof s r c ||g fS )z
A "do nothing" transition method.
Return unchanged `context` & `next_state`, empty result. Useful for
simple state changes (actionless transitions).
r r rv r< rB s r nopz State.nop s
B&&r r r )r4 r r r r r r r r r% r r r r r r r rw r- r5 r r r r r r s$ % %N H
I "O "O "O "OH
" " "5 5 5- - -& , , ,
/
/
/ + + + +B" " "& ! ! ! ' ' ' ' 'r r c . e Zd ZdZddZddZ d dZdS )
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.
FTc p | }| j | j || \ }}}|r%| t | dz
|rO|d s5| |dz
}|r|d 5||||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$ r r^ r
get_indentedr
r/ r: rO
trim_start)r until_blank strip_indentrA indentedindent blank_finishs r r zStateMachineWS.get_indented s %%'')-)9)F)F \*; *;&&, . NN3x==1, - - - x{ 0 0 2 2 ! ! ! aKF x{ 0 0 2 2 55r c n | }| j | j ||| \ }}}| t | dz
|rO|d s5| |dz
}|r|d 5|||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$ r r )r r r r rA r r s r get_known_indentedz!StateMachineWS.get_known_indented/ s ( %%'')-)9)F)F \! *G *# *#&&,
s8}}q())) x{ 0 0 2 2 ! ! ! aKF x{ 0 0 2 2 --r c t | }| j | j ||| \ }}}| t | dz
|rQ|rO|d s5| |dz
}|r|d 5||||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$ r r )r r r r strip_toprA r r s r get_first_known_indentedz'StateMachineWS.get_first_known_indentedM s , %%'')-)9)F)F \! *G *# *#&&,
s8}}q()))
8A;#4#4#6#6
##%%%!
8A;#4#4#6#6
55r N)FT)FTT)r4 r r r r r r r r r r r sc 6 6 6 64 . . . .< <A>B 6 6 6 6 6 6r r c e Zd ZdZdZ dZ dZ dZ ej d ej d dZ
dZ d
dZ d Z
d Zd
Zd Zd ZdS )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 +)blankr Fc t | || | j | j | _ | j | j | _ | j | j | _ | j | j | _ dS dS )z
Initialize a `StateSM` object; extends `State.__init__()`.
Check for indent state machine attributes, set defaults if not set.
N)r r indent_smr indent_sm_kwargsr known_indent_smknown_indent_sm_kwargsr s r r zStateWS.__init__ st t]E222 > ! !^DN ($($9D ! '#'>D & .*.*?D ' ' ' / .r c t | | j i | _ | j | j | | j \ }}| || dS )z
Add whitespace-specific transitions before those defined in subclass.
Extends `State.add_initial_transitions()`.
N)r r r r ws_patternsr ws_initial_transitionsr r s r r z StateWS.add_initial_transitions s| %%d+++ = DM
T -... ! 2 2 ' ) ){ UK00000r c 0 | ||| S )z9Handle blank lines. Does nothing. Override in subclasses.)r r s r r z
StateWS.blank s xxw
333r c | j \ }}}} | j dd| j i| 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`).
r r r )r r r r r rD )
r rv r< rB r r r
r smr? s
r r zStateWS.indent sf
,
,
.
. 6;
T^
F
F$*
F0E
F
F&& &<<
G++r c | j | \ }}} | j dd| j i| 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()``.
r r r )r r endr r r rD r rv r< rB r r
r r r? s r known_indentzStateWS.known_indent s
2
2599;;
?
? ;
!T
! A A
A$($?A A&& &<<
G++r c | j | \ }}} | j dd| j i| 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()``.
r r r )r r r r r r rD r s r first_known_indentzStateWS.first_known_indent s
8
8
E
E ;
!T
! A A
A$($?A A&& &<<
G++r r )r4 r r r r r r r r r r r r r r r r r r r r r r o s $ I O " 'BJu - - 'RZ - -/ /K 1F@ @ @ @ 1 1 1 4 4 4 , , ,
,
,
, , , , , ,r r c e Zd ZdZd ZdS )_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.
c 6 | | j S )z
Return the result of a regular expression search.
Overrides `StateMachine.match()`.
Parameter `pattern`: `re` compiled regular expression.
)searchr )r ry s r rv z_SearchOverride.match s ~~di(((r N)r4 r r r rv r r r r r s- ) ) ) ) )r r c e Zd ZdZdS )SearchStateMachinez@`StateMachine` which uses `re.search()` instead of `re.match()`.Nr4 r r r r r r r r s JJDr r c e Zd ZdZdS )SearchStateMachineWSzB`StateMachineWS` which uses `re.search()` instead of `re.match()`.Nr r r r r r s LLDr r c e Zd ZdZ d+dZd Zd Zd Zd Zd Z d Z
d
Z d Z d Z
d
Zd Zd Zd Zd Zd Zd Zd Zd ZeZd Zd Zd,dZd,dZd-d Z d.d Z d.d Z d Z d! Z d" Z!d# Z"d$ Z#d% Z$d& Z%d' Z&d( Z'd) Z(d* Z)dS )/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.
Nc g | _ g | _ || _ || _ t |t
r)|j d d | _ |j d d | _ nM|Kt
| | _ |r|| _ n-fdt t | D | _ t | j t | j k s
J d d S )Nc g | ]}|fS r r ).0ir s r
<listcomp>z%ViewList.__init__.<locals>.<listcomp>I s H H Havqk H H Hr
data mismatch) dataitemsparent
parent_offsetr& r listranger: )r initlistr r r r s ` r r zViewList.__init__1 s F
*H h ) ) I
aaa(DI! *DJJ
! XDI
I "
H H H H5X 3G3G H H H
49~~TZ 000/00000r c * t | j S r )r r rP s r __str__zViewList.__str__L 49~~ r c @ | j j d| j d| j dS )N(z, items=))r3 r4 r r rP s r __repr__zViewList.__repr__O s* .)LLDILLtzLLLLr c > | j | | k S r r _ViewList__castr others r __lt__zViewList.__lt__R DI E0B0B$B Br c > | j | | k S r r r s r __le__zViewList.__le__S DIU1C1C$C Cr c > | j | | k S r r r s r __eq__zViewList.__eq__T r r c > | j | | k S r r r s r __ne__zViewList.__ne__U r r c > | j | | k S r r r s r __gt__zViewList.__gt__V r r c > | j | | k S r r r s r __ge__zViewList.__ge__W r r c > t |t r|j S |S r )r& r r r s r __castzViewList.__castY s! eX & & : Lr c || j v S r r r items r __contains__zViewList.__contains___ s ty r c * t | j S r )r: r rP s r __len__zViewList.__len__b r r c t |t ra|j dv s
J d | | j |j |j | j |j |j | |j pd S | j | S )NNr$ cannot handle slice with strider )r r r )r& slicestepr3 r startstopr r r s r __getitem__zViewList.__getitem__i s a 6Y&&&(I&&&>>$)AGAFN";(,
1716>(B)-QW\ " K K
K 9Q< r c H t |t r|j dv s
J d t |t st d |j | j |j |j < |j | j |j |j < t | j t | j k s
J d | j
r=|j pd| j z }|j pt | | j z }|| j
||< d S d S || j |< | j
r|| j
|| j z < d S d S )Nr) r* z(assigning non-ViewList to ViewList slicer r ) r& r+ r, r rb r r- r. r r: r r )r r r$ krM s r __setitem__zViewList.__setitem__r s9 a ;6Y&&&(I&&& dH--
L JKKK(, DIagafn %)-DJqwqv~ &ty>>S__444o444{
(W\T%77V(s4yyD,>>#' AaC
(
(
DIaL{
;6: A 2 2333
;
;r c t | j |= | j |= | j r| j || j z = d S d S # t $ r |j
J d | j |j |j = | j |j |j = | j r<|j pd| j z }|j pt | | j z }| j ||= Y d S Y d S w xY w)Nr* r ) r r r r rb r, r- r. r: )r r r2 rM s r __delitem__zViewList.__delitem__ s % !
1
{
8KD$6 6777
8
8 % % %6>>#D>>> !'!&.)
1716>*{
%W\T%77V(s4yyD,>>K!$$$$
%
%
% %s '- BB76B7c t |t r1| | j |j z | j |j z S t d )Nr z!adding non-ViewList to a ViewListr& r r3 r r rb r s r __add__zViewList.__add__ s[ eX & & A>>$)ej"8)-ek)A " D D
D ?@@ @r c t |t r1| |j | j z |j | j z S t d )Nr7 z!adding ViewList to a non-ViewListr8 r s r __radd__zViewList.__radd__ s[ eX & & A>>%*ty"8).tz)A " D D
D ?@@ @r c z t |t r| xj |j z
c_ nt d | S )Nz!argument to += must be a ViewList)r& r r rb r s r __iadd__zViewList.__iadd__ s= eX & & A II #III ?@@ @ r c P | | j |z | j |z S )Nr7 )r3 r r rL s r __mul__zViewList.__mul__ s$ ~~di!mDJN~DDDr c F | xj |z c_ | xj |z c_ | S r )r r rL s r __imul__zViewList.__imul__ s% Q
a
r c B t |t st d | j r5| j t | j | j z | | j |j | j |j d S )Nz(extending a ViewList with a non-ViewList)
r& r rb r rk r: r r r. r r s r r. zViewList.extend s %** H FGG G ; K K s49~~0B BE J J J $$$
%+&&&&&r r c || | d S | j r7| j t | j | j z ||| | j | | j ||f d S r )r. r rk r: r r r r )r r$ r rA s r r zViewList.append s > KK {
3 ""3ty>>D4F#F#)63 3 3 I T " " " J vv . / / / / /r c n |t |t st d |j | j ||< |j | j ||< | j rQt
| j |z t
| j z }| j || j z | d S d S | j || | j |||f | j rSt
| j |z t
| j z }| j || j z ||| d S d S )Nz+inserting non-ViewList with no source given) r& r rb r r r r: rk r )r r r$ r rA indexs r rk zViewList.insert sF > dH--
O MNNN !YDIacN "jDJqsO{
E TY !+s49~~= ""54+=#=tDDDDD
E
E
I Q % % % J a&&!1 2 2 2{
3 TY !+s49~~= ""54+=#=t#)63 3 3 3 3
3
3r r c | j rNt | j |z t | j z }| j || j z | j | | j | S r )r r: r popr r )r r rE s r rG z ViewList.pop so ; 8^^a'3ty>>9E KOOED$6 6 7 7 7
qy}}Q r r$ c
|t | j k r(t d|dt | j d |dk rt d | j d|= | j d|= | j r| xj |z
c_ dS dS )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# r Trim size must be >= 0.N)r: r rJ r r r rL s r r zViewList.trim_start s
s49~~ *:;!!S^^^^ M N N
N
UU 677 7 IbqbM JrrN ; $ ! # $ $r c |t | j k r(t d|dt | j d |dk rt d | j | d= | j | d= dS )zU
Remove items from the end of the list, without touching the parent.
rI rJ r# r rK N)r: r rJ r rL s r trim_endzViewList.trim_end s
s49~~ *:;!!S^^^^ M N N
N
UU 677 7 IqbccN JrssOOOr c 6 | | }| |= d S r )rE )r r$ rE s r r zViewList.remove s
4 KKKr c 6 | j | S r )r countr# s r rP zViewList.count yt$$$r c 6 | j | S r )r rE r# s r rE zViewList.index rQ r c x | j | j d | _ d S r )r reverser r rP s r rT zViewList.reverse s5
r c t t | j | j g|R }d |D | _ d |D | _ d | _ d S )Nc g | ]
}|d S )r r r entrys r r z!ViewList.sort.<locals>.<listcomp> s ///%U1X///r c g | ]
}|d S r r rW s r r z!ViewList.sort.<locals>.<listcomp> s 0005eAh000r )sortedzipr r r )r r8 tmps r sortz
ViewList.sort sZ SDJ//7$777//3/// 00C000
r c | j | S # t $ r4 |t | j k r| j |dz
d dfcY S w xY w)z%Return source & offset for index `i`.r$ r N)r rJ r: r r/ s r r0 z
ViewList.info
se :a= C NN""z!a%(+T1111 s :A
A
c 8 | | d S )z Return source for index `i`.r r0 r/ s r r zViewList.source yy||A r c 8 | | d S )z Return offset for index `i`.r$ r` r/ s r rA zViewList.offset ra r c d| _ dS )z-Break link between this list and parent list.N)r rP s r
disconnectzViewList.disconnect s
r c # ^ K t | j | j D ]\ }\ }}|||fV dS )z8Return iterator yielding (source, offset, value) tuples.N)r[ r r )r r r rA s r xitemszViewList.xitems sM ),TY
)C)C ( ( %U$VV&%' ' ' ' ' ( (r c X | D ]}t d|z dS )z=Print the list in `grep` format (`source:offset:value` lines)z%s:%d:%sN)rf r( )r r s r pprintzViewList.pprint% s9 KKMM % %D *t# $ $ $ $ % %r )NNNNN)Nr )r r )*r4 r r r r r r r r r r r r r r% r' r0 r3 r5 r9 r; r= r? __rmul__rA r. r rk rG r rM r rP rE rT r] r0 r rA rd rf rh r r r r r se $ :>,0B B B B6 M M M CBBCCCCCCCCCBBBCCC ! ! ! ; ; ;"
%
%
% A A AA A A E E E H
' ' '0 0 0 03 3 3 3" $ $ $ $
% % %% % %
( ( (
% % % % %r r c P e Zd ZdZdej fdZd dZ d
dZdd Z d
Z
d Z dS )r' z*A `ViewList` with string-specific methods.r c R fd| j || D | j ||< dS )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.
c $ g | ] }|d
S r r )r r lengths r r z(StringList.trim_left.<locals>.<listcomp>5 s7 B B B$( !%VWW
B B Br Nr" )r rm r- r s ` r trim_leftzStringList.trim_left/ sN B B B B,0IeCi,@ B B B %) r Fc , |}t | j }||k ro| j | }| snM|r@|d dk r4| | \ }}t | || ||dz |dz
}||k o| || S )rn r r$ )r: r rO r0 rp )r r- rq r lastr r rA s r ro zStringList.get_text_block8 s 49~~Djj9S>D::<<
=tAw#~~!%3 0eCi &17!= = = 1HC Djj E#I r TNc z |}|}|||}||dz
}t | j }||k r| j | } | rT| d dk s |F| d| r*||k o"| j |dz
}
n_| } | s|rd}
nDn6|4t | t | z
} || }nt || }|dz
}||k d}
| || }
| |
r |
j d |d |
j d< |r|r|
||du |
|pd|
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$ r rp )r- )r: r rO lstripminrn )r r- r r r r r r rq r r stripped line_indentrr s r r zStringList.get_indentedM s , # (<'L # 1HC49~~Djj9S>D
aC ) 5!%m|m!4!:!:!<!< 6 "%u !C(, #'(:(@(@(B(B$B {{}}H
6 #$L % !$ii#h-- 7 > (FF 5 5F 1HC+ Djj. LU3Y # # !JqM,-- 8EJqM Fl F OOF<t+CO E E Efk<//r c
| || }|
t t |j D ]"}t j |j | } || }n=# t
$ r0 |t |j | t | z
z
}Y nw xY w || }n=# t
$ r0 |t |j | t | z
z
}Y nw xY w|j | || x|j |< } | r?t
t | t | z
$|r(d
cxk r|k rn n
fd|j D |_ |S )Nr c $ g | ] }|d
S r r )r r r s r r z+StringList.get_2D_block.<locals>.<listcomp> s! ???D$vww-???r ) r r: r r column_indicesrJ rstriprt rs ) r topleftbottomrightr rr r cir r s @r get_2D_blockzStringList.get_2D_block s SZ s5:''
E
EA%ejm44B
5$x
5
5
5EJqM**SWW44
5
65
6
6
6UZ]++c"gg55
6#(:a=e#<#C#C#E#E EEJqMD
E VSYYT[[]]1C1C%CDD @A . . . . . . . . .????EJ???EJ s$ A7BBB""7C C c P t t | j D ]}| j | }t |t r_g }|D ]=}| | t
| dv r| | >d | | j |< dS )zrPad all double-width characters in `self` appending `pad_char`.
For East Asian language support.
WFri N)r r: r r& r r r r) )r pad_charr r newchars r pad_double_widthzStringList.pad_double_width s
s49~~&& , ,A9Q<D$$$
, - -DJJt$$$'--55
8,,, !wws|| ! , ,r c t t | j D ]+}| j | || | j |< ,dS )z6Replace all occurrences of substring `old` with `new`.N)r r: r replace)r oldr r s r r zStringList.replace sN s49~~&& : :A 9Q<//S99DIaLL : :r r )r FTNN)T) r4 r r r r* maxsizern ro r r r r r r r r' r' + s 44&'S[ B B B B * EI59:0 :0 :0 :0x *
,
,
, : : : : :r r' c e Zd ZdS )StateMachineErrorNr4 r r r r r r r r r c e Zd ZdS )rH Nr r r r rH rH r r rH c e Zd ZdS )r| Nr r r r r| r| r r r| c e Zd ZdS )r Nr r r r r r r r r c e Zd ZdS )r Nr r r r r r r r r c e Zd ZdS )r Nr r r r r r r r r c e Zd ZdS )r Nr r r r r r r r r c e Zd ZdS )rp Nr r r r rp rp r r rp c e Zd ZdZdS )r6 z
Raise from within a transition method to switch to another transition.
Raise with one argument, the new transition name.
Nr r r r r6 r6 s r r6 c e Zd ZdZdS )r9 z
Raise from within a transition method to switch to another state.
Raise with one or two arguments: new state name, and an optional new
transition name.
Nr r r r r9 r9 s r r9 Fz[ ]c t |r| d| } fd| D S )a6
Return a list of one-line strings with tabs expanded, no newlines, and
trailing whitespace stripped.
Each tab is expanded with between 1 and `tab_width` spaces, so that the
next character's index becomes a multiple of `tab_width` (8 by default).
Parameters:
- `astring`: a multi-line string.
- `tab_width`: the number of columns between tab stops.
- `convert_whitespace`: convert form feeds and vertical tabs to spaces?
- `whitespace`: pattern object with the to-be-converted
whitespace characters (default [\v\f]).
rp c ^ g | ])}| *S r )
expandtabsrz )r s tab_widths r r z string2lines.<locals>.<listcomp> s1 K K KALL # # * * , , K K Kr )sub
splitlines)astringr convert_whitespace
whitespaces ` r string2linesr sF " / ..g.. K K K Kg6H6H6J6J K K KKr c t j \ } }}|j r|j }|j |j j }| j ||j |j |j fS )z
Return exception information:
- the exception's class name;
- the exception object;
- the name of the file containing the offending code;
- the line number of the offending code;
- the function name of the offending code.
) r* exc_infotb_nexttb_framef_coder4 co_filename tb_linenoco_name)r r tracebackcodes r r r sa !\^^D%
& %
& $D M5$"2I4G L r ) r
__docformat__r* r unicodedatar docutilsr r r r r r r r r r' Exceptionr rH r| r r r r rp r6 r9 r r r r r r <module>r so
e eN #
( ( ( ( ( ( A A A A A A A A H L' L' L' L' L' L' L' L'^d6 d6 d6 d6 d6\ d6 d6 d6NJ, J, J, J, J,e J, J, J,Z) ) ) ) ) ) ) ). ,
?N
K% K% K% K% K% K% K% K%\E: E: E: E: E: E: E: E:P ) ( ( ( ( ( ( ( 0 0 0 0 0) 0 0 0 2 2 2 2 2+ 2 2 2 5 5 5 5 5 . 5 5 5 7 7 7 7 7 0 7 7 7 8 8 8 8 8 1 8 8 8 7 7 7 7 7 0 7 7 7 9 9 9 9 9!2 9 9 9 9 i %&% &BJx 0 0L L L L, r