2bil
% S SK Jr S SKrS SKrS SKJrJrJrJrJrJ r J
r
J r J r J
r
Jr S SKJrJr S SKJr S SKrS SKrS SKrS SKrS SKrS SKJr S SKrS SK r S SK J r S SK J r S S K!J"r" S S
K#J$r$ S S K%J&r&J'r'J(r(J)r)J*r*J+r+J,r,J-r.J/r0J1r1 S S
K27 S S
K37 S SK4J5r5J6r6 S SK7J8r8 \Rr r:\;\<4r=\ \>S4 \?S' \R S: a S SK JArA O
" S S5 rA " S S\(5 rB " S S\(5 rC " S S\5 rDS \DS S4S jrES \DS S4S jrFSS jrGC(S!\R4 \; S"\R \; S \I4S# jrJ\J" \R \R R S$5 5 ( a \G" 5 \N\O\P\Q\R\S\T\U\V\W\X1 rY\ R r[\ \\\4 r]\
\5\ \5 4 r^\
\/ \4 \\5/\4 \\\\5/\4 \\;\\\5/\4 4 r_\
\/ \I4 \\5/\I4 \\\\5/\I4 \\;\\\5/\I4 4 r`\\;\\S%\a/S4 rb\\;\\S%\I/S4 rc\\;\\\\S%\5\I/S4 rd\\;\\S%\a\I/S4 re\R \R - rh\8R R rj\8R R rkS&rl\lS'- rm\h\l- rnS(R \R V s/ s H o \R ; d M U PM sn 5 rrSqs\R \?S)' SS* jru SS+\`S,\R \; S-\IS \_4S. jjrv SS/\;S0\\S1S%S2\I4S3 jjrw SS/\;S4\\S5\\S1S%S6\5S2\I4 S7 jjrx SS/\;S0\\S1S%S8\aS2\I4
S9 jjryS: rz " S; S%\5 r{ " S< S=\{5 r| " S> S?\{5 r} " S@ SA\}5 r~ " SB SC\}5 r " SD SE\5 r " SF SG\5 r\\{l " SH SI\}5 r " SJ SK\5 r " SL SM\5 r " SN SO\}5 r " SP SQ\}5 r " SR SS\5 r " ST SU\}5 r " SV SW\}5 r " SX SY\}5 r " SZ S[\}5 r " S\ S]\}5 r " S^ S_\5 r " S` Sa\5 r " Sb Sc\5 r " Sd Se\5 r " Sf Sg\5 r " Sh Si\5 r " Sj Sk\5 r " Sl Sm\{5 r " Sn So\5 r " Sp Sq\5 r " Sr Ss\5 r " St Su\5 r " Sv Sw\{5 r " Sx Sy\5 r " Sz S{\5 r " S| S}\5 r " S~ S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S5 r " S S\5 r\rH " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 rS\_S \_4S jr\" 5 GRa S5 r\" 5 GRa S5 r\" 5 GRa S5 r\" 5 GRa S5 r\" 5 GRa S5 r\" S5 GRm S 5 r\" S5 GRm S 5 r\" S5 GRm S 5 r\\- \- \" SS S9- r\" \\" S5 - \- 5 r\" S5 \" S5 GRy S5 - \" \" \\- 5 5 GRy S5 - \" S5 - rS\;S \;4S jrS \_4S jrSS jr\" \" S5 S- 5 GRa S5 r\" \" S5 S- 5 GRa S5 r\" \" S5 S- GRa S5 \" S5 S- GRa S5 - 5 GRa S5 r\" \" S\GR S9S- GRa S5 \" S\GR S9S- GRa S5 - \" S5 S- GRa S5 - \" S5 S- GRa S5 - 5 GRa S5 r\" S\R+ 5 - 5 GRa S5 r\" S5 r\" S5 r\" 5 GR 5 Vs/ s H n\" U\{5 ( d M UPM snr\\{ \?S' \r\r\r\r\r\r\r\r\1" \z5 S 5 r\1" \5 S 5 r\1" \v5 S 5 r\1" \5 S 5 rgs sn f s snf ) )dequeN) AnyCallable GeneratorList
NamedTupleSequenceSetTextIOTupleUnioncast)ABCabstractmethod)Enum)Iterable)
itemgetter)wraps)RLock)Path )
_FifoCache_UnboundedCache__config_flags_collapse_string_to_ranges_escape_regex_range_chars_bslash_flattenLRUMemo
UnboundedMemoreplaced_by_pep8)*) ParseResults_ParseResultsWithOffset)pyparsing_unicode.str_type) )cached_propertyc $ \ rS rSrS rSS jrSrg)r) T c Xl g N_func)selffuncs ڌ/builddir/build/BUILDROOT/alt-python313-pip-23.3.1-3.el8.x86_64/opt/alt/python313/lib/python3.13/site-packages/pip/_vendor/pyparsing/core.py__init__cached_property.__init__U s J Nc l U R U5 =o1R U R R ' U$ r- )r/ __dict____name__)r0 instanceownerrets r2 __get__cached_property.__get__X s- ;?::h;O OC##DJJ$7$78Jr5 r. r- )r8
__module__ __qualname____firstlineno__r3 r< __static_attributes__ r5 r2 r) r) T s r5 r) c \ rS rSrSrSrSr\" 5 V Vs/ s H oR S5 ( a M UPM snn r SR 5 r Sr gs snn f )
__compat__] a&
A cross-version compatibility configuration for pyparsing features that will be
released in a future version. By setting values in this configuration to True,
those features can be enabled in prior versions for compatibility development
and testing.
- ``collect_all_And_tokens`` - flag to enable fix for Issue #63 that fixes erroneous grouping
of results names when an :class:`And` expression is nested within an :class:`Or` or :class:`MatchFirst`;
maintained for compatibility, but setting to ``False`` no longer restores pre-2.3.1
behavior
compatibilityT_z(
collect_all_And_tokens
rB N)
r8 r> r? r@ __doc__
_type_desccollect_all_And_tokenslocals
startswith
_all_namessplit _fixed_namesrA ).0__s 00r2 rD rD ] sJ
!J ! %xBx}}S/A"xBJ EG Cs
AArD c \ rS rSrSrSrSrSrSrSr Sr
Sr Sr \
" 5 V Vs/ s H oR S5 ( a M UPM snn r\ V Vs/ s H o"R S5 ( d M UPM snn r\ V Vs/ s H o"R S5 ( d M UPM snn r\S
S j5 rS rgs snn f s snn f s snn f ) __diag__t
diagnosticFrG warn enable_debugNc L U R H nU R U5 M g r- )_warning_namesenable)clsnames r2 enable_all_warnings __diag__.enable_all_warnings s &&D JJt 'r5 rB returnN)r8 r> r? r@ rI )warn_multiple_tokens_in_named_alternation)warn_ungrouped_named_tokens_in_collection warn_name_set_on_empty_Forward!warn_on_parse_using_empty_Forward warn_on_assignment_to_Forward%warn_on_multiple_string_args_to_oneof(warn_on_match_first_with_lshift_operator!enable_debug_on_named_expressionsrK rL rM rY _debug_names classmethodr] rA )rP rQ r\ s 000r2 rS rS t s J05-05-%*"(-%$)!,1)/4,(-% %xBx}}S/A"xBJ'1Mzt__V5LdzMN%/SZT??>3RDZSL CMSs# B/ B/B5,B5;B;B;rS c 8 \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
g )
Diagnostics a_
Diagnostic configuration (all default to disabled)
- ``warn_multiple_tokens_in_named_alternation`` - flag to enable warnings when a results
name is defined on a :class:`MatchFirst` or :class:`Or` expression with one or more :class:`And` subexpressions
- ``warn_ungrouped_named_tokens_in_collection`` - flag to enable warnings when a results
name is defined on a containing expression with ungrouped subexpressions that also
have results names
- ``warn_name_set_on_empty_Forward`` - flag to enable warnings when a :class:`Forward` is defined
with a results name, but has no contents defined
- ``warn_on_parse_using_empty_Forward`` - flag to enable warnings when a :class:`Forward` is
defined in a grammar but has never had an expression attached to it
- ``warn_on_assignment_to_Forward`` - flag to enable warnings when a :class:`Forward` is defined
but is overwritten by assigning using ``'='`` instead of ``'<<='`` or ``'<<'``
- ``warn_on_multiple_string_args_to_oneof`` - flag to enable warnings when :class:`one_of` is
incorrectly called with multiple str arguments
- ``enable_debug_on_named_expressions`` - flag to auto-enable debug on all subsequent
calls to :class:`ParserElement.set_name`
Diagnostics are enabled/disabled by calling :class:`enable_diag` and :class:`disable_diag`.
All warnings can be enabled by calling :class:`enable_all_warnings`.
r r r' rB N)r8 r> r? r@ rH ra rb rc rd re rf rg rh rA rB r5 r2 rl rl s9 . 12-01-%&"()%$%!,-)/0,()%r5 rl diag_enumr` c B [ R U R 5 g)zG
Enable a global pyparsing diagnostic flag (see :class:`Diagnostics`).
N)rS rZ r\ rs s r2 enable_diagrv s
OOINN#r5 c B [ R U R 5 g)zH
Disable a global pyparsing diagnostic flag (see :class:`Diagnostics`).
N)rS disabler\ ru s r2 disable_diagry s
Y^^$r5 c , [ R 5 g)zM
Enable all global pyparsing diagnostic warnings (see :class:`Diagnostics`).
N)rS r] rB r5 r2 r] r] s
"r5 cmd_line_warn_options warn_env_varc J [ U5 nU H nUS- R S5 S S u pEpgnUR 5 R S5 ( d U( d U( d U( a US:X a SnMa UR 5 R S5 ( d M US; d M SnM U$ ) Nz:::::rp i pyparsingT)r F)boolrN lowerrL ) r{ r| rZ warn_optw_action w_message
w_categoryw_modulew_lines r2 _should_enable_warningsr s ,
F)=E=NO2OF * Mr5 PYPARSINGENABLEALLWARNINGS
ParserElement
0123456789 ABCDEFabcdefr _trim_arity_call_linec 2 ^ ^^^^ T [ ; a U 4S j$ SmSmSn[ =( d [ R " SS9S q[ S [ S U- 4mUU UUU4S jn[ T S
[ T S 5 R
5 nXCl T R Ul U$ ) zAdecorator to trim function calls to match the arity of the targetc > T" U5 $ r- rB )sltr1 s r2 _trim_arity.. s tAwr5 r Frr rn limitr c > T" U T S 6 nSmU$ ! [ a\ nT( a e UR n[ R " USS9nUS nUS S /S S S T :H nAU( a T T
: a T S-
m S nAMn e S nAff = f)Nr Trn r r ) TypeError
__traceback__ traceback
extract_tb) argsr; tetbframes
frame_summarytrim_arity_type_error found_arityr1 r max_limitpa_call_line_synths r2 wrapper _trim_arity..wrapper! s
DL) "
))B & 1 1"A >F$*2JM&r*+B/37II * , 9, !QJE $%
s
A6AA10A11A6r8 __class__)_single_arg_builtinsr r
extract_stackgetattrr8 rH )r1 r LINE_DIFFr func_namer r r s `` @@@r2 _trim_arityr
s ##&&
EK I 3 Zi6M6MTU6VWY6Z/24I!4Ly4XY < j'$ *D*M*MNI llGO Nr5 fnmessagefatalc ^ ^^ Ub UOSmU( a [ O[ m[ T 5 m [ T 5 UU U4S j5 nU$ )a
Function to convert a simple predicate function that returns ``True`` or ``False``
into a parse action. Can be used in places when a parse action is required
and :class:`ParserElement.add_condition` cannot be used (such as when adding a condition
to an operator level in :class:`infix_notation`).
Optional keyword arguments:
- ``message`` - define a custom message to be used in the raised exception
- ``fatal`` - if True, will raise :class:`ParseFatalException` to stop parsing immediately;
otherwise will raise :class:`ParseException`
z failed user-defined conditionc F > [ T" XU5 5 ( d T" XT5 eg r- )r )r r r exc_typer msgs r2 pa%condition_as_parse_action..paZ s& BqQK 1% % !r5 )ParseFatalExceptionParseExceptionr r )r r r r r r s ` @@r2 condition_as_parse_actionr F sB ('.MC&+" H R B
2Y& & Ir5 instringlocexpr cache_hitc U( a SOSn[ U SU SU S[ X5 S[ X5 S[ X5 SS [ X5 S
-
- S 35 g ) Nr" r Match z at loc (,z)
z
r ^)printlinenocolline)r r r r
cache_hit_strs r2 _default_start_debug_actionr b sr %C"M oVD6#as8M7NaPSTWPbOc dc$% &C*Q./0
3r5 startlocendloctoksc \ U( a SOSn[ U SU SUR 5 35 g )Nr" r zMatched z -> )r as_list)r r r r r r r s r2 _default_success_debug_actionr o s- %C"M ]O8D6dlln-=
>?r5 excc l U( a SOSn[ U SU S[ U5 R SU 35 g )Nr" r r z failed, z raised: )r typer8 )r r r r r r s r2 _default_exception_debug_actionr { s7 %C"M ]O6$yc1C1C0DIcU
STr5 c g)zG'Do-nothing' debug action, to suppress debugging output during parsing.NrB )r s r2 null_debug_actionr r5 c ' \ rS rSr% SrSr\\S' Sr\ \S' Sr
\ \S' \ S \S
S4S j5 r
\ S \ S
S4S
j5 r\S 5 r " S S\5 rSS\ 4S jjrS\S
S 4S jrS rSS jr SSS.S\S\ S\ S
S 4S jjjrSS jrSS \ S
S 4S jjrS \S
S 4S! jr S \S
S 4S" jr S \ S
S 4S# jr S$\ S
S 4S% jr!S&\S'\"S
\"4S( jr#S&\S'\"S
\"4S) jr$SS* jr%S+ r& SS
\'\"\(4 4S, jjr)SSS-.S&\S'\"S.\ S/\ S
\"4
S0 jjr*SS&\S'\"S/\ S
\ 4S1 jjr+\," 5 r-0 r.\/R` \'\"S2\ 4 \'\"\1\(\24 4 4 \S3' " S4 S5\35 r4\4" 5 r5\," 5 r6S6S6/r7 SS
\'\"\(4 4S7 jjr8\)r9\ SS8 j5 r:Sr;Sr<\ SS9 j5 r=\ SSS:.S;\/R| \" S
S4S< jjj5 r?\ SSS:.S;\"S=\ S
S4S> jjj5 r@ SSS?.S&\S@\ SA\ S
\(4SB jjjrA\BS4S\BSC.S&\SD\"SE\ SF\ SG\"S
\C\'\(\"\"4 SS4 4 SH jjjrDSSI.S&\SF\ S
\4SJ jjrE\B4S\BSC.S&\SD\"SF\ SG\"S
\(4
SK jjjrF\BS4SSL.S&\SM\"SN\ S
\C\SS4 4SO jjjrGSSP jrHSSQ jrISSR jrJSSS jrKSST jrLSSU jrMSSV jrNSSW jrOSSX jrPSSY jrQSSZ jrRSS[ jrSSS\ jrTSrUS] rVSS\/R| \ S
S 4S^ jjrWSS_ jrXSS`\ S
S 4Sa jjrYSS`\ S
S 4Sb jjrZ SS \1\[\ \4 Sc\ S
S 4Sd jjr\SSe jr]SSf jr^Sg\_Sh\`Si\aS
S 4Sj jrbSSk\ Sl\ S
S 4Sm jjrc\dS
\4Sn j5 re\fS
\4So j5 rgS\S
S 4Sp jrh\dS
\4Sq j5 riS
\4Sr jrjS
\4Ss jrkSSt jrlS
\mS 4Su jrnSv roSSSw jjrp SSS?.Sx\1\\q\r4 Sy\S@\ SA\ S
\(4
Sz jjjrsS{ rtS| ru SS S?.S}\S@\ SA\ S
\ 4S~ jjjrv SS S S SSS.S\1\\m\ 4 S@\ S\/R| \1S \4 S\ S\ S\ S\/R| \w\\(/\4 S\/R| \r S\ SA\ S\ S\ S\ S\/R| \w\\(/\4 S
\'\ \m\'\\1\(\24 4 4 4 S jjjrx SS\1\r\q\4 S\"S\ S\ S\ S
S4 S jjry\ \z" \5 S 5 5 r{\ \z" \
5 S 5 5 r|\z" \5 S 5 r}\z" \5 S 5 r~\z" \ 5 S 5 r\z" \ 5 S 5 r\z" \ 5 S 5 r\z" \!5 S 5 r\z" \*5 S 5 r\ \z" \?5 S 5 5 r\ \z" \@5 S 5 5 r\z" \A5 S 5 r\z" \D5 S 5 r\z" \E5 S 5 r\z" \F5 S 5 r\z" \Y5 S 5 r\z" \Z5 S 5 r\z" \\5 S 5 r\z" \]5 S 5 r\z" \b5 S 5 r\z" \c5 S 5 r\z" \h5 S 5 r\z" \s5 S 5 r\z" \x5 S 5 r\+r\:r\erSrg)r i z)Abstract base level parser element class.z
DEFAULT_WHITE_CHARSFverbose_stacktraceN_literalStringClasscharsr` c z U [ l [ H& nUR ( d M [ U 5 Ul M( g)a
Overrides the default whitespace chars
Example::
# default whitespace chars are space, and newline
Word(alphas)[1, ...].parse_string("abc def\nghi jkl") # -> ['abc', 'def', 'ghi', 'jkl']
# change to just treat newline as significant
ParserElement.set_default_whitespace_chars(" \t")
Word(alphas)[1, ...].parse_string("abc def\nghi jkl") # -> ['abc', 'def']
N)r r _builtin_exprscopyDefaultWhiteCharsset
whiteChars)r r s r2 set_default_whitespace_chars*ParserElement.set_default_whitespace_chars s/ -2
) #D)))"%e* #r5 r[ c U [ l g)a
Set class to be used for inclusion of string literals into a parser.
Example::
# default literal class used is Literal
integer = Word(nums)
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")
date_str.parse_string("1999/12/31") # -> ['1999', '/', '12', '/', '31']
# change to Suppress
ParserElement.inline_literals_using(Suppress)
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")
date_str.parse_string("1999/12/31") # -> ['1999', '12', '31']
N)r r )r[ s r2 inline_literals_using#ParserElement.inline_literals_using s ( -0
)r5 c + > ^ ^# UU 4S jU 5 Sh vN g N7f)z
Yields a sequence of class(obj, **class_kwargs) for obj in seq.
Example::
LPAR, RPAR, LBRACE, RBRACE, SEMI = Suppress.using_each("(){};")
c 3 6 ># U H nT" U40 TD6v M g 7fr- rB )rP obj class_kwargsr[ s r2 +ParserElement.using_each.. s <C,|,s NrB )r[ seqr s ` `r2
using_eachParserElement.using_each s =<< r? r@ typingOptionalDebugStartAction__annotations__DebugSuccessActionDebugExceptionActionrA rB r5 r2 DebugActionsParserElement.DebugActions s2 ??#344__%788OO$899r5 r savelistc [ 5 U l S U l S U l S U l S U l Xl SU l [ [ R 5 U l SU l SU l
SU l [ 5 U l SU l SU l SU l SU l SU l U R+ S S S 5 U l SU l SU l / U l g )NTFr )list parseAction
failAction
customName _defaultName resultsName
saveAsListskipWhitespacer r r r r mayReturnEmptykeepTabs ignoreExprsdebug streamlined
mayIndexErrorerrmsg modalResultsr debugActions callPreparse
callDuringTrysuppress_warnings_)r0 r s r2 r3 ParserElement.__init__ s .2f<@ #26 $" " m ? ?@%)" #
26&
! - -dD$ ? "57 r5 warning_typec < U R R U5 U $ )a"
Suppress warnings emitted for a particular diagnostic on this expression.
Example::
base = pp.Forward()
base.suppress_warning(Diagnostics.warn_on_parse_using_empty_Forward)
# statement would normally raise a warning, but is now suppressed
print(base.parse_string("x"))
)r append)r0 r s r2 suppress_warning ParserElement.suppress_warning s
&&|4 r5 c # # [ U /5 n[ 5 nU( aU UR 5 nX2; a M UR U5 UR UR 5 5 Uv U( a MT gg7f)zsGeneral-purpose method to yield all expressions and sub-expressions
in a grammar. Typically just for internal use.
N)r r popleftaddextendrecurse)r0 to_visitseencurs r2 visit_allParserElement.visit_all s] $=u""$C { HHSM OOCKKM *I hs A0A64A6c [ R " U 5 nU R SS Ul U R SS Ul U R ( a [ [
R 5 Ul U$ )a
Make a copy of this :class:`ParserElement`. Useful for defining
different parse actions for the same parsing pattern, using copies of
the original parse element.
Example::
integer = Word(nums).set_parse_action(lambda toks: int(toks[0]))
integerK = integer.copy().add_parse_action(lambda toks: toks[0] * 1024) + Suppress("K")
integerM = integer.copy().add_parse_action(lambda toks: toks[0] * 1024 * 1024) + Suppress("M")
print((integerK | integerM | integer)[1, ...].parse_string("5K 100 640K 256M"))
prints::
[5120, 100, 655360, 268435456]
Equivalent form of ``expr.copy()`` is just ``expr()``::
integerM = integer().add_parse_action(lambda toks: toks[0] * 1024 * 1024) + Suppress("M")
N)copyr r
r r r r r )r0 cpys r2 r% ParserElement.copy
sU , iio **1- **1- % % !B!B CCN
r5 )listAllMatchesr\ list_all_matchesr( c : U=( d UnU R X5 $ )a3
Define name for referencing matching tokens as a nested attribute
of the returned parse results.
Normally, results names are assigned as you would assign keys in a dict:
any existing value is overwritten by later values. If it is necessary to
keep all values captured for a particular results name, call ``set_results_name``
with ``list_all_matches`` = True.
NOTE: ``set_results_name`` returns a *copy* of the original :class:`ParserElement` object;
this is so that the client can define a basic element, such as an
integer, and reference it in multiple places with different names.
You can also set results names using the abbreviated syntax,
``expr("name")`` in place of ``expr.set_results_name("name")``
- see :class:`__call__`. If ``list_all_matches`` is required, use
``expr("name*")``.
Example::
date_str = (integer.set_results_name("year") + '/'
+ integer.set_results_name("month") + '/'
+ integer.set_results_name("day"))
# equivalent form:
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")
)_setResultsName)r0 r\ r) r( s r2 set_results_name ParserElement.set_results_name' s < (;+;##D99r5 c Uc U $ U R 5 nUR S5 ( a US S nSnXl U( + Ul U$ )Nr" r T)r% endswithr r )r0 r\ r( newselfs r2 r+ ParserElement._setResultsNameH sL <K))+ == 9D !N "#1 1 r5 T
break_flagc ^ U( a# U R mSU4S jjnTUl X l U $ [ U R S5 ( a U R R U l U $ )z
Method to invoke the Python pdb debugger when this element is
about to be parsed. Set ``break_flag`` to ``True`` to enable, ``False`` to
disable.
c > > SS K nUR 5 T" XX#5 $ Nr )pdb set_trace)r r doActions callPreParser6 _parseMethods r2 breaker(ParserElement.set_break..breaker\ s
#H9KKr5 _originalParseMethodTT)_parser= hasattr)r0 r2 r; r: s @r2 set_breakParserElement.set_breakS sW ;;L
L ,8G (!K t{{$:;; "kk > > r5 fnsc [ U5 S/:X a / U l U $ [ S U 5 5 ( d [ S5 eU Vs/ s H n[ U5 PM snU l UR SUR SS5 5 U l U $ s snf )a
Define one or more actions to perform when successfully matching parse element definition.
Parse actions can be called to perform data conversions, do extra validation,
update external data structures, or enhance or replace the parsed tokens.
Each parse action ``fn`` is a callable method with 0-3 arguments, called as
``fn(s, loc, toks)`` , ``fn(loc, toks)`` , ``fn(toks)`` , or just ``fn()`` , where:
- ``s`` = the original string being parsed (see note below)
- ``loc`` = the location of the matching substring
- ``toks`` = a list of the matched tokens, packaged as a :class:`ParseResults` object
The parsed tokens are passed to the parse action as ParseResults. They can be
modified in place using list-style append, extend, and pop operations to update
the parsed list elements; and with dictionary-style item set and del operations
to add, update, or remove any named results. If the tokens are modified in place,
it is not necessary to return them with a return statement.
Parse actions can also completely replace the given tokens, with another ``ParseResults``
object, or with some entirely different object (common for parse actions that perform data
conversions). A convenient way to build a new parse result is to define the values
using a dict, and then create the return value using :class:`ParseResults.from_dict`.
If None is passed as the ``fn`` parse action, all previously added parse actions for this
expression are cleared.
Optional keyword arguments:
- ``call_during_try`` = (default= ``False``) indicate if parse action should be run during
lookaheads and alternate testing. For parse actions that have side effects, it is
important to only call the parse action once it is determined that it is being
called as part of a successful parse. For parse actions that perform additional
validation, then call_during_try should be passed as True, so that the validation
code is included in the preliminary "try" parses.
Note: the default parsing behavior is to expand tabs in the input string
before starting the parsing process. See :class:`parse_string` for more
information on parsing strings containing ```` s, and suggested
methods to maintain a consistent view of the parsed string, the parse
location, and line and column positions within the parsed string.
Example::
# parse dates in the form YYYY/MM/DD
# use parse action to convert toks from str to int at parse time
def convert_to_int(toks):
return int(toks[0])
# use a parse action to verify that the date is a valid date
def is_valid_date(instring, loc, toks):
from datetime import date
year, month, day = toks[::2]
try:
date(year, month, day)
except ValueError:
raise ParseException(instring, loc, "invalid date given")
integer = Word(nums)
date_str = integer + '/' + integer + '/' + integer
# add parse actions
integer.set_parse_action(convert_to_int)
date_str.set_parse_action(is_valid_date)
# note that integer fields are now ints, not strings
date_str.run_tests('''
# successful parse - note that integer fields were converted to ints
1999/12/31
# fail - invalid date
1999/13/31
''')
Nc 3 8 # U H n[ U5 v M g 7fr- )callable)rP r s r2 r 1ParserElement.set_parse_action.. s 2cx||c z parse actions must be callablecall_during_tryr F)r r allr r getr r0 rC kwargsr s r2 set_parse_action ParserElement.set_parse_actionj s V 9 !D
2c222 @AA:= >#B B# >D !'!6::ou#E"D ?s Bc U =R U Vs/ s H n[ U5 PM sn-
sl U R =( d" UR SUR SS5 5 U l U $ s snf )z
Add one or more parse actions to expression's list of parse actions. See :class:`set_parse_action`.
See examples in :class:`copy`.
rI r F)r r r rK rL s r2 add_parse_action ParserElement.add_parse_action sb
s ;s[_s ;; ! / /
6:: vzz/5 A4
= 2000, message="Only support years 2000 and later")
date_str = year_int + '/' + integer + '/' + integer
result = date_str.parse_string("1999/12/31") # -> Exception: Only support years 2000 and later (at char 0),
(line:1, col:1)
r r F)r r rI r )r r r strrK r r rL s r2
add_conditionParserElement.add_condition s . B # #)
9 5 6 vzz'5 9:
" / /
6:: vzz/5 A4
r5 r c Xl U $ )a
Define action to perform if parsing fails at this expression.
Fail acton fn is a callable function that takes the arguments
``fn(s, loc, expr, err)`` where:
- ``s`` = string being parsed
- ``loc`` = location where expression match was attempted and failed
- ``expr`` = the parse expression that failed
- ``err`` = the exception thrown
The function returns no value. It may throw :class:`ParseFatalException`
if it is desired to stop parsing immediately.)r )r0 r s r2 set_fail_action ParserElement.set_fail_action s r5 r r c U R ( d U$ SnU R Vs/ s H oDR PM nnU( a" SnU H n U" X5 u p'SnM U( a M" U$ s snf ! [ a M2 f = fNTF)r
r? r )r0 r r
exprsFoundeignore_expr_fns ignore_fndummys r2 _skipIgnorables ParserElement._skipIgnorables s J
-1-=-=>-=88-=> J , %.x%=
%)
- j
? & s A&
A++
A98A9c U R ( a U R X5 nU R ( a8 [ U5 nU R nX#: a X U; a US-
nX#: a
X U; a M U$ Nr )r
ra r lenr )r0 r r instrlen white_charss r2 preParseParserElement.preParse sd &&x5C 8}H //K.X]k%Aq .X]k%A
r5 c
U/ 4$ r- rB r0 r r r8 s r2 parseImplParserElement.parseImpl Bwr5 c U$ r- rB r0 r r tokenlists r2 postParseParserElement.postParse s r5 c
< Su pVnU R n[ U5 n U( d U R ( a U( a# U R ( a U R X5 n
OUn
U
n U R
R ( a U R
R
XU S5 U R ( d X: a U R XU5 u p,OU R XU5 u p,OnU( a# U R ( a U R X5 n
OUn
U
n U R ( d X: a U R XU5 u p,OU R XU5 u p,U R XU 5 n [ XR U R" U R$ S9nU R& ( a U( d U R( ( a U( aq U R& H_ n U" XU5 n U c M XLd M [ U U R U R" =( a [+ U [ [, 45 U R$ S9nMa OoU R& H_ n U" XU5 n U c M XLd M [ U U R U R" =( a [+ U [ [, 45 U R$ S9nMa U( a9 U R
R. ( a U R
R/ XX US5 X.4$ ! [ a [ XU R U 5 ef = f! [ ac n
U R
R ( a U R
R UW X
S5 U R ( a U R UW X
5 e S n
A
ff = f! [ a [ XU R U 5 ef = f! [ a n[ S5 nUUeS nAff = f! [ a> n
U R
R ( a U R
R XX
S5 e S n
A
ff = f! [ a n[ S5 nUUeS nAff = f)Nr r rn F)asListmodalz exception raised in parse action)r re r r rh r r r
rl
IndexErrorr r Exceptionr rr r# r r r r r
isinstancer r )r0 r r r8 r9 TRYMATCHFAIL debugging len_instringpre_loc tokens_starttokenserr
ret_tokensr parse_action_excr s r2
_parseNoCacheParserElement._parseNoCache$ s #DJJ 8}
D$5$5 "mmH :G !G & $$..%%//eT%%)@X&*nnX &R V #'..I"NKC 1 1 --6 "L!!W%<T"&..I"NKC #nnX J v6! $$T__DDUDU
d.@.@ " . .<%'
%KF
"-&2J)5 & $ 0 0'+ (M$.v d7K$L&*&7&7 * J /. **B8!#HJ!G
)f.F%1 " , ,#'?? $I *6L$3G H"&"3"3 &
+ ,,!!-- Cz5 a & X ,XT[[RV WWX
$$//%%00 ,5 ??OOHlDF
$ " T(dSST * <"01S"TC"%+; ;< ! ((33 ))44 $Du
& 8 ,-O P !'778s A 3K K> "M. 7N3 NN3 N3 A N3 7 O>"K;;K> >
M+A M&&M+."N
N0 N++N00N3 3
O;=9O66O;>
PPP) raise_fatal
do_actionsr r c U R XUS9S $ ! [ a U( a e [ XU R U 5 ef = f)Nr8 r )r? r r r )r0 r r r r s r2 try_parseParserElement.try_parse sJ C;;x
;CAF F" C TB B Cs *?c R U R XUS9 g! [ [ 4 a gf = f)Nr TF)r r rx )r0 r r r s r2 can_parse_next ParserElement.can_parse_next s5 NN8ZN @
+ s &&Forwardrecursion_memosc 0 \ rS rSr% Sr\\S' S rS rSr g)zParserElement._CacheTypei z
class to help type checking
not_in_cachec g r- rB r0 r s r2 rK ParserElement._CacheType.get r5 c g r- rB r s r2 r ParserElement._CacheType.set r r5 rB N)
r8 r> r? r@ rH r r rK r rA rB r5 r2
_CacheTypeParserElement._CacheType s r5 r r c
Su pVSu pxn XX$U4n
[ R [ R n U R U
5 n XR L aa [ R
U== S-
ss' U R
XX45 n U R XS U S R 5 U45 U sS S S 5 $ [ R
U== S-
ss' U R ( a7 U R R ( a U R R XU SS9 [! U [" 5 ( aL U R ( a9 U R R$ ( a U R R% XX SS9 U eU e[' [( [* [, [* 4 U 5 n U S U S R 5 U S npU R ( a8 U R R. ( a U R R/ X UXSS9 X4sS S S 5 $ ! [ a. n
U R XR " U
R 6 5 e S n
A
ff = f! [ a GNN,OM )%&7:J&JK K04
-r5 r c F U( a [ R 5 O [ R ( a [ S5 e[ R ( dP S[ l U c [ 5 [ l O[ U 5 [ l [ R [ l gg)a
Enables "packrat" parsing, which adds memoizing to the parsing logic.
Repeated parse attempts at the same string location (which happens
often in many complex grammars) can immediately return a cached value,
instead of re-executing parsing/validating code. Memoizing is done of
both valid results and parsing exceptions.
Parameters:
- ``cache_size_limit`` - (default= ``128``) - if an integer value is provided
will limit the size of the packrat cache; if None is passed, then
the cache size will be unbounded; if 0 is passed, the cache will
be effectively disabled.
This speedup may break existing programs that use parse actions that
have side-effects. For this reason, packrat parsing is disabled when
you first import pyparsing. To activate the packrat feature, your
program must call the class method :class:`ParserElement.enable_packrat`.
For best results, call ``enable_packrat()`` immediately after
importing pyparsing.
Example::
from pip._vendor import pyparsing
pyparsing.ParserElement.enable_packrat()
Packrat parsing works similar but not identical to Bounded Recursion parsing,
thus the two cannot be used together. Use ``force=True`` to disable any
previous, conflicting settings.
r TN)
r r r r r r r r r r? r s r2 enable_packrat ParserElement.enable_packrat9 sl @ - - /
2
2 QR R ,,,0M ) '.=.?
+.89I.J
+#0#<#>> res = Word('a').parse_string('aaaaabaaa')
>>> print(res)
['aaaaa']
The parsing behavior varies by the inheriting class of this abstract class. Please refer to the children
directly to see more examples.
It raises an exception if parse_all flag is set and instring does not match the whole grammar.
>>> res = Word('a').parse_string('aaaaabaaa', parse_all=True)
Traceback (most recent call last):
...
pyparsing.ParseException: Expected end of text, found 'b' (at char 5), (line:1, col:6)
r N)r r r
streamliner
r
expandtabsr? rh Empty StringEndr r with_traceback) r0 r r r r] r r ser s r2 parse_stringParserElement.parse_stringe s Z (!!# OO !!A
LLN "}} **,H
++h2KCmmH2Wy{* (( M " / // ((.. /s AC
D$'D D)r
maxMatches max_matchesoverlapr r c # # [ XR5 nU R ( d U R 5 U R H nUR 5 M U R ( d [ U5 R
5 n[ U5 nSnU R n U R n
[ R 5 Sn X:: a X: az U " X5 n U
" X SS9u pX: aO U S-
n U( a [ UR 5 U U
S.5 XU
4v U( a U " X5 nX: a U
nOUS-
nO U
nOU S- n X:: a X: a Mx gggg! [ a W S- n N!f = f! [ a, n[ R ( a e UR# S5 eSnAff = f7f)a
Scan the input string for expression matches. Each match will return the
matching tokens, start location, and end location. May be called with optional
``max_matches`` argument, to clip scanning after 'n' matches are found. If
``overlap`` is specified, then overlapping matches will be reported.
Note that the start and end locations are reported relative to the string
being parsed. See :class:`parse_string` for more information on parsing
strings with embedded tabs.
Example::
source = "sldjf123lsdjjkf345sldkjf879lkjsfd987"
print(source)
for tokens, start, end in Word(alphas).scan_string(source):
print(' '*start + '^'*(end-start))
print(' '*start + tokens[0])
prints::
sldjf123lsdjjkf345sldkjf879lkjsfd987
^^^^^
sldjf
^^^^^^^
lsdjjkf
^^^^^^
sldkjf
^^^^^^
lkjsfd
r Fr9 r )r startendN)minr r r
r rT r re rh r? r
resetCacher rv r r r r )r0 r r r r r r] rf r
preparseFnparseFnmatchesprelocnextLocr nextlocr s r2 scan_stringParserElement.scan_string s~ N 1
OO !!A
LLN " }}8}//1Hx=]]
++ "$ //g&: )",X";F '.hU&SOG } 1 !.4mmo-3+2!" %g 55"&0&?G &}&- #q")C $qj; /g&:/&:/ & % 1*C%0 " / // ((.. /sO B5F 8
E D> A$E :F >E
E EE
F 'FF F r c / nSnSU l U R XS9 H u pVnUR XU 5 U( au [ U[ 5 ( a X5R 5 -
nOM[ U[ 5 ( a' [ U[ 5 ( d UR U5 OUR U5 UnM UR XS 5 U Vs/ s H
o( d M UPM nnSR [ U5 Vs/ s H n[ U5 PM sn5 $ s snf s snf ! [ a, n [ R ( a e U R S5 eSn A ff = f)a
Extension to :class:`scan_string`, to modify matching text with modified tokens that may
be returned from a parse action. To use ``transform_string``, define a grammar and
attach a parse action to it that modifies the returned token list.
Invoking ``transform_string()`` on a target string will then scan for matches,
and replace the matched text patterns according to the logic in the parse
action. ``transform_string()`` returns the resulting transformed string.
Example::
wd = Word(alphas)
wd.set_parse_action(lambda toks: toks[0].title())
print(wd.transform_string("now is the winter of our discontent made glorious summer by this sun of york."))
prints::
Now Is The Winter Of Our Discontent Made Glorious Summer By This Sun Of York.
r Tr Nr )r r r rz r# r r r& r joinr rT r r r r )
r0 r r outlastEr r r] or s
r2 transform_string ParserElement.transform_string s" (
/ ++H+Ba
8!,-!!\22yy{*#Ax00Ax9P9P
1
1
C
JJx' ( !'cQ1cC'77HSM:MqCFM:; ; (:! / // ((.. /s< CD"
D D"D" <D D"
D" "
E,'EEc
[ XB5 n [ U R XUS9 VVVs/ s H u pVouPM snnn5 $ s snnnf ! [ a, n[ R
( a e UR
S5 eSnAff = f)a<
Another extension to :class:`scan_string`, simplifying the access to the tokens found
to match the given parse expression. May be called with optional
``max_matches`` argument, to clip searching after 'n' matches are found.
Example::
# a capitalized word starts with an uppercase letter, followed by zero or more lowercase letters
cap_word = Word(alphas.upper(), alphas.lower())
print(cap_word.search_string("More than Iron, more than Lead, more than Gold I need Electricity"))
# the sum() builtin can be used to merge results into a single ParseResults object
print(sum(cap_word.search_string("More than Iron, more than Lead, more than Gold I need Electricity")))
prints::
[['More'], ['Iron'], ['Lead'], ['Gold'], ['I'], ['Electricity']]
['More', 'Iron', 'Lead', 'Gold', 'I', 'Electricity']
r N)r r# r r r r r ) r0 r r r r r r r] r s r2
search_stringParserElement.search_string3 sz 8 1
/ "&"2"28u"2"UV"UwqQ"UV
V! / // ((.. /s% A = A A
A:'A55A:)includeSeparatorsmaxsplitinclude_separatorsc # # U=( d UnSnU R XS9 H u pgnXU v U( a US v UnM XS v g7f)a
Generator method to split a string using the given expression as a separator.
May be called with optional ``maxsplit`` argument, to limit the number of splits;
and the optional ``include_separators`` argument (default= ``False``), if the separating
matching text should be included in the split results.
Example::
punc = one_of(list(".,;:/-!?"))
print(list(punc.split("This, this?, this sentence, is badly punctuated!")))
prints::
['This', ' this', '', ' this sentence', ' is badly punctuated', '']
r )r N)r ) r0 r r r r lastr r r] s r2 rN ParserElement.split[ s] . . C1C'''GGA!" " d
D H
uo s AAc U[ L a [ U 5 $ [ U[ 5 ( a U R U5 n[ U[
5 ( d [ $ [ X/5 $ )a
Implementation of ``+`` operator - returns :class:`And`. Adding strings to a :class:`ParserElement`
converts them to :class:`Literal`\ s by default.
Example::
greet = Word(alphas) + "," + Word(alphas) + "!"
hello = "Hello, World!"
print(hello, "->", greet.parse_string(hello))
prints::
Hello, World! -> ['Hello', ',', 'World', '!']
``...`` may be used as a parse expression as a short form of :class:`SkipTo`::
Literal('start') + ... + Literal('end')
is equivalent to::
Literal('start') + SkipTo('end')("_skipped*") + Literal('end')
Note that the skipped text is returned with '_skipped' as a results name,
and to support having multiple skips in the same parser, the value returned is
a list of all skipped text.
)Ellipsis _PendingSkiprz r& r r NotImplementedAndr0 others r2 __add__ParserElement.__add__{ sT 6 H % % eX & &,,U3E% //! !D=!!r5 c U[ L a [ U 5 " S5 U - $ [ U[ 5 ( a U R U5 n[ U[
5 ( d [ $ X- $ )zT
Implementation of ``+`` operator when left operand is not a :class:`ParserElement`
_skipped*)r SkipTorz r& r r r r s r2 __radd__ParserElement.__radd__ sX H $< ,t3 3 eX & &,,U3E% //! !|r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ U [
R
5 - U- $ )zH
Implementation of ``-`` operator, returns :class:`And` with error stop
)rz r& r r r r
_ErrorStopr s r2 __sub__ParserElement.__sub__ sK eX & &,,U3E% //! !cnn&&..r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ X-
$ )zT
Implementation of ``-`` operator when left operand is not a :class:`ParserElement`
rz r& r r r r s r2 __rsub__ParserElement.__rsub__ < eX & &,,U3E% //! !|r5 c ^ ^ U[ L a SnO1[ U[ 5 ( a USS [ 4:X a SUSS - S- SS n[ U[ 5 ( a USp2O[ U[ 5 ( a [ S U 5 5 nUS - SS nUS c SUS 4n[ US [ 5 ( aB US c< US S:X a [ T 5 $ US S:X a [ T 5 $ T US - [ T 5 - $ [ US [ 5 ( a! [ US [ 5 ( a Uu p#X2- nO [ $ [ $ US: a [ S
5 eUS: a [ S 5 eX#s=:X a S:X a O O [ / 5 $ U( aG UU 4S jmU( a. US:X a
T T" U5 - nU$ [ T /U- 5 T" U5 - n U$ T" U5 n U$ US:X a T nU$ [ T /U- 5 nU$ )
ae
Implementation of ``*`` operator, allows use of ``expr * 3`` in place of
``expr + expr + expr``. Expressions may also be multiplied by a 2-integer
tuple, similar to ``{min, max}`` multipliers in regular expressions. Tuples
may also include ``None`` as in:
- ``expr*(n, None)`` or ``expr*(n, )`` is equivalent
to ``expr*n + ZeroOrMore(expr)``
(read as "at least n instances of ``expr``")
- ``expr*(None, n)`` is equivalent to ``expr*(0, n)``
(read as "0 to n instances of ``expr``")
- ``expr*(None, None)`` is equivalent to ``ZeroOrMore(expr)``
- ``expr*(1, None)`` is equivalent to ``OneOrMore(expr)``
Note that ``expr*(None, n)`` does not raise an exception if
more than n exprs exist in the input stream; that is,
``expr*(None, n)`` does not enforce a maximum number of expr
occurrences. If this behavior is desired, then write
``expr*(None, n) + ~expr``
)r NNr )r r- rn r c 3 : # U H o[ La UOS v M g 7fr- )r )rP r s r2 r (ParserElement.__mul__.. s JEq 0!d:Es )NNz/cannot multiply ParserElement by negative valuez@second tuple value must be greater or equal to first tuple valuec T > U S: a [ TT" U S-
5 - 5 $ [ T5 $ rd )Opt)nmakeOptionalListr0 s r2 r /ParserElement.__mul__..makeOptionalList s. q5 t&6q1u&= =>> t9$r5 ) r rz tupler
ZeroOrMore OneOrMorer
ValueErrorr )r0 r minElements optElementsr; r s ` @r2 __mul__ParserElement.__mul__ s * H E
u
%
%%){*BE!"I%/!4E eS ! !',a
u
%
%JEJJE\)2A.EQx E!H
%(C((U1X-=8q=%d++8q=$T?* %(?Z-===E!Hc**z%(C/H/H+0( * %%! ! ? NO O ? R
* *r7N
% !# !1+!>>C
tf{ 236F{6SSC
'{3
a
4&;./
r5 c $ U R U5 $ r- )r r s r2 __rmul__ParserElement.__rmul__ s ||E""r5 c U[ L a
[ U SS9$ [ U[ 5 ( a" US:X a [ U 5 $ U R U5 n[ U[ 5 ( d [ $ [ X/5 $ )z@
Implementation of ``|`` operator - returns :class:`MatchFirst`
T) must_skipr ) r r rz r& r r r r
MatchFirstr s r2 __or__ParserElement.__or__ sg H 5 5 eX & &{4y ,,U3E% //! !4-((r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ X- $ )zT
Implementation of ``|`` operator when left operand is not a :class:`ParserElement`
r r s r2 __ror__ParserElement.__ror__" r r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ [ X/5 $ )z8
Implementation of ``^`` operator - returns :class:`Or`
)rz r& r r r Orr s r2 __xor__ParserElement.__xor__, sA eX & &,,U3E% //! !4- r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ X- $ )zT
Implementation of ``^`` operator when left operand is not a :class:`ParserElement`
r r s r2 __rxor__ParserElement.__rxor__6 r r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ [ X/5 $ )z:
Implementation of ``&`` operator - returns :class:`Each`
)rz r& r r r Eachr s r2 __and__ParserElement.__and__@ sA eX & &,,U3E% //! !TM""r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ X- $ )zT
Implementation of ``&`` operator when left operand is not a :class:`ParserElement`
r r s r2 __rand__ParserElement.__rand__J r r5 c [ U 5 $ )z<
Implementation of ``~`` operator - returns :class:`NotAny`
)NotAnyr0 s r2
__invert__ParserElement.__invert__T s d|r5 c Sn[ 5 n[ U[ 5 ( a UR UR p1Uc SnSnOQ[ U[
5 ( a< [ US [ 5 ( a$ US US R 4US R p1Sn[ U[ 5 ( a U4n [ U5 [ U5 S: a2 [ S USS
[ U5 S
: a S [ U5 S 3OS
S35 eU [ USS 5 - n[ R " [ U5 nU( a UR U5 U$ ! [ a X4n Nf = f)a
use ``[]`` indexing notation as a short form for expression repetition:
- ``expr[n]`` is equivalent to ``expr*n``
- ``expr[m, n]`` is equivalent to ``expr*(m, n)``
- ``expr[n, ...]`` or ``expr[n,]`` is equivalent
to ``expr*n + ZeroOrMore(expr)``
(read as "at least n instances of ``expr``")
- ``expr[..., n]`` is equivalent to ``expr*(0, n)``
(read as "0 to n instances of ``expr``")
- ``expr[...]`` and ``expr[0, ...]`` are equivalent to ``ZeroOrMore(expr)``
- ``expr[1, ...]`` is equivalent to ``OneOrMore(expr)``
``None`` may be used in place of ``...``.
Note that ``expr[..., n]`` and ``expr[m, n]`` do not raise an exception
if more than ``n`` ``expr``\ s exist in the input stream. If this behavior is
desired, then write ``expr[..., n] + ~expr``.
For repetition with a stop_on expression, use slice notation:
- ``expr[...: end_expr]`` and ``expr[0, ...: end_expr]`` are equivalent to ``ZeroOrMore(expr, stop_on=end_expr)``
- ``expr[1, ...: end_expr]`` is equivalent to ``OneOrMore(expr, stop_on=end_expr)``
FN.Tr r r rn z'only 1 or 2 index arguments supported (rp z... []r ))NoMatchrz slicer stopr r& iterr re r r _MultipleMatchstopOn)r0 keystop_on_definedstop_onr; s r2 __getitem__ParserElement.__getitem__^ sC 6 ) c5 ! ! 99chh{ "O
U
#
#
3r7E(B(B FCFLL13q6;; "O c8 $ $&C I s8a<9#bq'Z]^aZbefZfU3s8*TUCVlnBoopq
U3r7^#kk.#. JJw
*C s + D= =
E
E
c J Ub U R U5 $ U R 5 $ )a
Shortcut for :class:`set_results_name`, with ``list_all_matches=False``.
If ``name`` is given with a trailing ``'*'`` character, then ``list_all_matches`` will be
passed as ``True``.
If ``name`` is omitted, same as calling :class:`copy`.
Example::
# these are equivalent
userdata = Word(alphas).set_results_name("name") + Word(nums + "-").set_results_name("socsecno")
userdata = Word(alphas)("name") + Word(nums + "-")("socsecno")
)r+ r% r0 r\ s r2 __call__ParserElement.__call__ s' ''- -99; r5 c [ U 5 $ )zv
Suppresses the output of this :class:`ParserElement`; useful to keep punctuation from
cluttering up returned output.
)Suppressr5 s r2 suppressParserElement.suppress s
~ r5 recursivec SU l U $ )z
Enables the skipping of whitespace before matching the characters in the
:class:`ParserElement`'s defined pattern.
:param recursive: If ``True`` (the default), also enable whitespace skipping in child elements (if any)
Tr r0 rN s r2 ignore_whitespace ParserElement.ignore_whitespace s # r5 c SU l U $ )aT
Disables the skipping of whitespace before matching the characters in the
:class:`ParserElement`'s defined pattern. This is normally only used internally by
the pyparsing module, but may be needed in some whitespace-sensitive grammars.
:param recursive: If true (the default), also disable whitespace skipping in child elements (if any)
FrP rQ s r2 leave_whitespace ParserElement.leave_whitespace s $ r5
copy_defaultsc @ SU l [ U5 U l X l U $ )z(
Overrides the default whitespace chars
T)r r r r )r0 r rW s r2 set_whitespace_chars"ParserElement.set_whitespace_chars s" # e*%2" r5 c SU l U $ )z
Overrides default behavior to expand ```` s to spaces before parsing the input string.
Must be called before ``parse_string`` when the input grammar contains elements that
match ```` characters.
T)r r5 s r2 parse_with_tabs ParserElement.parse_with_tabs s
r5 c 4 SSK n[ U[ 5 ( a [ U5 n[ U[ 5 ( a, XR ; a U R R U5 U $ U R R [ UR
5 5 5 U $ )a
Define expression to be ignored (e.g., comments) while doing pattern
matching; may be called repeatedly, to define multiple comment or other
ignorable patterns.
Example::
patt = Word(alphas)[1, ...]
patt.parse_string('ablaj /* comment */ lskjd')
# -> ['ablaj']
patt.ignore(c_style_comment)
patt.parse_string('ablaj /* comment */ lskjd')
# -> ['ablaj', 'lskjd']
r N)r rz r& rK r
r r% )r0 r r s r2 ignoreParserElement.ignore sw eX & & UOE eX & & , ,, ''.
# #HUZZ\$: ; r5 start_actionsuccess_actionexception_actionc U R U=( d [ U=( d [ U=( d [ 5 U l SU l U $ )a
Customize display of debugging messages while doing pattern matching:
- ``start_action`` - method to be called when an expression is about to be parsed;
should have the signature ``fn(input_string: str, location: int, expression: ParserElement, cache_hit: bool)``
- ``success_action`` - method to be called when an expression has successfully parsed;
should have the signature ``fn(input_string: str, start_location: int, end_location: int, expression: ParserELement, parsed_tokens: ParseResults, cache_hit: bool)``
- ``exception_action`` - method to be called when expression fails to parse;
should have the signature ``fn(input_string: str, location: int, expression: ParserElement, exception: Exception, cache_hit: bool)``
T)r r r r r r )r0 ra rb rc s r2 set_debug_actions ParserElement.set_debug_actions s@ $ ! - - 7 7 ; ; ? ?
r5 flagr c U( a) U R 5 H nUR USS9 M U $ U( a! U R [ [ [
5 U $ SU l U $ )a
Enable display of debugging messages while doing pattern matching.
Set ``flag`` to ``True`` to enable, ``False`` to disable.
Set ``recurse`` to ``True`` to set the debug flag on this expression and all sub-expressions.
Example::
wd = Word(alphas).set_name("alphaword")
integer = Word(nums).set_name("numword")
term = wd | integer
# turn on debugging for wd
wd.set_debug()
term[1, ...].parse_string("abc 123 xyz 890")
prints::
Match alphaword at loc 0(1,1)
Matched alphaword -> ['abc']
Match alphaword at loc 3(1,4)
Exception raised:Expected alphaword (at char 4), (line:1, col:5)
Match alphaword at loc 7(1,8)
Matched alphaword -> ['xyz']
Match alphaword at loc 11(1,12)
Exception raised:Expected alphaword (at char 12), (line:1, col:13)
Match alphaword at loc 15(1,16)
Exception raised:Expected alphaword (at char 15), (line:1, col:16)
The output shown is that produced by the default debug actions - custom debug actions can be
specified using :class:`set_debug_actions`. Prior to attempting
to match the ``wd`` expression, the debugging message ``"Match at loc (,)"``
is shown. Then if the parse succeeds, a ``"Matched"`` message is shown, or an ``"Exception raised"``
message is shown. Also note the use of :class:`set_name` to assign a human-readable name to the expression,
which makes debugging and exception messages easier to understand - for instance, the default
name created for the :class:`Word` expression without calling ``set_name`` is ``"W:(A-Za-z)"``.
F)r )r" set_debugre r r r r )r0 rg r r s r2 ri ParserElement.set_debug s] L (tU3 )K " "+-/
DJ r5 c ^ U R c U R 5 U l U R $ r- )r _generateDefaultNamer5 s r2 default_nameParserElement.default_nameI s+ $ $ 9 9 ;D r5 c g)zW
Child classes must define this method, which defines how the ``default_name`` is set.
NrB r5 s r2 rl "ParserElement._generateDefaultNameO r r5 c Xl SU R - U l [ R ( a U R 5 U $ )a6
Define name for this expression, makes debugging and exception messages clearer.
Example::
Word(nums).parse_string("ABC") # -> Exception: Expected W:(0-9) (at char 0), (line:1, col:1)
Word(nums).set_name("integer").parse_string("ABC") # -> Exception: Expected integer (at char 0), (line:1, col:1)
Expected )r r\ r rS rh ri rG s r2 set_nameParserElement.set_nameU s1 !DII- 5 5 NN r5 c L U R b U R $ U R $ r- )r rm r5 s r2 r\ ParserElement.named s" #'//"=tT4CTCTTr5 c U R $ r- r\ r5 s r2 __str__ParserElement.__str__i s yyr5 c [ U 5 $ r- rT r5 s r2 __repr__ParserElement.__repr__l s 4yr5 c " SU l S U l U $ NT)r r r5 s r2 r ParserElement.streamlineo s r5 c / $ r- rB r5 s r2 r ParserElement.recurset r5 c f US S U /- nU R 5 H nUR U5 M g r- )r _checkRecursionr0 parseElementListsubRecCheckListr] s r2 r ParserElement._checkRecursionw s1 *1-6 A
o . r5 c Z [ R " S[ SS9 U R / 5 g)zZ
Check defined expressions for valid structure, check for infinite recursive definitions.
ZParserElement.validate() is deprecated, and should not be used to check for left recursionrn
stacklevelN)warningsrV DeprecationWarningr )r0
validateTraces r2 validateParserElement.validate| s)
h
R r5 file_or_filenameencodingc U=( d Un [ R " [ U5 nUR 5 n U R WU5 $ ! [ aU [ R " [
U5 n[
USUS9 nUR 5 nSSS5 M_ ! , ( d f Nn= ff = f! [ a, n[ R ( a e UR S5 eSnAff = f)z
Execute the parse expression on the given file or filename.
If a filename is specified (instead of a file object),
the entire file is opened, read, and closed before parsing.
rr N) r r r readAttributeErrorrT openr r r r r )r0 r r r r
file_contentsfr s r2
parse_fileParserElement.parse_file s (y ) %{{63C D , 1 1 3M
/$$]H= = ) %{{30@ A &h?1 !
@??? ) " / // ((.. /s@ +A B- 0B*;B B*
B& !B*&B*-
C#7'C C#c XL a g[ U[ 5 ( a U R USS9$ [ U[ 5 ( a [ U 5 [ U5 :H $ g)NTr F)rz r& r r varsr s r2 __eq__ParserElement.__eq__ sM =
x
(
(<<<6 6
}
-
-:e, ,r5 c [ U 5 $ r- )idr5 s r2 __hash__ParserElement.__hash__ s $xr5 test_stringc n U=( a Un U R [ U5 US9 g! [ a gf = f)a
Method for quick testing of a parser against a test string. Good for simple
inline microtests of sub expressions while building up larger parser.
Parameters:
- ``test_string`` - to test against this expression for a match
- ``parse_all`` - (default= ``True``) - flag to pass to :class:`parse_string` when running tests
Example::
expr = Word(nums)
assert expr.matches("100")
r TF)r rT r )r0 r r r s r2 r ParserElement.matches s@ " ) c+ .( C! s '
44)r fullDump printResults failureTestsrr testscomment full_dump
print_results
failure_tests
post_parsefilewith_line_numbersr r r rr c
SSK Jn U
=( a Un
U =( a Un U =( a Un U
=( d Un
U=( d Un[ U[ 5 ( ad [ R
" [ U5 n[ U5 R nUR 5 R 5 Vs/ s H nU" U5 PM
nnUSLnU( a; [ U[ 5 ( a& [ R
" [ U5 n[ U5 n[ R
" [ U5 nUc [ R nUR n/ n/ nSn[ S5 R! [# S5 5 R% [& 5 nSnU GH nU( a UR) US5 ( d U( a2 U( d+ UR+ U ( a UR- U5 OU5 M[ U( d Md U( a SSR/ U5 - OS U ( a UR- U5 OU/n/ n UR1 UR3 U5 5 nU R5 UU
S
9nU=( a U
( + nUb} U" UU5 n U bP [ U [6 5 ( a UR+ U R9 5 5 OZUR+ [
U 5 5 O?UR+ UR9 5 5 O UR+ UR9 U S 95 UR+ S 5 U ( a U" SR/ U5 5 UR+ UU45 GM UU4$ s snf ! [: a^ n UR+ UR9 U S 95 UR+ UR< S [ U 5 R< S
U 35 Sn A NSn A ff = f! [> a n [ U [@ 5 ( a SOS n UR+ U RC 5 5 UR+ S[
U 5 - 5 [ RD ( a/ URG [H RJ " U RL 5 5 U=( a U
nU n Sn A GNqSn A f[: a n UR+ S[ U 5 R< S
U 35 [ RD ( a/ URG [H RJ " U RL 5 5 U=( a U
nU n Sn A GNSn A ff = f)a
Execute the parse expression on a series of test strings, showing each
test, the parsed results or where the parse failed. Quick and easy way to
run a parse expression against a list of sample strings.
Parameters:
- ``tests`` - a list of separate test strings, or a multiline string of test strings
- ``parse_all`` - (default= ``True``) - flag to pass to :class:`parse_string` when running tests
- ``comment`` - (default= ``'#'``) - expression for indicating embedded comments in the test
string; pass None to disable comment filtering
- ``full_dump`` - (default= ``True``) - dump results as list followed by results names in nested outline;
if False, only dump nested list
- ``print_results`` - (default= ``True``) prints test output to stdout
- ``failure_tests`` - (default= ``False``) indicates if these tests are expected to fail parsing
- ``post_parse`` - (default= ``None``) optional callback for successful parse results; called as
`fn(test_string, parse_results)` and returns a string to be added to the test output
- ``file`` - (default= ``None``) optional file-like object to which test output will be written;
if None, will default to ``sys.stdout``
- ``with_line_numbers`` - default= ``False``) show test strings with line and column numbers
Returns: a (success, results) tuple, where success indicates that all tests succeeded
(or failed if ``failure_tests`` is True), and the results contain a list of lines of each
test's output
Example::
number_expr = pyparsing_common.number.copy()
result = number_expr.run_tests('''
# unsigned integer
100
# negative integer
-100
# float with scientific notation
6.02e23
# integer with scientific notation
1e-12
''')
print("Success" if result[0] else "Failed!")
result = number_expr.run_tests('''
# stray character
100Z
# missing leading digit before '.'
-.100
# too many '.'
3.14.159
''', failure_tests=True)
print("Success" if result[0] else "Failed!")
prints::
# unsigned integer
100
[100]
# negative integer
-100
[-100]
# float with scientific notation
6.02e23
[6.02e+23]
# integer with scientific notation
1e-12
[1e-12]
Success
# stray character
100Z
^
FAIL: Expected end of text (at char 3), (line:1, col:4)
# missing leading digit before '.'
-.100
^
FAIL: Expected {real number with scientific notation | real number | signed integer} (at char 0), (line:1, col:1)
# too many '.'
3.14.159
^
FAIL: Expected end of text (at char 4), (line:1, col:5)
Success
Each test string must be on a single line. If you want to test a string that spans multiple
lines, create a test like this::
expr.run_tests(r"this is a test\n of strings that spans \n 3 lines")
(Note that this is a raw string literal, you must include the leading ``'r'``.)
r )pyparsing_testNT\n
u Fr r )fullz failed: : z(FATAL)zFAIL: zFAIL-EXCEPTION: )'testingr rz r& r r rT r striprstrip
splitlinesLiteralr sysstdoutwriterQ replace_withr_
quoted_stringr r r r r lstripr r# dumpry r8 r r explainr r r format_tbr )!r0 r r r r r r r r r r r r r rr r
line_strip test_linecomment_specifiedprint_
allResultscommentssuccessNLBOMr r r pp_valuer] r r r s! r2 run_testsParserElement.run_tests s b ,) ) #5
#4} + eX & &KKU+E e**J%>(ST;LN44Q7RS .6tyy**B7H003aC H$
;''
6 **1*A "6,&6 (
#,Q#7#/ )(L A A #
8==? ; #
3x= 9 JJv{{} 5 JJv{{{ 9: JJrNtyy~& q&k *o r
""U Yx %
6;;H;#=>
( 1 1 2)DG, , and tags to embed
the resulting HTML in an enclosing HTML source
- ``head`` - str containing additional HTML to insert into the section of the generated code;
can be used to insert custom CSS styling
- ``body`` - str containing additional HTML to insert at the beginning of the section of the
generated code
Additional diagram-formatting keyword arguments can also be included;
see railroad.Diagram class.
r ) to_railroadrailroad_to_htmlzMmust ``pip install pyparsing[diagrams]`` to generate parser railroad diagramsN)r r r diagram_kwargswutf-8r r ) diagramr r ImportErrorry r rz rT r r r ) r0 r r r r r rM r r ierailroad diag_files r2 create_diagram ParserElement.create_diagram s @ >
1#!
kC; / /k39Y 0 Q Q& QR :9
.x Ou O O P' _
:9s# B
B'
B$ B B$'
B5c g r- rB rB r5 r2 inlineLiteralsUsing!ParserElement.inlineLiteralsUsing "r5 c g r- rB rB r5 r2 setDefaultWhitespaceChars'ParserElement.setDefaultWhitespaceChars s %(r5 c g r- rB r5 s r2 setResultsName ParserElement.setResultsName !r5 c g r- rB r5 s r2 setBreakParserElement.setBreak r5 c g r- rB r5 s r2 setParseAction ParserElement.setParseAction r r5 c g r- rB r5 s r2 addParseAction ParserElement.addParseAction r r5 c g r- rB r5 s r2 addConditionParserElement.addCondition r5 c g r- rB r5 s r2
setFailActionParserElement.setFailAction r5 c g r- rB r5 s r2 tryParseParserElement.tryParse r r5 c g r- rB rB r5 r2 enableLeftRecursion!ParserElement.enableLeftRecursion r r5 c g r- rB rB r5 r2
enablePackratParserElement.enablePackrat s r5 c g r- rB r5 s r2 parseStringParserElement.parseString s r5 c g r- rB r5 s r2
scanStringParserElement.scanString s r5 c g r- rB r5 s r2 transformString ParserElement.transformString "r5 c g r- rB r5 s r2 searchStringParserElement.searchString r r5 c g r- rB r5 s r2 ignoreWhitespace ParserElement.ignoreWhitespace #r5 c g r- rB r5 s r2 leaveWhitespace ParserElement.leaveWhitespace r r5 c g r- rB r5 s r2 setWhitespaceChars ParserElement.setWhitespaceChars s "%r5 c g r- rB r5 s r2
parseWithTabsParserElement.parseWithTabs r r5 c g r- rB r5 s r2 setDebugActions ParserElement.setDebugActions r r5 c g r- rB r5 s r2 setDebugParserElement.setDebug r r5 c g r- rB r5 s r2 setNameParserElement.setName r5 c g r- rB r5 s r2 parseFileParserElement.parseFile s r5 c g r- rB r5 s r2 runTestsParserElement.runTests r r5 )r r? r r r r r r r r r
r r
r r r r r r r r r Fr` r Tr> r_ r- ) )r r r` r )TF)r F)T#TTFNNF)r' FFF)r8 r> r? r@ rH r rT r r r r r staticmethodr r rj r r r r3 rl r r" r% r, r+ rA ParseActionrN rQ ParseConditionrU ParseFailActionrX r ra rh rl rr r r# r r r r recursion_lockr r Dictr
ry dictr r r r r r? r r r r r r r r _MAX_INTr r r r rN r r r r r r r r# r' r* r. r1 r6 __iter__rD rH rL rR rU r
rY r\ r_ r r r re ri propertyrm r rl rs r\ ry r} r r r r r r r r r r r r r r r! r r r r r r r r r r
r
r r r r r r! r$ r' r* r- r0 r4 r7 canParseNextr defaultNamerA rB r5 r2 r r s
3 (( $$ $$-C -D - -( 04 0D 0 0* = =:z :
8 88[ _ "< 38 :SX : :+/ :LP : :B D O .T[ T Tl
[
#. # #J/ o # #
3
3
;?d sL !d V "
C
C
C
C
C
C s $ SW WN V[[
c9d"#U3lI6M0N+N%OO T a&
;?/$ sL !/$b F. . O # ; ; 15-5@E-5 //#.-5
-5 -5^ )=U )= )=d )=t )= )=X 05CJOCC(,CCGC CP $ Y/ "Y/Y/ Y/ Y/
Y/ Y/
5 sC/0$< =Y/v @E ,/ ,/ ,/ ,/b $&/
"
&/&/ &/
&/
&/
&/V !#(
!
3d? # @""H / M^#) ! # H:x V__S 1 _ ( 4 ? $ / BG 3s8S=) :> 8& + /
43d 3D 3_ 3j !c ! !
c
S
_
Uc U U #
o. /
! /
/ T6 12 / / /
/
/< 37LP +/EI
6 @C " #JN(,"'E# ! "IM!E#S$s)^$E# E# ';!<= E#
E#
E# E# OOHc<-@#-E$FGE# oof%E# E# E# E# E# E# ??8S,,?,D#EF!E#"
tT%U<+B%C CDEE F#E#T #( !
5Q64,-5Q 5Q ! 5Q
5Q
5Q
5Qr +," - "23( 4 (&'! (!i !&'! (!&'! (!m$ % o& ' i !+," - "n% & l# $ k" # &'" ("m$ % '(# )#&'" ("*+% ,%o& ' '(" )"i !h j! " i !!L J Kr5 c \ ^ \ rS rSrS S\S\4U 4S jjjrS\4S jrS S jr S r
S r S
r U =r
$ )
r i r r c : > [ TU ] 5 Xl X l g r- )superr3 anchorr )r0 r r r s r2 r3 _PendingSkip.__init__ s
"r5 r` c b [ U R [ 5 - 5 R SS5 $ )Nr ...)rT rM r replacer5 s r2 rl !_PendingSkip._generateDefaultName# s% 4;;()11'5AAr5 c ^ [ U5 R S5 " S5 nT R ( aF S nU 4S jnT R U" 5 R U5 - U" 5 R U5 - U- $ T R U- U- $ )NrP r c U R ( a U R R 5 S/:X a U S U R SS 5 g g )Nr r _skipped)rU r pop)r s r2 r '_PendingSkip.__add__..must_skip* s: zzQZZ%7%7%9bT%A!EE*d+ &Br5 c > U R R 5 SS S/:X a0 U R S5 S[ TR 5 - S- U S' g g )Nr r rU z missing <>)rU r rV reprrM )r r0 s r2 show_skip'_PendingSkip.__add__..show_skip/ sN ::%%',4EE*%$/$t{{2C$Cc$IAjM 5r5 )r rs r rM rQ )r0 r skipperr r[ s ` r2 r _PendingSkip.__add__& s -((/ < >>
,
J gi 8 8 CC),,Y78
{{W$u,,r5 c U R $ r- )rI r5 s r2 r} _PendingSkip.__repr__; s r5 c [ S5 e)NzBuse of `...` expression without following SkipTo target expression)ry r s r2 rl _PendingSkip.parseImpl> s P
r5 )rM r r9 r: )r8 r> r? r@ r r r3 rT rl r r} rl rA
__classcell__r s @r2 r r s= #] #t # #
Bc B-*
r5 r c : ^ \ rS rSrSrU 4S jrS\4S jrSrU =r $ )TokeniD zQAbstract :class:`ParserElement` subclass, for defining atomic
matching patterns.
c > [ TU ] SS9 g )NFr rL r3 r0 r s r2 r3 Token.__init__I s
%(r5 r` c , [ U 5 R $ r- )r r8 r5 s r2 rl Token._generateDefaultNameL s Dz"""r5 rB )
r8 r> r? r@ rH r3 rT rl rA rc rd s @r2 rf rf D s )#c # #r5 rf c 6 ^ \ rS rSrSrU 4S jrSS jrSrU =r$ )r; iP z
A token that will never match.
c L > [ TU ] 5 SU l SU l SU l g )NTFzUnmatchable token)rL r3 r r
r rj s r2 r3 NoMatch.__init__U s%
" ") r5 c 0 [ XU R U 5 er- )r r rk s r2 rl NoMatch.parseImpl[ s XDKK>>r5 )r r
r r; r8 r> r? r@ rH r3 rl rA rc rd s @r2 r; r; P s * ? ?r5 r; c ^ \ rS rSrSrSSS.S\S\4U 4S jjjjrS rSSS.S\S\4U 4S jjjjrS
\4S jr SS jr
S
r U =r $ )r i_ a
Token to exactly match a specified string.
Example::
Literal('blah').parse_string('blah') # -> ['blah']
Literal('blah').parse_string('blahfooblah') # -> ['blah']
Literal('blah').parse_string('bla') # -> Exception: Expected "blah"
For case-insensitive matching, use :class:`CaselessLiteral`.
For keyword matching (force word break before and after the matched string),
use :class:`Keyword` or :class:`CaselessKeyword`.
r matchString match_stringrv c > U [ L aG U=( d UnU( d [ TU ] [ 5 $ [ U5 S:X a [ TU ] [
5 $ [ TU ] U 5 $ rd )r rL __new__r re _SingleCharLiteral)r[ rw rv r s r2 ry Literal.__new__o sT '>&6,L wu--< A% w'9:: ws##r5 c U R 4$ r- )matchr5 s r2 __getnewargs__Literal.__getnewargs__| s
} r5 c > [ TU ] 5 U=( d UnXl [ U5 U l US S U l SU R - U l SU l SU l g )Nr rr F)
rL r3 r} re matchLenfirstMatchCharr\ r r r
r0 rw rv r s r2 r3 Literal.__init__ sX
"2l !
L)
*2A .!DII- # "r5 r` c , [ U R 5 $ r- rZ r} r5 s r2 rl Literal._generateDefaultName DJJ r5 c X U R :X a; UR U R U5 ( a X R - U R 4$ [ XU R
U 5 er- )r rL r} r r r rk s r2 rl Literal.parseImpl sX =D / / /H4G4G JJ5
5
&
2 2 XDKK>>r5 )r r r} r r
r r r; )
r8 r> r? r@ rH rT ry r~ r3 rl rl rA rc rd s @r2 r r _ sa
$2
$3
$S
$
$ #R #S #s # # c ? ?r5 r c P ^ \ rS rSrSrS
SS.U 4S jjjrS\4S jrS S jrS r U =r
$ ) r i z$
An empty token, will always match.
r ru c @ > [ TU ] S5 SU l SU l g )Nr TFrL r3 r r
r s r2 r3 Empty.__init__ s
" "r5 r` c g)Nr rB r5 s r2 rl Empty._generateDefaultName s r5 c
U/ 4$ r- rB rk s r2 rl Empty.parseImpl rn r5 r
r r r; ) r8 r> r? r@ rH r3 rT rl rl rA rc rd s @r2 r r s/ #r # #
c r5 r c \ rS rSrSS jrSrg)rz i c v X U R :X a US- U R 4$ [ XU R U 5 erd )r r} r r rk s r2 rl _SingleCharLiteral.parseImpl s8 =D / / /7DJJ& & XDKK>>r5 rB Nr; )r8 r> r? r@ rl rA rB r5 r2 rz rz s ?r5 rz c
^ \ rS rSrSr\S- r SSSS.S\S\R \ S \
S
\S \R \ 4
U 4S jjjjr S
\4S jr SS jr
\SS j5 r\rSrU =r$ )Keywordi aR
Token to exactly match a specified string as a keyword, that is,
it must be immediately preceded and followed by whitespace or
non-keyword characters. Compare with :class:`Literal`:
- ``Literal("if")`` will match the leading ``'if'`` in
``'ifAndOnlyIf'``.
- ``Keyword("if")`` will not; it will only match the leading
``'if'`` in ``'if x=1'``, or ``'if(y==2)'``
Accepts two optional constructor arguments in addition to the
keyword string:
- ``ident_chars`` is a string of characters that would be valid
identifier characters, defaulting to all alphanumerics + "_" and
"$"
- ``caseless`` allows case-insensitive matching, default is ``False``.
Example::
Keyword("start").parse_string("start") # -> ['start']
Keyword("start").parse_string("starting") # -> Exception
For case-insensitive matching, use :class:`CaselessKeyword`.
z_$r Nrv
identCharsrw ident_charscaselessrv r c > [ TU ] 5 U=( d UnUc [ R nU=( d UnXl [ U5 U l US U l S[ U 5 R SU R 3U l
SU l SU l X0l U( a% UR# 5 U l UR# 5 n[' U5 U l g ! [ a [ S5 ef = f)Nr z2null string passed to Keyword; use Empty() insteadrr r F)rL r3 r DEFAULT_KEYWORD_CHARSr} re r r rx r r r8 r\ r r r
r upper
caselessmatchr r )r0 rw r r rv r r s r2 r3 Keyword.__init__ s .;
66J"2l !
L)
S".q/D "$t*"5"5!6a {C # "
!-!3!3!5D #))+J j/ S QR R Ss
C C+r` c , [ U R 5 $ r- r r5 s r2 rl Keyword._generateDefaultName r r5 c U R nUnU R ( a XX R - R 5 U R :X a US:X d# XS-
R 5 U R
; aw U[
U5 U R -
: d- XU R - R 5 U R
; a X R - U R 4$ US-
nX R - nOUS-
nUS-
nOX U R :X a U R S:X d! UR U R U5 ( a US:X d XS-
U R
; ai U[
U5 U R -
: d XU R - U R
; a X R - U R 4$ US-
nX R - nO
US-
nUS-
n[ XX@5 e)Nr r z/, was immediately followed by keyword characterz7, keyword was immediately preceded by keyword characterz7, keyword was immediately followed by keyword character) r r r r r r re r} r rL r )r0 r r r8 r errlocs r2 rl Keyword.parseImpl s ==cMM 1288:d>P>PP!8xa 0 6 6 8 Os8}t}} <<#$--$78>>@W "]] 2DJJ >> "SS!$}}!4 WWF 1WF
!4!44MMQ&&&tzz377!8xa 0 Gs8}t}} <<#$--$78O "]] 2DJJ >> U "%}}!4 WWF 1WF Xv< r? r@ rH alphanumsr rT r r r r3 rl rl r> r setDefaultKeywordCharsrA rc rd s @r2 r r s 4 & , ,0 * +/** __S)* *
* OOC(* *: c -=^ . . 7r5 r c N ^ \ rS rSrSrS
SS.S\S\4U 4S jjjjrS S jrS rU =r $ ) CaselessLiterali%
aQ
Token to match a specified string, ignoring case of letters.
Note: the matched results will always be in the case of the given
match string, NOT the case of the input text.
Example::
CaselessLiteral("CMD")[1, ...].parse_string("cmd CMD Cmd10")
# -> ['CMD', 'CMD', 'CMD']
(Contrast with example for :class:`CaselessKeyword`.)
r ru rw rv c > U=( d Un[ TU ] UR 5 5 Xl SU R - U l g )Nrr )rL r3 r returnStringr\ r r s r2 r3 CaselessLiteral.__init__3
s9 "2l
++-. (!DII- r5 c XX R - R 5 U R :X a X R - U R 4$ [ XU R
U 5 er- )r r r} r r r rk s r2 rl CaselessLiteral.parseImpl:
sN #
- . 4 4 6$** D &(9(99 9 XDKK>>r5 )r r r r; )
r8 r> r? r@ rH rT r3 rl rA rc rd s @r2 r r %
s1 .R .S .s . .? ?r5 r c ^ \ rS rSrSr S SSS.S\S\R \ S\S \R \ 4U 4S
jjjjrS r U =r
$ )
CaselessKeywordi@
z
Caseless version of :class:`Keyword`.
Example::
CaselessKeyword("CMD")[1, ...].parse_string("cmd CMD Cmd10")
# -> ['CMD', 'CMD']
(Contrast with example for :class:`CaselessLiteral`.)
r Nr rw r rv r c N > U=( d UnU=( d Un[ TU ] XSS9 g )NT)r ri )r0 rw r rv r r s r2 r3 CaselessKeyword.__init__L
s+ .;
"2l
DAr5 rB )r N) r8 r> r? r@ rH rT r r r3 rA rc rd s @r2 r r @
sf ,0
B
+/
B
B __S)
B
B OOC(
B
Br5 r c ~ ^ \ rS rSrSr SSSS.S\S\R \ S\4U 4S jjjjr S
\4S jr
SS jr S
r U =r
$ )
CloseMatchiY
a A variation on :class:`Literal` which matches "close" matches,
that is, strings with at most 'n' mismatching characters.
:class:`CloseMatch` takes parameters:
- ``match_string`` - string to be matched
- ``caseless`` - a boolean indicating whether to ignore casing when comparing characters
- ``max_mismatches`` - (``default=1``) maximum number of
mismatches allowed to count as a match
The results from a successful parse will contain the matched text
from the input string and the following named results:
- ``mismatches`` - a list of the positions within the
match_string where mismatches were found
- ``original`` - the original match_string used to compare
against the input string
If ``mismatches`` is an empty list, then the match was an exact
match.
Example::
patt = CloseMatch("ATCATCGAATGGA")
patt.parse_string("ATCATCGAAXGGA") # -> (['ATCATCGAAXGGA'], {'mismatches': [[9]], 'original': ['ATCATCGAATGGA']})
patt.parse_string("ATCAXCGAAXGGA") # -> Exception: Expected 'ATCATCGAATGGA' (with up to 1 mismatches) (at char 0), (line:1, col:1)
# exact match
patt.parse_string("ATCATCGAATGGA") # -> (['ATCATCGAATGGA'], {'mismatches': [[]], 'original': ['ATCATCGAATGGA']})
# close match allowing up to 2 mismatches
patt = CloseMatch("ATCATCGAATGGA", max_mismatches=2)
patt.parse_string("ATCAXCGAAXGGA") # -> (['ATCAXCGAAXGGA'], {'mismatches': [[4, 9]], 'original': ['ATCATCGAATGGA']})
r F)
maxMismatchesr rw max_mismatchesr c > Ub UOUn[ TU ] 5 Xl X0l SU R < SU R S3U l X@l SU l SU l g )Nrr z
(with up to z mismatches)F)rL r3 rw r r r r
r )r0 rw r r r r s r2 r3 CloseMatch.__init__|
sb +9*D-
( *!$"3"3!6mDDVDVCWWcd
" #r5 r` c L [ U 5 R SU R < 3$ )Nr~ )r r8 rw r5 s r2 rl CloseMatch._generateDefaultName
s% t*%%&a(9(9'<==r5 c Un[ U5 nU[ U R 5 - nXe:: a U R nSn/ n U R n
[ [ XU U5 5 Hb u pU u pU R
( a U R
5 U
R
5 pX:w d M@ U R U5 [ U 5 U
: d Mb O" XH- S- n[ XU /5 nX~S' XS' X.4$ [ XU R U 5 e)Nr r original
mismatches) re rw r enumeratezipr r r r# r r )r0 r r r8 r rf maxlocrw match_stringlocr r s_msrcmatresultss r2 rl CloseMatch.parseImpl
s x=T . .// ,,L OJ . .M(1H(,7)$ == "yy{CIIK: %%o6: 6 ) -1&s(;'<=&2
#(2 %|# XDKK>>r5 )r r rw r r
r r- r; )r8 r> r? r@ rH rT r r r r3 rl rl rA rc rd s @r2 r r Y
s` J 04$
$$ ,$
$ $">c > ? ?r5 r c ^ \ rS rSrSr SSSSSS.S\S\R \ S\S \S
\S \ S \R \ S
\R \ S\R \ S\ S\R \ 4U 4S jjjjr
S\4S jr SS jr SS jr
SrU =r$ )Wordi
an
Token for matching words composed of allowed character sets.
Parameters:
- ``init_chars`` - string of all characters that should be used to
match as a word; "ABC" will match "AAA", "ABAB", "CBAC", etc.;
if ``body_chars`` is also specified, then this is the string of
initial characters
- ``body_chars`` - string of characters that
can be used for matching after a matched initial character as
given in ``init_chars``; if omitted, same as the initial characters
(default=``None``)
- ``min`` - minimum number of characters to match (default=1)
- ``max`` - maximum number of characters to match (default=0)
- ``exact`` - exact number of characters to match (default=0)
- ``as_keyword`` - match as a keyword (default=``False``)
- ``exclude_chars`` - characters that might be
found in the input ``body_chars`` string but which should not be
accepted for matching ;useful to define a word of all
printables except for one or two characters, for instance
(default=``None``)
:class:`srange` is useful for defining custom character set strings
for defining :class:`Word` expressions, using range notation from
regular expression character sets.
A common mistake is to use :class:`Word` to match a specific literal
string, as in ``Word("Address")``. Remember that :class:`Word`
uses the string argument to define *sets* of matchable characters.
This expression would match "Add", "AAA", "dAred", or any other word
made up of the characters 'A', 'd', 'r', 'e', and 's'. To match an
exact literal string, use :class:`Literal` or :class:`Keyword`.
pyparsing includes helper strings for building Words:
- :class:`alphas`
- :class:`nums`
- :class:`alphanums`
- :class:`hexnums`
- :class:`alphas8bit` (alphabetic characters in ASCII range 128-255
- accented, tilded, umlauted, etc.)
- :class:`punc8bit` (non-alphabetic characters in ASCII range
128-255 - currency, symbols, superscripts, diacriticals, etc.)
- :class:`printables` (any non-whitespace character)
``alphas``, ``nums``, and ``printables`` are also defined in several
Unicode sets - see :class:`pyparsing_unicode``.
Example::
# a word composed of digits
integer = Word(nums) # equivalent to Word("0123456789") or Word(srange("0-9"))
# a word with a leading capital, and zero or more lowercase
capital_word = Word(alphas.upper(), alphas.lower())
# hostnames are alphanumeric, with leading alpha, and '-'
hostname = Word(alphas, alphanums + '-')
# roman numeral (not a strict parser, accepts invalid mix of characters)
roman = Word("IVXLCDM")
# any string of non-whitespace characters, except for ','
csv_value = Word(printables, exclude_chars=",")
NF) initChars bodyChars asKeyword excludeChars
init_chars
body_charsr maxexact
as_keyword
exclude_charsr r r r c > U=( d UnU =( d Un U
=( d Un
U =( d Un [ TU ] 5 U( d" [ S[ U 5 R S35 e[ U5 n U ( a3 [ U 5 n
X- n U ( a SR
[ U 5 U
-
5 n Xl SR
[ U 5 5 U l U ( a0 [ U 5 U l
SR
[ U 5 5 U l OXl
U R U l US: U l US: a [ S5 eU R ( a X4: a [ SU SU S 35 eX0l
US: a X@l O [ U l US: a U=p4XPl XPl
S
U R - U l S U l Xl U R& ( a U =R" S -
sl S
U R U R - ; Ga [) U R 5 S:X a! [* R, " U R 5 nOS[/ U R 5 S3nU R U R :X a| US:X a SnOgUS:X a SnO^U R U R :w a4 SU R SU R [ :X a SO U R S3nOSU R S3nU U 3U l OyUS:X a SnSnOaS[/ U R 5 S3nUS:X a SnO?US:X a US:: a SOSnO.X4:w a SUS: a US-
OS SUS-
S3nOSUS: a US-
OS S3nU U U 3U l U R& ( a SU R0 S3U l [* R2 " U R0 5 U l U R* R4 U l U R8 U l g g ! [* R< a
S U l g f = f)Nzinvalid z", initChars cannot be empty stringr r r zUcannot specify a minimum length < 1; use Opt(Word()) if zero-length word is permittedzDinvalid args, if min and max both specified min must be <= max (min=z, max=r: rr Fz
as a keywordr [r9 +{r }r" rn ?z\b) rL r3 r r r8 r r r sorted
initCharsOrigr
bodyCharsOrig maxSpecifiedminLenmaxLenrE r\ r r
r re reescaper reStringcompiler} re_matchparseImpl_regexrl error)r0 r r r r r r r r r r r
initChars_setexcludeChars_setre_leading_fragmentrepeatre_body_fragmentr s r2 r3
Word.__init__
s + + + #4}
4:..//QR
I
"< 0 -M GGC N5E$E F & WWVM%: ; ^DN!# ):!;D *N!%!3!3D !G 7 g
VWZV[[abeaffgh
7 K"DK 19 C K K!DII- "" >> KK? *K t~~6 74>>"a'&(ii0B0B&C#()*DT^^*T)UUV&W#~~ /!8 FAX F{{dkk1#%dkk]!$++:QBW[WbWb3cce!f#%dkk]"!5#6"7x @
!8')$ F)*+Ednn+U*VVW'X$ax!$ (+qb :')S1W#'!)DAcAgYb%QF')S1W#'!)DB%GF ++0@/AfXN
~~#%dmm_B 7
6 **T]]3 !%
!%!5!5] 8T 88
s %O O21O2r` c S nU R U R :w a* SU" U R 5 SU" U R 5 S3nOSU" U R 5 S3nU R S: d U R [ :w a U R U R :X a( U R S:X a USS $ USU R S3- $ U R [ :X a USU R S 3- $ USU R S
U R S3- $ U$ ) Nc R Sn[ U SS9n [ U 5 U: a U S US-
S- $ U $ )N F) re_escaper' rP )r re )r max_repr_lens r2
charsAsStr-Word._generateDefaultName..charsAsStrl s< L*1>A1v $+>T^^ +DNN34Bz$..7Q6RRSTDDNN34A6D ;;?dkkX 5{{dkk);;!# 8O Bt{{m2"666(4;;-v 6664;;-q
R @@@ r5 c X U R ; a [ XU R U 5 eUnUS-
n[ U5 nU R nX@R
- n[
Xu5 nX': a X U; a US-
nX': a
X U; a M SnX$-
U R : a SnORU R ( a X%: a X U; a SnO1U R ( a US: a XS-
U; d
X%: a
X U; a SnU( a [ XU R U 5 eX!XB 4$ )Nr FTr )
r r r re r r r r r r ) r0 r r r8 r rf bodycharsr throwExceptions r2 rl Word.parseImpl s
= . TB B qx=NN $V&lx} 9 1HC lx} 9 ; $ !N
3>hmy6P !N
^^ QY'94> MY.!% TB BU'''r5 c U R X5 nU( d [ XU R U 5 eUR 5 nX$R 5 4$ r- )r r r r group)r0 r r r8 r s r2 r Word.parseImpl_regex s@ x- TB BjjlLLN""r5 )r r r r r r r r r
r rl r r r )r Nr r r FNr; )r8 r> r? r@ rH rT r r r r r3 rl rl r rA rc rd s @r2 r r
s @H +/ .2v6 +/*. -1v6v6 OOC(v6 v6
v6
v6 v6 s+v6 ??3'v6 ??3'v6 v6 ooc*v6 v6pc 6 (@# #r5 r c
^ \ rS rSrSr S
SSS.S\S\S\R \ S \S
\R \ 4
U 4S jjjjr S r
U =r $ )Chari zA short-cut class for defining :class:`Word` ``(characters, exact=1)``,
when defining a match of any single character in a string of
characters.
FN)r r charsetr r r r c P > U=( d UnU=( d Un[ TU ] USXES9 g )Nr )r r r ri )r0 r r r r r r s r2 r3
Char.__init__ s2 + #4}
1
r5 rB )FN) r8 r> r? r@ rH rT r r r r3 rA rc rd s @r2 r r si !.2
-1
s+
ooc*
r5 r c ^ \ rS rSrSr SSSS.S\S\\R \ 4 S\
S\
S \
S
\
4 U 4S jjjjr \ S 5 r\ S
5 r
\ S 5 rS\4S jrSS jrSS jrSS jrS\S\4S jrSrU =r$ )Regexi aC Token for matching strings that match a given regular
expression. Defined with string specifying the regular expression in
a form recognized by the stdlib Python `re module `_.
If the given regex contains named groups (defined using ``(?P...)``),
these will be preserved as named :class:`ParseResults`.
If instead of the Python stdlib ``re`` module you wish to use a different RE module
(such as the ``regex`` module), you can do so by building your ``Regex`` object with
a compiled RE that was compiled using ``regex``.
Example::
realnum = Regex(r"[+-]?\d+\.\d*")
# ref: https://stackoverflow.com/questions/267399/how-do-you-match-only-valid-roman-numerals-with-a-regular-expression
roman = Regex(r"M{0,4}(CM|CD|D?{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3})")
# named fields in a regex will be returned as named results
date = Regex(r'(?P\d{4})-(?P\d\d?)-(?P\d\d?)')
# the Regex class will accept re's compiled using the regex module
import regex
parser = pp.Regex(regex.compile(r'[0-9]'))
F) asGroupListasMatchpatternflags
as_group_listas_matchr r
c P > [ TU ] 5 U=( d UnU=( d Un[ U[ 5 ( a. U( d [ S5 eSU l U=U l U l X l OR[ US5 ( a6 [ US5 ( a% Xl UR =U l U l X l O [ S5 eSU R - U l SU l
XPl X`l U R ( a U R U l U R ( a U R$ U l gg)zThe parameters ``pattern`` and ``flags`` are passed
to the ``re.compile()`` function as-is. See the Python
`re module `_ module for an
explanation of the acceptable patterns and flags.
z0null string passed to Regex; use Empty() insteadNr r} zCRegex may only be constructed with a string or a compiled RE objectrr F)rL r3 rz r& r _rer r r r@ r r\ r r
r r
parseImplAsGroupListrl parseImplAsMatch)r0 r r r
r r r
r s r2 r3 Regex.__init__ s !2] %X gx ( ( !STTDH+2 2DMDL J
Wi
(
(WWg-F-F H+2?? :DL4= J U
"DII- "& ! 6 6DN << ! 2 2DN r5 c U R ( a U R $ [ R " U R U R 5 $ ! [ R
a [
SU R < S35 ef = f)Nzinvalid pattern (z) passed to Regex)r r r r r r r r5 s r2 r Regex.re sa 8888O
Xzz$,,
;;88
X #4T\\4DDU!VWW
Xs *A
/A9c . U R R $ r- )r r} r5 s r2 r Regex.re_match s ww}} r5 c ( U R S5 S L$ Nr )r r5 s r2 r Regex.mayReturnEmpty s }}R ,,r5 r` c j SR [ U R 5 R SS5 5 $ )NzRe:({})z\\\)formatrZ r rQ r5 s r2 rl Regex._generateDefaultName s) T\\ 2 : :64 HIIr5 c U R X5 nU( d [ XU R U 5 eUR 5 n[ UR 5 5 nUR
5 nU( a UR 5 H u pxXU' M X%4$ r- )r r r r r# r groupdictitems) r0 r r r8 r r; dkvs r2 rl Regex.parseImpl! sr x- TB Bjjl6<<>* A "xr5 c U R X5 nU( d [ XU R U 5 eUR 5 nUR 5 nX%4$ r- )r r r r groupsr0 r r r8 r r; s r2 r Regex.parseImplAsGroupList. sC x- TB Bjjlmmoxr5 c U R X5 nU( d [ XU R U 5 eUR 5 nUnX%4$ r- )r r r r r( s r2 r Regex.parseImplAsMatch7 s= x- TB Bjjlxr5 replc ^ ^ T R ( a [ S5 eT R ( a [ T5 ( a [ S5 eT R ( a U4S jnOUU 4S jnT R U5 $ )a[
Return :class:`Regex` with an attached parse action to transform the parsed
result as if called using `re.sub(expr, repl, string) `_.
Example::
make_html = Regex(r"(\w+):(.*?):").sub(r"<\1>\2")
print(make_html.transform_string("h1:main title:"))
# prints "main title
"
z/cannot use sub() with Regex(as_group_list=True)z:cannot use sub() with a callable with Regex(as_match=True)c , > U S R T5 $ r5 )expand)r r, s r2 r Regex.sub..paU s ay''--r5 c B > TR R TU S 5 $ r5 )r sub)r r, r0 s r2 r r0 Z s ww{{433r5 )r r r
rF rQ )r0 r, r s `` r2 r2 Regex.sub@ s_ MN N < r? r@ rH r r
r RegexFlagr r r3 r) r r rT rl rl r r r r2 rA rc rd s @r2 r r s 6 +, # ,3 " ,3,3 R\\3&',3 ,3
,3 ,3 ,3 ,3\ X X - -Jc J ) )
) )r5 r c L ^ \ rS rSrSr\" S5 r SSSSSSSS.S\S \R \ S
\R \ S \
S \
S
\R \ S\
S\S\R \ S\R \ S\
S\R \ S\
4U 4S jjjjr S\4S jr SS jr
SrU =r$ ) QuotedStringi` a
Token for matching strings that are delimited by quoting characters.
Defined with the following parameters:
- ``quote_char`` - string of one or more characters defining the
quote delimiting string
- ``esc_char`` - character to re_escape quotes, typically backslash
(default= ``None``)
- ``esc_quote`` - special quote sequence to re_escape an embedded quote
string (such as SQL's ``""`` to re_escape an embedded ``"``)
(default= ``None``)
- ``multiline`` - boolean indicating whether quotes can span
multiple lines (default= ``False``)
- ``unquote_results`` - boolean indicating whether the matched text
should be unquoted (default= ``True``)
- ``end_quote_char`` - string of one or more characters defining the
end of the quote delimited string (default= ``None`` => same as
quote_char)
- ``convert_whitespace_escapes`` - convert escaped whitespace
(``'\t'``, ``'\n'``, etc.) to actual whitespace
(default= ``True``)
Example::
qs = QuotedString('"')
print(qs.search_string('lsjdf "This is the quote" sldjf'))
complex_qs = QuotedString('{{', end_quote_char='}}')
print(complex_qs.search_string('lsjdf {{This is the "quote"}} sldjf'))
sql_qs = QuotedString('"', esc_quote='""')
print(sql_qs.search_string('lsjdf "This is the quote with ""embedded"" quotes" sldjf'))
prints::
[['This is the quote']]
[['This is the "quote"']]
[['This is the quote with "embedded" quotes']]
))z\t )r r )z\f )z\r
r NT) quoteCharescCharescQuoteunquoteResults endQuoteCharconvertWhitespaceEscapes
quote_charesc_char esc_quote multilineunquote_resultsend_quote_charconvert_whitespace_escapesr: r; r< r= r> r? c
>^ [ TT ] 5 U =( d Un U
=( d Un
U =( a Un U =( d Un U
=( a Un
U=( d UnUR 5 nU( d [ S5 eU c Un O"U R 5 n U ( d [ S5 eUT l [ U5 T l US T l U T l [ U 5 T l U =( d ST l
U
=( d ST l U T l U
T l
UT l SnSnU
( a X S[ R " U
5 S3-
nSnU ( a> X S[ R " U 5 S3-
nSn[ R " U 5 S - T l [ T R 5 S
: aJ UU S3SR% U 4S j[' [ T R 5 S
-
SS 5 5 5 - S- -
nSn[ R( " S5 T l U( aX [ R, [ R. - T l UU S
[1 T R S 5 U b [1 U 5 OS S3-
nO2UU S
[1 T R S 5 SU b [1 U 5 OS S3-
nSR% [ R " T R 5 SUS[ R " T R 5 /5 T l T R ( a T R ( aj [ R4 " SSR% S T R6 5 5 S[ R " T R 5 S3T R* S9T l OF[ R4 " S[ R " T R 5 S3T R* S9T l [ R4 " T R2 T R* 5 T l T R2 T l T R R< T l ST RB - T l" ST l# ST l$ g ! [ R@ a [ ST R2 < S35 ef = f)Nz%quote_char cannot be the empty stringz)end_quote_char cannot be the empty stringr r (?:r: |z.)z(.)r c 3 ># U HP nS [ R " TR SU 5 S[ R " TR US 5 S3v MR g7f)rH Nz(?!z)))r r r> )rP r r0 s r2 r (QuotedString.__init__.. sX E "))D$5$5bq$9:;3ryyIZIZ[\[]I^?_>``bc Es AAr z(?:[^z])z\n\rz)*r c 3 N # U H n[ R " U5 v M g 7fr- )r r )rP r# s r2 r rK s !D 1"))A,, s #%z)|(z .)|(\n|.)r zinvalid pattern z passed to Regexrr FT)%rL r3 r r r: re quoteCharLenfirstQuoteCharr> endQuoteCharLenr; r< r= r? rC r r escCharReplacePatternr ranger4 r MULTILINEDOTALLr r r ws_mapunquote_scan_rer r} r r r\ r r
r )r0 r@ rA rB rC rD rE rF r: r; r< r= r> r? sep
inner_patternr s ` r2 r3 QuotedString.__init__ s " %X(y';O#5~ $ C)C ! ,*
%%'
DE E %L'--/L !LMM (!$Z #-a=!-$' $5 #Mr %^
$2.F%"
S8)<(=Q ? ?MC S7);( rz r& r5 s r2 rl !QuotedString._generateDefaultName
sU >>T . . .:dnnh3W3W( (:; ;.t~~.>mDL]L]K^__r5 c ^ X T R :H =( a T R X5 =( d S nU( d [ XT R T 5 eUR 5 nUR 5 nT R ( a UT R T R * n[ U[ 5 ( a T R ( a5 SR U 4S jT R R U5 5 5 nO1SR S T R R U5 5 5 nT R ( a& UR! T R T R" 5 nX%4$ )Nr c 3 ># U Ht nUR S 5 ( a TR UR S 5 O:UR S5 ( a UR S5 S OUR S5 v Mv g7f)r rn r r' N)r rU )rP r} r0 s r2 r )QuotedString.parseImpl..
so " &HE !;;q>> EKKN3 !;;q>> #[[^B / "[[^ ,
&Hs A rP r r; rQ r< rO r r
r rC r r: rN r r r r= rV )r NNFTNTr; )r8 r> r? r@ rH rD rU rT r r r r3 rl rl rA rc rd s @r2 r6 r6 ` s/ %L N
OF )-*. $/3+/u# (,)- #-1)- u#u# //#&u# ??3' u#
u#
u# ,u# %)u# u# %u# //#&u# u# ooc* u# #' u# u#n`c ` $ $r5 r6 c p ^ \ rS rSrSr SSS.S\S\S\S\S \4
U 4S
jjjjrS \4S jrSS
jr Sr
U =r $ )
CharsNotIni-
a Token for matching words composed of characters *not* in a given
set (will include whitespace in matched characters if not listed in
the provided exclusion set - see example). Defined with string
containing all disallowed characters, and an optional minimum,
maximum, and/or exact length. The default value for ``min`` is
1 (a minimum value < 1 is not valid); the default values for
``max`` and ``exact`` are 0, meaning no maximum or exact
length restriction.
Example::
# define a comma-separated-value as anything that is not a ','
csv_value = CharsNotIn(',')
print(DelimitedList(csv_value).parse_string("dkls,lsdkjf,s12 34,@!#,213"))
prints::
['dkls', 'lsdkjf', 's12 34', '@!#', '213']
r )notChars not_charsr r r rd c d > [ TU ] 5 SU l U=( d UU l [ U R 5 U l US: a [
S5 eX l US: a X0l O [ U l US: a X@l X@l SU R - U l U R S:H U l SU l
g )NFr zacannot specify a minimum length < 1; use Opt(CharsNotIn()) if zero-length char group is permittedr rr )rL r3 r rd r notCharsSetr r r rE r\ r r r
)r0 re r r r rd r s r2 r3 CharsNotIn.__init__B
s #!-X
t}}- 7 K
7 K"DK 19 K K!DII- "kkQ . "r5 r` c [ U R 5 n[ U5 S: a SU R S S S3$ SU R S3$ )Nr z!W:(
z...)r: )r rd re )r0
not_chars_strs r2 rl CharsNotIn._generateDefaultNamee
sK 24==A
} "$--&12$7 7$-- * *r5 c F U R nX U; a [ XU R U 5 eUnUS-
n[ XPR - [ U5 5 nX&: a X U; a US-
nX&: a
X U; a M X%-
U R : a [ XU R U 5 eX!XR 4$ rd )rg r r r r re r )r0 r r r8 notcharsr maxlens r2 rl CharsNotIn.parseImpll
s ## =H $ TB B qU[[(#h-8lx}H < 1HC lx}H < ; $ TB BU'''r5 )r r r
r r rd rg r )r r r r r; ) r8 r> r? r@ rH rT r r3 rl rl rA rc rd s @r2 rc rc -
sq , !# !#!# !# !#
!# !# !#F+c +( (r5 rc c ^ \ rS rSrSr0 SS_SS_SS_S S
_S S _S
S_SS_SS_SS_SS_SS_SS_SS _S S _S S _S!S"_S#S$_S%S&S'S(S)S*S+.ErS5S,\S-\S.\S/\4U 4S0 jjjrS1\4S2 jr S6S3 jr
S4r U =r $ )7Whitei}
a} Special matching class for matching whitespace. Normally,
whitespace is ignored by pyparsing grammars. This class is included
when some whitespace structures are significant. Define with
a string containing the whitespace characters to be matched; default
is ``" \t\r\n"``. Also takes optional ``min``,
``max``, and ``exact`` arguments, as defined for the
:class:`Word` class.
r zr7 zr zr9 zr8 z zu zu zu z u z u z
u z
u zu zu zu zu zz z zzzz)u u u u u u wsr r r c 8 >^ [ TT ] 5 UT l T R SR U 4S jT R
5 5 SS9 ST l ST R - T l UT l US: a UT l
O [ T l
US: a UT l
UT l g g )Nr c 3 J ># U H oTR ; d M Uv M g 7fr- )
matchWhite)rP cr0 s r2 r !White.__init__..
s J~!$//1IAA~s # #TrW rr r ) rL r3 rw rY r whiteStrsr r\ r r r rE )r0 rt r r r r s ` r2 r3 White.__init__
s
!! GGJt~~J J "
#!DII- 7 DK"DK 19 DK DK r5 r` c F SR S U R 5 5 $ )Nr c 3 H # U H n[ R U v M g 7fr- )rr r{ rP rx s r2 r -White._generateDefaultName..
s C?auq)?s ")r rw r5 s r2 rl White._generateDefaultName
s wwC4??CCCr5 c n X U R ; a [ XU R U 5 eUnUS-
nX@R - n[ U[ U5 5 nX%: a0 X U R ; a US-
nX%: a X U R ; a M X$-
U R : a [ XU R U 5 eX!XB 4$ rd )rw r r r r re r )r0 r r r8 r r s r2 rl White.parseImpl
s = / TB B q$VS]+lx} ? 1HC lx} ? ; $ TB BU'''r5 )r rw r r r )z
r r r r; )
r8 r> r? r@ rH r{ rT r r3 rl rl rA rc rd s @r2 rr rr }
s5 V g
f
f
f (
& / + + , , ( ' & "!" '#$ ! &'/I4 3 s s ,Dc D
(
(r5 rr c ( ^ \ rS rSrU 4S jrSrU =r$ )
PositionTokeni
c > > [ TU ] 5 SU l SU l g r[ r rj s r2 r3 PositionToken.__init__
s
" "r5 r )r8 r> r? r@ r3 rA rc rd s @r2 r r
s
# #r5 r c T ^ \ rS rSrSrS\4U 4S jjrS\S\S\4S jrS S jr S
r
U =r $ )
GoToColumni
zYToken to advance to a specific column of input text; useful for
tabular report scraping.
colnoc . > [ TU ] 5 Xl g r- )rL r3 r )r0 r r s r2 r3 GoToColumn.__init__
s
r5 r r r` c t [ X!5 U R :w a [ U5 nU R ( a U R X5 nX#: al X R 5 ( aU [ X!5 U R :w a< US-
nX#: a2 X R 5 ( a [ X!5 U R :w a M< U$ rd )r re r
ra isspace)r0 r r rf s r2 rh GoToColumn.preParse
s s )8}H **89 M))++&$((2q M))++&$((2
r5 c [ X!5 nX@R : a
[ XSU 5 eX R - U-
nXU nXV4$ )NzText not in expected column)r r )r0 r r r8 thiscolnewlocr; s r2 rl GoToColumn.parseImpl
sH c$ XX 0MtT Txx ')6"{r5 r r; ) r8 r> r? r@ rH r r3 rT rh rl rA rc rd s @r2 r r
s8 c 3 3 r5 r c L ^ \ rS rSrSrU 4S jrS\S\S\4S jrS
S jr S r
U =r $ ) LineStarti
a| Matches if current position is at the beginning of a line within
the parse string
Example::
test = '''\
AAA this line
AAA and this line
AAA but not this one
B AAA and definitely not this one
'''
for t in (LineStart() + 'AAA' + rest_of_line).search_string(test):
print(t)
prints::
['AAA', ' this line']
['AAA', ' and this line']
c > [ TU ] 5 U R 5 [ 5 U R - U l U R R
S5 [ 5 R U R 5 U l SU l
g )Nr zExpected start of line) rL r3 rU r r orig_whiteCharsdiscardr rY r] r rj s r2 r3 LineStart.__init__ s^
"ut 6 % w33DOOD . r5 r r r` c US:X a U$ U R R X5 nSU R ; a6 XUS- S:X a+ U R R XS- 5 nXUS- S:X a M+ U$ )Nr r r )r] rh r )r0 r r r; s r2 rh LineStart.preParse sq !8J,,''6Ct+++ S1W-5 ,,//'BC S1W-5Jr5 c V [ X!5 S:X a U/ 4$ [ XU R U 5 erd )r r r rk s r2 rl LineStart.parseImpl s+ s "7N XDKK>>r5 )r r r] r; ) r8 r> r? r@ rH r3 rT r rh rl rA rc rd s @r2 r r
s1 ,/ 3 3 ? ?r5 r c 6 ^ \ rS rSrSrU 4S jrSS jrSrU =r$ )LineEndi zLMatches if current position is at the end of a line within the
parse string
c > [ TU ] 5 U R R S5 U R U R SS9 SU l g )Nr Frz zExpected end of line)rL r3 r r rY r rj s r2 r3 LineEnd.__init__$ s>
% !!$//!G, r5 c U[ U5 : a& X S:X a US- S4$ [ XU R U 5 eU[ U5 :X a US- / 4$ [ XU R U 5 e)Nr r re r r rk s r2 rl LineEnd.parseImpl* sf X }$Qw}$$XDKKFF
CM
!7B; TB Br5 r r; rs rd s @r2 r r s - C Cr5 r c 6 ^ \ rS rSrSrU 4S jrSS jrSrU =r$ ) StringStarti6 zDMatches if current position is at the beginning of the parse
string
c 0 > [ TU ] 5 SU l g )NzExpected start of textrL r3 r rj s r2 r3 StringStart.__init__; s
. r5 c n US:w a, X R US5 :w a [ XU R U 5 eU/ 4$ r5 )rh r r rk s r2 rl StringStart.parseImpl? s6 !8mmHa00$XDKKFFBwr5 r r; rs rd s @r2 r r 6 s / r5 r c 6 ^ \ rS rSrSrU 4S jrSS jrSrU =r$ )r iG z?
Matches if current position is at the end of the parse string
c 0 > [ TU ] 5 SU l g )NzExpected end of textr rj s r2 r3 StringEnd.__init__L s
, r5 c U[ U5 : a [ XU R U 5 eU[ U5 :X a US- / 4$ U[ U5 : a U/ 4$ [ XU R U 5 erd r rk s r2 rl StringEnd.parseImplP sc X TB B
CM
!7B;
3x=
7N TB Br5 r r; rs rd s @r2 r r G s -C Cr5 r c P ^ \ rS rSrSr\4\S.S\S\4U 4S jjjjrS S jrSr U =r
$ )
WordStarti[ ag Matches if the current position is at the beginning of a
:class:`Word`, and is not preceded by any character in a given
set of ``word_chars`` (default= ``printables``). To emulate the
```` behavior of regular expressions, use
``WordStart(alphanums)``. ``WordStart`` will also match at
the beginning of the string being parsed, or at the beginning of
a line.
wordChars
word_charsr c l > U[ :X a UOUn[ TU ] 5 [ U5 U l SU l g )NzNot at the start of a word)
printablesrL r3 r r r r0 r r r s r2 r3 WordStart.__init__e s. "+z"9Jy
Y 2 r5 c US:w a> XS-
U R ; d X U R ; a [ XU R U 5 eU/ 4$ Nr r )r r r rk s r2 rl WordStart.parseImplk sF !8q!T^^3=6$XDKKFFBwr5 )r r r; r8 r> r? r@ rH r rT r3 rl rA rc rd s @r2 r r [ s6 *4 3 33 33 3 3 r5 r c P ^ \ rS rSrSr\4\S.S\S\4U 4S jjjjrS S jrSr U =r
$ )
WordEndiu aQ Matches if the current position is at the end of a :class:`Word`,
and is not followed by any character in a given set of ``word_chars``
(default= ``printables``). To emulate the ```` behavior of
regular expressions, use ``WordEnd(alphanums)``. ``WordEnd``
will also match at the end of the string being parsed, or at the end
of a line.
r r r c z > U[ :X a UOUn[ TU ] 5 [ U5 U l SU l SU l g )NFzNot at the end of a word)r rL r3 r r r r r s r2 r3 WordEnd.__init__~ s6 "+z"9Jy
Y #0 r5 c [ U5 nUS: aC X$: a> X U R ; d XS-
U R ; a [ XU R U 5 eU/ 4$ r )re r r r )r0 r r r8 rf s r2 rl WordEnd.parseImpl sS x= a^ [ TT ] U5 T [ U[ 5 ( a [ U5 n[ U[
5 ( a T R
U5 /T l O[ U[ 5 ( a U/T l Oe[ U[ 5 ( a? [ U5 n[ S U 5 5 ( a U 4S jU 5 n[ U5 T l O [ U5 T l ST l g ! [ a U/T l N f = f)Nc 3 B # U H n[ U[ 5 v M g 7fr- )rz r& )rP r s r2 r +ParseExpression.__init__.. s @%$:dH--%s c 3 t ># U H- n[ U[ 5 ( a TR U5 OUv M/ g 7fr- )rz r& r )rP r] r0 s r2 r r s5 " 4>a3J3JD,,Q/PQQ "s 58F)
rL r3 rz _generatorTyper r& r r r r anyr r r0 r r r s ` r2 r3 ParseExpression.__init__ s
" e^ , ,KE eX & & 2259:DJ
}
-
- DJ
x
(
(KE@%@@@ " eDJ
% !%[
"
% #W
%s C, ,D Dr` c U R S S $ r- )r r5 s r2 r ParseExpression.recurse s zz!} r5 c J U R R U5 S U l U $ r- )r r r r s r2 r ParseExpression.append s!
% r5 rN c > [ TU ] U5 U( aS U R Vs/ s H o"R 5 PM snU l U R H nUR U5 M U $ s snf )z|
Extends ``leave_whitespace`` defined in base class, and also invokes ``leave_whitespace`` on
all contained expressions.
)rL rU r r% r0 rN r] r s r2 rU ParseExpression.leave_whitespace sY
+ ,0JJ7Jq&&(J7DJZZ""9- 8 A-c > [ TU ] U5 U( aS U R Vs/ s H o"R 5 PM snU l U R H nUR U5 M U $ s snf )z}
Extends ``ignore_whitespace`` defined in base class, and also invokes ``leave_whitespace`` on
all contained expressions.
)rL rR r r% r s r2 rR !ParseExpression.ignore_whitespace sY
!), ,0JJ7Jq&&(J7DJZZ##I. 8r c T > [ U[ 5 ( aQ XR ; a@ [ TU ] U5 U R
H! nUR U R S 5 M# U $ [ TU ] U5 U R
H! nUR U R S 5 M# U $ Nr )rz rK r
rL r_ r )r0 r r] r s r2 r_ ParseExpression.ignore s eX & & , ,,u% AHHT - -b 12 $
GN5 !ZZ))"-. r5 c ` U R R S[ U R 5 S3$ Nz:(r: )r r8 rT r r5 s r2 rl $ParseExpression._generateDefaultName s) ..))*"S_,=Q??r5 c > U R ( a U $ [ TU ] 5 U R H nUR 5 M [ U R 5 S:X Ga U R S n[ X R 5 ( a UR ( d UR c{ UR ( dj UR S S U R S /- U l S U l
U =R UR - sl U =R UR - sl U R S n[ X R 5 ( a UR ( d UR cz UR ( di U R S S UR S S - U l S U l
U =R UR - sl U =R UR - sl S[ U 5 - U l U $ )Nrn r r r rr )r rL r r re rz r r r r r r r
rT r )r0 r] r r s r2 r ParseExpression.streamline sr K
A
LLN tzz?a JJqME5..11 ))%%- "[[^tzz!}o =
$(!##u';';;#""e&9&99"JJrNE5..11 ))%%- !ZZ_u{{1~ =
$(!##u';';;#""e&9&99"!CI- r5 c [ R " S[ SS9 Ub UO/ S S U /- nU R H nUR U5 M U R / 5 g Nr rn r )r rV r r r r )r0 r tmpr] s r2 r ParseExpression.validate sX
h
!. 9}r1ENA
JJsO R r5 c > [ TU ] 5 n[ R " [ U5 nU R
Vs/ s H o"R 5 PM snUl U$ s snf r- )rL r% r r r r )r0 r; r] r s r2 r% ParseExpression.copy sF glnkk/3/'+zz2z!VVXz2
3s A c
> [ R ( a [ R U R ; a U R H n[ U[ 5 ( d M UR ( d M- [ R UR ; d MM [ R " SR SU[ U 5 R UR 5 SS9 M [ TU ]9 X5 $ NzY{}: setting results name {!r} on {} expression collides with {!r} on contained expressionrb r' r )rS rb rl r r rz r r r rV r r r8 rL r+ r0 r\ r( r] r s r2 r+ ParseExpression._setResultsName s > >EE**+ ZZ q-00
#MM //0 MMEEKV G J / / MM F $% $ w&t< r? r@ rH r r r r r3 r r r rU rR r_ rT rl r r r% r+ r! r! r rA rc rd s @r2 r r s "foom < " " "4 m, }
$ -
4
=
}
@c @'M 'R !m =8 &'" ("'(# )#r5 r c ^ \ rS rSrSr " S S\5 r SS\R \ S\
4U 4S jjjr S\ 4U 4S jjr SS
jr
S rS rS\4S
jrSrU =r$ )r i= a
Requires all given :class:`ParseExpression` s to be found in the given order.
Expressions may be separated by whitespace.
May be constructed using the ``'+'`` operator.
May also be constructed using the ``'-'`` operator, which will
suppress backtracking.
Example::
integer = Word(nums)
name_expr = Word(alphas)[1, ...]
expr = And([integer("id"), name_expr("name"), integer("age")])
# more easily written as:
expr = integer("id") + name_expr("name") + integer("age")
c 6 ^ \ rS rSrU 4S jrS\4S jrSrU =r$ )zAnd._ErrorStopiO c F > [ TU ] " U0 UD6 U R 5 g r- )rL r3 rU )r0 r rM r s r2 r3 And._ErrorStop.__init__P s! G d -f - ! ! #r5 r` c g)N-rB r5 s r2 rl #And._ErrorStop._generateDefaultNameT s r5 rB ) r8 r> r? r@ r3 rT rl rA rc rd s @r2 r And._ErrorStopO s $ # r5 r exprs_argr c @ > [ U5 nU( a [ U; a / n[ U5 H u pVU[ L aw U[ U5 S-
: aZ [ R
" [ [ 5 X5S- - 5 R S nUR [ U5 " S5 5 Mz [ S5 eUR U5 M XCS S & [ TU ]5 X25 U R ( a [ S U R 5 5 U l [! U R S [" 5 ( d] U R% U R S R& U R S R( S9 U R S R* U l OSU l OS U l S U l g )
Nr r r z0cannot construct And with sequence ending in ...c 3 8 # U H oR v M g 7fr- r rP r] s r2 r And.__init__..m %K
1&6&6
rH r rz FT)r r r re r r r r r r r ry rL r3 rJ r rz rr rY r r r r ) r0 r r r r r r
skipto_argr s r2 r3 And.__init__W sV &*)_ X&C$U+8#3u:>)4:KK +eg!e .D5 %5$
6*#5k#BC ' N JJt$ , !H
) ::"%%K
%K"KD djjmU33))JJqM,,"&**Q-"E"E * '+jjm&B&B#&+#"&D r5 r` c P > U R ( Ga [ S U R S S 5 5 ( a [ 5 n[ U R S S 5 H u p#X1L a M [ U[
5 ( d M" UR ( d M5 [ UR S [ 5 ( d MY UR S U R US- - UR S' XR US- ' M U R Vs/ s H o3ULd M UPM
snU l [ T U ]! 5 [ U R U R SS 5 H u pE[ 5 n [ U5 U; a M! UR [ U5 5 [ U[ 5 ( a UR U4S j5 Mg UR 5 n[! [# U5 S 5 nUc M [$ R& " [( U5 nM [+ S U R 5 5 U l U $ s snf )Nc 3 # U HL n[ U[ 5 =( a0 UR =( a [ UR S [ 5 v MN g7fr N)rz r r r r s r2 r !And.streamline..} sJ )A 1o. :GG: qwwr{L9: )s AAr r c . [ US[ X5 5 $ )N
parent_anchor)setattrr )r r r cur_s r2 r And.streamline.. s ' /3q93r5 c 3 8 # U H oR v M g 7fr- r r s r2 r r s !GJq"2"2JrH )r r r; r rz r r rL r r r r r
IndentedBlockrQ r nextr> r r r rJ r )
r0 deleted_expr_markerr r] prevr! r subs
next_firstr s
r2 r And.streamlinez s ::: CR '.i# %djj"o 6DA/ "1o66 GGG &qwwr{L A A&'ggbkDJJq1u4E&E ,?
1q5) 7 *. TA@S7Sa T
TZZAB 8ID 5Dc7d?C! c=11))-0
{{} !$t*d 3
% kk-< 9* "!GDJJ!G G ; Us H#H#c U R S R XUSS9u p$SnU R SS HX n[ U5 [ R L a SnM# U( a UR XU5 u p'OUR XU5 u p'XG-
nMZ X$4$ ! [
a e [ a! nS Ul [
R U5 eS nAf[ a" [ U[ U5 U R U 5 ef = f)Nr Fr r T) r r? r r r ParseSyntaxExceptionr r _from_exceptionrx re r ) r0 r r r8
resultlist errorStopr]
exprtokensr s r2 rl
And.parseImpl s **Q-.. 95 /
AB AAw#..(
&'hhxi&HOC #$((8)"D $J' ( , ) C'+B$.>>rBB! . #h-d s BC0% C/C0c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ U R U5 $ r- rz r& r r r r r s r2 __iadd__ And.__iadd__ A eX & &,,U3E% //! !{{5!!r5 c US S U /- nU R H' nUR U5 UR ( a M' g g r- )r r r r s r2 r And._checkRecursion s> *1-6A
o .### r5 c SR S U R 5 5 n[ U5 S: aF USS [ U5 S-
2 S:X a. USS n[ U5 S: a USS [ U5 S-
2 S:X a M. SU- S- $ ) Nr c 3 8 # U H n[ U5 v M g 7fr- r| r s r2 r +And._generateDefaultName.. s 4AQrH r r {}r r r )r r re r0 inners r2 rl And._generateDefaultName s 444%j1nq':CJN':!;t!C!BKE %j1nq':CJN':!;t!CU{S r5 )r r r r r; )r8 r> r? r@ rH r r r r r r r3 r rl r r rT rl rA rc rd s @r2 r r = sl "U KO!! 7!!CG!! !!F1M 1f :"!c ! !r5 r c ^ \ rS rSrSrS
S\R \ S\4U 4S jjjr S\4U 4S jjr
SS jr S r S\
4S
jrS
U 4S jjrS rU =r$ )r& i a Requires that at least one :class:`ParseExpression` is found. If
two expressions match, the expression that matches the longest
string will be used. May be constructed using the ``'^'``
operator.
Example::
# construct Or using '^' operator
number = Word(nums) ^ Combine(Word(nums) + '.' + Word(nums))
print(number.search_string("123 3.1416 789"))
prints::
[['123'], ['3.1416'], ['789']]
r r c > [ TU ] X5 U R ( aC [ S U R 5 5 U l [ S U R 5 5 U l g SU l g )Nc 3 8 # U H oR v M g 7fr- r r s r2 r Or.__init__.. r rH c 3 8 # U H oR v M g 7fr- rP r s r2 r r+ r rH TrL r3 r r r rJ r r s r2 r3 Or.__init__ M
) ::"%%K
%K"KD "%%K
%K"KD "&D r5 r` c > [ TU ] 5 U R ( ae [ S U R 5 5 U l [ S U R 5 5 U l [
S U R 5 5 U l U $ SU l U $ )Nc 3 8 # U H oR v M g 7fr- r r s r2 r Or.streamline.. r rH c 3 8 # U H oR v M g 7fr- r r s r2 r r2 !C
1,,
rH c 3 p # U H, oR =( a [ U[ 5 ( + v M. g 7fr- r rz rr r s r2 r r2 ) &GQ! =Au)=%==z 46F)rL r r r r r rJ r rj s r2 r
Or.streamline su
::"%%K
%K"KD !!C
!C CDO"% &GKzz& #D
$DO r5 c B SnS n/ n/ n[ S U R 5 5 ( a U R X5 nU R H& n UR XSS9n UR X45 M( U( a UR [ S5 SS9 U( d US S n U R XU5 $ Sn
U H@ u pXS :: a U
s $ UR XU5 u n nX: a U U4s $ XS : a U U4n
M@ MB U
S:w a U
$ U( aV [ U5 S: a@ UR S S
9 US R US R :X a UR S S
9 US nUeUb XB:X a U R Ul Ue[ XS U 5 e! [
a. n
S U
l Xl UR U
5 S nSn S n
A
GMs S n
A
f[ aF n U( d3 S U l U R U: a U nU R n S n A GM S n A GM S n A GM S n A f[ aD [ U5 U: a0 [ U[ U5 UR U 5 n[ U5 n GM
GM f = f! [ a8 n S U l U R U: a U nU R n S n A GM S n A GM S n A ff = f)
Nr c 3 8 # U H oR v M g 7fr- r r s r2 r Or.parseImpl.. s 2z!~~zrH Tr r )rA reverser r c U R * $ r- r r] s r2 r Or.parseImpl..J
155&r5 rA c Z U R * [ [ U R 5 5 * 4$ r- r re rT parser_elementrC s r2 r rD L " vC@P@P.c ;
1A
rH r r r r5 s r2 rl Or._generateDefaultNameb % UZZ ;
;;;cAAr5 c < > [ R ( ax [ R U R ; aZ [ S U R
5 5 ( a9 [ R " SR SU[ U 5 R 5 SS9 [ TU ]1 X5 $ )Nc 3 # U H9 n[ U[ 5 =( a [ R UR ; v M; g 7fr- rz r rl ra r r s r2 r %Or._setResultsName..k C $A 1c" , II++,, $ AA{}: setting results name {!r} on {} expression will return a list of all parsed tokens in an And alternative, in prior versions only the first token was returned; enclose contained argument in Groupra r' r
rS ra rl r r r r rV r r r8 rL r+ r0 r\ r( r s r2 r+ Or._setResultsNamee > >EE**+
2 39&C T
++3
!
w&t< r? r@ rH r r r r r3 r rl rY rT rl r+ rA rc rd s @r2 r& r& sY "'foom < ' ' '
M
Sj"Bc B= =r5 r& c ^ \ rS rSrSrS
S\R \ S\4U 4S jjjr S\4U 4S jjr
SS jr S r S\
4S
jrS
U 4S jjrS rU =r$ )r i a Requires that at least one :class:`ParseExpression` is found. If
more than one expression matches, the first one listed is the one that will
match. May be constructed using the ``'|'`` operator.
Example::
# construct MatchFirst using '|' operator
# watch the order of expressions to match
number = Word(nums) | Combine(Word(nums) + '.' + Word(nums))
print(number.search_string("123 3.1416 789")) # Fail! -> [['123'], ['3'], ['1416'], ['789']]
# put more selective expression first
number = Combine(Word(nums) + '.' + Word(nums)) | Word(nums)
print(number.search_string("123 3.1416 789")) # Better -> [['123'], ['3.1416'], ['789']]
r r c > [ TU ] X5 U R ( aC [ S U R 5 5 U l [ S U R 5 5 U l g SU l g )Nc 3 8 # U H oR v M g 7fr- r r s r2 r &MatchFirst.__init__.. r rH c 3 8 # U H oR v M g 7fr- rP r s r2 r rq r rH Tr- r s r2 r3 MatchFirst.__init__ r/ r5 r` c R > U R ( a U $ [ TU ] 5 U R ( ae [ S U R 5 5 U l [ S U R 5 5 U l [ S U R 5 5 U l U $ SU l SU l U $ )Nc 3 8 # U H oR v M g 7fr- r4 r s r2 r (MatchFirst.streamline.. r5 rH c 3 8 # U H oR v M g 7fr- r r s r2 r rv r rH c 3 p # U H, oR =( a [ U[ 5 ( + v M. g 7fr- r7 r s r2 r rv r8 r9 FT) r rL r r r r r rJ r rj s r2 r MatchFirst.streamline s K
:: !!C
!C CDO"%%K
%K"KD "% &GKzz& #D $DO"&D r5 c SnS nU R H n UR UUU5 s $ Ub XB:X a U R Ul
Ue[ XSU 5 e! [ a nS Ul Xgl e S nAf[
a/ nUR U: a UnUR n S nAM S nAM S nAf[ aB [ U5 U: a/ [ U[ U5 UR U 5 n[ U5 n M M f = f)Nr rK ) r r? r r rI r r rx re r r ) r0 r r r8 rM rN r] rQ r s r2 rl MatchFirst.parseImpl s A
.xx , # #';; A4
- '
$(!%&"!
(77Y&#&L #I '
.x=9,#1 #h-4$L !$H
I -
.s* A
C2 A,,
C29 B##AC21C2c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ U R U5 $ r- r r s r2 __ior__MatchFirst.__ior__ r r5 c R SSR S U R 5 5 - S- $ )Nr z | c 3 8 # U H n[ U5 v M g 7fr- r| r s r2 r 2MatchFirst._generateDefaultName.. r^ rH r r_ r5 s r2 rl MatchFirst._generateDefaultName ra r5 c < > [ R ( ax [ R U R ; aZ [ S U R
5 5 ( a9 [ R " SR SU[ U 5 R 5 SS9 [ TU ]1 X5 $ )Nc 3 # U H9 n[ U[ 5 =( a [ R UR ; v M; g 7fr- rd r s r2 r -MatchFirst._setResultsName.. rf rg rh ra r' r ri rj s r2 r+ MatchFirst._setResultsName rl r5 rm r9 r; )r8 r> r? r@ rH r r r r r3 r rl r} rT rl r+ rA rc rd s @r2 r r sX "'foom < ' ' 'M #J"Bc B= =r5 r c ^ \ rS rSrSrS S\R \ S\4U 4S jjjr S r
S\4U 4S jjr S S jr S\
4S
jrS rU =r$ )
r- i a Requires all given :class:`ParseExpression` s to be found, but in
any order. Expressions may be separated by whitespace.
May be constructed using the ``'&'`` operator.
Example::
color = one_of("RED ORANGE YELLOW GREEN BLUE PURPLE BLACK WHITE BROWN")
shape_type = one_of("SQUARE CIRCLE TRIANGLE STAR HEXAGON OCTAGON")
integer = Word(nums)
shape_attr = "shape:" + shape_type("shape")
posn_attr = "posn:" + Group(integer("x") + ',' + integer("y"))("posn")
color_attr = "color:" + color("color")
size_attr = "size:" + integer("size")
# use Each (using operator '&') to accept attributes in any order
# (shape and posn are required, color and size are optional)
shape_spec = shape_attr & posn_attr & Opt(color_attr) & Opt(size_attr)
shape_spec.run_tests('''
shape: SQUARE color: BLACK posn: 100, 120
shape: CIRCLE size: 50 color: BLUE posn: 50,80
color:GREEN size:20 shape:TRIANGLE posn:20,40
'''
)
prints::
shape: SQUARE color: BLACK posn: 100, 120
['shape:', 'SQUARE', 'color:', 'BLACK', 'posn:', ['100', ',', '120']]
- color: BLACK
- posn: ['100', ',', '120']
- x: 100
- y: 120
- shape: SQUARE
shape: CIRCLE size: 50 color: BLUE posn: 50,80
['shape:', 'CIRCLE', 'size:', '50', 'color:', 'BLUE', 'posn:', ['50', ',', '80']]
- color: BLUE
- posn: ['50', ',', '80']
- x: 50
- y: 80
- shape: CIRCLE
- size: 50
color: GREEN size: 20 shape: TRIANGLE posn: 20,40
['color:', 'GREEN', 'size:', '20', 'shape:', 'TRIANGLE', 'posn:', ['20', ',', '40']]
- color: GREEN
- posn: ['20', ',', '40']
- x: 20
- y: 40
- shape: TRIANGLE
- size: 20
r r c > [ TU ] X5 U R ( a" [ S U R 5 5 U l OSU l SU l SU l SU l g )Nc 3 8 # U H oR v M g 7fr- r r s r2 r Each.__init__..1 r rH T)rL r3 r rJ r r initExprGroupsr r s r2 r3
Each.__init__. sM
) ::"%%K
%K"KD "&D " " r5 c [ U[ 5 ( a U R U5 n[ U[ 5 ( d [ $ U R U5 $ r- r r s r2 __iand__
Each.__iand__8 r r5 r` c > [ TU ] 5 U R ( a# [ S U R 5 5 U l U $ SU l U $ )Nc 3 8 # U H oR v M g 7fr- r r s r2 r "Each.streamline..B r rH T)rL r r rJ r rj s r2 r Each.streamline? sB
::"%%K
%K"KD #'D r5 c * U R ( Ga [ S U R 5 5 U l U R Vs/ s H& n[ U[
5 ( d M UR PM( nnU R Vs/ s H: nUR ( d M [ U[
[ [ 45 ( a M8 UPM< nnXV- U l
U R Vs/ s H> n[ U[ 5 ( d M UR R UR SS9PM@ snU l U R Vs/ s H> n[ U[ 5 ( d M UR R UR SS9PM@ snU l U R Vs/ s H' n[ U[
[ [ 45 ( a M% UPM) snU l U =R" U R -
sl SU l UnU R" S S nU R S S n U R S S n
/ n Sn / n
/ nU ( a X- U
- nU
R% 5 UR% 5 U Hx n UR' XSS9nU R) U R R+ [- U5 U5 5 XH; a UR/ U5 M` XI; a U R/ U5 Mx Mz [9 U
5 [9 U5 :X a Sn U ( a M U( aV [9 U5 S: a@ UR; S S9 US R< US R< :X a UR; S
S9 US nUeU( a< S R? U Vs/ s H n[A U5 PM sn5 n[7 UUS U S
35 eXR Vs/ s H. n[ U[
5 ( d M UR U ; d M, UPM0 sn-
n [C / 5 nU H nURE XU5 u nnUU-
nM UU4$ s snf s snf s snf s snf s snf ! [0 a< nS Ul UUl UR) U5 U
R) U5 S nAGM S nAf[6 a U
R) U5 GM5 f = fs snf s snf )Nc 3 ~ # U H3 n[ U[ 5 ( d M [ UR 5 U4v M5 g 7fr- )rz r r r r s r2 r !Each.parseImpl..I s* )3Az!S7IAFFQs = =T)r) Fr? r c U R * $ r- rB rC s r2 r Each.parseImpl.. rE r5 rF r c Z U R * [ [ U R 5 5 * 4$ r- rH rC s r2 r r rJ r5 r z'Missing one or more required elements (r: )#r rD r opt1maprz r r r r r optionalsr? r, r multioptionalsr
multirequiredrequiredr r r rK r remover r rI r re rL r r rT r# r? )r0 r r r8 r] opt1opt2tmpLoctmpReqdtmpOptmultis
matchOrder keepMatchingfailedrO tmpExprsrQ rV missing
total_resultsr s r2 rl Each.parseImplG s )- DL %)JJEJq*Q2DFAFFJDE #A## ,6q3z:R,S #
"[DN ##A a 0 N''
'M##D "#A a+ N''
'M#"D :: %aZCY;W-X: DM
MMT / / /M"'D --" "$$Q'
'&0H LLN LLN ) [[t[ LF %%dll&6&6r!ua&@A| q)
a( % 6{c(m+ $ + l0 6{Q 0 1!9==F1IMM1KK$SKT q IO ii 9AQ 9:G 9'!D
**X*Q
1c0BqqvvQWGWq*XX
$R(
A 88H9=LC W $M M!!a F #
"
, + %(,C%)*C&MM#&MM!$$% %MM!$$%* !: Ysx P P ?P P:PP6(P4P(P$P 7P P$$R R<RR$
R.0Q%% RRc R SSR S U R 5 5 - S- $ )Nr z & c 3 8 # U H n[ U5 v M g 7fr- r| r s r2 r ,Each._generateDefaultName.. r^ rH r r_ r5 s r2 rl Each._generateDefaultName ra r5 ) r r r r r r r r r r; )r8 r> r? r@ rH r r r r r3 r r rl rT rl rA rc rd s @r2 r- r- sV 7r foom < "M U"nBc B Br5 r- c ^ \ rS rSrSrSS\\\4 S\4U 4S jjjr S\
\ 4S jr SS jr SS \S\4U 4S
jjjr
SS \S\4U 4S jjjrS\4U 4S jjrS\4U 4S
jjrS rSSS jjrS\4S jr\" \
5 S 5 r\" \5 S 5 rSrU =r$ )ParseElementEnhancei z^Abstract subclass of :class:`ParserElement`, for combining and
post-processing parsed tokens.
r r c > [ TU ] U5 [ U[ 5 ( a [ R
" [ U5 n[ U R [ 5 ( a U R U5 nOJ[ [ U 5 U R 5 ( a [ U5 nOU R [ U5 5 n[ R
" [ U5 nXl
Ub UR U l UR U l U R! UR" UR$ S9 UR& U l UR( U l UR* U l U R, R/ UR, 5 g g )Nrz )rL r3 rz r& r r rT
issubclassr rf r r r r r
r rY r r r r r r
r )r0 r r expr_strr s r2 r3 ParseElementEnhance.__init__ s'
" dH % % {{3-H$22E:://9DJ(@(@AA x(//0AB{{=$/ !%!3!3D "&"5"5D % %t/I/I
&
#'"5"5D "ooDO $ 1 1D # #D$4$4 5 r5 r` c : U R b
U R /$ / $ r- r r5 s r2 r ParseElementEnhance.recurse s "ii 3 {;;r5 c U R b U R R XUSS9$ [ XSU 5 e! [ a nU R Ul e S nAff = f)NFr zNo expression defined)r r? r r r r )r0 r r r8 pbes r2 rl ParseElementEnhance.parseImpl s_ 99
yy''yu'UU
!0GN N &
++
s 7
AAArN c > [ TU ] U5 U( aG U R b: U R R 5 U l U R R U5 U $ r- )rL rU r r% r0 rN r s r2 rU $ParseElementEnhance.leave_whitespace sF
+ yy$ IINN , **95 r5 c > [ TU ] U5 U( aG U R b: U R R 5 U l U R R U5 U $ r- )rL rR r r% r s r2 rR %ParseElementEnhance.ignore_whitespace sF
!), yy$ IINN , ++I6 r5 c d > [ U[ 5 ( aU XR ; aD [ TU ] U5 U R
b( U R
R U R S 5 U $ [ TU ] U5 U R
b( U R
R U R S 5 U $ r )rz rK r
rL r_ r r0 r r s r2 r_ ParseElementEnhance.ignore s eX & & , ,,u%99(II$$T%5%5b%9:
GN5 !yy$ !1!1"!56 r5 c r > [ TU ] 5 U R b U R R 5 U $ r- )rL r r rj s r2 r ParseElementEnhance.streamline s-
99 II " r5 c X; a [ X/- 5 eUS S U /- nU R b U R R U5 g g r- )RecursiveGrammarExceptionr r )r0 r r s r2 r #ParseElementEnhance._checkRecursion sK #+,>r5 c g r- rB r5 s r2 r! #ParseElementEnhance.leaveWhitespace r r5 c g r- rB r5 s r2 r $ParseElementEnhance.ignoreWhitespace r r5 )r r r
r r r r9 r; r- r_ )r8 r> r? r@ rH r
r rT r r3 r r rl rU rR r_ r r r rl r! r! r rA rc rd s @r2 r r s 6U=##5 6 6$ 6 6.<m, <O$ - 4 =
}
M 7 !?c ?
&'" ("'(# )#r5 r c | ^ \ rS rSrSr " S S\5 r " S S\5 rSSS .S
\S \ S \ 4U 4S
jjjr
SS jr Sr U =r
$ )r i z
Expression to match one or more expressions at a given indentation level.
Useful for parsing text where structure is implied by indentation (like Python source code).
c 0 ^ \ rS rSrS\4U 4S jjrSrU =r$ )zIndentedBlock._Indenti ref_colc b >^ [ TU ] 5 ST 3U l U R U4S j5 g )Nzexpected indent at column c > [ X5 T:H $ r- r r r r r s r2 r 0IndentedBlock._Indent.__init__.. s s1yG/Cr5 rL r3 r rU r0 r r s `r2 r3 IndentedBlock._Indent.__init__ s+ G 6wi@DK C Dr5 r r8 r> r? r@ r r3 rA rc rd s @r2 _IndentIndentedBlock._Indent s EC E Er5 r c 0 ^ \ rS rSrS\4U 4S jjrSrU =r$ )z IndentedBlock._IndentGreateri r c b >^ [ TU ] 5 ST 3U l U R U4S j5 g )Nz'expected indent at column greater than c > [ X5 T: $ r- r r s r2 r 7IndentedBlock._IndentGreater.__init__.. s s1y7/Br5 r r s `r2 r3 %IndentedBlock._IndentGreater.__init__ s+ G CG9MDK B Cr5 r r rd s @r2 _IndentGreater IndentedBlock._IndentGreater s DC D Dr5 r FTrN groupedr rN r c H > [ TU ] USS9 X l X0l SU l g )NTrh r )rL r3
_recursive_groupedr )r0 r rN r r s r2 r3 IndentedBlock.__init__" s+ - $
r5 c [ 5 R X5 nU R R XUS9 [ XA5 nU R U5 n[ 5 U- U R - nU R ( ak U R U5 n[ U R U R U R S9n U R U R 5 XYl U[ X- 5 -
nUR S[ [! U5 5 SS R# 5 SU 35 [% U5 n
U R U R 5 [' 5 - n U R ( a [( n OS n U " U
5 [+ U 5 - R- XU5 $ )Nr r zinner @c U $ r- rB r s r2 r )IndentedBlock.parseImpl..J s 4r5 )r rh r r r r r r r r ri r r r rs hexr r r r Groupr rl )
r0 r r r8
anchor_loc
indent_colpeer_detect_expr
inner_expr
sub_indent nested_blockblocktrailing_undentr s
r2 rl IndentedBlock.parseImpl, sO W%%h4
HYG.
<<
3W //$));
?? ,,Z8J( T__dmm L
" "4:: .)3 & #j 78 8JfSJ %8%=%C%C%E$Fa
| TU*% ,,t'9'9:Y[H ==G'G/!::EE )
r5 )r r r r; )r8 r> r? r@ rH r r r r r r3 rl rA rc rd s @r2 r r sW
E% E D D 9>t ! 15 HL !
!
r5 r c N ^ \ rS rSrSrS\\\4 4U 4S jjrSU 4S jjr Sr
U =r $ )
AtStringStartiP zMatches if expression matches at the beginning of the parse
string::
AtStringStart(Word(nums)).parse_string("123")
# prints ["123"]
AtStringStart(Word(nums)).parse_string(" 123")
# raises ParseException
r c 2 > [ TU ] U5 SU l g NFrL r3 r r0 r r s r2 r3 AtStringStart.__init__[
!r5 c H > US:w a [ XS5 e[ TU ] XU5 $ )Nr znot found at string start)r rL rl r0 r r r8 r s r2 rl AtStringStart.parseImpl_ s* !8 0KL Lw ::r5 r= r; r8 r> r? r@ rH r
r rT r3 rl rA rc rd s @r2 r r P s( "U=##5 6 "; ;r5 r c N ^ \ rS rSrSrS\\\4 4U 4S jjrSU 4S jjr Sr
U =r $ ) AtLineStartie a} Matches if an expression matches at the beginning of a line within
the parse string
Example::
test = '''\
AAA this line
AAA and this line
AAA but not this one
B AAA and definitely not this one
'''
for t in (AtLineStart('AAA') + rest_of_line).search_string(test):
print(t)
prints::
['AAA', ' this line']
['AAA', ' and this line']
r c 2 > [ TU ] U5 SU l g r r r s r2 r3 AtLineStart.__init__| r r5 c Z > [ X!5 S:w a [ XS5 e[ TU ]
XU5 $ )Nr znot found at line start)r r rL rl r s r2 rl AtLineStart.parseImpl s0 s " 0IJ Jw ::r5 r= r; r rd s @r2 r r e s( ,"U=##5 6 "; ;r5 r c H ^ \ rS rSrSrS\\\4 4U 4S jjrSS jr Sr
U =r $ )
FollowedByi a' Lookahead matching of the given parse expression.
``FollowedBy`` does *not* advance the parsing position within
the input string, it only verifies that the specified parse
expression matches at the current position. ``FollowedBy``
always returns a null token list. If any results names are defined
in the lookahead expression, those *will* be returned for access by
name.
Example::
# use FollowedBy to match a label only if it is followed by a ':'
data_word = Word(alphas)
label = data_word + FollowedBy(':')
attr_expr = Group(label + Suppress(':') + OneOrMore(data_word, stop_on=label).set_parse_action(' '.join))
attr_expr[1, ...].parse_string("shape: SQUARE color: BLACK posn: upper left").pprint()
prints::
[['shape', 'SQUARE'], ['color', 'BLACK'], ['posn', 'upper left']]
r c 2 > [ TU ] U5 SU l g r rL r3 r r s r2 r3 FollowedBy.__init__ s
"r5 c J U R R XUS9u pEUS S 2 X%4$ )Nr )r r? )r0 r r r8 rG r; s r2 rl FollowedBy.parseImpl s- !!(9!E Fxr5 r r; r rd s @r2 r r s( ,#U=##5 6 # r5 r c l ^ \ rS rSrSr SS\\\4 S\R \
4U 4S jjjr S S jr Sr
U =r$ )
PrecededByi aH Lookbehind matching of the given parse expression.
``PrecededBy`` does not advance the parsing position within the
input string, it only verifies that the specified parse expression
matches prior to the current position. ``PrecededBy`` always
returns a null token list, but if a results name is defined on the
given expression, it is returned.
Parameters:
- ``expr`` - expression that must match prior to the current parse
location
- ``retreat`` - (default= ``None``) - (int) maximum number of characters
to lookbehind prior to the current parse location
If the lookbehind expression is a string, :class:`Literal`,
:class:`Keyword`, or a :class:`Word` or :class:`CharsNotIn`
with a specified exact or maximum length, then the retreat
parameter is not required. Otherwise, retreat must be specified to
give a maximum number of characters to look back from
the current parse position for a lookbehind match.
Example::
# VB-style variable names with type prefixes
int_var = PrecededBy("#") + pyparsing_common.identifier
str_var = PrecededBy("$") + pyparsing_common.identifier
r retreatc > [ TU ] U5 U R 5 R 5 U l SU l SU l SU l [ U[ 5 ( a. [ R " [ U5 n[ U5 nSU l O[ U[ [ 45 ( a UR nSU l Oa[ U[ [" 45 ( a( UR$ [& :w a UR$ nSU l O [ U[( 5 ( a SnSU l X l S[ U5 - U l SU l U R0 R3 S 5 g )NTFr znot preceded by c 8 UR [ S S 5 5 $ r- ) __delitem__r< r r r s r2 r %PrecededBy.__init__.. s
eD$>O0Pr5 )rL r3 r rU r r
r rz r& r r rT re r r r r rc r rE r r r r r r )r0 r r r s r2 r3 PrecededBy.__init__ s IIK002 " "
dH % %;;sD)D$iG DJ
w 0
1
1mmG DJ
tZ 0
1
1dkkX6MkkG DJ
m
,
,G DJ (3t94 # PQr5 c 0 U R ( aS X R : a [ XU R 5 eX R -
nU R R X5 u pVX&4$ U R [
5 - nU[ SX R -
5 U n[ XU R 5 n [ S[ X R S- 5 S- 5 H& n
UR U[ U5 U
-
5 u pV X&4$ U e! [ a
n U n S n A M> S n A ff = fr ) r r r r r r? r r rR r re r ) r0 r r r8 r rG r; test_exprinstring_slice last_exproffsetr s r2 rl PrecededBy.parseImpl s ::\\!$XDKK@@,,&EYY%%h6FA$ x IK/I %c!S<<-?&@3 GN&xdkkBI 3sLL1,<#=#AB & - -&N(;f(D FA x C * $ #I$s C>>
DDD)r r r r
r r r r- )r T)r8 r> r? r@ rH r
r rT r r r r3 rl rA rc rd s @r2 r r sJ < PTR-,-R8>8LR R4 r5 r c " \ rS rSrSrSS jrSrg)Locatedi ar
Decorates a returned token with its starting and ending
locations in the input string.
This helper adds the following results names:
- ``locn_start`` - location where matched expression begins
- ``locn_end`` - location where matched expression ends
- ``value`` - the actual parsed results
Be careful if the input text contains ```` characters, you
may want to call :class:`ParserElement.parse_with_tabs`
Example::
wd = Word(alphas)
for match in Located(wd).search_string("ljsdf123lksdjjf123lkkjj1222"):
print(match)
prints::
[0, ['ljsdf'], 5]
[8, ['lksdjjf'], 15]
[18, ['lkkjj'], 23]
c UnU R R XUSS9u p%[ XEU/5 nXFS' XVS' X&S' U R ( a X&/4$ X&4$ )NFr
locn_startr locn_end)r r? r# r )r0 r r r8 r r r s r2 rl Located.parseImpl sh ii&&x PU&V !5#"67
#(< $7!$: $ $? "r5 rB Nr; )r8 r> r? r@ rH rl rA rB r5 r2 r' r' s 6 #r5 r' c V ^ \ rS rSrSrS\\\4 4U 4S jjrS S jr S\4S jr
Sr U =r $ )
r4 i& au
Lookahead to disallow matching with the given parse expression.
``NotAny`` does *not* advance the parsing position within the
input string, it only verifies that the specified parse expression
does *not* match at the current position. Also, ``NotAny`` does
*not* skip over leading whitespace. ``NotAny`` always returns
a null token list. May be constructed using the ``'~'`` operator.
Example::
AND, OR, NOT = map(CaselessKeyword, "AND OR NOT".split())
# take care not to mistake keywords for identifiers
ident = ~(AND | OR | NOT) + Word(alphas)
boolean_term = Opt(NOT) + ident
# very crude boolean expression - to support parenthesis groups and
# operation hierarchy, use infix_notation
boolean_expr = boolean_term + ((AND | OR) + boolean_term)[...]
# integers that are followed by "." are actually floats
integer = Word(nums) + ~Char(".")
r c z > [ TU ] U5 SU l SU l S[ U R
5 - U l g )NFTzFound unwanted token, )rL r3 r r rT r r r s r2 r3 NotAny.__init__? s6
$ ".TYY ? r5 c v U R R XUS9( a [ XU R U 5 eU/ 4$ )Nr )r r r r rk s r2 rl NotAny.parseImplH s5 99 # #Hi # H TB BBwr5 r` c 8 S[ U R 5 - S- $ )Nz~{r rT r r5 s r2 rl NotAny._generateDefaultNameM s c$))n$s**r5 )r r r r; )
r8 r> r? r@ rH r
r rT r3 rl rl rA rc rd s @r2 r4 r4 & s6 0@U=##5 6 @
+c + +r5 r4 c ^ \ rS rSr S
SS.S\\\4 S\R \\\4 S\R \\\4 4U 4S jjjjr S\4S jr
SS
jr SU 4S jjr S r
U =r$ )r? iQ Nr@ r rC r@ c > [ TU ] U5 U=( d UnSU l Un[ U[ 5 ( a U R U5 nU R
U5 g r )rL r3 r rz r& r r@ )r0 r rC r@ enderr s r2 r3 _MultipleMatch.__init__R sQ "7 eX & &,,U3E Er5 r` c z [ U[ 5 ( a U R U5 nUb
U) U l U $ S U l U $ r- )rz r& r not_ender)r0 r7 s r2 r@ _MultipleMatch.stopOna s@ eX & &,,U3E#(#4% ;? r5 c U R R nU R nU R S LnU( a U R R nU( a W" X5 U" XU5 u p( U R
( n U( a W" X5 U ( a U" X5 n
OUn
U" XU5 u p+X-
nM2 ! [ [ 4 a X(4$ f = fr- )r r? ra r: r r
r rx ) r0 r r r8 self_expr_parseself_skip_ignorables check_ender
try_not_enderr hasIgnoreExprsr tmptokenss r2 rl _MultipleMatch.parseImplg s ))** # 3 3 nnD0 NN 4 4M ( (%hY? %)%5%5!5N !(0! 1( @F F!09!M#
+ { s )AB, ,C Cc
> [ R ( a [ R U R ; a U R /U R R 5 - H n[
U[ 5 ( d M UR ( d M- [ R UR ; d MM [ R " SR SU[ U 5 R UR 5 SS9 M [ TU ]= X5 $ r )rS rb rl r r r rz r r r rV r r r8 rL r+ r s r2 r+ _MultipleMatch._setResultsName s > >EE**+ ii[499#4#4#66 q-00
#MM //0 MMEEKV G J / / MM F $% 7$ w&t< r? r@ r
rT r r r r3 r@ rl r+ rA rc rd s @r2 r? r? Q s ?C
>B
C &'
}c'9!:;
mS&8 9:
} 8= =r5 r? c & \ rS rSrSrS\4S jrSrg)r i a-
Repetition of one or more of the given expression.
Parameters:
- ``expr`` - expression that must match one or more times
- ``stop_on`` - (default= ``None``) - expression for a terminating sentinel
(only required if the sentinel would ordinarily match the repetition
expression)
Example::
data_word = Word(alphas)
label = data_word + FollowedBy(':')
attr_expr = Group(label + Suppress(':') + OneOrMore(data_word).set_parse_action(' '.join))
text = "shape: SQUARE posn: upper left color: BLACK"
attr_expr[1, ...].parse_string(text).pprint() # Fail! read 'color' as data instead of next label -> [['shape', 'SQUARE color']]
# use stop_on attribute for OneOrMore to avoid reading label string as part of the data
attr_expr = Group(label + Suppress(':') + OneOrMore(data_word, stop_on=label).set_parse_action(' '.join))
OneOrMore(attr_expr).parse_string(text).pprint() # Better -> [['shape', 'SQUARE'], ['posn', 'upper left'], ['color', 'BLACK']]
# could also be written as
(attr_expr * (1,)).parse_string(text).pprint()
r` c 8 S[ U R 5 - S- $ )Nr z}...r2 r5 s r2 rl OneOrMore._generateDefaultName S^#f,,r5 rB N)r8 r> r? r@ rH rT rl rA rB r5 r2 r r s 6-c -r5 r c ^ \ rS rSrSr S
SS.S\\\4 S\R \\\4 S\R \\\4 4U 4S jjjjr
SU 4S jjr S
\4S jr S r
U =r$ )r i aP
Optional repetition of zero or more of the given expression.
Parameters:
- ``expr`` - expression that must match zero or more times
- ``stop_on`` - expression for a terminating sentinel
(only required if the sentinel would ordinarily match the repetition
expression) - (default= ``None``)
Example: similar to :class:`OneOrMore`
Nr5 r rC r@ c @ > [ TU ] X=( d US9 SU l g )Nr5 Tr )r0 r rC r@ r s r2 r3 ZeroOrMore.__init__ s" &78 "r5 c ~ > [ TU ] XU5 $ ! [ [ 4 a U[ / U R
S94s $ f = f)Nrx )rL rl r rx r# r r s r2 rl ZeroOrMore.parseImpl sI @7$XI> >
+ @ Rd.>.>?? ? @s &<<r` c 8 S[ U R 5 - S- $ )Nr z]...r2 r5 s r2 rl ZeroOrMore._generateDefaultName rI r5 r r- r; )r8 r> r? r@ rH r
rT r r r r3 rl rl rA rc rd s @r2 r r s ?C#
>B #C &'# }c'9!:;#
mS&8 9: # #@ -c - -r5 r c ^ \ rS rSr SSS.S\\\4 S\\\4 S\S\R \
S\R \
S \4 U 4S
jjjjr S \4S jr S
r
U =r$ )
DelimitedListi F)allow_trailing_delimr delimcombiner r rS c > [ U[ 5 ( a [ R U5 n[ R
" [ U5 nUb US: a [
S5 eUb Ub XT: a [
S5 eXl [ U5 U l X l
X0l U( d [ U5 U l
U=( d SU l
XPl X`l U R U R U R - U R S-
U R c SOU R S-
4- - nU R ( a U[! U R 5 -
nU R ( a [# U5 n[$ TU ]M USS9 g)a Helper to define a delimited list of expressions - the delimiter
defaults to ','. By default, the list elements and delimiters can
have intervening whitespace, and comments, but this can be
overridden by passing ``combine=True`` in the constructor. If
``combine`` is set to ``True``, the matching tokens are
returned as a single token string, with the delimiters included;
otherwise, the matching tokens are returned as a list of tokens,
with the delimiters suppressed.
If ``allow_trailing_delim`` is set to True, then the list may end with
a delimiter.
Example::
DelimitedList(Word(alphas)).parse_string("aa,bb,cc") # -> ['aa', 'bb', 'cc']
DelimitedList(Word(hexnums), delim=':', combine=True).parse_string("AA:BB:CC:DD:EE") # -> ['AA:BB:CC:DD:EE']
Nr zmin must be greater than 0z)max must be greater than, or equal to minTrh )rz r& r r r r r contentrT raw_delimrT rU rK r r rS r CombinerL r3 ) r0 r rT rU r r rS delim_list_exprr s r2 r3 DelimitedList.__init__ s+ 6 dH % % 44T:D{{=$/ ?Qw !=>> ?39 !LMM U
!% DJ8!$8! ,,$**t||*C HHqLHH$D$((Q,H
*
$ $ s4:: .O << %o 6O
48r5 r` c j SR U R R 5 U R 5 $ )Nz{0} [{1} {0}]...)r rW r rX r5 s r2 rl "DelimitedList._generateDefaultName s& !(( )@)@)BDNNSSr5 )rS rU rW rT r r rX )r FNN)r8 r> r? r@ r
rT r r r r r r3 rl rA rc rd s @r2 rR rR s ,/ $($(
:9 &+:9C &':9 S-'(:9 :9
__S
! :9 __S
!
:9 #:9 :9xTc T Tr5 rR c \ rS rSrS rS rSrg)
_NullTokeni! c gr rB r5 s r2 __bool___NullToken.__bool__" s r5 c gr rB r5 s r2 ry _NullToken.__str__% s r5 rB N)r8 r> r? r@ ra ry rA rB r5 r2 r_ r_ ! s r5 r_ c n ^ \ rS rSrSr\" 5 r\4S\\\ 4 S\
4U 4S jjjr S
S jr S\ 4S jr
S rU =r$ ) r i) a
Optional matching of the given expression.
Parameters:
- ``expr`` - expression that must match zero or more times
- ``default`` (optional) - value to be returned if the optional expression is not found.
Example::
# US postal code can be a 5-digit zip, plus optional 4-digit qualifier
zip = Combine(Word(nums, exact=5) + Opt('-' + Word(nums, exact=4)))
zip.run_tests('''
# traditional ZIP code
12345
# ZIP+4 form
12101-0001
# invalid ZIP
98765-
''')
prints::
# traditional ZIP code
12345
['12345']
# ZIP+4 form
12101-0001
['12101-0001']
# invalid ZIP
98765-
^
FAIL: Expected end of text (at char 5), (line:1, col:6)
r defaultc r > [ TU ] USS9 U R R U l X l SU l g )NFrh T)rL r3 r r defaultValuer )r0 r rf r s r2 r3 Opt.__init__S s6 . )).. # "r5 c U R n UR XUSS9u p%X%4$ ! [ [ 4 aT U R nX`R
La3 UR ( a [ U/5 nXeUR ' O U/n X%4$ / n X%4$ f = f)NFr )r r? r rx rh _Opt__optionalNotMatchedr r# )r0 r r r8 self_exprr
default_values r2 rl
Opt.parseImpl[ s II #**8)RW*XKC {
+ - -M $=$== (( )=/ :F4A9001 +_F { { s $ ABBBr` c [ U R 5 n[ U5 S: aF USS [ U5 S-
2 S:X a. USS n[ U5 S: a USS [ U5 S-
2 S:X a M. SU- S- $ )Nr r r$ r r r9 )rT r re r% s r2 rl Opt._generateDefaultNamek sy DII%j1nq':CJN':!;t!C!BKE %j1nq':CJN':!;t!CU{S r5 )rh r r r; )r8 r> r? r@ rH r_ rk r
r rT r r3 rl rl rA rc rd s @r2 r r ) sS %N &< ?S#-,-#8;# # !c ! !r5 r c ^ \ rS rSrSr S
SS.S\\\4 S\S\ R \\\4 S\ R \\\4 S \ R \\\4 4
U 4S
jjjjr SS jr S r
U =r$ )r iv a_
Token for skipping over all undefined text until the matched
expression is found.
Parameters:
- ``expr`` - target expression marking the end of the data to be skipped
- ``include`` - if ``True``, the target expression is also parsed
(the skipped text and target expression are returned as a 2-element
list) (default= ``False``).
- ``ignore`` - (default= ``None``) used to define grammars (typically quoted strings and
comments) that might contain false matches to the target expression
- ``fail_on`` - (default= ``None``) define expressions that are not allowed to be
included in the skipped test; if found before the target expression is found,
the :class:`SkipTo` is not a match
Example::
report = '''
Outstanding Issues Report - 1 Jan 2000
# | Severity | Description | Days Open
-----+----------+-------------------------------------------+-----------
101 | Critical | Intermittent system crash | 6
94 | Cosmetic | Spelling error on Login ('log|n') | 14
79 | Minor | System slow when running too many reports | 47
'''
integer = Word(nums)
SEP = Suppress('|')
# use SkipTo to simply match everything up until the next SEP
# - ignore quoted strings, so that a '|' character inside a quoted string does not match
# - parse action will call token.strip() for each matched token, i.e., the description body
string_data = SkipTo(SEP, ignore=quoted_string)
string_data.set_parse_action(token_map(str.strip))
ticket_expr = (integer("issue_num") + SEP
+ string_data("sev") + SEP
+ string_data("desc") + SEP
+ integer("days_open"))
for tkt in ticket_expr.search_string(report):
print tkt.dump()
prints::
['101', 'Critical', 'Intermittent system crash', '6']
- days_open: '6'
- desc: 'Intermittent system crash'
- issue_num: '101'
- sev: 'Critical'
['94', 'Cosmetic', "Spelling error on Login ('log|n')", '14']
- days_open: '14'
- desc: "Spelling error on Login ('log|n')"
- issue_num: '94'
- sev: 'Cosmetic'
['79', 'Minor', 'System slow when running too many reports', '47']
- days_open: '47'
- desc: 'System slow when running too many reports'
- issue_num: '79'
- sev: 'Minor'
N)failOnr includer_ fail_onrr c 6 > [ TU ] U5 U=( d UnUb U R U5 SU l SU l X l SU l [ U[ 5 ( a U R U5 U l
OXPl
S[ U R 5 - U l
g )NTFzNo match found for )rL r3 r_ r r
includeMatchr rz r& r rr rT r r )r0 r rs r_ rt rr r s r2 r3 SkipTo.__init__ s "7 KK " " # fh ' ' 226:DK K+c$))n< r5 c Un[ U5 nU R R nU R b U R R OS nU R
( a U R OS nUn X:: a& Ub U" X5 ( a O,Ub U" X5 n U" XSSS9 O[ XU R U 5 eU nXU n
[ U
5 n U R ( a U" XUSS9u p,X-
n X+4$ ! [ [ 4 a U S-
n Of = fX:: a M Nm)NF)r8 r9 r r ) re r r? rr rH r rh r rx r r# rv )
r0 r r r8 r rf r= self_failOn_canParseNext
self_preParsetmplocskiptext
skipresultr s
r2 rl SkipTo.parseImpl s x= ))**(, (?DKK $ $T ! *.):):
'3+H== (&x8
EPUV ! TB B S)!(+
&xieTHC J ) #J/
!
s C C76C7)r rr rv r
r r )FNNr; )r8 r> r? r@ rH r
r rT r r r r3 rl rA rc rd s @r2 r r v s ;@ =A>B = >B=]C'(= = mS&8 9: =
}c'9!:; = mS&8 9:= =.* * r5 r c H ^ \ rS rSrSrSS\R \\\ 4 4U 4S jjjr
SS jr SS jr SU 4S jjr
S rSU 4S
jjrSS \S\4S jjrSS \S\4S
jjrS\4S jrSSS jjrS\ 4S jrS\4U 4S jjrSU 4S jjr\" \5 S 5 r\" \5 S 5 rSrU =r $ ) r i a3
Forward declaration of an expression to be defined later -
used for recursive grammars, such as algebraic infix notation.
When the expression is known, it is assigned to the ``Forward``
variable using the ``'<<'`` operator.
Note: take care when assigning to ``Forward`` not to overlook
precedence of operators.
Specifically, ``'|'`` has a lower precedence than ``'<<'``, so that::
fwd_expr << a | b | c
will actually be evaluated as::
(fwd_expr << a) | b | c
thereby leaving b and c out as parseable alternatives. It is recommended that you
explicitly group the values inserted into the ``Forward``::
fwd_expr << (a | b | c)
Converting to use the ``'<<='`` operator instead will avoid this problem.
See :class:`ParseResults.pprint` for an example of a recursive
parser created using ``Forward``.
r c h > [ R " SS9S U l [ TU ] USS9 S U l g )Nrn r r Frh )r r caller_framerL r3 lshift_liner s r2 r3 Forward.__init__ s5 % 3 3! [ R " SS9S n[ R ( aB X R :X a3 [
R U R ; a [ R " SSS9 [ TU ]) U5 nU$ )Nrn r r z U R c [ R ( a~ [ R U R ; a` Sn[
R " SS9n[ [ U5 SS9 H u pgUR U; d M US- n O Sn[ R " SUS9 [ R ( d [ TU ]= XU5 $ [ R [ R" n XX4 u p[% U [& 5 ( a U eXR) 5 4sS S S 5 $ ! [* Ga X S 4n X S
4n
US-
[- XS U 5 4=u pX' U( a X X' [ TU ]= XS
5 u nnO)! [, a [% U[& 5 ( a e Xnn Of = fX:: aO U( a* X =u pX' X X XR) 5 4s sS S S 5 $ X XR) 5 4s sS S S 5 $ U( a1 [ TU ]= XS 5 X' O ! [, a nUU4=X' X' e S nAff = fUU4=u pX' M f = f! , ( d f g = f) N)r r r r r r )r rn zGForward expression was never assigned a value, will not parse any inputr TFz#Forward recursion without base case)r rS rd rl r r r r reversedr\ r rV r r rL rl rB r rz ry r% KeyErrorr )r0 r r r8 parse_fnsr r frmr memoprev_loc prev_resultact_keypeek_key prev_peeknew_locnew_peekr] r s r2 rl Forward.parseImplS sz II ::==**+I ((s3B#HRL:88y(!"QJ ;
MMY%
447$XI> >(
)
) 00D-
Q(,$-A(B% k955%% !1!1!33 *
) '
Q d+ u- !G" 'Ld8 #dn $(NDM@,1G,=hU,S)) @%i;; !,4 @ *$ FJ] R 1HDN $
#+-=-=-?#? ?I *
)J !N ' )9 99M *
)R % &050A(QU0V
#1 &BI1 M % & @G?PP+dn5 '
Q *
)s~ H5)/D""9H2 E0/H20#FH2F.H2H5H2"H5-H25HH2
H" H H""H22H55
IrN c SU l U $ r rP rQ s r2 rU Forward.leave_whitespace s # r5 c SU l U $ r rP rQ s r2 rR Forward.ignore_whitespace s " r5 c U R ( d. SU l U R b U R R 5 U $ r )r r r r5 s r2 r Forward.streamline s2 #D yy$ $$& r5 c [ R " S[ SS9 Uc / nX; a1 US S U /- nU R b U R R U5 U R / 5 g r r r s r2 r Forward.validate se
h
M $ "dV+Cyy$ ""3' R r5 c SU l Sn U R b [ U R 5 S S nOSnU R R S- U- $ ! U R R S- U- s s $ = f)Nz: ...rP i Noner )r r rT r r8 )r0 retStrings r2 rl Forward._generateDefaultName sn # >yy$ N5D 1 " >>**T1I= =4>>**T1I= =s (A A0c Z > U R b [ TU ] 5 $ [ 5 nX- nU$ r- )r rL r% r )r0 r; r s r2 r% Forward.copy s, 99 7<> !)C LCJr5 c > [ R ( ad [ R U R ; aF U R c9 [
R " SR SU[ U 5 R 5 SS9 [ TU ]- X5 $ )NzO{}: setting results name {!r} on {} expression that has no contained expressionrc r' r ) rS rc rl r r r rV r r r8 rL r+ )r0 r\ r) r s r2 r+ Forward._setResultsName sr 3 3::**+ yy
77=v8$T
@S@S8 ! w&t>>r5 c g r- rB r5 s r2 r! Forward.leaveWhitespace r r5 c g r- rB r5 s r2 r Forward.ignoreWhitespace r r5 ) r r r r r
r r r r r- )r` r r: r; r_ r9 ) r8 r> r? r@ rH r r r
r rT r3 r r r r rl r rU rR r r rl r% r+ r! r! r rA rc rd s @r2 r r s 8 fooeM34F.G H
,
]Q~$ - 4 = M
! >c > m ?& &'" ("'(# )#r5 r c B ^ \ rS rSrSrSS\\\4 4U 4S jjjrSr U =r
$ )TokenConverteri zO
Abstract subclass of :class:`ParseExpression`, for converting parsed results.
r c 2 > [ TU ] U5 SU l g r )rL r3 r r0 r r r s r2 r3 TokenConverter.__init__ s
r5 r4 r9 ) r8 r> r? r@ rH r
r rT r3 rA rc rd s @r2 r r s# U=##5 6 r5 r c ^ \ rS rSrSr SSS.S\S\S\S\R \ 4U 4S jjjjr
S
\4U 4S jjr S r S
r
U =r$ )rY i a Converter to concatenate all matching tokens to a single string.
By default, the matching patterns must also be contiguous in the
input string; this can be disabled by specifying
``'adjacent=False'`` in the constructor.
Example::
real = Word(nums) + '.' + Word(nums)
print(real.parse_string('3.1416')) # -> ['3', '.', '1416']
# will also erroneously match the following
print(real.parse_string('3. 1416')) # -> ['3', '.', '1416']
real = Combine(Word(nums) + '.' + Word(nums))
print(real.parse_string('3.1416')) # -> ['3.1416']
# no match when there are internal spaces
print(real.parse_string('3. 1416')) # -> Exception: Expected W:(0123...)
N)
joinStringr join_stringadjacentr c > [ TU ] U5 Ub UOUnU( a U R 5 X0l SU l X@l SU l g r )rL r3 rU r r r r )r0 r r r r r s r2 r3 Combine.__init__ sG #-#9Z{
! ! #
"$ r5 r` c v > U R ( a [ R X5 U $ [ TU ] U5 U $ r- )r r r_ rL r s r2 r_ Combine.ignore0 s2 == -
GN5 ! r5 c UR 5 nUS S 2 U[ SR UR U R 5 5 /U R
S9-
nU R ( a UR 5 ( a U/$ U$ )Nr )rw )r% r# r
_asStringListr r r haskeys)r0 r r rq retTokss r2 rr Combine.postParse7 sp .." AJ<
WWY,,T__=
> ?tGXGX
1 19 Nr5 )r r r r )r T)r8 r> r? r@ rH r rT r r r r3 r_ rr rA rc rd s @r2 rY rY si * ! ,0
!! ! ! OOC(
! !$}
r5 rY c B ^ \ rS rSrSrSS\S\4U 4S jjjrS rSr U =r
$ ) r iD a` Converter to return the matched tokens as a list - useful for
returning tokens of :class:`ZeroOrMore` and :class:`OneOrMore` expressions.
The optional ``aslist`` argument when set to True will return the
parsed tokens as a Python list instead of a pyparsing ParseResults.
Example::
ident = Word(alphas)
num = Word(nums)
term = ident | num
func = ident + Opt(DelimitedList(term))
print(func.parse_string("fn a, b, 100"))
# -> ['fn', 'a', 'b', '100']
func = ident + Group(Opt(DelimitedList(term)))
print(func.parse_string("fn a, b, 100"))
# -> ['fn', ['a', 'b', '100']]
r aslistc > > [ TU ] U5 SU l X l g r )rL r3 r
_asPythonList)r0 r r r s r2 r3 Group.__init__Y
#r5 c U R ( aH [ R " [ U[ 5 ( a UR 5 5 $ [ U5 5 $ U/$ r- )r r# r rz rv r rp s r2 rr Group.postParse^ sV $$ i 66 "
)_
; r5 )r r r9 r8 r> r? r@ rH r r r3 rr rA rc rd s @r2 r r D s* ($] $D $ $
r5 r c B ^ \ rS rSrSrSS\S\4U 4S jjjrS rSr U =r
$ ) rC ii a Converter to return a repetitive expression as a list, but also
as a dictionary. Each element can also be referenced using the first
token in the expression as its key. Useful for tabular report
scraping when the first column can be used as a item key.
The optional ``asdict`` argument when set to True will return the
parsed tokens as a Python dict instead of a pyparsing ParseResults.
Example::
data_word = Word(alphas)
label = data_word + FollowedBy(':')
text = "shape: SQUARE posn: upper left color: light blue texture: burlap"
attr_expr = (label + Suppress(':') + OneOrMore(data_word, stop_on=label).set_parse_action(' '.join))
# print attributes as plain groups
print(attr_expr[1, ...].parse_string(text).dump())
# instead of OneOrMore(expr), parse using Dict(Group(expr)[1, ...]) - Dict will auto-assign names
result = Dict(Group(attr_expr)[1, ...]).parse_string(text)
print(result.dump())
# access named fields as dict entries, or output as dict
print(result['shape'])
print(result.as_dict())
prints::
['shape', 'SQUARE', 'posn', 'upper left', 'color', 'light blue', 'texture', 'burlap']
[['shape', 'SQUARE'], ['posn', 'upper left'], ['color', 'light blue'], ['texture', 'burlap']]
- color: 'light blue'
- posn: 'upper left'
- shape: 'SQUARE'
- texture: 'burlap'
SQUARE
{'color': 'light blue', 'posn': 'upper left', 'texture': 'burlap', 'shape': 'SQUARE'}
See more examples at :class:`ParseResults` of accessing fields by results name.
r asdictc > > [ TU ] U5 SU l X l g r )rL r3 r
_asPythonDict)r0 r r r s r2 r3
Dict.__init__ r r5 c , [ U5 GH u pE[ U5 S:X a M US n[ U[ 5 ( a [ U5 R 5 n[ U5 S:X a [
SU5 X6' Mi [ U5 S:X a+ [ US [ 5 ( d [
US U5 X6' M UR 5 nUS [ U5 S:w d* [ U[ 5 ( a$ UR 5 ( a [
Xt5 X6' M [
US U5 X6' GM U R ( a2 U R ( a UR 5 /$ UR 5 $ U R ( a U/$ U$ ! [ a [ S5 nUS ef = f)Nr r r rn zdcould not extract dict values from parsed results - Dict expression must contain Grouped expressions)r re rz r rT r r$ r# r% ry r r r r as_dict) r0 r r rq r tokikey dictvaluer s r2 rr Dict.postParse s_ *FA3x1}q6D$$$4y(3x1}"9"a"@ SQ z#a&,'G'G"9#a&!"D ( #
I aLy>Q& y,77I USL a [ [ 5 5 n[ TU ]
U5 g )N.)r r; rL r3 r s r2 r3 Suppress.__init__ s# 3; *D
r5 r` c > [ U R [ 5 ( a [ [ U5 5 U- $ [
TU ] U5 $ r- )rz r r rK r rL r r s r2 r Suppress.__add__ 7 dii . .F5M*U2 27?5) )r5 c > [ U R [ 5 ( a [ [ U5 5 U-
$ [
TU ] U5 $ r- )rz r r rK r rL r r s r2 r Suppress.__sub__ r r5 c / $ r- rB rp s r2 rr Suppress.postParse r r5 c U $ r- rB r5 s r2 rL Suppress.suppress s r5 rB r9 r: )r8 r> r? r@ rH r
r rT r r3 r r rr rL rA rc rd s @r2 rK rK sJ < U=##5 6 $
* * - r5 rK r c L ^ [ T 5 m U 4S jnT R Ul U$ )a3 Decorator for debugging parse actions.
When the parse action is called, this decorator will print
``">> entering method-name(line:, , )"``.
When the parse action completes, the decorator will print
``"<<"`` followed by the returned value, or any exception that the parse action raised.
Example::
wd = Word(alphas)
@trace_parse_action
def remove_duplicate_chars(tokens):
return ''.join(sorted(set(''.join(tokens))))
wds = wd[1, ...].set_parse_action(remove_duplicate_chars)
print(wds.parse_string("slkdjs sld sldd sdlf sdljf"))
prints::
>>entering remove_duplicate_chars(line: 'slkdjs sld sldd sdlf sdljf', 0, (['slkdjs', 'sld', 'sldd', 'sdlf', 'sdljf'], {}))
< TR nU SS u p#n[ U 5 S: a U S R R S- U- n[ R R SU S[
X25 < SU SU< S3 5 T" U 6 n[ R R S U S U< S35 U$ ! [ a, n[ R R S U S
U S35 e S nAff = f) Nr' r .z >>entering z(line: r z)
z
<.z s ::+a v;? ay**33c9HDH
;xjQ
~Rs"QEQTUV V*C
:hZwsgSAB
JJ z(=S I J s <B* *
C 4'CC )r r8 )r r s ` r2 trace_parse_actionr s% 2 AA AJ Hr5 empty
line_startline_end string_start
string_endz \\[\\[\]\/\-\*\.\$\+\^\?()~ ]c US S $ r rB r s r2 r r , s AaDGr5 z\\0?[xX][0-9a-fA-F]+c P [ [ US R S5 S5 5 $ )Nr z\0xr )chrr r r s r2 r r / s CAaDKK /45r5 z \\0[0-7]+c 8 [ [ US SS S5 5 $ )Nr r r( )r r r s r2 r r 2 s CAaDHa()r5 z\])r r r r negatebodyr9 r c ^ S m SR U4S j[ R U 5 R 5 5 $ ! [ a
n SnAgSnAff = f)a Helper to easily define string ranges for use in :class:`Word`
construction. Borrows syntax from regexp ``'[]'`` string range
definitions::
srange("[0-9]") -> "0123456789"
srange("[a-z]") -> "abcdefghijklmnopqrstuvwxyz"
srange("[a-z$_]") -> "abcdefghijklmnopqrstuvwxyz$_"
The input string must be enclosed in []'s, and the returned string
is the expanded character set joined into a single string. The
values enclosed in the []'s may be:
- a single character
- an escaped character with a leading backslash (such as ``\-``
or ``\]``)
- an escaped hex character with a leading ``'\x'``
(``\x21``, which is a ``'!'`` character) (``\0x##``
is also supported for backwards compatibility)
- an escaped octal character with a leading ``'\0'``
(``\041``, which is a ``'!'`` character)
- a range of any of the above, separated by a dash (``'a-z'``,
etc.)
- any combination of the above (``'aeiouy'``,
``'a-zA-Z0-9_$'``, etc.)
c
[ U [ 5 ( d U $ SR S [ [ U S 5 [ U S 5 S- 5 5 5 $ )Nr c 3 8 # U H n[ U5 v M g 7fr- )r r s r2 r +srange....] s E%DSVV%DrH r r )rz r# r rR ord)ps r2 r srange..[ sM !\** F
WWEU3qt9c!A$i!m%DE
EFr5 r c 3 4 ># U H
nT" U5 v M g 7fr- rB )rP part _expandeds r2 r srange..` s W3V4y3Vs N)r _reBracketExprr r ry )r r] r s @r2 sranger
@ sL 6 F
wwW>3N3Nq3Q3V3VWWW s 7>
A
Ac f ^ ^ UU 4S jn[ T S[ T S5 R 5 nX2l U$ )a Helper to define a parse action by mapping a function to all
elements of a :class:`ParseResults` list. If any additional args are passed,
they are forwarded to the given function as additional arguments
after the token, as in
``hex_integer = Word(hexnums).set_parse_action(token_map(int, 16))``,
which will convert the parsed data to an integer using base 16.
Example (compare the last to example in :class:`ParserElement.transform_string`::
hex_ints = Word(hexnums)[1, ...].set_parse_action(token_map(int, 16))
hex_ints.run_tests('''
00 11 22 aa FF 0a 0d 1a
''')
upperword = Word(alphas).set_parse_action(token_map(str.upper))
upperword[1, ...].run_tests('''
my kingdom for a horse
''')
wd = Word(alphas).set_parse_action(token_map(str.title))
wd[1, ...].set_parse_action(' '.join).run_tests('''
now is the winter of our discontent made glorious summer by this sun of york
''')
prints::
00 11 22 aa FF 0a 0d 1a
[0, 17, 34, 170, 255, 10, 13, 26]
my kingdom for a horse
['MY', 'KINGDOM', 'FOR', 'A', 'HORSE']
now is the winter of our discontent made glorious summer by this sun of york
['Now Is The Winter Of Our Discontent Made Glorious Summer By This Sun Of York']
c B > U Vs/ s H nT" U/TQ76 PM sn$ s snf r- rB )r r r toknr r1 s r2 r token_map..pa s% ./0adT!D!a000s r8 r )r r8 )r1 r r r s `` r2 token_mapr e s0 J1 j'$ *D*M*MNIK
Ir5 c P [ R " 5 R n U c g[ R " [
R U 5 n U R R 5 H@ u p[ U[ 5 ( d M UR ( a M/ UR U5 MB g)zm
Utility to simplify mass-naming of parser elements, for
generating railroad diagram with named subdiagrams.
N)
r _getframef_backr r types FrameTypef_localsr! rz r r rs )
calling_framer\ vars r2 autoname_elementsr sn
MMO**M KK ?M"++113 c= ) )#... LL 4r5 z4"(?:[^"\n\r\\]|(?:"")|(?:\\(?:[^x]|x[0-9a-fA-F]+)))*"z string enclosed in double quotesz4'(?:[^'\n\r\\]|(?:'')|(?:\\(?:[^x]|x[0-9a-fA-F]+)))*'z string enclosed in single quoteszdouble quoted stringzsingle quoted stringz+quoted string using single or double quotesz""""(?:[^"\\]|""(?!")|"(?!"")|\\.)*rM z"""z multiline double quoted stringz"'''(?:[^'\\]|''(?!')|'(?!'')|\\.)*z'''z multiline single quoted stringz5"(?:[^"\n\r\\]|(?:\\")|(?:\\(?:[^x]|x[0-9a-fA-F]+)))*z5'(?:[^'\n\r\\]|(?:\\')|(?:\\(?:[^x]|x[0-9a-fA-F]+)))*zPython quoted stringuzunicode string literalz#[\0xc0-\0xd6\0xd8-\0xf6\0xf8-\0xff]z[\0xa1-\0xbf\0xd7\0xf7]r c g r- rB rB r5 r2 nullDebugActionr r2 r5 c g r- rB rB r5 r2 traceParseActionr r r5 c g r- rB rB r5 r2 conditionAsParseActionr! r r5 c g r- rB rB r5 r2 tokenMapr# s r5 r_ )r' r r9 ) collectionsr osr r r r r r r r
r r r
r abcr r enumr stringr% r r r collections.abcr r r operatorr functoolsr threadingr pathlibr utilr r r r r r r r r r r r!
exceptionsactionsr r# r$ unicoder% maxsizerE rT bytesr& r r version_infor) rD rS rl rv ry r] r r r warnoptionsenvironrK sumre r r r r r r rJ r r r
GeneratorTyper r ParseImplReturnTypePostParseReturnTyper? r@ ry rA r r r ascii_uppercaseascii_lowercasealphasLatin1
identcharsidentbodycharsnumshexnumsr r printable
whitespacer r StackSummaryr r r r r r r r rf r; r r rz r r r r r r r r r6 rc rr r r r r r r r r r r r& r r- r r r r r r r' r4 r? r r rR r_ r r r r rY r rC rK r rs r r r r r rN _escapedPunc_escapedHexChar_escapedOctChar _singleChar
_charRanger, r r
r r dbl_quoted_stringsgl_quoted_stringr rS python_quoted_stringunicode_string
alphas8bitpunc8bitr valuesrz r sglQuotedStringdblQuotedString quotedString
unicodeString lineStartlineEnd stringStart stringEndr r r! r# )rx r$ s 00r2 rZ s
$
$ : & ;; !5\%c
)4 v ) . ~ , *$ *D$; $4 $%K %D %# !??3/?Es?S " OORZZ^^$@A
$$CHo L(<*@ @A RW l^S
! c<
#
%& c3
%s
*+- RX l^T
!" c<
$
&' c3
%t
+,. CoyA4GHS# =t CD #sO\48$> c?It Ld RS
&"8"8 8
%
%
0
0
"))88
TM
WW!1!1P!1Af>O>O5Oa!1P
Q
04 y-- 46t MR!' !5EI: GL
#2
?C
&
@ @ @
@ @
@
@" UU U U
U
URM C M b<&
= &
R #M # ?e ? 2?e 2?jG "? ? %,
!s7e s7l?g ?6Bg B2T? T?n|#5 |#~
4
,X)E X)vJ5 JZM( M(`J(E J(Z#E # >,?
,?^Cm C.- "C
C(
4m 6i$m i$Z`!/ `!F]= ]=@q= q=hkB? kB\j$- j$\=
' =
@;' ;* ;% ;B!$ !HO$ Od'#! '#T(+
(+VJ=( J=Z - -@ - -D>T' >TB G!
G!T
DE$! E$R ( 6n 6r" N " JTB> TBn4~ 4n*
+ *
+ *
\ !
[
!
!,
/
9 j )}%%n5
[
!
!,
/
56GG /0AA5 %66) ?"_4z%q7QQ ;# .<
=
CL #h )* Ij;. /0AA&IJ cl "c "c "J+k +\
ABSH
( -.
ABSH
( -.
BCcISS
DEKUU ( 89
0 EMWW( 32<<H5Ph/0 1
EFLVV
EFLVV
( !" } 1 1 334==>VW :
;
, -
v}}' !*Q
">A']# $#
#$ % $% & +, ! - !) uv QBv's <a:a:
a? a?