3
T'ícqà ã @ s¨ d Z ddlmZ dZddlZddlZddlZddlmZ ddl m
Z
ej d5krRe Z
G dd d eZG d
d d eZG d d
d
eZG dd deZG dd deZG dd deeZG dd deeZG dd deZG dd deZG dd deZG d d d eZG d d d eZG d d! d!eZ G d"d# d#eZ G d$d% d%eZ G d&d' d'eZ G d(d) d)eZ G d*d+ d+eZ!G d,d- d-eZ"d.d/ej#d0fd1d2Z$d3d4 Z%dS )6a
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'::
input_string = open('inputfile').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()
é )Úprint_functionZrestructuredtextN)Úutils)Ú ErrorOutputé c @ sà e Zd ZdZd6ddZdd Zd7d d
Zd8d d Zd9ddZdd Z dd Z
dd Z d:ddZ dd Z
dd Zd d Zd d Zd;d d!Zd"d# Zd<d$d%Zd=d&d'Zd(d) Zd*d+ Zd,d- Zd.d/ Zd0d1 Zd2d3 Zd4d5 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 C sL d| _ d| _d| _d| _|| _|| _|| _i | _| j| g | _ t
| _ 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_offsetÚlineÚ line_offsetÚdebugÚ
initial_stateÚ
current_stateÚstatesÚ
add_statesÚ observersr Ú_stderr)ÚselfÚ
state_classesr r
© r ú9/tmp/pip-build-gk9425m9/docutils/docutils/statemachine.pyÚ__init__ s
zStateMachine.__init__c C s& x| j j D ] }|j q W d| _ dS )z9Remove circular references to objects no longer required.N)r ÚvaluesÚunlink)r Ústater r r r µ s zStateMachine.unlinkr Nc C sn | j t|tr|| _nt||d| _|| _d
| _|p<| j| _| jrft d| jdj
| jf | j d d}g }| j }yÌ| jrt d| j d |j
|\}} |j| xy¬yR| j | jrè| jj| j\}
} t d|
| | jf | j d | j|||\}} } W nJ tk
rH | jr.t d |jj | j d |j|} |j| P Y n X |j| W nØ tk
r¶ }
zB| j |
jd
f}| jr¤t d |jj|d
f | j d wªW Y dd}
~
X n~ tk
r. }
z\| j |
jd
} t|
jdkrðd}n |
jd f}| jr t d | |d
f | j d W Y dd}
~
X nX d}| j | }qªW W n | jr\| j Y nX g | _ |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 z5
StateMachine.run: input_lines (line_offset=%s):
| %sz
| )ÚfileNz!
StateMachine.run: bof transitionz4
StateMachine.run: line (source=%r, offset=%r):
| %sz$
StateMachine.run: %s.eof transitionr zE
StateMachine.run: TransitionCorrection to state "%s", transition %s.z@
StateMachine.run: StateCorrection to state "%s", transition %s.r ) Ú runtime_initÚ
isinstanceÚ
StringListr r
r r r r
ÚprintÚjoinr Ú get_stateÚbofÚextendÚ next_lineÚinfor Ú
check_lineÚEOFErrorÚ __class__Ú__name__ÚeofÚTransitionCorrectionÚ
previous_lineÚargsÚStateCorrectionÚlenÚerrorr )r r r
ÚcontextZ input_sourcer Ú transitionsÚresultsr Úresultr ÚoffsetÚ
next_stateÚ exceptionr r r Úrun» sz
(zStateMachine.runc C sh |r8| j r2|| jkr2td| j|| j f | jd || _y | j| j S tk
rb t| jY nX dS )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.
zJ
StateMachine.get_state: Changing state from "%s" to "%s" (input line %s).)r N)r
r r! Úabs_line_numberr r ÚKeyErrorÚUnknownStateError)r r8 r r r r# s zStateMachine.get_stater c C sV zFy | j |7 _ | j| j | _W n tk
r@ d| _tY nX | jS | j X dS )z9Load `self.line` with the `n`'th next line and return it.N)r r r Ú
IndexErrorr) Únotify_observers)r Únr r r r& + s
zStateMachine.next_linec C s0 y| j | jd j S tk
r* dS X dS )z3Return 1 if the next line is blank or non-existant.r N)r r Ústripr> )r r r r Úis_next_line_blank8 s z StateMachine.is_next_line_blankc C s | j t| jd kS )z0Return 1 if the input is at or past end-of-file.r )r r1 r )r r r r Úat_eof? s zStateMachine.at_eofc C s
| j dkS )z8Return 1 if the input is at or before beginning-of-file.r )r )r r r r Úat_bofC s zStateMachine.at_bofc C s< | j |8 _ | j dk r d| _n| j| j | _| j | jS )z=Load `self.line` with the `n`'th previous line and return it.r N)r r r r? )r r@ r r r r. G s
zStateMachine.previous_linec C sT zDy || j | _| j| j | _W n tk
r> d| _tY nX | jS | j X dS )z?Jump to absolute line offset `line_offset`, load and return it.N)r
r r r r> r) r? )r r r r r Ú goto_lineQ s
zStateMachine.goto_linec C s | j j|| j S )z<Return source of line at absolute line offset `line_offset`.)r r r
)r r r r r Ú
get_source^ s zStateMachine.get_sourcec C s | j | j S )z;Return line offset of current line, from beginning of file.)r r
)r r r r Úabs_line_offsetb s z StateMachine.abs_line_offsetc C s | j | j d S )z5Return line number of current line (counting from 1).r )r r
)r r r r r; f s z StateMachine.abs_line_numberc C s |dkr| j }n|| j d }y | jj|\}}|d }W nJ tk
rj | j|| j \}}||d fS tk
r d\}}Y nX ||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 r' Ú TypeErrorÚget_source_and_liner> )r Úlinenor7 ÚsrcZ srcoffsetZsrcliner r r rI j s z StateMachine.get_source_and_linec C s^ | j j| jd dd| t|d | j j| jd dd| dd | j j| jd t|| d S )Nr Ú zinternal padding after )r r7 zinternal padding before é r )r Úinsertr r1 r )r r r r r r Ú insert_input
s zStateMachine.insert_inputc C sl y&| j j| j|}| jt|d |S tk
rf } z$|jd }| jt|d W Y dd}~X nX dS )zÜ
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& r1 ÚUnexpectedIndentationErrorr/ )r Ú
flush_leftÚblockÚerrr r r rP s
zStateMachine.get_text_blockc
C s¸ |dkr|j }d}| jr2td|jj|f | jd x|D ]P}|j| \}}}|j| j} | r8| jr|td||jjf | jd || ||S q8W | jr¨td|jj | jd |j ||S dS )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.
Nz5
StateMachine.check_line: state="%s", transitions=%r.)r z@
StateMachine.check_line: Matched transition "%s" in state "%s".z1
StateMachine.check_line: No match in state "%s".)
Útransition_orderr
r! r* r+ r r4 Úmatchr Úno_match)
r r3 r r4 Zstate_correctionÚnameÚpatternÚmethodr8 rV r r r r( ¡ s$
zStateMachine.check_linec C s. |j }|| jkrt||| | j| j|< dS )zª
Initialize & add a `state_class` (`State` subclass) object.
Exception: `DuplicateStateError` raised if `state_class` was already
added.
N)r+ r ÚDuplicateStateErrorr
)r Ú state_classZ statenamer r r Ú add_stateÊ s
zStateMachine.add_statec C s x|D ]}| j | qW dS )zE
Add `state_classes` (a list of `State` subclasses).
N)r] )r r r\ r r r r Ö s
zStateMachine.add_statesc C s x| j j D ] }|j q W dS )z+
Initialize `self.states`.
N)r r r )r r r r r r Ý s zStateMachine.runtime_initc C sX t \}}}}}td||f | jd td| j | jd td|||f | jd dS )zReport error details.z%s: %s)r z
input line %sz module %s, line %s, function %sN)Ú_exception_datar! r r; )r ÚtypeÚvalueÚmoduler Úfunctionr r r r2 ä s
zStateMachine.errorc C s | j 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 Úappend)r Úobserverr r r Úattach_observerì s z StateMachine.attach_observerc C s | j j| d S )N)r Úremove)r rd r r r Údetach_observeró s z StateMachine.detach_observerc C sH xB| j D ]8}y| jj| j}W n tk
r6 d}Y nX || qW d S )N)NN)r r r' r r> )r rd r' r r r r? ö s
z StateMachine.notify_observers)F)r NNN)N)r )r )N)F)N) r+ Ú
__module__Ú __qualname__Ú__doc__r r r: r# r& rB rC rD r. rE rF rG r; rI rO rP r( r] r r r2 re rg r? r r r r r x s4
/
[
) r c @ s e Zd ZdZdZdZdZdZd ddZdd Z dd Z
d
d Z d d
Z dd Z
dd Zd ddZdd Zdd Zdd Zdd Zd d ZdS ) ÚStateav
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 retured 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 C sV g | _ i | _| j || _|| _| jdkr4| jj| _| jdkrR| jg| jjd| _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 r4 Úadd_initial_transitionsÚ
state_machiner
Ú nested_smr* Únested_sm_kwargsr+ )r rm r
r r r r L s
zState.__init__c C s dS )z{
Initialize this `State` before running the state machine; called from
`self.state_machine.run()`.
Nr )r r r r r p s zState.runtime_initc C s
d| _ dS )z9Remove circular references to objects no longer required.N)rm )r r r r r w s z State.unlinkc C s& | j r"| j| j \}}| j|| dS )z>Make and add transitions listed in `self.initial_transitions`.N)Úinitial_transitionsÚmake_transitionsÚadd_transitions)r Únamesr4 r r r rl { s z State.add_initial_transitionsc C sN x.|D ]&}|| j kr t|||krt|qW || jdd
< | j 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 )r4 ÚDuplicateTransitionErrorÚUnknownTransitionErrorrU Úupdate)r rs r4 rX r r r rr s
zState.add_transitionsc C s0 || j krt||g| jdd
< || j |< dS )z¹
Add a transition to the start of the transition list.
Parameter `transition`: a ready-made transition 3-tuple.
Exception: `DuplicateTransitionError`.
Nr )r4 rt rU )r rX Z
transitionr r r Úadd_transition s
zState.add_transitionc C s2 y| j |= | jj| W n t|Y nX dS )z^
Remove a transition by `name`.
Exception: `UnknownTransitionError`.
N)r4 rU rf ru )r rX r r r Úremove_transition¢ s
zState.remove_transitionc C s¨ |dkr| j j}y,| j| }t|ds:tj| }| j|< W n( tk
rd td| j j|f Y nX yt| |}W n( t k
r t
d| j j|f Y nX |||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%s.patterns[%r]z%s.%s) r* r+ ÚpatternsÚhasattrÚreÚcompiler< ÚTransitionPatternNotFoundÚgetattrÚAttributeErrorÚTransitionMethodNotFound)r rX r8 rY rZ r r r Úmake_transition® s
zState.make_transitionc C sj t d}g }i }xP|D ]H}t||r>| j|||< |j| q| j| ||d < |j|d qW ||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).
rL r )r_ r r rc )r Ú name_listZ
stringtypers r4 Z namestater r r rq Ï s
zState.make_transitionsc C s
|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 r3 r4 r r r rW ã s zState.no_matchc C s |g fS )z±
Handle beginning-of-file. Return unchanged `context`, empty result.
Override in subclasses.
Parameter `context`: application-defined storage.
r )r r3 r r r r$ ñ s z State.bofc C s g S )z
Handle end-of-file. Return empty result.
Override in subclasses.
Parameter `context`: application-defined storage.
r )r r3 r r r r, û s z State.eofc C s
||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 r3 r8 r r r Únop s z State.nop)F)N)r+ rh ri rj ry rp rn ro r r r rl rr rw rx r rq rW r$ r, r r r r r rk ÿ s$ '
$
!
rk c @ s. e Zd ZdZd ddZd ddZd
dd Zd
S )Ú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 C sj | j }| jj| j||\}}}|r6| jt|d x&|r\|d j r\|j |d7 }q8W ||||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 )rG r Ú get_indentedr r& r1 rA Ú
trim_start)r Ú until_blankÚ strip_indentr7 ÚindentedÚindentÚ blank_finishr r r r
s zStateMachineWS.get_indentedc C sh | j }| jj| j|||d\}}}| jt|d x&|r\|d j r\|j |d7 }q8W |||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 )rG r r
r r& r1 rA r )r r r r r7 r r r r r Úget_known_indented6 s z!StateMachineWS.get_known_indentedc C sn | j }| jj| j|||d\}}}| jt|d |rbx&|r`|d j r`|j |d7 }q<W ||||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 )rG r r
r r& r1 rA r )r r r r Z strip_topr7 r r r r r Úget_first_known_indentedT s z'StateMachineWS.get_first_known_indentedN)FT)FT)FTT)r+ rh ri rj r
r r r r r r r s
r c @ sl e Zd ZdZdZdZdZdZej dej ddZ
dZ dd d
Z d d Z
d
d Zdd Zdd Zdd 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 r r Fc C sZ t j| || | jdkr | j| _| jdkr2| j| _| jdkrD| j| _| jdkrV| j| _dS )z
Initialize a `StateSM` object; extends `State.__init__()`.
Check for indent state machine attributes, set defaults if not set.
N)rk r Ú indent_smrn Úindent_sm_kwargsro Úknown_indent_smÚknown_indent_sm_kwargs)r rm r
r r r r ³ s
zStateWS.__init__c C sH t j| | jdkri | _| jj| j | j| j\}}| j|| dS )z
Add whitespace-specific transitions before those defined in subclass.
Extends `State.add_initial_transitions()`.
N)rk rl ry rv Ú ws_patternsrq Úws_initial_transitionsrr )r rs r4 r r r rl à s
z StateWS.add_initial_transitionsc C s | j |||S )z9Handle blank lines. Does nothing. Override in subclasses.)r )r rV r3 r8 r r r r Ñ s z
StateWS.blankc
C sB | j j \}}}}| jf d| ji| j}|j||d} ||| 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
)rm r
r r
r r: )
r rV r3 r8 r r r r Úsmr5 r r r r Õ s zStateWS.indentc C sF | j j|j \}}}| jf d| ji| j}|j||d}|||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
)rm r Úendr r
r r: ) r rV r3 r8 r r r r r5 r r r Ú known_indentâ s
zStateWS.known_indentc C sF | j j|j \}}}| jf d| ji| j}|j||d}|||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
)rm r r r r
r r: ) r rV r3 r8 r r r r r5 r r r Úfirst_known_indentñ s
zStateWS.first_known_indent)r r )F)r+ rh ri rj r r r r r{ r| r r r rl r r r r r r r r r v s
r c @ s e Zd ZdZdd 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 C s |j | jS )z®
Return the result of a regular expression search.
Overrides `StateMachine.match()`.
Parameter `pattern`: `re` compiled regular expression.
)Úsearchr )r rY r r r rV s z_SearchOverride.matchN)r+ rh ri rj rV r r r r r s
r c @ s e Zd ZdZdS )ÚSearchStateMachinez@`StateMachine` which uses `re.search()` instead of `re.match()`.N)r+ rh ri rj r r r r r s r c @ s e Zd ZdZdS )ÚSearchStateMachineWSzB`StateMachineWS` which uses `re.search()` instead of `re.match()`.N)r+ rh ri rj r r r r r s r c @ sP e Zd ZdZdQddZdd Zdd Zd d
Zd d Zd
d Z dd Z
dd Z dd Z dd Z
dd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* ZeZd+d, Zd-d. ZdRd0d1ZdSd2d3Z dUd5d6Z dVd7d8Z dWd9d:Z d;d< Z d=d> Z!d?d@ Z"dAdB Z#dCdD Z$dEdF Z%dGdH Z&dIdJ Z'dKdL Z(dMdN Z)dOdP Z*dS )XÚ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 s g | _ g | _|| _|| _t|trD|j d d
| _ |jd d
| _n:|d k r~t|| _ |rb|| _n fddtt|D | _t| j t| jkst dd S )Nc s g | ] } |fqS r r )Ú.0Úi)r r r ú
<listcomp>P s z%ViewList.__init__.<locals>.<listcomp>z
data mismatch)
ÚdataÚitemsÚparentÚ
parent_offsetr r ÚlistÚranger1 ÚAssertionError)r Úinitlistr r¥ r¦ r§ r )r r r 8 s
zViewList.__init__c C s
t | jS )N)Ústrr¤ )r r r r Ú__str__S s zViewList.__str__c C s d| j j| j| jf S )Nz%s(%s, items=%s))r* r+ r¤ r¥ )r r r r Ú__repr__V s zViewList.__repr__c C s | j | j|k S )N)r¤ Ú_ViewList__cast)r Úotherr r r Ú__lt__Z s zViewList.__lt__c C s | j | j|kS )N)r¤ r¯ )r r° r r r Ú__le__[ s zViewList.__le__c C s | j | j|kS )N)r¤ r¯ )r r° r r r Ú__eq__\ s zViewList.__eq__c C s | j | j|kS )N)r¤ r¯ )r r° r r r Ú__ne__] s zViewList.__ne__c C s | j | j|kS )N)r¤ r¯ )r r° r r r Ú__gt__^ s zViewList.__gt__c C s | j | j|kS )N)r¤ r¯ )r r° r r r Ú__ge___ s zViewList.__ge__c C s | j }| j|}||k||k S )N)r¤ r¯ )r r° ZmineZyoursr r r Ú__cmp__a s
zViewList.__cmp__c C s t |tr|jS |S d S )N)r r r¤ )r r° r r r Ú__castg s
zViewList.__castc C s
|| j kS )N)r¤ )r Úitemr r r Ú __contains__m s zViewList.__contains__c C s
t | jS )N)r1 r¤ )r r r r Ú__len__n s zViewList.__len__c C s^ t |trP|jdks td| j| j|j|j
| j|j|j
| |jpJddS | j| S d S )Nr z cannot handle slice with strider )r¥ r¦ r§ )Nr ) r ÚsliceÚsteprª r* r¤ ÚstartÚstopr¥ )r r¢ r r r Ú __getitem__t s
zViewList.__getitem__c C sÈ t |tr¤|jdks tdt |ts.td|j| j|j|j
< |j | j |j|j
< t
| jt
| j ksrtd| j rÄ|| j |jpd| j |jpt
| | j
< n || j|< | j rÄ|| j || j < d S )Nr z cannot handle slice with stridez(assigning non-ViewList to ViewList slicez
data mismatchr )Nr )
r r¼ r½ rª r rH r¤ r¾ r¿ r¥ r1 r¦ r§ )r r¢ r¹ r r r Ú __setitem__} s
,
zViewList.__setitem__c C s¢ y(| j |= | j|= | jr&| j|| j = W nt tk
r |jd ksJtd| j |j|j
= | j|j|j
= | jr| j|jp|d| j |jpt | | j
= Y nX d S )Nz cannot handle slice with strider )
r¤ r¥ r¦ r§ rH r½ rª r¾ r¿ r1 )r r¢ r r r Ú __delitem__ s zViewList.__delitem__c C s4 t |tr(| j| j|j | j|j dS tdd S )N)r¥ z!adding non-ViewList to a ViewList)r r r* r¤ r¥ rH )r r° r r r Ú__add__ s
zViewList.__add__c C s4 t |tr(| j|j| j |j| j dS tdd S )N)r¥ z!adding ViewList to a non-ViewList)r r r* r¤ r¥ rH )r r° r r r Ú__radd__¢ s
zViewList.__radd__c C s( t |tr | j|j7 _ntd| S )Nz!argument to += must be a ViewList)r r r¤ rH )r r° r r r Ú__iadd__© s
zViewList.__iadd__c C s | j | j| | j| dS )N)r¥ )r* r¤ r¥ )r r@ r r r Ú__mul__° s zViewList.__mul__c C s | j |9 _ | j|9 _| S )N)r¤ r¥ )r r@ r r r Ú__imul__µ s zViewList.__imul__c C sR t |tstd| jr2| jjt| j| j | | jj|j | j j|j d S )Nz(extending a ViewList with a non-ViewList)
r r rH r¦ rN r1 r¤ r§ r% r¥ )r r° r r r r% º s
zViewList.extendr c C sX |d kr| j | n@| jr8| jjt| j| j ||| | jj| | jj||f d S )N)r% r¦ rN r1 r¤ r§ rc r¥ )r r¹ r r7 r r r rc  s zViewList.appendc C sÈ |d krnt |tstd|j| j||
< |j| j||
< | jrÄt| j| t| j }| jj|| j | nV| jj|| | jj|||f | jrÄt| j| t| j }| jj|| j ||| d S )Nz+inserting non-ViewList with no source given) r r rH r¤ r¥ r¦ r1 rN r§ )r r¢ r¹ r r7 Úindexr r r rN Ì s
zViewList.insertr c C sH | j r0t| j| t| j }| j j|| j | jj| | jj|S )N)r¦ r1 r¤ Úpopr§ r¥ )r r¢ rÈ r r r rÉ Ý s
z ViewList.popc C sf |t | jkr&td|t | jf n|dk r6td| jd|
= | jd|
= | jrb| j|7 _dS )zW
Remove items from the start of the list, without touching the parent.
zCSize of trim too large; can't trim %s items from a list of size %s.r zTrim size must be >= 0.N)r1 r¤ r> r¥ r¦ r§ )r r@ r r r r ä s zViewList.trim_startc C sV |t | jkr&td|t | jf n|dk r6td| j| d
= | j| d
= dS )zU
Remove items from the end of the list, without touching the parent.
zCSize of trim too large; can't trim %s items from a list of size %s.r zTrim size must be >= 0.N)r1 r¤ r> r¥ )r r@ r r r Útrim_endò s zViewList.trim_endc C s | j |}| |= d S )N)rÈ )r r¹ rÈ r r r rf þ s
zViewList.removec C s | j j|S )N)r¤ Úcount)r r¹ r r r rË s zViewList.countc C s | j j|S )N)r¤ rÈ )r r¹ r r r rÈ s zViewList.indexc C s | j j | jj d | _d S )N)r¤ Úreverser¥ r¦ )r r r r rÌ s
zViewList.reversec G sB t t| j| jf| }dd |D | _dd |D | _d | _d S )Nc S s g | ] }|d qS )r r )r¡ Úentryr r r r£ s z!ViewList.sort.<locals>.<listcomp>c S s g | ] }|d qS )r r )r¡ rÍ r r r r£
s )ÚsortedÚzipr¤ r¥ r¦ )r r/ Útmpr r r Úsort
s z
ViewList.sortc C sJ y
| j | S tk
rD |t| jkr>| j |d d dfS Y nX dS )z%Return source & offset for index `i`.r r N)r¥ r> r1 r¤ )r r¢ r r r r' s
z
ViewList.infoc C s | j |d S )z Return source for index `i`.r )r' )r r¢ r r r r s zViewList.sourcec C s | j |d S )z Return offset for index `i`.r )r' )r r¢ r r r r7 s zViewList.offsetc C s
d| _ dS )z-Break link between this list and parent list.N)r¦ )r r r r Ú
disconnect" s zViewList.disconnectc c s0 x*t | j| jD ]\}\}}|||fV qW dS )z8Return iterator yielding (source, offset, value) tuples.N)rÏ r¤ r¥ )r r` r r7 r r r Úxitems& s zViewList.xitemsc C s" x | j D ]}td| q
W dS )z=Print the list in `grep` format (`source:offset:value` lines)z%s:%d:%sN)rÓ r! )r r r r r Úpprint+ s zViewList.pprint)NNNNN)Nr )Nr r )r )r )r )+r+ rh ri rj r r r® r± r² r³ r´ rµ r¶ r· r¯ rº r» rÀ rÁ r rà rÄ rÅ rÆ Ú__rmul__rÇ r% rc rN rÉ r rÊ rf rË rÈ rÌ rÑ r' r r7 rÒ rÓ rÔ r r r r r $ sR
r c @ sN e Zd ZdZdejfddZdddZdd
d Zdd d
Z dd Z
dd Z d S )r z*A `ViewList` with string-specific methods.r c s* fdd| 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 s g | ]}| d
qS )Nr )r¡ r )Úlengthr r r£ ; s z(StringList.trim_left.<locals>.<listcomp>N)r¤ )r rÖ r¾ r r )rÖ r Ú trim_left5 s
zStringList.trim_leftFc C sz |}t | j}x^||k rl| j| }|j s,P |rb|d dkrb| j|\}}t| ||
||d |d7 }qW | ||
S )zÜ
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 )r1 r¤ rA r' rQ )r r¾ rR r Úlastr r r7 r r r rP > s
zStringList.get_text_blockTNc C sJ |}|}|dk r |dkr |}|dk r,|d7 }t | j}x°||k râ| j| } | r| d dksr|dk r| d|
j r||ko| j|d j }
P | j } | s¨|rØd}
P n0|dkrØt | t | } |dkrÎ| }n
t|| }|d7 }q8W d}
| ||
}
|dk r |
r |
jd |d
|
jd< |r:|r:|
j||dk d |
|pDd|
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 mininum indent removed;
- the amount of the indent;
- a boolean: did the indented block finish with a blank line or EOF?
Nr r rØ )r¾ )r1 r¤ rA ÚlstripÚminr× )r r¾ r r r r r r rÙ r r ÚstrippedZ line_indentrS r r r r
S sB
zStringList.get_indentedc
s* | ||
}| xÜt t|jD ]Ê}tj|j| }y || }W n. tk
rn |t|j| t| 7 }Y nX y || }W n. tk
rª |t|j| t| 7 }Y nX |j| ||
j |j|< } | r t t| t| j q W |r&d k o|k n r& fdd|jD |_|S )Nr c s g | ]}| d
qS )Nr )r¡ r )r r r r£ ¡ s z+StringList.get_2D_block.<locals>.<listcomp>) r© r1 r¤ r Zcolumn_indicesr> ÚrstriprÛ rÚ )
r ÚtopÚleftZbottomÚrightr rS r¢ Zcir r )r r Ú get_2D_block s$ "zStringList.get_2D_blockc C sx t j}xltt| jD ]Z}| j| }t|trg }x,|D ]$}|j| ||dkr8|j| q8W dj|| j|< qW dS )z
Pad all double-width characters in self by appending `pad_char` to each.
For East Asian language support.
ZWFrL N) Ú unicodedataÚeast_asian_widthr© r1 r¤ r Úunicoderc r" )r Zpad_charrã r¢ r ÚnewÚcharr r r Úpad_double_width¤ s
zStringList.pad_double_widthc C s4 x.t t| jD ] }| j| j||| j|< qW dS )z6Replace all occurrences of substring `old` with `new`.N)r© r1 r¤ Úreplace)r Úoldrå r¢ r r r rè ´ s zStringList.replace)F)r FTNN)T) r+ rh ri rj ÚsysÚmaxsizer× rP r
rá rç rè r r r r r 1 s
;
r c @ s e Zd ZdS )ÚStateMachineErrorN)r+ rh ri r r r r rì º s rì c @ s e Zd ZdS )r= N)r+ rh ri r r r r r= » s r= c @ s e Zd ZdS )r[ N)r+ rh ri r r r r r[ ¼ s r[ c @ s e Zd ZdS )ru N)r+ rh ri r r r r ru ½ s ru c @ s e Zd ZdS )rt N)r+ rh ri r r r r rt ¾ s rt c @ s e Zd ZdS )r} N)r+ rh ri r r r r r} ¿ s r} c @ s e Zd ZdS )r N)r+ rh ri r r r r r À s r c @ s e Zd ZdS )rQ N)r+ rh ri r r r r rQ Á s rQ c @ s e Zd ZdZdS )r- z
Raise from within a transition method to switch to another transition.
Raise with one argument, the new transition name.
N)r+ rh ri rj r r r r r- Ä s r- c @ s e Zd ZdZdS )r0 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.
N)r+ rh ri rj r r r r r0 Í s r0 é Fz[ ]c s* |r|j d| } fdd| j 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]).
rØ c s g | ]}|j j qS r )Ú
expandtabsrÝ )r¡ Ús)Ú tab_widthr r r£ é s z string2lines.<locals>.<listcomp>)ÚsubÚ
splitlines)Zastringrð Zconvert_whitespaceÚ
whitespaceÚlinesr )rð r Ú string2linesÖ s rõ c C s> t j \} }}x|jr |j}qW |jj}| j||j|j|jfS )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_infoÚtb_nextÚtb_frameÚf_coder+ Ú co_filenameÚ tb_linenoÚco_name)r_ r` Ú tracebackÚcoder r r r^ ì s
r^ )r r )&rj Ú
__future__r Z
__docformat__rê r{ râ Zdocutilsr Z docutils.utils.error_reportingr Ú version_infor¬ rä Úobjectr rk r r r r r r r Ú Exceptionrì r= r[ ru rt r} r rQ r- r0 r| rõ r^ r r r r Ú<module>i sP
g