pyparsing module¶

pyparsing module - Classes and methods to define and execute parsing grammars¶

The pyparsing module is an alternative approach to creating and executing simple grammars, vs. the traditional lex/yacc approach, or the use of regular expressions. With pyparsing, you don’t need to learn a new syntax for defining grammars or matching expressions - the parsing module provides a library of classes that you use to construct the grammar directly in Python.

Here is a program to parse “Hello, World!” (or any greeting of the form "<salutation>, <addressee>!"), built up using Word, Literal, and And elements (the '+' operators create And expressions, and the strings are auto-converted to Literal expressions):

from pyparsing import Word, alphas

# define grammar of a greeting
greet = Word(alphas) + "," + Word(alphas) + "!"

hello = "Hello, World!"
print(hello, "->", greet.parse_string(hello))

The program outputs the following:

Hello, World! -> ['Hello', ',', 'World', '!']

The Python representation of the grammar is quite readable, owing to the self-explanatory class names, and the use of '+', '|', '^' and '&' operators.

The ParseResults object returned from ParserElement.parseString can be accessed as a nested list, a dictionary, or an object with named attributes.

The pyparsing module handles some of the problems that are typically vexing when writing text parsers:

extra or missing whitespace (the above program will also handle “Hello,World!”, “Hello , World !”, etc.)

quoted strings

embedded comments

Getting Started -¶

Visit the classes ParserElement and ParseResults to see the base classes that most other pyparsing classes inherit from. Use the docstrings for examples of how to:

construct literal match expressions from Literal and CaselessLiteral classes

construct character word-group expressions using the Word class

see how to create repetitive expressions using ZeroOrMore and OneOrMore classes

use '+', '|', '^', and '&' operators to combine simple expressions into more complex ones

associate names with your parsed results using ParserElement.setResultsName

access the parsed data, which is returned as a ParseResults object

find some helpful expression short-cuts like delimitedList and oneOf

find more useful common expressions in the pyparsing_common namespace class

class pyparsing.And(exprs_arg: Iterable[pyparsing.core.ParserElement], savelist: bool = True)¶

Bases: pyparsing.core.ParseExpression

Requires all given 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")

__init__(exprs_arg: Iterable[pyparsing.core.ParserElement], savelist: bool = True)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.AtLineStart(expr: Union[pyparsing.core.ParserElement, str])¶

Bases: pyparsing.core.ParseElementEnhance

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') + restOfLine).search_string(test):
    print(t)

prints:

['AAA', ' this line']
['AAA', ' and this line']

__init__(expr: Union[pyparsing.core.ParserElement, str])¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.AtStringStart(expr: Union[pyparsing.core.ParserElement, str])¶

Bases: pyparsing.core.ParseElementEnhance

Matches 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

__init__(expr: Union[pyparsing.core.ParserElement, str])¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.CaselessKeyword(match_string: str = '', ident_chars: Optional[str] = None, *, matchString: str = '', identChars: Optional[str] = None)¶

Bases: pyparsing.core.Keyword

Caseless version of Keyword.

Example:

CaselessKeyword("CMD")[1, ...].parse_string("cmd CMD Cmd10")
# -> ['CMD', 'CMD']

(Contrast with example for CaselessLiteral.)

__init__(match_string: str = '', ident_chars: Optional[str] = None, *, matchString: str = '', identChars: Optional[str] = None)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.CaselessLiteral(match_string: str = '', *, matchString: str = '')¶

Bases: pyparsing.core.Literal

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 CaselessKeyword.)

__init__(match_string: str = '', *, matchString: str = '')¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Char(charset: str, as_keyword: bool = False, exclude_chars: Optional[str] = None, *, asKeyword: bool = False, excludeChars: Optional[str] = None)¶

Bases: pyparsing.core._WordRegex

A short-cut class for defining Word (characters, exact=1), when defining a match of any single character in a string of characters.

__init__(charset: str, as_keyword: bool = False, exclude_chars: Optional[str] = None, *, asKeyword: bool = False, excludeChars: Optional[str] = None)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.CharsNotIn(not_chars: str = '', min: int = 1, max: int = 0, exact: int = 0, *, notChars: str = '')¶

Bases: pyparsing.core.Token

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(delimited_list(csv_value).parse_string("dkls,lsdkjf,s12 34,@!#,213"))

prints:

['dkls', 'lsdkjf', 's12 34', '@!#', '213']

__init__(not_chars: str = '', min: int = 1, max: int = 0, exact: int = 0, *, notChars: str = '')¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.CloseMatch(match_string: str, max_mismatches: Optional[int] = None, *, maxMismatches: int = 1, caseless=False)¶

Bases: pyparsing.core.Token

A variation on Literal which matches “close” matches, that is, strings with at most ‘n’ mismatching characters. 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']})

__init__(match_string: str, max_mismatches: Optional[int] = None, *, maxMismatches: int = 1, caseless=False)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Combine(expr: pyparsing.core.ParserElement, join_string: str = '', adjacent: bool = True, *, joinString: Optional[str] = None)¶

Bases: pyparsing.core.TokenConverter

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...)

__init__(expr: pyparsing.core.ParserElement, join_string: str = '', adjacent: bool = True, *, joinString: Optional[str] = None)¶: Initialize self. See help(type(self)) for accurate signature.

ignore(other) → pyparsing.core.ParserElement¶

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']

class pyparsing.Dict(expr: pyparsing.core.ParserElement, asdict: bool = False)¶

Bases: pyparsing.core.TokenConverter

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 ParseResults of accessing fields by results name.

__init__(expr: pyparsing.core.ParserElement, asdict: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Each(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = True)¶

Bases: pyparsing.core.ParseExpression

Requires all given 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

__init__(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = True)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Empty¶

Bases: pyparsing.core.Token

An empty token, will always match.

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.FollowedBy(expr: Union[pyparsing.core.ParserElement, str])¶

Bases: pyparsing.core.ParseElementEnhance

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']]

__init__(expr: Union[pyparsing.core.ParserElement, str])¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Forward(other: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶

Bases: pyparsing.core.ParseElementEnhance

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 ParseResults.pprint for an example of a recursive parser created using Forward.

__init__(other: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶: Initialize self. See help(type(self)) for accurate signature.

__or__(other)¶: Implementation of | operator - returns MatchFirst

copy() → pyparsing.core.ParserElement¶

Make a copy of this 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")

ignoreWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Enables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern.

Parameters: recursive – If True (the default), also enable whitespace skipping in child elements (if any)

ignore_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Enables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern.

Parameters: recursive – If True (the default), also enable whitespace skipping in child elements (if any)

leaveWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Disables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars.

Parameters: recursive – If true (the default), also disable whitespace skipping in child elements (if any)

leave_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Disables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars.

Parameters: recursive – If true (the default), also disable whitespace skipping in child elements (if any)

validate(validateTrace=None) → None¶: Check defined expressions for valid structure, check for infinite recursive definitions.

class pyparsing.GoToColumn(colno: int)¶

Bases: pyparsing.core.PositionToken

Token to advance to a specific column of input text; useful for tabular report scraping.

__init__(colno: int)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Group(expr: pyparsing.core.ParserElement, aslist: bool = False)¶

Bases: pyparsing.core.TokenConverter

Converter to return the matched tokens as a list - useful for returning tokens of ZeroOrMore and 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(delimited_list(term))
print(func.parse_string("fn a, b, 100"))
# -> ['fn', 'a', 'b', '100']

func = ident + Group(Opt(delimited_list(term)))
print(func.parse_string("fn a, b, 100"))
# -> ['fn', ['a', 'b', '100']]

__init__(expr: pyparsing.core.ParserElement, aslist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.IndentedBlock(expr: pyparsing.core.ParserElement, *, recursive: bool = False, grouped: bool = True)¶

Bases: pyparsing.core.ParseElementEnhance

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).

__init__(expr: pyparsing.core.ParserElement, *, recursive: bool = False, grouped: bool = True)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Keyword(match_string: str = '', ident_chars: Optional[str] = None, caseless: bool = False, *, matchString: str = '', identChars: Optional[str] = None)¶

Bases: pyparsing.core.Token

Token to exactly match a specified string as a keyword, that is, it must be immediately followed by a non-keyword character. Compare with 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:

identChars 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 CaselessKeyword.

__init__(match_string: str = '', ident_chars: Optional[str] = None, caseless: bool = False, *, matchString: str = '', identChars: Optional[str] = None)¶: Initialize self. See help(type(self)) for accurate signature.

static setDefaultKeywordChars(chars) → None¶: Overrides the default characters used by Keyword expressions.

static set_default_keyword_chars(chars) → None¶: Overrides the default characters used by Keyword expressions.

class pyparsing.LineEnd¶

Bases: pyparsing.core.PositionToken

Matches if current position is at the end of a line within the parse string

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.LineStart¶

Bases: pyparsing.core.PositionToken

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' + restOfLine).search_string(test):
    print(t)

prints:

['AAA', ' this line']
['AAA', ' and this line']

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Literal(match_string: str = '', *, matchString: str = '')¶

Bases: pyparsing.core.Token

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 CaselessLiteral.

For keyword matching (force word break before and after the matched string), use Keyword or CaselessKeyword.

__init__(match_string: str = '', *, matchString: str = '')¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Located(expr: Union[pyparsing.core.ParserElement, str], savelist: bool = False)¶

Bases: pyparsing.core.ParseElementEnhance

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 <TAB> characters, you may want to call 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]

class pyparsing.MatchFirst(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = False)¶

Bases: pyparsing.core.ParseExpression

Requires that at least one 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']]

__init__(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.NoMatch¶

Bases: pyparsing.core.Token

A token that will never match.

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.NotAny(expr: Union[pyparsing.core.ParserElement, str])¶

Bases: pyparsing.core.ParseElementEnhance

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(".")

__init__(expr: Union[pyparsing.core.ParserElement, str])¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.OneOrMore(expr: pyparsing.core.ParserElement, stop_on: Optional[Union[pyparsing.core.ParserElement, str]] = None, *, stopOn: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶

Bases: pyparsing.core._MultipleMatch

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()

class pyparsing.OnlyOnce(method_call)¶

Bases: object

Wrapper for parse actions, to ensure they are only called once.

__call__(s, l, t)¶: Call self as a function.

__init__(method_call)¶: Initialize self. See help(type(self)) for accurate signature.

__weakref__¶: list of weak references to the object (if defined)

reset()¶: Allow the associated parse action to be called once more.

class pyparsing.OpAssoc(value)¶

Bases: enum.Enum

An enumeration.

class pyparsing.Opt(expr: Union[pyparsing.core.ParserElement, str], default: Any = <pyparsing.core._NullToken object>)¶

Bases: pyparsing.core.ParseElementEnhance

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)

__init__(expr: Union[pyparsing.core.ParserElement, str], default: Any = <pyparsing.core._NullToken object>)¶: Initialize self. See help(type(self)) for accurate signature.

pyparsing.Optional¶: alias of pyparsing.core.Opt

class pyparsing.Or(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = False)¶

Bases: pyparsing.core.ParseExpression

Requires that at least one 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']]

__init__(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

exception pyparsing.ParseBaseException(pstr: str, loc: int = 0, msg: Optional[str] = None, elem=None)¶

Bases: Exception

base exception class for all parsing runtime exceptions

__init__(pstr: str, loc: int = 0, msg: Optional[str] = None, elem=None)¶: Initialize self. See help(type(self)) for accurate signature.

__repr__()¶: Return repr(self).

__str__() → str¶: Return str(self).

__weakref__¶: list of weak references to the object (if defined)

property col¶: Return the 1-based column on the line of text where the exception occurred.

property column¶: Return the 1-based column on the line of text where the exception occurred.

explain(depth=16) → str¶

Method to translate the Python internal traceback into a list of the pyparsing expressions that caused the exception to be raised.

Parameters:

depth (default=16) - number of levels back in the stack trace to list expression and function names; if None, the full stack trace names will be listed; if 0, only the failing input line, marker, and exception string will be shown

Returns a multi-line string listing the ParserElements and/or function names in the exception’s stack trace.

Example:

expr = pp.Word(pp.nums) * 3
try:
    expr.parse_string("123 456 A789")
except pp.ParseException as pe:
    print(pe.explain(depth=0))

prints:

123 456 A789
        ^
ParseException: Expected W:(0-9), found 'A'  (at char 8), (line:1, col:9)

Note: the diagnostic output will include string representations of the expressions that failed to parse. These representations will be more helpful if you use set_name to give identifiable names to your expressions. Otherwise they will use the default string forms, which may be cryptic to read.

Note: pyparsing’s default truncation of exception tracebacks may also truncate the stack of expressions that are displayed in the explain output. To get the full listing of parser expressions, you may have to set ParserElement.verbose_stacktrace = True

static explain_exception(exc, depth=16)¶

Method to take an exception and translate the Python internal traceback into a list of the pyparsing expressions that caused the exception to be raised.

Parameters:

exc - exception raised during parsing (need not be a ParseException, in support of Python exceptions that might be raised in a parse action)
depth (default=16) - number of levels back in the stack trace to list expression and function names; if None, the full stack trace names will be listed; if 0, only the failing input line, marker, and exception string will be shown

Returns a multi-line string listing the ParserElements and/or function names in the exception’s stack trace.

property line¶: Return the line of text where the exception occurred.

property lineno¶: Return the 1-based line number of text where the exception occurred.

markInputline(marker_string: Optional[str] = None, *, markerString='>!<') → str¶: Extracts the exception line from the input string, and marks the location of the exception with a special symbol.

mark_input_line(marker_string: Optional[str] = None, *, markerString='>!<') → str¶: Extracts the exception line from the input string, and marks the location of the exception with a special symbol.

class pyparsing.ParseElementEnhance(expr: Union[pyparsing.core.ParserElement, str], savelist: bool = False)¶

Bases: pyparsing.core.ParserElement

Abstract subclass of ParserElement, for combining and post-processing parsed tokens.

__init__(expr: Union[pyparsing.core.ParserElement, str], savelist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

ignore(other) → pyparsing.core.ParserElement¶

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']

ignoreWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Enables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern.

Parameters: recursive – If True (the default), also enable whitespace skipping in child elements (if any)

ignore_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Enables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern.

Parameters: recursive – If True (the default), also enable whitespace skipping in child elements (if any)

leaveWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Disables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars.

Parameters: recursive – If true (the default), also disable whitespace skipping in child elements (if any)

leave_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Disables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars.

Parameters: recursive – If true (the default), also disable whitespace skipping in child elements (if any)

validate(validateTrace=None) → None¶: Check defined expressions for valid structure, check for infinite recursive definitions.

exception pyparsing.ParseException(pstr: str, loc: int = 0, msg: Optional[str] = None, elem=None)¶

Bases: pyparsing.exceptions.ParseBaseException

Exception thrown when a parse expression doesn’t match the input string

Example:

try:
    Word(nums).set_name("integer").parse_string("ABC")
except ParseException as pe:
    print(pe)
    print("column: {}".format(pe.column))

prints:

Expected integer (at char 0), (line:1, col:1)
 column: 1

class pyparsing.ParseExpression(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = False)¶

Bases: pyparsing.core.ParserElement

Abstract subclass of ParserElement, for combining and post-processing parsed tokens.

__init__(exprs: Iterable[pyparsing.core.ParserElement], savelist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

copy() → pyparsing.core.ParserElement¶

Make a copy of this 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")

ignore(other) → pyparsing.core.ParserElement¶

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']

ignoreWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Extends ignore_whitespace defined in base class, and also invokes leave_whitespace on: all contained expressions.

ignore_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Extends ignore_whitespace defined in base class, and also invokes leave_whitespace on: all contained expressions.

leaveWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Extends leave_whitespace defined in base class, and also invokes leave_whitespace on: all contained expressions.

leave_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Extends leave_whitespace defined in base class, and also invokes leave_whitespace on: all contained expressions.

validate(validateTrace=None) → None¶: Check defined expressions for valid structure, check for infinite recursive definitions.

exception pyparsing.ParseFatalException(pstr: str, loc: int = 0, msg: Optional[str] = None, elem=None)¶

Bases: pyparsing.exceptions.ParseBaseException

User-throwable exception thrown when inconsistent parse content is found; stops all parsing immediately

class pyparsing.ParseResults(toklist=None, name=None, **kwargs)¶

Bases: object

Structured parse results, to provide multiple means of access to the parsed data:

as a list (len(results))
by list index (results[0], results[1], etc.)
by attribute (results.<results_name> - see ParserElement.set_results_name)

Example:

integer = Word(nums)
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"))

# parse_string returns a ParseResults object
result = date_str.parse_string("1999/12/31")

def test(s, fn=repr):
    print("{} -> {}".format(s, fn(eval(s))))
test("list(result)")
test("result[0]")
test("result['month']")
test("result.day")
test("'month' in result")
test("'minutes' in result")
test("result.dump()", str)

prints:

list(result) -> ['1999', '/', '12', '/', '31']
result[0] -> '1999'
result['month'] -> '12'
result.day -> '31'
'month' in result -> True
'minutes' in result -> False
result.dump() -> ['1999', '/', '12', '/', '31']
- day: '31'
- month: '12'
- year: '1999'

class List(contained=None)¶

Bases: list

Simple wrapper class to distinguish parsed list results that should be preserved as actual Python lists, instead of being converted to ParseResults:

LBRACK, RBRACK = map(pp.Suppress, “[]”) element = pp.Forward() item = ppc.integer element_list = LBRACK + pp.delimited_list(element) + RBRACK

# add parse actions to convert from ParseResults to actual Python collection types def as_python_list(t):

return pp.ParseResults.List(t.as_list())

element_list.add_parse_action(as_python_list)

element <<= item | element_list

element.run_tests(‘’’
100 [2,3,4] [[2, 1],3,4] [(2, 1),3,4] (2,3,4) ‘’’, post_parse=lambda s, r: (r[0], type(r[0])))

prints:

100 (100, <class ‘int’>)

[2,3,4] ([2, 3, 4], <class ‘list’>)

[[2, 1],3,4] ([[2, 1], 3, 4], <class ‘list’>)

(Used internally by Group when aslist=True.)

__dict__ = mappingproxy({'__module__': 'pyparsing.results', '__doc__': '\n Simple wrapper class to distinguish parsed list results that should be preserved\n as actual Python lists, instead of being converted to :class:`ParseResults`:\n\n LBRACK, RBRACK = map(pp.Suppress, "[]")\n element = pp.Forward()\n item = ppc.integer\n element_list = LBRACK + pp.delimited_list(element) + RBRACK\n\n # add parse actions to convert from ParseResults to actual Python collection types\n def as_python_list(t):\n return pp.ParseResults.List(t.as_list())\n element_list.add_parse_action(as_python_list)\n\n element <<= item | element_list\n\n element.run_tests(\'\'\'\n 100\n [2,3,4]\n [[2, 1],3,4]\n [(2, 1),3,4]\n (2,3,4)\n \'\'\', post_parse=lambda s, r: (r[0], type(r[0])))\n\n prints:\n\n 100\n (100, <class \'int\'>)\n\n [2,3,4]\n ([2, 3, 4], <class \'list\'>)\n\n [[2, 1],3,4]\n ([[2, 1], 3, 4], <class \'list\'>)\n\n (Used internally by :class:`Group` when `aslist=True`.)\n ', '__new__': <staticmethod object>, '__dict__': <attribute '__dict__' of 'List' objects>, '__weakref__': <attribute '__weakref__' of 'List' objects>, '__annotations__': {}})¶

static __new__(cls, contained=None)¶: Create and return a new object. See help(type) for accurate signature.

__weakref__¶: list of weak references to the object (if defined)

__dir__()¶: Default dir() implementation.

__init__(toklist=None, name=None, asList=True, modal=True, isinstance=<built-in function isinstance>)¶: Initialize self. See help(type(self)) for accurate signature.

static __new__(cls, toklist=None, name=None, **kwargs)¶: Create and return a new object. See help(type) for accurate signature.

__repr__() → str¶: Return repr(self).

__str__() → str¶: Return str(self).

append(item)¶

Add single element to end of ParseResults list of elements.

Example:

numlist = Word(nums)[...]
print(numlist.parse_string("0 123 321")) # -> ['0', '123', '321']

# use a parse action to compute the sum of the parsed integers, and add it to the end
def append_sum(tokens):
    tokens.append(sum(map(int, tokens)))
numlist.add_parse_action(append_sum)
print(numlist.parse_string("0 123 321")) # -> ['0', '123', '321', 444]

asDict() → dict¶

Returns the named parse results as a nested dictionary.

Example:

integer = Word(nums)
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")

result = date_str.parse_string('12/31/1999')
print(type(result), repr(result)) # -> <class 'pyparsing.ParseResults'> (['12', '/', '31', '/', '1999'], {'day': [('1999', 4)], 'year': [('12', 0)], 'month': [('31', 2)]})

result_dict = result.as_dict()
print(type(result_dict), repr(result_dict)) # -> <class 'dict'> {'day': '1999', 'year': '12', 'month': '31'}

# even though a ParseResults supports dict-like access, sometime you just need to have a dict
import json
print(json.dumps(result)) # -> Exception: TypeError: ... is not JSON serializable
print(json.dumps(result.as_dict())) # -> {"month": "31", "day": "1999", "year": "12"}

asList() → list¶

Returns the parse results as a nested list of matching tokens, all converted to strings.

Example:

patt = Word(alphas)[1, ...]
result = patt.parse_string("sldkj lsdkj sldkj")
# even though the result prints in string-like form, it is actually a pyparsing ParseResults
print(type(result), result) # -> <class 'pyparsing.ParseResults'> ['sldkj', 'lsdkj', 'sldkj']

# Use as_list() to create an actual list
result_list = result.as_list()
print(type(result_list), result_list) # -> <class 'list'> ['sldkj', 'lsdkj', 'sldkj']

as_dict() → dict¶

Returns the named parse results as a nested dictionary.

Example:

integer = Word(nums)
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")

result = date_str.parse_string('12/31/1999')
print(type(result), repr(result)) # -> <class 'pyparsing.ParseResults'> (['12', '/', '31', '/', '1999'], {'day': [('1999', 4)], 'year': [('12', 0)], 'month': [('31', 2)]})

result_dict = result.as_dict()
print(type(result_dict), repr(result_dict)) # -> <class 'dict'> {'day': '1999', 'year': '12', 'month': '31'}

# even though a ParseResults supports dict-like access, sometime you just need to have a dict
import json
print(json.dumps(result)) # -> Exception: TypeError: ... is not JSON serializable
print(json.dumps(result.as_dict())) # -> {"month": "31", "day": "1999", "year": "12"}

as_list() → list¶

Returns the parse results as a nested list of matching tokens, all converted to strings.

Example:

patt = Word(alphas)[1, ...]
result = patt.parse_string("sldkj lsdkj sldkj")
# even though the result prints in string-like form, it is actually a pyparsing ParseResults
print(type(result), result) # -> <class 'pyparsing.ParseResults'> ['sldkj', 'lsdkj', 'sldkj']

# Use as_list() to create an actual list
result_list = result.as_list()
print(type(result_list), result_list) # -> <class 'list'> ['sldkj', 'lsdkj', 'sldkj']

clear()¶: Clear all elements and results names.

copy() → pyparsing.results.ParseResults¶: Returns a new copy of a ParseResults object.

dump(indent='', full=True, include_list=True, _depth=0) → str¶

Diagnostic method for listing out the contents of a ParseResults. Accepts an optional indent argument so that this string can be embedded in a nested display of other data.

Example:

integer = Word(nums)
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")

result = date_str.parse_string('1999/12/31')
print(result.dump())

prints:

['1999', '/', '12', '/', '31']
- day: '31'
- month: '12'
- year: '1999'

extend(itemseq)¶

Add sequence of elements to end of ParseResults list of elements.

Example:

patt = Word(alphas)[1, ...]

# use a parse action to append the reverse of the matched strings, to make a palindrome
def make_palindrome(tokens):
    tokens.extend(reversed([t[::-1] for t in tokens]))
    return ''.join(tokens)
patt.add_parse_action(make_palindrome)
print(patt.parse_string("lskdj sdlkjf lksd")) # -> 'lskdjsdlkjflksddsklfjkldsjdksl'

classmethod from_dict(other, name=None) → pyparsing.results.ParseResults¶: Helper classmethod to construct a ParseResults from a dict, preserving the name-value relations as results names. If an optional name argument is given, a nested ParseResults will be returned.

get(key, default_value=None)¶

Returns named result matching the given key, or if there is no such name, then returns the given default_value or None if no default_value is specified.

Similar to dict.get().

Example:

integer = Word(nums)
date_str = integer("year") + '/' + integer("month") + '/' + integer("day")

result = date_str.parse_string("1999/12/31")
print(result.get("year")) # -> '1999'
print(result.get("hour", "not specified")) # -> 'not specified'
print(result.get("hour")) # -> None

getName()¶

Returns the results name for this token expression. Useful when several different expressions might match at a particular location.

Example:

integer = Word(nums)
ssn_expr = Regex(r"\d\d\d-\d\d-\d\d\d\d")
house_number_expr = Suppress('#') + Word(nums, alphanums)
user_data = (Group(house_number_expr)("house_number")
            | Group(ssn_expr)("ssn")
            | Group(integer)("age"))
user_info = user_data[1, ...]

result = user_info.parse_string("22 111-22-3333 #221B")
for item in result:
    print(item.get_name(), ':', item[0])

prints:

age : 22
ssn : 111-22-3333
house_number : 221B

get_name()¶

Returns the results name for this token expression. Useful when several different expressions might match at a particular location.

Example:

integer = Word(nums)
ssn_expr = Regex(r"\d\d\d-\d\d-\d\d\d\d")
house_number_expr = Suppress('#') + Word(nums, alphanums)
user_data = (Group(house_number_expr)("house_number")
            | Group(ssn_expr)("ssn")
            | Group(integer)("age"))
user_info = user_data[1, ...]

result = user_info.parse_string("22 111-22-3333 #221B")
for item in result:
    print(item.get_name(), ':', item[0])

prints:

age : 22
ssn : 111-22-3333
house_number : 221B

haskeys() → bool¶: Since keys() returns an iterator, this method is helpful in bypassing code that looks for the existence of any defined results names.

insert(index, ins_string)¶

Inserts new element at location index in the list of parsed tokens.

Similar to list.insert().

Example:

numlist = Word(nums)[...]
print(numlist.parse_string("0 123 321")) # -> ['0', '123', '321']

# use a parse action to insert the parse location in the front of the parsed results
def insert_locn(locn, tokens):
    tokens.insert(0, locn)
numlist.add_parse_action(insert_locn)
print(numlist.parse_string("0 123 321")) # -> [0, '0', '123', '321']

pop(*args, **kwargs)¶

Removes and returns item at specified index (default= last). Supports both list and dict semantics for pop(). If passed no argument or an integer argument, it will use list semantics and pop tokens from the list of parsed tokens. If passed a non-integer argument (most likely a string), it will use dict semantics and pop the corresponding value from any defined results names. A second default return value argument is supported, just as in dict.pop().

Example:

numlist = Word(nums)[...]
print(numlist.parse_string("0 123 321")) # -> ['0', '123', '321']

def remove_first(tokens):
    tokens.pop(0)
numlist.add_parse_action(remove_first)
print(numlist.parse_string("0 123 321")) # -> ['123', '321']

label = Word(alphas)
patt = label("LABEL") + Word(nums)[1, ...]
print(patt.parse_string("AAB 123 321").dump())

# Use pop() in a parse action to remove named result (note that corresponding value is not
# removed from list form of results)
def remove_LABEL(tokens):
    tokens.pop("LABEL")
    return tokens
patt.add_parse_action(remove_LABEL)
print(patt.parse_string("AAB 123 321").dump())

prints:

['AAB', '123', '321']
- LABEL: 'AAB'

['AAB', '123', '321']

pprint(*args, **kwargs)¶

Pretty-printer for parsed results as a list, using the pprint module. Accepts additional positional or keyword args as defined for pprint.pprint .

Example:

ident = Word(alphas, alphanums)
num = Word(nums)
func = Forward()
term = ident | num | Group('(' + func + ')')
func <<= ident + Group(Optional(delimited_list(term)))
result = func.parse_string("fna a,b,(fnb c,d,200),100")
result.pprint(width=40)

prints:

['fna',
 ['a',
  'b',
  ['(', 'fnb', ['c', 'd', '200'], ')'],
  '100']]

exception pyparsing.ParseSyntaxException(pstr: str, loc: int = 0, msg: Optional[str] = None, elem=None)¶

Bases: pyparsing.exceptions.ParseFatalException

Just like ParseFatalException, but thrown internally when an ErrorStop (‘-‘ operator) indicates that parsing is to stop immediately because an unbacktrackable syntax error has been found.

class pyparsing.ParserElement(savelist: bool = False)¶

Bases: abc.ABC

Abstract base level parser element class.

class DebugActions(debug_try, debug_match, debug_fail)¶

Bases: NamedTuple

__getnewargs__()¶: Return self as a plain tuple. Used by copy and pickle.

static __new__(_cls, debug_try: Optional[Callable[[str, int, ParserElement, bool], None]], debug_match: Optional[Callable[[str, int, int, ParserElement, pyparsing.results.ParseResults, bool], None]], debug_fail: Optional[Callable[[str, int, ParserElement, Exception, bool], None]])¶: Create new instance of DebugActions(debug_try, debug_match, debug_fail)

__repr__()¶: Return a nicely formatted representation string

debug_fail: Optional[Callable[[str, int, pyparsing.core.ParserElement, Exception, bool], None]]¶: Alias for field number 2

debug_match: Optional[Callable[[str, int, int, pyparsing.core.ParserElement, pyparsing.results.ParseResults, bool], None]]¶: Alias for field number 1

debug_try: Optional[Callable[[str, int, pyparsing.core.ParserElement, bool], None]]¶: Alias for field number 0

__add__(other) → pyparsing.core.ParserElement¶

Implementation of + operator - returns And. Adding strings to a 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 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.

__and__(other) → pyparsing.core.ParserElement¶: Implementation of & operator - returns Each

__call__(name: Optional[str] = None) → pyparsing.core.ParserElement¶

Shortcut for 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 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")

__eq__(other)¶: Return self==value.

__getitem__(key)¶

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.

__hash__()¶: Return hash(self).

__init__(savelist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

__invert__() → pyparsing.core.ParserElement¶: Implementation of ~ operator - returns NotAny

__mul__(other) → pyparsing.core.ParserElement¶

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

__or__(other) → pyparsing.core.ParserElement¶: Implementation of | operator - returns MatchFirst

__radd__(other) → pyparsing.core.ParserElement¶: Implementation of + operator when left operand is not a ParserElement

__rand__(other) → pyparsing.core.ParserElement¶: Implementation of & operator when left operand is not a ParserElement

__repr__() → str¶: Return repr(self).

__ror__(other) → pyparsing.core.ParserElement¶: Implementation of | operator when left operand is not a ParserElement

__rsub__(other) → pyparsing.core.ParserElement¶: Implementation of - operator when left operand is not a ParserElement

__rxor__(other) → pyparsing.core.ParserElement¶: Implementation of ^ operator when left operand is not a ParserElement

__str__() → str¶: Return str(self).

__sub__(other) → pyparsing.core.ParserElement¶: Implementation of - operator, returns And with error stop

__weakref__¶: list of weak references to the object (if defined)

__xor__(other) → pyparsing.core.ParserElement¶: Implementation of ^ operator - returns Or

addCondition(*fns: Union[Callable[], bool], Callable[[pyparsing.results.ParseResults], bool], Callable[[int, pyparsing.results.ParseResults], bool], Callable[[str, int, pyparsing.results.ParseResults], bool]], **kwargs) → pyparsing.core.ParserElement¶

Add a boolean predicate function to expression’s list of parse actions. See set_parse_action for function call signatures. Unlike set_parse_action, functions passed to add_condition need to return boolean success/fail of the condition.

Optional keyword arguments:

message = define a custom message to be used in the raised exception
fatal = if True, will raise ParseFatalException to stop parsing immediately; otherwise will raise ParseException
call_during_try = boolean to indicate if this method should be called during internal tryParse calls, default=False

Example:

integer = Word(nums).set_parse_action(lambda toks: int(toks[0]))
year_int = integer.copy()
year_int.add_condition(lambda toks: toks[0] >= 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)

addParseAction(*fns: Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]], **kwargs) → pyparsing.core.ParserElement¶

Add one or more parse actions to expression’s list of parse actions. See set_parse_action.

See examples in copy.

add_condition(*fns: Union[Callable[], bool], Callable[[pyparsing.results.ParseResults], bool], Callable[[int, pyparsing.results.ParseResults], bool], Callable[[str, int, pyparsing.results.ParseResults], bool]], **kwargs) → pyparsing.core.ParserElement¶

Add a boolean predicate function to expression’s list of parse actions. See set_parse_action for function call signatures. Unlike set_parse_action, functions passed to add_condition need to return boolean success/fail of the condition.

Optional keyword arguments:

message = define a custom message to be used in the raised exception
fatal = if True, will raise ParseFatalException to stop parsing immediately; otherwise will raise ParseException
call_during_try = boolean to indicate if this method should be called during internal tryParse calls, default=False

Example:

integer = Word(nums).set_parse_action(lambda toks: int(toks[0]))
year_int = integer.copy()
year_int.add_condition(lambda toks: toks[0] >= 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)

add_parse_action(*fns: Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]], **kwargs) → pyparsing.core.ParserElement¶

Add one or more parse actions to expression’s list of parse actions. See set_parse_action.

See examples in copy.

copy() → pyparsing.core.ParserElement¶

Make a copy of this 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")

create_diagram(output_html: Union[TextIO, pathlib.Path, str], vertical: int = 3, show_results_names: bool = False, show_groups: bool = False, **kwargs) → None¶

Create a railroad diagram for the parser.

Parameters: - output_html (str or file-like object) - output target for generated

diagram HTML

vertical (int) - threshold for formatting multiple alternatives vertically instead of horizontally (default=3)
show_results_names - bool flag whether diagram should show annotations for defined results names
show_groups - bool flag whether groups should be highlighted with an unlabeled surrounding box

Additional diagram-formatting keyword arguments can also be included; see railroad.Diagram class.

static disable_memoization() → None¶

Disables active Packrat or Left Recursion parsing and their memoization

This method also works if neither Packrat nor Left Recursion are enabled. This makes it safe to call before activating Packrat nor Left Recursion to clear any previous settings.

static enableLeftRecursion(cache_size_limit: Optional[int] = None, *, force=False) → None¶

Enables “bounded recursion” parsing, which allows for both direct and indirect left-recursion. During parsing, left-recursive Forward elements are repeatedly matched with a fixed recursion depth that is gradually increased until finding the longest match.

Example:

import pyparsing as pp
pp.ParserElement.enable_left_recursion()

E = pp.Forward("E")
num = pp.Word(pp.nums)
# match `num`, or `num '+' num`, or `num '+' num '+' num`, ...
E <<= E + '+' - num | num

print(E.parse_string("1+2+3"))

Recursion search naturally memoizes matches of Forward elements and may thus skip reevaluation of parse actions during backtracking. This may break programs with parse actions which rely on strict ordering of side-effects.

Parameters:

cache_size_limit - (default=``None``) - memoize at most this many Forward elements during matching; if None (the default), memoize all Forward elements.

Bounded Recursion parsing works similar but not identical to Packrat parsing, thus the two cannot be used together. Use force=True to disable any previous, conflicting settings.

static enablePackrat(cache_size_limit: int = 128, *, force: bool = False) → None¶

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 ParserElement.enable_packrat. For best results, call enable_packrat() immediately after importing pyparsing.

Example:

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.

static enable_left_recursion(cache_size_limit: Optional[int] = None, *, force=False) → None¶

Enables “bounded recursion” parsing, which allows for both direct and indirect left-recursion. During parsing, left-recursive Forward elements are repeatedly matched with a fixed recursion depth that is gradually increased until finding the longest match.

Example:

import pyparsing as pp
pp.ParserElement.enable_left_recursion()

E = pp.Forward("E")
num = pp.Word(pp.nums)
# match `num`, or `num '+' num`, or `num '+' num '+' num`, ...
E <<= E + '+' - num | num

print(E.parse_string("1+2+3"))

Recursion search naturally memoizes matches of Forward elements and may thus skip reevaluation of parse actions during backtracking. This may break programs with parse actions which rely on strict ordering of side-effects.

Parameters:

cache_size_limit - (default=``None``) - memoize at most this many Forward elements during matching; if None (the default), memoize all Forward elements.

Bounded Recursion parsing works similar but not identical to Packrat parsing, thus the two cannot be used together. Use force=True to disable any previous, conflicting settings.

static enable_packrat(cache_size_limit: int = 128, *, force: bool = False) → None¶

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 ParserElement.enable_packrat. For best results, call enable_packrat() immediately after importing pyparsing.

Example:

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.

ignore(other: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

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']

ignoreWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Enables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern.

Parameters: recursive – If True (the default), also enable whitespace skipping in child elements (if any)

ignore_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Enables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern.

Parameters: recursive – If True (the default), also enable whitespace skipping in child elements (if any)

static inlineLiteralsUsing(cls: type) → None¶

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']

static inline_literals_using(cls: type) → None¶

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']

leaveWhitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Disables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars.

Parameters: recursive – If true (the default), also disable whitespace skipping in child elements (if any)

leave_whitespace(recursive: bool = True) → pyparsing.core.ParserElement¶

Disables the skipping of whitespace before matching the characters in the ParserElement’s defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars.

Parameters: recursive – If true (the default), also disable whitespace skipping in child elements (if any)

matches(test_string: str, parse_all: bool = True, *, parseAll: bool = True) → bool¶

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 parse_string when running tests

Example:

expr = Word(nums)
assert expr.matches("100")

parseFile(file_or_filename: Union[str, pathlib.Path, TextIO], encoding: str = 'utf-8', parse_all: bool = False, *, parseAll: bool = False) → pyparsing.results.ParseResults¶: 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.

parseString(instring: str, parse_all: bool = False, *, parseAll: bool = False) → pyparsing.results.ParseResults¶

Parse a string with respect to the parser definition. This function is intended as the primary interface to the client code.

Parameters

instring – The input string to be parsed.
parse_all – If set, the entire input string must match the grammar.
parseAll – retained for pre-PEP8 compatibility, will be removed in a future release.

Raises

ParseException – Raised if parse_all is set and the input string does not match the whole grammar.

Returns

the parsed data as a ParseResults object, which may be accessed as a list, a dict, or an object with attributes if the given parser includes results names.

If the input string is required to match the entire grammar, parse_all flag must be set to True. This is also equivalent to ending the grammar with :class:`StringEnd`().

To report proper column numbers, parse_string operates on a copy of the input string where all tabs are converted to spaces (8 spaces per tab, as per the default in string.expandtabs). If the input string contains tabs and the grammar uses parse actions that use the loc argument to index into the string being parsed, one can ensure a consistent view of the input string by doing one of the following:

calling parse_with_tabs on your grammar before calling parse_string (see parse_with_tabs),
define your parse action using the full (s,loc,toks) signature, and reference the input string using the parse action’s s argument, or
explicitly expand the tabs in your input string before calling parse_string.

Examples:

By default, partial matches are OK.

>>> 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)

parseWithTabs() → pyparsing.core.ParserElement¶: Overrides default behavior to expand <TAB> s to spaces before parsing the input string. Must be called before parse_string when the input grammar contains elements that match <TAB> characters.

parse_file(file_or_filename: Union[str, pathlib.Path, TextIO], encoding: str = 'utf-8', parse_all: bool = False, *, parseAll: bool = False) → pyparsing.results.ParseResults¶: 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.

parse_string(instring: str, parse_all: bool = False, *, parseAll: bool = False) → pyparsing.results.ParseResults¶

Parse a string with respect to the parser definition. This function is intended as the primary interface to the client code.

Parameters

instring – The input string to be parsed.
parse_all – If set, the entire input string must match the grammar.
parseAll – retained for pre-PEP8 compatibility, will be removed in a future release.

Raises

ParseException – Raised if parse_all is set and the input string does not match the whole grammar.

Returns

the parsed data as a ParseResults object, which may be accessed as a list, a dict, or an object with attributes if the given parser includes results names.

If the input string is required to match the entire grammar, parse_all flag must be set to True. This is also equivalent to ending the grammar with :class:`StringEnd`().

To report proper column numbers, parse_string operates on a copy of the input string where all tabs are converted to spaces (8 spaces per tab, as per the default in string.expandtabs). If the input string contains tabs and the grammar uses parse actions that use the loc argument to index into the string being parsed, one can ensure a consistent view of the input string by doing one of the following:

calling parse_with_tabs on your grammar before calling parse_string (see parse_with_tabs),
define your parse action using the full (s,loc,toks) signature, and reference the input string using the parse action’s s argument, or
explicitly expand the tabs in your input string before calling parse_string.

Examples:

By default, partial matches are OK.

>>> 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)

parse_with_tabs() → pyparsing.core.ParserElement¶: Overrides default behavior to expand <TAB> s to spaces before parsing the input string. Must be called before parse_string when the input grammar contains elements that match <TAB> characters.

runTests(tests: Union[str, List[str]], parse_all: bool = True, comment: Optional[Union[pyparsing.core.ParserElement, str]] = '#', full_dump: bool = True, print_results: bool = True, failure_tests: bool = False, post_parse: Optional[Callable[[str, pyparsing.results.ParseResults], str]] = None, file: Optional[TextIO] = None, with_line_numbers: bool = False, *, parseAll: bool = True, fullDump: bool = True, printResults: bool = True, failureTests: bool = False, postParse: Optional[Callable[[str, pyparsing.results.ParseResults], str]] = None) → Tuple[bool, List[Tuple[str, Union[pyparsing.results.ParseResults, Exception]]]]¶

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 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'.)

run_tests(tests: Union[str, List[str]], parse_all: bool = True, comment: Optional[Union[pyparsing.core.ParserElement, str]] = '#', full_dump: bool = True, print_results: bool = True, failure_tests: bool = False, post_parse: Optional[Callable[[str, pyparsing.results.ParseResults], str]] = None, file: Optional[TextIO] = None, with_line_numbers: bool = False, *, parseAll: bool = True, fullDump: bool = True, printResults: bool = True, failureTests: bool = False, postParse: Optional[Callable[[str, pyparsing.results.ParseResults], str]] = None) → Tuple[bool, List[Tuple[str, Union[pyparsing.results.ParseResults, Exception]]]]¶

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 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'.)

scanString(instring: str, max_matches: int = 9223372036854775807, overlap: bool = False, *, debug: bool = False, maxMatches: int = 9223372036854775807) → Generator[Tuple[pyparsing.results.ParseResults, int, int], None, None]¶

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 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

scan_string(instring: str, max_matches: int = 9223372036854775807, overlap: bool = False, *, debug: bool = False, maxMatches: int = 9223372036854775807) → Generator[Tuple[pyparsing.results.ParseResults, int, int], None, None]¶

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 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

searchString(instring: str, max_matches: int = 9223372036854775807, *, debug: bool = False, maxMatches: int = 9223372036854775807) → pyparsing.results.ParseResults¶

Another extension to 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']

search_string(instring: str, max_matches: int = 9223372036854775807, *, debug: bool = False, maxMatches: int = 9223372036854775807) → pyparsing.results.ParseResults¶

Another extension to 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']

setBreak(break_flag: bool = True) → pyparsing.core.ParserElement¶: 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.

setDebug(flag: bool = True) → pyparsing.core.ParserElement¶

Enable display of debugging messages while doing pattern matching. Set flag to True to enable, False to disable.

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 set_debug_actions. Prior to attempting to match the wd expression, the debugging message "Match <exprname> at loc <n>(<line>,<col>)" is shown. Then if the parse succeeds, a "Matched" message is shown, or an "Exception raised" message is shown. Also note the use of 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 Word expression without calling set_name is "W:(A-Za-z)".

setDebugActions(start_action: Callable[[str, int, pyparsing.core.ParserElement, bool], None], success_action: Callable[[str, int, int, pyparsing.core.ParserElement, pyparsing.results.ParseResults, bool], None], exception_action: Callable[[str, int, pyparsing.core.ParserElement, Exception, bool], None]) → pyparsing.core.ParserElement¶

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)

static setDefaultWhitespaceChars(chars: str) → None¶

Overrides the default whitespace chars

Example:

# default whitespace chars are space, <TAB> 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']

setFailAction(fn: Callable[[str, int, pyparsing.core.ParserElement, Exception], None]) → pyparsing.core.ParserElement¶

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 ParseFatalException if it is desired to stop parsing immediately.

setName(name: str) → pyparsing.core.ParserElement¶

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)

setParseAction(*fns: Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]], **kwargs) → pyparsing.core.ParserElement¶

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 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 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 parse_string for more information on parsing strings containing <TAB> 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
    ''')

setResultsName(name: str, list_all_matches: bool = False, *, listAllMatches: bool = False) → pyparsing.core.ParserElement¶

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 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 __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")

setWhitespaceChars(chars: Union[Set[str], str], copy_defaults: bool = False) → pyparsing.core.ParserElement¶: Overrides the default whitespace chars

set_break(break_flag: bool = True) → pyparsing.core.ParserElement¶: 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.

set_debug(flag: bool = True) → pyparsing.core.ParserElement¶

Enable display of debugging messages while doing pattern matching. Set flag to True to enable, False to disable.

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 set_debug_actions. Prior to attempting to match the wd expression, the debugging message "Match <exprname> at loc <n>(<line>,<col>)" is shown. Then if the parse succeeds, a "Matched" message is shown, or an "Exception raised" message is shown. Also note the use of 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 Word expression without calling set_name is "W:(A-Za-z)".

set_debug_actions(start_action: Callable[[str, int, pyparsing.core.ParserElement, bool], None], success_action: Callable[[str, int, int, pyparsing.core.ParserElement, pyparsing.results.ParseResults, bool], None], exception_action: Callable[[str, int, pyparsing.core.ParserElement, Exception, bool], None]) → pyparsing.core.ParserElement¶

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)

static set_default_whitespace_chars(chars: str) → None¶

Overrides the default whitespace chars

Example:

# default whitespace chars are space, <TAB> 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']

set_fail_action(fn: Callable[[str, int, pyparsing.core.ParserElement, Exception], None]) → pyparsing.core.ParserElement¶

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 ParseFatalException if it is desired to stop parsing immediately.

set_name(name: str) → pyparsing.core.ParserElement¶

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)

set_parse_action(*fns: Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]], **kwargs) → pyparsing.core.ParserElement¶

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 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 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 parse_string for more information on parsing strings containing <TAB> 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
    ''')

set_results_name(name: str, list_all_matches: bool = False, *, listAllMatches: bool = False) → pyparsing.core.ParserElement¶

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 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 __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")

set_whitespace_chars(chars: Union[Set[str], str], copy_defaults: bool = False) → pyparsing.core.ParserElement¶: Overrides the default whitespace chars

split(instring: str, maxsplit: int = 9223372036854775807, include_separators: bool = False, *, includeSeparators=False) → Generator[str, None, None]¶

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', '']

suppress() → pyparsing.core.ParserElement¶: Suppresses the output of this ParserElement; useful to keep punctuation from cluttering up returned output.

suppress_warning(warning_type: pyparsing.core.Diagnostics) → pyparsing.core.ParserElement¶

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.parseString("x"))

transformString(instring: str, *, debug: bool = False) → str¶

Extension to 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.

transform_string(instring: str, *, debug: bool = False) → str¶

Extension to 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.

validate(validateTrace=None) → None¶: Check defined expressions for valid structure, check for infinite recursive definitions.

class pyparsing.PositionToken¶

Bases: pyparsing.core.Token

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.PrecededBy(expr: Union[pyparsing.core.ParserElement, str], retreat: Optional[int] = None)¶

Bases: pyparsing.core.ParseElementEnhance

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, Literal, Keyword, or a Word or 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

__init__(expr: Union[pyparsing.core.ParserElement, str], retreat: Optional[int] = None)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.QuotedString(quote_char: str = '', esc_char: Optional[str] = None, esc_quote: Optional[str] = None, multiline: bool = False, unquote_results: bool = True, end_quote_char: Optional[str] = None, convert_whitespace_escapes: bool = True, *, quoteChar: str = '', escChar: Optional[str] = None, escQuote: Optional[str] = None, unquoteResults: bool = True, endQuoteChar: Optional[str] = None, convertWhitespaceEscapes: bool = True)¶

Bases: pyparsing.core.Token

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']]

__init__(quote_char: str = '', esc_char: Optional[str] = None, esc_quote: Optional[str] = None, multiline: bool = False, unquote_results: bool = True, end_quote_char: Optional[str] = None, convert_whitespace_escapes: bool = True, *, quoteChar: str = '', escChar: Optional[str] = None, escQuote: Optional[str] = None, unquoteResults: bool = True, endQuoteChar: Optional[str] = None, convertWhitespaceEscapes: bool = True)¶: Initialize self. See help(type(self)) for accurate signature.

exception pyparsing.RecursiveGrammarException(parseElementList)¶

Bases: Exception

Exception thrown by ParserElement.validate if the grammar could be left-recursive; parser may need to enable left recursion using ParserElement.enable_left_recursion

__init__(parseElementList)¶: Initialize self. See help(type(self)) for accurate signature.

__str__() → str¶: Return str(self).

__weakref__¶: list of weak references to the object (if defined)

class pyparsing.Regex(pattern: Any, flags: Union[re.RegexFlag, int] = 0, as_group_list: bool = False, as_match: bool = False, *, asGroupList: bool = False, asMatch: bool = False)¶

Bases: pyparsing.core.Token

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<name>...)), these will be preserved as named 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<year>\d{4})-(?P<month>\d\d?)-(?P<day>\d\d?)')

# the Regex class will accept re's compiled using the regex module
import regex
parser = pp.Regex(regex.compile(r'[0-9]'))

__init__(pattern: Any, flags: Union[re.RegexFlag, int] = 0, as_group_list: bool = False, as_match: bool = False, *, asGroupList: bool = False, asMatch: bool = False)¶: The 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.

sub(repl: str) → pyparsing.core.ParserElement¶

Return 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</\1>")
print(make_html.transform_string("h1:main title:"))
# prints "<h1>main title</h1>"

class pyparsing.SkipTo(other: Union[pyparsing.core.ParserElement, str], include: bool = False, ignore: Optional[bool] = None, fail_on: Optional[Union[pyparsing.core.ParserElement, str]] = None, *, failOn: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶

Bases: pyparsing.core.ParseElementEnhance

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 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'

__init__(other: Union[pyparsing.core.ParserElement, str], include: bool = False, ignore: Optional[bool] = None, fail_on: Optional[Union[pyparsing.core.ParserElement, str]] = None, *, failOn: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.StringEnd¶

Bases: pyparsing.core.PositionToken

Matches if current position is at the end of the parse string

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.StringStart¶

Bases: pyparsing.core.PositionToken

Matches if current position is at the beginning of the parse string

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Suppress(expr: Union[pyparsing.core.ParserElement, str], savelist: bool = False)¶

Bases: pyparsing.core.TokenConverter

Converter for ignoring the results of a parsed expression.

Example:

source = "a, b, c,d"
wd = Word(alphas)
wd_list1 = wd + (',' + wd)[...]
print(wd_list1.parse_string(source))

# often, delimiters that are useful during parsing are just in the
# way afterward - use Suppress to keep them out of the parsed output
wd_list2 = wd + (Suppress(',') + wd)[...]
print(wd_list2.parse_string(source))

# Skipped text (using '...') can be suppressed as well
source = "lead in START relevant text END trailing text"
start_marker = Keyword("START")
end_marker = Keyword("END")
find_body = Suppress(...) + start_marker + ... + end_marker
print(find_body.parse_string(source)

prints:

['a', ',', 'b', ',', 'c', ',', 'd']
['a', 'b', 'c', 'd']
['START', 'relevant text ', 'END']

(See also delimited_list.)

__add__(other) → pyparsing.core.ParserElement¶

Implementation of + operator - returns And. Adding strings to a 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 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.

__init__(expr: Union[pyparsing.core.ParserElement, str], savelist: bool = False)¶: Initialize self. See help(type(self)) for accurate signature.

__sub__(other) → pyparsing.core.ParserElement¶: Implementation of - operator, returns And with error stop

suppress() → pyparsing.core.ParserElement¶: Suppresses the output of this ParserElement; useful to keep punctuation from cluttering up returned output.

class pyparsing.Token¶

Bases: pyparsing.core.ParserElement

Abstract ParserElement subclass, for defining atomic matching patterns.

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.TokenConverter(expr: Union[pyparsing.core.ParserElement, str], savelist=False)¶

Bases: pyparsing.core.ParseElementEnhance

Abstract subclass of ParseExpression, for converting parsed results.

__init__(expr: Union[pyparsing.core.ParserElement, str], savelist=False)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.White(ws: str = ' \t\r\n', min: int = 1, max: int = 0, exact: int = 0)¶

Bases: pyparsing.core.Token

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 Word class.

__init__(ws: str = ' \t\r\n', min: int = 1, max: int = 0, exact: int = 0)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.Word(init_chars: str = '', body_chars: Optional[str] = None, min: int = 1, max: int = 0, exact: int = 0, as_keyword: bool = False, exclude_chars: Optional[str] = None, *, initChars: Optional[str] = None, bodyChars: Optional[str] = None, asKeyword: bool = False, excludeChars: Optional[str] = None)¶

Bases: pyparsing.core.Token

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``)

srange is useful for defining custom character set strings for defining Word expressions, using range notation from regular expression character sets.

A common mistake is to use Word to match a specific literal string, as in Word("Address"). Remember that 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 Literal or Keyword.

pyparsing includes helper strings for building Words:

alphas
nums
alphanums
hexnums
alphas8bit (alphabetic characters in ASCII range 128-255 - accented, tilded, umlauted, etc.)
punc8bit (non-alphabetic characters in ASCII range 128-255 - currency, symbols, superscripts, diacriticals, etc.)
printables (any non-whitespace character)

alphas, nums, and printables are also defined in several Unicode sets - see 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=",")

__init__(init_chars: str = '', body_chars: Optional[str] = None, min: int = 1, max: int = 0, exact: int = 0, as_keyword: bool = False, exclude_chars: Optional[str] = None, *, initChars: Optional[str] = None, bodyChars: Optional[str] = None, asKeyword: bool = False, excludeChars: Optional[str] = None)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.WordEnd(word_chars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~', *, wordChars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~')¶

Bases: pyparsing.core.PositionToken

Matches if the current position is at the end of a 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.

__init__(word_chars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~', *, wordChars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~')¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.WordStart(word_chars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~', *, wordChars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~')¶

Bases: pyparsing.core.PositionToken

Matches if the current position is at the beginning of a 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.

__init__(word_chars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~', *, wordChars: str = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~')¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.ZeroOrMore(expr: pyparsing.core.ParserElement, stop_on: Optional[Union[pyparsing.core.ParserElement, str]] = None, *, stopOn: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶

Bases: pyparsing.core._MultipleMatch

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 OneOrMore

__init__(expr: pyparsing.core.ParserElement, stop_on: Optional[Union[pyparsing.core.ParserElement, str]] = None, *, stopOn: Optional[Union[pyparsing.core.ParserElement, str]] = None)¶: Initialize self. See help(type(self)) for accurate signature.

class pyparsing.__compat__¶

Bases: pyparsing.util.__config_flags

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 And expression is nested within an Or or MatchFirst; maintained for compatibility, but setting to False no longer restores pre-2.3.1 behavior

class pyparsing.__diag__¶: Bases: pyparsing.util.__config_flags

pyparsing.autoname_elements() → None¶: Utility to simplify mass-naming of parser elements, for generating railroad diagram with named subdiagrams.

pyparsing.col(loc: int, strg: str) → int¶

Returns current column within a string, counting newlines as line separators. The first column is number 1.

Note: the default parsing behavior is to expand tabs in the input string before starting the parsing process. See ParserElement.parseString for more information on parsing strings containing <TAB> 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.

pyparsing.conditionAsParseAction(fn: Union[Callable[], bool], Callable[[pyparsing.results.ParseResults], bool], Callable[[int, pyparsing.results.ParseResults], bool], Callable[[str, int, pyparsing.results.ParseResults], bool]], message: Optional[str] = None, fatal: bool = False) → Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]¶

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 ParserElement.add_condition cannot be used (such as when adding a condition to an operator level in infix_notation).

Optional keyword arguments:

message - define a custom message to be used in the raised exception
fatal - if True, will raise ParseFatalException to stop parsing immediately; otherwise will raise ParseException

pyparsing.condition_as_parse_action(fn: Union[Callable[], bool], Callable[[pyparsing.results.ParseResults], bool], Callable[[int, pyparsing.results.ParseResults], bool], Callable[[str, int, pyparsing.results.ParseResults], bool]], message: Optional[str] = None, fatal: bool = False) → Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]¶

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 ParserElement.add_condition cannot be used (such as when adding a condition to an operator level in infix_notation).

Optional keyword arguments:

message - define a custom message to be used in the raised exception
fatal - if True, will raise ParseFatalException to stop parsing immediately; otherwise will raise ParseException

pyparsing.countedArray(expr: pyparsing.core.ParserElement, int_expr: Optional[pyparsing.core.ParserElement] = None, *, intExpr: Optional[pyparsing.core.ParserElement] = None) → pyparsing.core.ParserElement¶

Helper to define a counted list of expressions.

This helper defines a pattern of the form:

integer expr expr expr...

where the leading integer tells how many expr expressions follow. The matched tokens returns the array of expr tokens as a list - the leading count token is suppressed.

If int_expr is specified, it should be a pyparsing expression that produces an integer value.

Example:

counted_array(Word(alphas)).parse_string('2 ab cd ef')  # -> ['ab', 'cd']

# in this parser, the leading integer value is given in binary,
# '10' indicating that 2 values are in the array
binary_constant = Word('01').set_parse_action(lambda t: int(t[0], 2))
counted_array(Word(alphas), int_expr=binary_constant).parse_string('10 ab cd ef')  # -> ['ab', 'cd']

# if other fields must be parsed after the count but before the
# list items, give the fields results names and they will
# be preserved in the returned ParseResults:
count_with_metadata = integer + Word(alphas)("type")
typed_array = counted_array(Word(alphanums), int_expr=count_with_metadata)("items")
result = typed_array.parse_string("3 bool True True False")
print(result.dump())

# prints
# ['True', 'True', 'False']
# - items: ['True', 'True', 'False']
# - type: 'bool'

pyparsing.counted_array(expr: pyparsing.core.ParserElement, int_expr: Optional[pyparsing.core.ParserElement] = None, *, intExpr: Optional[pyparsing.core.ParserElement] = None) → pyparsing.core.ParserElement¶

Helper to define a counted list of expressions.

This helper defines a pattern of the form:

integer expr expr expr...

where the leading integer tells how many expr expressions follow. The matched tokens returns the array of expr tokens as a list - the leading count token is suppressed.

If int_expr is specified, it should be a pyparsing expression that produces an integer value.

Example:

counted_array(Word(alphas)).parse_string('2 ab cd ef')  # -> ['ab', 'cd']

# in this parser, the leading integer value is given in binary,
# '10' indicating that 2 values are in the array
binary_constant = Word('01').set_parse_action(lambda t: int(t[0], 2))
counted_array(Word(alphas), int_expr=binary_constant).parse_string('10 ab cd ef')  # -> ['ab', 'cd']

# if other fields must be parsed after the count but before the
# list items, give the fields results names and they will
# be preserved in the returned ParseResults:
count_with_metadata = integer + Word(alphas)("type")
typed_array = counted_array(Word(alphanums), int_expr=count_with_metadata)("items")
result = typed_array.parse_string("3 bool True True False")
print(result.dump())

# prints
# ['True', 'True', 'False']
# - items: ['True', 'True', 'False']
# - type: 'bool'

pyparsing.delimitedList(expr: Union[str, pyparsing.core.ParserElement], delim: Union[str, pyparsing.core.ParserElement] = ',', combine: bool = False, min: Optional[int] = None, max: Optional[int] = None, *, allow_trailing_delim: bool = False) → pyparsing.core.ParserElement¶

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:

delimited_list(Word(alphas)).parse_string("aa,bb,cc") # -> ['aa', 'bb', 'cc']
delimited_list(Word(hexnums), delim=':', combine=True).parse_string("AA:BB:CC:DD:EE") # -> ['AA:BB:CC:DD:EE']

pyparsing.delimited_list(expr: Union[str, pyparsing.core.ParserElement], delim: Union[str, pyparsing.core.ParserElement] = ',', combine: bool = False, min: Optional[int] = None, max: Optional[int] = None, *, allow_trailing_delim: bool = False) → pyparsing.core.ParserElement¶

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:

delimited_list(Word(alphas)).parse_string("aa,bb,cc") # -> ['aa', 'bb', 'cc']
delimited_list(Word(hexnums), delim=':', combine=True).parse_string("AA:BB:CC:DD:EE") # -> ['AA:BB:CC:DD:EE']

pyparsing.dictOf(key: pyparsing.core.ParserElement, value: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

Helper to easily and clearly define a dictionary by specifying the respective patterns for the key and value. Takes care of defining the Dict, ZeroOrMore, and Group tokens in the proper order. The key pattern can include delimiting markers or punctuation, as long as they are suppressed, thereby leaving the significant key text. The value pattern can include named results, so that the Dict results can include named token fields.

Example:

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(attr_expr[1, ...].parse_string(text).dump())

attr_label = label
attr_value = Suppress(':') + OneOrMore(data_word, stop_on=label).set_parse_action(' '.join)

# similar to Dict, but simpler call format
result = dict_of(attr_label, attr_value).parse_string(text)
print(result.dump())
print(result['shape'])
print(result.shape)  # object attribute access works too
print(result.as_dict())

prints:

[['shape', 'SQUARE'], ['posn', 'upper left'], ['color', 'light blue'], ['texture', 'burlap']]
- color: 'light blue'
- posn: 'upper left'
- shape: 'SQUARE'
- texture: 'burlap'
SQUARE
SQUARE
{'color': 'light blue', 'shape': 'SQUARE', 'posn': 'upper left', 'texture': 'burlap'}

pyparsing.dict_of(key: pyparsing.core.ParserElement, value: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

Helper to easily and clearly define a dictionary by specifying the respective patterns for the key and value. Takes care of defining the Dict, ZeroOrMore, and Group tokens in the proper order. The key pattern can include delimiting markers or punctuation, as long as they are suppressed, thereby leaving the significant key text. The value pattern can include named results, so that the Dict results can include named token fields.

Example:

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(attr_expr[1, ...].parse_string(text).dump())

attr_label = label
attr_value = Suppress(':') + OneOrMore(data_word, stop_on=label).set_parse_action(' '.join)

# similar to Dict, but simpler call format
result = dict_of(attr_label, attr_value).parse_string(text)
print(result.dump())
print(result['shape'])
print(result.shape)  # object attribute access works too
print(result.as_dict())

prints:

[['shape', 'SQUARE'], ['posn', 'upper left'], ['color', 'light blue'], ['texture', 'burlap']]
- color: 'light blue'
- posn: 'upper left'
- shape: 'SQUARE'
- texture: 'burlap'
SQUARE
SQUARE
{'color': 'light blue', 'shape': 'SQUARE', 'posn': 'upper left', 'texture': 'burlap'}

pyparsing.indentedBlock(blockStatementExpr, indentStack, indent=True, backup_stacks=[])¶

(DEPRECATED - use IndentedBlock class instead) Helper method for defining space-delimited indentation blocks, such as those used to define block statements in Python source code.

Parameters:

blockStatementExpr - expression defining syntax of statement that is repeated within the indented block
indentStack - list created by caller to manage indentation stack (multiple statementWithIndentedBlock expressions within a single grammar should share a common indentStack)
indent - boolean indicating whether block must be indented beyond the current level; set to False for block of left-most statements (default= True)

A valid block must contain at least one blockStatement.

(Note that indentedBlock uses internal parse actions which make it incompatible with packrat parsing.)

Example:

data = '''
def A(z):
  A1
  B = 100
  G = A2
  A2
  A3
B
def BB(a,b,c):
  BB1
  def BBA():
    bba1
    bba2
    bba3
C
D
def spam(x,y):
     def eggs(z):
         pass
'''


indentStack = [1]
stmt = Forward()

identifier = Word(alphas, alphanums)
funcDecl = ("def" + identifier + Group("(" + Opt(delimitedList(identifier)) + ")") + ":")
func_body = indentedBlock(stmt, indentStack)
funcDef = Group(funcDecl + func_body)

rvalue = Forward()
funcCall = Group(identifier + "(" + Opt(delimitedList(rvalue)) + ")")
rvalue << (funcCall | identifier | Word(nums))
assignment = Group(identifier + "=" + rvalue)
stmt << (funcDef | assignment | identifier)

module_body = stmt[1, ...]

parseTree = module_body.parseString(data)
parseTree.pprint()

prints:

[['def',
  'A',
  ['(', 'z', ')'],
  ':',
  [['A1'], [['B', '=', '100']], [['G', '=', 'A2']], ['A2'], ['A3']]],
 'B',
 ['def',
  'BB',
  ['(', 'a', 'b', 'c', ')'],
  ':',
  [['BB1'], [['def', 'BBA', ['(', ')'], ':', [['bba1'], ['bba2'], ['bba3']]]]]],
 'C',
 'D',
 ['def',
  'spam',
  ['(', 'x', 'y', ')'],
  ':',
  [[['def', 'eggs', ['(', 'z', ')'], ':', [['pass']]]]]]]

pyparsing.infixNotation(base_expr: pyparsing.core.ParserElement, op_list: List[Union[Tuple[Union[pyparsing.core.ParserElement, str, Tuple[Union[pyparsing.core.ParserElement, str], Union[pyparsing.core.ParserElement, str]]], int, pyparsing.helpers.OpAssoc, Optional[Union[Callable[[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]]], Tuple[Union[pyparsing.core.ParserElement, str, Tuple[Union[pyparsing.core.ParserElement, str], Union[pyparsing.core.ParserElement, str]]], int, pyparsing.helpers.OpAssoc]]], lpar: Union[str, pyparsing.core.ParserElement] = Suppress:('('), rpar: Union[str, pyparsing.core.ParserElement] = Suppress:(')')) → pyparsing.core.ParserElement¶

Helper method for constructing grammars of expressions made up of operators working in a precedence hierarchy. Operators may be unary or binary, left- or right-associative. Parse actions can also be attached to operator expressions. The generated parser will also recognize the use of parentheses to override operator precedences (see example below).

Note: if you define a deep operator list, you may see performance issues when using infix_notation. See ParserElement.enable_packrat for a mechanism to potentially improve your parser performance.

Parameters: - base_expr - expression representing the most basic operand to

be used in the expression

op_list - list of tuples, one for each operator precedence level in the expression grammar; each tuple is of the form (op_expr, num_operands, right_left_assoc, (optional)parse_action), where:
- op_expr is the pyparsing expression for the operator; may also be a string, which will be converted to a Literal; if num_operands is 3, op_expr is a tuple of two expressions, for the two operators separating the 3 terms
- num_operands is the number of terms for this operator (must be 1, 2, or 3)
- right_left_assoc is the indicator whether the operator is right or left associative, using the pyparsing-defined constants OpAssoc.RIGHT and OpAssoc.LEFT.
- parse_action is the parse action to be associated with expressions matching this operator expression (the parse action tuple member may be omitted); if the parse action is passed a tuple or list of functions, this is equivalent to calling set_parse_action(*fn) (ParserElement.set_parse_action)
lpar - expression for matching left-parentheses; if passed as a str, then will be parsed as Suppress(lpar). If lpar is passed as an expression (such as Literal('(')), then it will be kept in the parsed results, and grouped with them. (default= Suppress('('))
rpar - expression for matching right-parentheses; if passed as a str, then will be parsed as Suppress(rpar). If rpar is passed as an expression (such as Literal(')')), then it will be kept in the parsed results, and grouped with them. (default= Suppress(')'))

Example:

# simple example of four-function arithmetic with ints and
# variable names
integer = pyparsing_common.signed_integer
varname = pyparsing_common.identifier

arith_expr = infix_notation(integer | varname,
    [
    ('-', 1, OpAssoc.RIGHT),
    (one_of('* /'), 2, OpAssoc.LEFT),
    (one_of('+ -'), 2, OpAssoc.LEFT),
    ])

arith_expr.run_tests('''
    5+3*6
    (5+3)*6
    -2--11
    ''', full_dump=False)

prints:

5+3*6
[[5, '+', [3, '*', 6]]]

(5+3)*6
[[[5, '+', 3], '*', 6]]

-2--11
[[['-', 2], '-', ['-', 11]]]

pyparsing.infix_notation(base_expr: pyparsing.core.ParserElement, op_list: List[Union[Tuple[Union[pyparsing.core.ParserElement, str, Tuple[Union[pyparsing.core.ParserElement, str], Union[pyparsing.core.ParserElement, str]]], int, pyparsing.helpers.OpAssoc, Optional[Union[Callable[[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]]], Tuple[Union[pyparsing.core.ParserElement, str, Tuple[Union[pyparsing.core.ParserElement, str], Union[pyparsing.core.ParserElement, str]]], int, pyparsing.helpers.OpAssoc]]], lpar: Union[str, pyparsing.core.ParserElement] = Suppress:('('), rpar: Union[str, pyparsing.core.ParserElement] = Suppress:(')')) → pyparsing.core.ParserElement¶

Helper method for constructing grammars of expressions made up of operators working in a precedence hierarchy. Operators may be unary or binary, left- or right-associative. Parse actions can also be attached to operator expressions. The generated parser will also recognize the use of parentheses to override operator precedences (see example below).

Note: if you define a deep operator list, you may see performance issues when using infix_notation. See ParserElement.enable_packrat for a mechanism to potentially improve your parser performance.

Parameters: - base_expr - expression representing the most basic operand to

be used in the expression

op_list - list of tuples, one for each operator precedence level in the expression grammar; each tuple is of the form (op_expr, num_operands, right_left_assoc, (optional)parse_action), where:
- op_expr is the pyparsing expression for the operator; may also be a string, which will be converted to a Literal; if num_operands is 3, op_expr is a tuple of two expressions, for the two operators separating the 3 terms
- num_operands is the number of terms for this operator (must be 1, 2, or 3)
- right_left_assoc is the indicator whether the operator is right or left associative, using the pyparsing-defined constants OpAssoc.RIGHT and OpAssoc.LEFT.
- parse_action is the parse action to be associated with expressions matching this operator expression (the parse action tuple member may be omitted); if the parse action is passed a tuple or list of functions, this is equivalent to calling set_parse_action(*fn) (ParserElement.set_parse_action)
lpar - expression for matching left-parentheses; if passed as a str, then will be parsed as Suppress(lpar). If lpar is passed as an expression (such as Literal('(')), then it will be kept in the parsed results, and grouped with them. (default= Suppress('('))
rpar - expression for matching right-parentheses; if passed as a str, then will be parsed as Suppress(rpar). If rpar is passed as an expression (such as Literal(')')), then it will be kept in the parsed results, and grouped with them. (default= Suppress(')'))

Example:

# simple example of four-function arithmetic with ints and
# variable names
integer = pyparsing_common.signed_integer
varname = pyparsing_common.identifier

arith_expr = infix_notation(integer | varname,
    [
    ('-', 1, OpAssoc.RIGHT),
    (one_of('* /'), 2, OpAssoc.LEFT),
    (one_of('+ -'), 2, OpAssoc.LEFT),
    ])

arith_expr.run_tests('''
    5+3*6
    (5+3)*6
    -2--11
    ''', full_dump=False)

prints:

5+3*6
[[5, '+', [3, '*', 6]]]

(5+3)*6
[[[5, '+', 3], '*', 6]]

-2--11
[[['-', 2], '-', ['-', 11]]]

pyparsing.line(loc: int, strg: str) → str¶: Returns the line of text containing loc within a string, counting newlines as line separators.

pyparsing.lineno(loc: int, strg: str) → int¶

Returns current line number within a string, counting newlines as line separators. The first line is number 1.

Note - the default parsing behavior is to expand tabs in the input string before starting the parsing process. See ParserElement.parseString for more information on parsing strings containing <TAB> 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.

pyparsing.locatedExpr(expr: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

(DEPRECATED - future code should use the Located class) Helper to decorate 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 <TAB> characters, you may want to call ParserElement.parseWithTabs

Example:

wd = Word(alphas)
for match in locatedExpr(wd).searchString("ljsdf123lksdjjf123lkkjj1222"):
    print(match)

prints:

[[0, 'ljsdf', 5]]
[[8, 'lksdjjf', 15]]
[[18, 'lkkjj', 23]]

pyparsing.makeHTMLTags(tag_str: Union[str, pyparsing.core.ParserElement]) → Tuple[pyparsing.core.ParserElement, pyparsing.core.ParserElement]¶

Helper to construct opening and closing tag expressions for HTML, given a tag name. Matches tags in either upper or lower case, attributes with namespaces and with quoted or unquoted values.

Example:

text = '<td>More info at the <a href="https://github.com/pyparsing/pyparsing/wiki">pyparsing</a> wiki page</td>'
# make_html_tags returns pyparsing expressions for the opening and
# closing tags as a 2-tuple
a, a_end = make_html_tags("A")
link_expr = a + SkipTo(a_end)("link_text") + a_end

for link in link_expr.search_string(text):
    # attributes in the <A> tag (like "href" shown here) are
    # also accessible as named results
    print(link.link_text, '->', link.href)

prints:

pyparsing -> https://github.com/pyparsing/pyparsing/wiki

pyparsing.makeXMLTags(tag_str: Union[str, pyparsing.core.ParserElement]) → Tuple[pyparsing.core.ParserElement, pyparsing.core.ParserElement]¶

Helper to construct opening and closing tag expressions for XML, given a tag name. Matches tags only in the given upper/lower case.

Example: similar to make_html_tags

pyparsing.make_html_tags(tag_str: Union[str, pyparsing.core.ParserElement]) → Tuple[pyparsing.core.ParserElement, pyparsing.core.ParserElement]¶

Helper to construct opening and closing tag expressions for HTML, given a tag name. Matches tags in either upper or lower case, attributes with namespaces and with quoted or unquoted values.

Example:

text = '<td>More info at the <a href="https://github.com/pyparsing/pyparsing/wiki">pyparsing</a> wiki page</td>'
# make_html_tags returns pyparsing expressions for the opening and
# closing tags as a 2-tuple
a, a_end = make_html_tags("A")
link_expr = a + SkipTo(a_end)("link_text") + a_end

for link in link_expr.search_string(text):
    # attributes in the <A> tag (like "href" shown here) are
    # also accessible as named results
    print(link.link_text, '->', link.href)

prints:

pyparsing -> https://github.com/pyparsing/pyparsing/wiki

pyparsing.make_xml_tags(tag_str: Union[str, pyparsing.core.ParserElement]) → Tuple[pyparsing.core.ParserElement, pyparsing.core.ParserElement]¶

Helper to construct opening and closing tag expressions for XML, given a tag name. Matches tags only in the given upper/lower case.

Example: similar to make_html_tags

pyparsing.matchOnlyAtCol(n)¶: Helper method for defining parse actions that require matching at a specific column in the input text.

pyparsing.matchPreviousExpr(expr: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

Helper to define an expression that is indirectly defined from the tokens matched in a previous expression, that is, it looks for a ‘repeat’ of a previous expression. For example:

first = Word(nums)
second = match_previous_expr(first)
match_expr = first + ":" + second

will match "1:1", but not "1:2". Because this matches by expressions, will not match the leading "1:1" in "1:10"; the expressions are evaluated first, and then compared, so "1" is compared with "10". Do not use with packrat parsing enabled.

pyparsing.matchPreviousLiteral(expr: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

Helper to define an expression that is indirectly defined from the tokens matched in a previous expression, that is, it looks for a ‘repeat’ of a previous expression. For example:

first = Word(nums)
second = match_previous_literal(first)
match_expr = first + ":" + second

will match "1:1", but not "1:2". Because this matches a previous literal, will also match the leading "1:1" in "1:10". If this is not desired, use match_previous_expr. Do not use with packrat parsing enabled.

pyparsing.match_only_at_col(n)¶: Helper method for defining parse actions that require matching at a specific column in the input text.

pyparsing.match_previous_expr(expr: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

Helper to define an expression that is indirectly defined from the tokens matched in a previous expression, that is, it looks for a ‘repeat’ of a previous expression. For example:

first = Word(nums)
second = match_previous_expr(first)
match_expr = first + ":" + second

will match "1:1", but not "1:2". Because this matches by expressions, will not match the leading "1:1" in "1:10"; the expressions are evaluated first, and then compared, so "1" is compared with "10". Do not use with packrat parsing enabled.

pyparsing.match_previous_literal(expr: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶

Helper to define an expression that is indirectly defined from the tokens matched in a previous expression, that is, it looks for a ‘repeat’ of a previous expression. For example:

first = Word(nums)
second = match_previous_literal(first)
match_expr = first + ":" + second

will match "1:1", but not "1:2". Because this matches a previous literal, will also match the leading "1:1" in "1:10". If this is not desired, use match_previous_expr. Do not use with packrat parsing enabled.

pyparsing.nestedExpr(opener: Union[str, pyparsing.core.ParserElement] = '(', closer: Union[str, pyparsing.core.ParserElement] = ')', content: Optional[pyparsing.core.ParserElement] = None, ignore_expr: pyparsing.core.ParserElement = quotedString using single or double quotes, *, ignoreExpr: pyparsing.core.ParserElement = quotedString using single or double quotes) → pyparsing.core.ParserElement¶

Helper method for defining nested lists enclosed in opening and closing delimiters ("(" and ")" are the default).

Parameters: - opener - opening character for a nested list

(default= "("); can also be a pyparsing expression

closer - closing character for a nested list (default= ")"); can also be a pyparsing expression
content - expression for items within the nested lists (default= None)
ignore_expr - expression for ignoring opening and closing delimiters (default= quoted_string)
ignoreExpr - this pre-PEP8 argument is retained for compatibility but will be removed in a future release

If an expression is not provided for the content argument, the nested expression will capture all whitespace-delimited content between delimiters as a list of separate values.

Use the ignore_expr argument to define expressions that may contain opening or closing characters that should not be treated as opening or closing characters for nesting, such as quoted_string or a comment expression. Specify multiple expressions using an Or or MatchFirst. The default is quoted_string, but if no expressions are to be ignored, then pass None for this argument.

Example:

data_type = one_of("void int short long char float double")
decl_data_type = Combine(data_type + Opt(Word('*')))
ident = Word(alphas+'_', alphanums+'_')
number = pyparsing_common.number
arg = Group(decl_data_type + ident)
LPAR, RPAR = map(Suppress, "()")

code_body = nested_expr('{', '}', ignore_expr=(quoted_string | c_style_comment))

c_function = (decl_data_type("type")
              + ident("name")
              + LPAR + Opt(delimited_list(arg), [])("args") + RPAR
              + code_body("body"))
c_function.ignore(c_style_comment)

source_code = '''
    int is_odd(int x) {
        return (x%2);
    }

    int dec_to_hex(char hchar) {
        if (hchar >= '0' && hchar <= '9') {
            return (ord(hchar)-ord('0'));
        } else {
            return (10+ord(hchar)-ord('A'));
        }
    }
'''
for func in c_function.search_string(source_code):
    print("%(name)s (%(type)s) args: %(args)s" % func)

prints:

is_odd (int) args: [['int', 'x']]
dec_to_hex (int) args: [['char', 'hchar']]

pyparsing.nested_expr(opener: Union[str, pyparsing.core.ParserElement] = '(', closer: Union[str, pyparsing.core.ParserElement] = ')', content: Optional[pyparsing.core.ParserElement] = None, ignore_expr: pyparsing.core.ParserElement = quotedString using single or double quotes, *, ignoreExpr: pyparsing.core.ParserElement = quotedString using single or double quotes) → pyparsing.core.ParserElement¶

Helper method for defining nested lists enclosed in opening and closing delimiters ("(" and ")" are the default).

Parameters: - opener - opening character for a nested list

(default= "("); can also be a pyparsing expression

closer - closing character for a nested list (default= ")"); can also be a pyparsing expression
content - expression for items within the nested lists (default= None)
ignore_expr - expression for ignoring opening and closing delimiters (default= quoted_string)
ignoreExpr - this pre-PEP8 argument is retained for compatibility but will be removed in a future release

If an expression is not provided for the content argument, the nested expression will capture all whitespace-delimited content between delimiters as a list of separate values.

Use the ignore_expr argument to define expressions that may contain opening or closing characters that should not be treated as opening or closing characters for nesting, such as quoted_string or a comment expression. Specify multiple expressions using an Or or MatchFirst. The default is quoted_string, but if no expressions are to be ignored, then pass None for this argument.

Example:

data_type = one_of("void int short long char float double")
decl_data_type = Combine(data_type + Opt(Word('*')))
ident = Word(alphas+'_', alphanums+'_')
number = pyparsing_common.number
arg = Group(decl_data_type + ident)
LPAR, RPAR = map(Suppress, "()")

code_body = nested_expr('{', '}', ignore_expr=(quoted_string | c_style_comment))

c_function = (decl_data_type("type")
              + ident("name")
              + LPAR + Opt(delimited_list(arg), [])("args") + RPAR
              + code_body("body"))
c_function.ignore(c_style_comment)

source_code = '''
    int is_odd(int x) {
        return (x%2);
    }

    int dec_to_hex(char hchar) {
        if (hchar >= '0' && hchar <= '9') {
            return (ord(hchar)-ord('0'));
        } else {
            return (10+ord(hchar)-ord('A'));
        }
    }
'''
for func in c_function.search_string(source_code):
    print("%(name)s (%(type)s) args: %(args)s" % func)

prints:

is_odd (int) args: [['int', 'x']]
dec_to_hex (int) args: [['char', 'hchar']]

pyparsing.nullDebugAction(*args)¶: ‘Do-nothing’ debug action, to suppress debugging output during parsing.

pyparsing.null_debug_action(*args)¶: ‘Do-nothing’ debug action, to suppress debugging output during parsing.

pyparsing.oneOf(strs: Union[Iterable[str], str], caseless: bool = False, use_regex: bool = True, as_keyword: bool = False, *, useRegex: bool = True, asKeyword: bool = False) → pyparsing.core.ParserElement¶

Helper to quickly define a set of alternative Literal s, and makes sure to do longest-first testing when there is a conflict, regardless of the input order, but returns a MatchFirst for best performance.

Parameters:

strs - a string of space-delimited literals, or a collection of string literals
caseless - treat all literals as caseless - (default= False)
use_regex - as an optimization, will generate a Regex object; otherwise, will generate a MatchFirst object (if caseless=True or asKeyword=True, or if creating a Regex raises an exception) - (default= True)
as_keyword - enforce Keyword-style matching on the generated expressions - (default= False)
asKeyword and useRegex are retained for pre-PEP8 compatibility, but will be removed in a future release

Example:

comp_oper = one_of("< = > <= >= !=")
var = Word(alphas)
number = Word(nums)
term = var | number
comparison_expr = term + comp_oper + term
print(comparison_expr.search_string("B = 12  AA=23 B<=AA AA>12"))

prints:

[['B', '=', '12'], ['AA', '=', '23'], ['B', '<=', 'AA'], ['AA', '>', '12']]

pyparsing.one_of(strs: Union[Iterable[str], str], caseless: bool = False, use_regex: bool = True, as_keyword: bool = False, *, useRegex: bool = True, asKeyword: bool = False) → pyparsing.core.ParserElement¶

Helper to quickly define a set of alternative Literal s, and makes sure to do longest-first testing when there is a conflict, regardless of the input order, but returns a MatchFirst for best performance.

Parameters:

strs - a string of space-delimited literals, or a collection of string literals
caseless - treat all literals as caseless - (default= False)
use_regex - as an optimization, will generate a Regex object; otherwise, will generate a MatchFirst object (if caseless=True or asKeyword=True, or if creating a Regex raises an exception) - (default= True)
as_keyword - enforce Keyword-style matching on the generated expressions - (default= False)
asKeyword and useRegex are retained for pre-PEP8 compatibility, but will be removed in a future release

Example:

comp_oper = one_of("< = > <= >= !=")
var = Word(alphas)
number = Word(nums)
term = var | number
comparison_expr = term + comp_oper + term
print(comparison_expr.search_string("B = 12  AA=23 B<=AA AA>12"))

prints:

[['B', '=', '12'], ['AA', '=', '23'], ['B', '<=', 'AA'], ['AA', '>', '12']]

pyparsing.opAssoc¶: alias of pyparsing.helpers.OpAssoc

pyparsing.originalTextFor(expr: pyparsing.core.ParserElement, as_string: bool = True, *, asString: bool = True) → pyparsing.core.ParserElement¶

Helper to return the original, untokenized text for a given expression. Useful to restore the parsed fields of an HTML start tag into the raw tag text itself, or to revert separate tokens with intervening whitespace back to the original matching input text. By default, returns astring containing the original parsed text.

If the optional as_string argument is passed as False, then the return value is a ParseResults containing any results names that were originally matched, and a single token containing the original matched text from the input string. So if the expression passed to original_text_for contains expressions with defined results names, you must set as_string to False if you want to preserve those results name values.

The asString pre-PEP8 argument is retained for compatibility, but will be removed in a future release.

Example:

src = "this is test <b> bold <i>text</i> </b> normal text "
for tag in ("b", "i"):
    opener, closer = make_html_tags(tag)
    patt = original_text_for(opener + SkipTo(closer) + closer)
    print(patt.search_string(src)[0])

prints:

['<b> bold <i>text</i> </b>']
['<i>text</i>']

pyparsing.original_text_for(expr: pyparsing.core.ParserElement, as_string: bool = True, *, asString: bool = True) → pyparsing.core.ParserElement¶

Helper to return the original, untokenized text for a given expression. Useful to restore the parsed fields of an HTML start tag into the raw tag text itself, or to revert separate tokens with intervening whitespace back to the original matching input text. By default, returns astring containing the original parsed text.

If the optional as_string argument is passed as False, then the return value is a ParseResults containing any results names that were originally matched, and a single token containing the original matched text from the input string. So if the expression passed to original_text_for contains expressions with defined results names, you must set as_string to False if you want to preserve those results name values.

The asString pre-PEP8 argument is retained for compatibility, but will be removed in a future release.

Example:

src = "this is test <b> bold <i>text</i> </b> normal text "
for tag in ("b", "i"):
    opener, closer = make_html_tags(tag)
    patt = original_text_for(opener + SkipTo(closer) + closer)
    print(patt.search_string(src)[0])

prints:

['<b> bold <i>text</i> </b>']
['<i>text</i>']

class pyparsing.pyparsing_common¶

Bases: object

Here are some common low-level expressions that may be useful in jump-starting parser development:

numeric forms (integers, reals, scientific notation)
common programming identifiers
network addresses (MAC, IPv4, IPv6)
ISO8601 dates and datetime
UUID
comma-separated list
url

Parse actions:

convertToInteger
convertToFloat
convertToDate
convertToDatetime
stripHTMLTags
upcaseTokens
downcaseTokens

Example:

pyparsing_common.number.runTests('''
    # any int or real number, returned as the appropriate type
    100
    -100
    +100
    3.14159
    6.02e23
    1e-12
    ''')

pyparsing_common.fnumber.runTests('''
    # any int or real number, returned as float
    100
    -100
    +100
    3.14159
    6.02e23
    1e-12
    ''')

pyparsing_common.hex_integer.runTests('''
    # hex numbers
    100
    FF
    ''')

pyparsing_common.fraction.runTests('''
    # fractions
    1/2
    -3/4
    ''')

pyparsing_common.mixed_integer.runTests('''
    # mixed fractions
    1
    1/2
    -3/4
    1-3/4
    ''')

import uuid
pyparsing_common.uuid.setParseAction(tokenMap(uuid.UUID))
pyparsing_common.uuid.runTests('''
    # uuid
    12345678-1234-5678-1234-567812345678
    ''')

prints:

# any int or real number, returned as the appropriate type
100
[100]

-100
[-100]

+100
[100]

3.14159
[3.14159]

6.02e23
[6.02e+23]

1e-12
[1e-12]

# any int or real number, returned as float
100
[100.0]

-100
[-100.0]

+100
[100.0]

3.14159
[3.14159]

6.02e23
[6.02e+23]

1e-12
[1e-12]

# hex numbers
100
[256]

FF
[255]

# fractions
1/2
[0.5]

-3/4
[-0.75]

# mixed fractions
1
[1]

1/2
[0.5]

-3/4
[-0.75]

1-3/4
[1.75]

# uuid
12345678-1234-5678-1234-567812345678
[UUID('12345678-1234-5678-1234-567812345678')]

__weakref__¶: list of weak references to the object (if defined)

comma_separated_list = comma separated list¶: Predefined expression of 1 or more printable words or quoted strings, separated by commas.

static convertToDate(fmt: str = '%Y-%m-%d')¶

Helper to create a parse action for converting parsed date string to Python datetime.date

Params - - fmt - format to be passed to datetime.strptime (default= "%Y-%m-%d")

Example:

date_expr = pyparsing_common.iso8601_date.copy()
date_expr.setParseAction(pyparsing_common.convertToDate())
print(date_expr.parseString("1999-12-31"))

prints:

[datetime.date(1999, 12, 31)]

static convertToDatetime(fmt: str = '%Y-%m-%dT%H:%M:%S.%f')¶

Helper to create a parse action for converting parsed datetime string to Python datetime.datetime

Params - - fmt - format to be passed to datetime.strptime (default= "%Y-%m-%dT%H:%M:%S.%f")

Example:

dt_expr = pyparsing_common.iso8601_datetime.copy()
dt_expr.setParseAction(pyparsing_common.convertToDatetime())
print(dt_expr.parseString("1999-12-31T23:59:59.999"))

prints:

[datetime.datetime(1999, 12, 31, 23, 59, 59, 999000)]

static convert_to_date(fmt: str = '%Y-%m-%d')¶

Helper to create a parse action for converting parsed date string to Python datetime.date

Params - - fmt - format to be passed to datetime.strptime (default= "%Y-%m-%d")

Example:

date_expr = pyparsing_common.iso8601_date.copy()
date_expr.setParseAction(pyparsing_common.convertToDate())
print(date_expr.parseString("1999-12-31"))

prints:

[datetime.date(1999, 12, 31)]

static convert_to_datetime(fmt: str = '%Y-%m-%dT%H:%M:%S.%f')¶

Helper to create a parse action for converting parsed datetime string to Python datetime.datetime

Params - - fmt - format to be passed to datetime.strptime (default= "%Y-%m-%dT%H:%M:%S.%f")

Example:

dt_expr = pyparsing_common.iso8601_datetime.copy()
dt_expr.setParseAction(pyparsing_common.convertToDatetime())
print(dt_expr.parseString("1999-12-31T23:59:59.999"))

prints:

[datetime.datetime(1999, 12, 31, 23, 59, 59, 999000)]

convert_to_float(l, t)¶: Parse action for converting parsed numbers to Python float

convert_to_integer(l, t)¶: Parse action for converting parsed integers to Python int

static downcase_tokens(s, l, t)¶: Parse action to convert tokens to lower case.

fnumber = fnumber¶: any int or real number, returned as float

fraction = fraction¶: fractional expression of an integer divided by an integer, returns a float

hex_integer = hex integer¶: expression that parses a hexadecimal integer, returns an int

identifier = identifier¶: typical code identifier (leading alpha or ‘_’, followed by 0 or more alphas, nums, or ‘_’)

integer = integer¶: expression that parses an unsigned integer, returns an int

ipv4_address = IPv4 address¶: IPv4 address (0.0.0.0 - 255.255.255.255)

ipv6_address = IPv6 address¶: IPv6 address (long, short, or mixed form)

iso8601_date = ISO8601 date¶: ISO8601 date (yyyy-mm-dd)

iso8601_datetime = ISO8601 datetime¶: ISO8601 datetime (yyyy-mm-ddThh:mm:ss.s(Z|+-00:00)) - trailing seconds, milliseconds, and timezone optional; accepts separating 'T' or ' '

mac_address = MAC address¶: MAC address xx:xx:xx:xx:xx (may also have ‘-‘ or ‘.’ delimiters)

mixed_integer = fraction or mixed integer-fraction¶: mixed integer of the form ‘integer - fraction’, with optional leading integer, returns float

number = number¶: any numeric expression, returns the corresponding Python type

real = real number¶: expression that parses a floating point number and returns a float

sci_real = real number with scientific notation¶: expression that parses a floating point number with optional scientific notation and returns a float

signed_integer = signed integer¶: expression that parses an integer with optional leading sign, returns an int

static stripHTMLTags(s: str, l: int, tokens: pyparsing.results.ParseResults)¶

Parse action to remove HTML tags from web page HTML source

Example:

# strip HTML links from normal text
text = '<td>More info at the <a href="https://github.com/pyparsing/pyparsing/wiki">pyparsing</a> wiki page</td>'
td, td_end = makeHTMLTags("TD")
table_text = td + SkipTo(td_end).setParseAction(pyparsing_common.stripHTMLTags)("body") + td_end
print(table_text.parseString(text).body)

Prints:

More info at the pyparsing wiki page

static strip_html_tags(s: str, l: int, tokens: pyparsing.results.ParseResults)¶

Parse action to remove HTML tags from web page HTML source

Example:

# strip HTML links from normal text
text = '<td>More info at the <a href="https://github.com/pyparsing/pyparsing/wiki">pyparsing</a> wiki page</td>'
td, td_end = makeHTMLTags("TD")
table_text = td + SkipTo(td_end).setParseAction(pyparsing_common.stripHTMLTags)("body") + td_end
print(table_text.parseString(text).body)

Prints:

More info at the pyparsing wiki page

static upcase_tokens(s, l, t)¶: Parse action to convert tokens to upper case.

uuid = UUID¶: UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

class pyparsing.pyparsing_test¶

Bases: object

namespace class for classes useful in writing unit tests

class TestParseResultsAsserts¶

Bases: object

A mixin class to add parse results assertion methods to normal unittest.TestCase classes.

__dict__ = mappingproxy({'__module__': 'pyparsing.testing', '__doc__': '\n A mixin class to add parse results assertion methods to normal unittest.TestCase classes.\n ', 'assertParseResultsEquals': <function pyparsing_test.TestParseResultsAsserts.assertParseResultsEquals>, 'assertParseAndCheckList': <function pyparsing_test.TestParseResultsAsserts.assertParseAndCheckList>, 'assertParseAndCheckDict': <function pyparsing_test.TestParseResultsAsserts.assertParseAndCheckDict>, 'assertRunTestResults': <function pyparsing_test.TestParseResultsAsserts.assertRunTestResults>, 'assertRaisesParseException': <function pyparsing_test.TestParseResultsAsserts.assertRaisesParseException>, '__dict__': <attribute '__dict__' of 'TestParseResultsAsserts' objects>, '__weakref__': <attribute '__weakref__' of 'TestParseResultsAsserts' objects>, '__annotations__': {}})¶

__weakref__¶: list of weak references to the object (if defined)

assertParseAndCheckDict(expr, test_string, expected_dict, msg=None, verbose=True)¶: Convenience wrapper assert to test a parser element and input string, and assert that the resulting ParseResults.asDict() is equal to the expected_dict.

assertParseAndCheckList(expr, test_string, expected_list, msg=None, verbose=True)¶: Convenience wrapper assert to test a parser element and input string, and assert that the resulting ParseResults.asList() is equal to the expected_list.

assertParseResultsEquals(result, expected_list=None, expected_dict=None, msg=None)¶: Unit test assertion to compare a ParseResults object with an optional expected_list, and compare any defined results names with an optional expected_dict.

assertRaisesParseException(exc_type=<class 'pyparsing.exceptions.ParseException'>, msg=None)¶

assertRunTestResults(run_tests_report, expected_parse_results=None, msg=None)¶

Unit test assertion to evaluate output of ParserElement.runTests(). If a list of list-dict tuples is given as the expected_parse_results argument, then these are zipped with the report tuples returned by runTests and evaluated using assertParseResultsEquals. Finally, asserts that the overall runTests() success value is True.

Parameters

run_tests_report – tuple(bool, [tuple(str, ParseResults or Exception)]) returned from runTests
(optional) (expected_parse_results) – [tuple(str, list, dict, Exception)]

__weakref__¶: list of weak references to the object (if defined)

class reset_pyparsing_context¶

Bases: object

Context manager to be used when writing unit tests that modify pyparsing config values: - packrat parsing - bounded recursion parsing - default whitespace characters. - default keyword characters - literal string auto-conversion class - __diag__ settings

Example:

with reset_pyparsing_context():
    # test that literals used to construct a grammar are automatically suppressed
    ParserElement.inlineLiteralsUsing(Suppress)

    term = Word(alphas) | Word(nums)
    group = Group('(' + term[...] + ')')

    # assert that the '()' characters are not included in the parsed tokens
    self.assertParseAndCheckList(group, "(abc 123 def)", ['abc', '123', 'def'])

# after exiting context manager, literals are converted to Literal expressions again

__dict__ = mappingproxy({'__module__': 'pyparsing.testing', '__doc__': '\n Context manager to be used when writing unit tests that modify pyparsing config values:\n - packrat parsing\n - bounded recursion parsing\n - default whitespace characters.\n - default keyword characters\n - literal string auto-conversion class\n - __diag__ settings\n\n Example::\n\n with reset_pyparsing_context():\n # test that literals used to construct a grammar are automatically suppressed\n ParserElement.inlineLiteralsUsing(Suppress)\n\n term = Word(alphas) | Word(nums)\n group = Group(\'(\' + term[...] + \')\')\n\n # assert that the \'()\' characters are not included in the parsed tokens\n self.assertParseAndCheckList(group, "(abc 123 def)", [\'abc\', \'123\', \'def\'])\n\n # after exiting context manager, literals are converted to Literal expressions again\n ', '__init__': <function pyparsing_test.reset_pyparsing_context.__init__>, 'save': <function pyparsing_test.reset_pyparsing_context.save>, 'restore': <function pyparsing_test.reset_pyparsing_context.restore>, 'copy': <function pyparsing_test.reset_pyparsing_context.copy>, '__enter__': <function pyparsing_test.reset_pyparsing_context.__enter__>, '__exit__': <function pyparsing_test.reset_pyparsing_context.__exit__>, '__dict__': <attribute '__dict__' of 'reset_pyparsing_context' objects>, '__weakref__': <attribute '__weakref__' of 'reset_pyparsing_context' objects>, '__annotations__': {}})¶

__enter__()¶

__exit__(*args)¶

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

__weakref__¶: list of weak references to the object (if defined)

copy()¶

restore()¶

save()¶

static with_line_numbers(s: str, start_line: Optional[int] = None, end_line: Optional[int] = None, expand_tabs: bool = True, eol_mark: str = '|', mark_spaces: Optional[str] = None, mark_control: Optional[str] = None) → str¶

Helpful method for debugging a parser - prints a string with line and column numbers. (Line and column numbers are 1-based.)

Parameters

s – tuple(bool, str - string to be printed with line and column numbers
start_line – int - (optional) starting line number in s to print (default=1)
end_line – int - (optional) ending line number in s to print (default=len(s))
expand_tabs – bool - (optional) expand tabs to spaces, to match the pyparsing default
eol_mark – str - (optional) string to mark the end of lines, helps visualize trailing spaces (default=”|”)
mark_spaces – str - (optional) special character to display in place of spaces
mark_control – str - (optional) convert non-printing control characters to a placeholding character; valid values: - “unicode” - replaces control chars with Unicode symbols, such as “␍” and “␊” - any single character string - replace control characters with given string - None (default) - string is displayed as-is

Returns

str - input string with leading line numbers and column number headers

class pyparsing.pyparsing_unicode¶

Bases: pyparsing.unicode.unicode_set

A namespace class for defining common language unicode_sets.

class Arabic¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Arabic Unicode Character Range

BMP¶: alias of pyparsing.unicode.pyparsing_unicode.BasicMultilingualPlane

class BasicMultilingualPlane¶

Bases: pyparsing.unicode.unicode_set

Unicode set for the Basic Multilingual Plane

class CJK¶

Bases: pyparsing.unicode.pyparsing_unicode.Chinese, pyparsing.unicode.pyparsing_unicode.Japanese, pyparsing.unicode.pyparsing_unicode.Hangul

Unicode set for combined Chinese, Japanese, and Korean (CJK) Unicode Character Range

class Chinese¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Chinese Unicode Character Range

class Cyrillic¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Cyrillic Unicode Character Range

class Devanagari¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Devanagari Unicode Character Range

class Greek¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Greek Unicode Character Ranges

class Hangul¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Hangul (Korean) Unicode Character Range

class Hebrew¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Hebrew Unicode Character Range

class Japanese¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Japanese Unicode Character Range, combining Kanji, Hiragana, and Katakana ranges

class Hiragana¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Hiragana Unicode Character Range

class Kanji¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Kanji Unicode Character Range

class Katakana¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Katakana Unicode Character Range

ひらがな¶: alias of pyparsing.unicode.pyparsing_unicode.Japanese.Hiragana

カタカナ¶: alias of pyparsing.unicode.pyparsing_unicode.Japanese.Katakana

漢字¶: alias of pyparsing.unicode.pyparsing_unicode.Japanese.Kanji

Korean¶: alias of pyparsing.unicode.pyparsing_unicode.Hangul

class Latin1¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Latin-1 Unicode Character Range

class LatinA¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Latin-A Unicode Character Range

class LatinB¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Latin-B Unicode Character Range

class Thai¶

Bases: pyparsing.unicode.unicode_set

Unicode set for Thai Unicode Character Range

Ελληνικά¶: alias of pyparsing.unicode.pyparsing_unicode.Greek

кириллица¶: alias of pyparsing.unicode.pyparsing_unicode.Cyrillic

العربية¶: alias of pyparsing.unicode.pyparsing_unicode.Arabic

ไทย¶: alias of pyparsing.unicode.pyparsing_unicode.Thai

中文¶: alias of pyparsing.unicode.pyparsing_unicode.Chinese

日本語¶: alias of pyparsing.unicode.pyparsing_unicode.Japanese

한국어¶: alias of pyparsing.unicode.pyparsing_unicode.Hangul

pyparsing.removeQuotes(s, l, t)¶

Helper parse action for removing quotation marks from parsed quoted strings.

Example:

# by default, quotation marks are included in parsed results
quoted_string.parse_string("'Now is the Winter of our Discontent'") # -> ["'Now is the Winter of our Discontent'"]

# use remove_quotes to strip quotation marks from parsed results
quoted_string.set_parse_action(remove_quotes)
quoted_string.parse_string("'Now is the Winter of our Discontent'") # -> ["Now is the Winter of our Discontent"]

pyparsing.remove_quotes(s, l, t)¶

Helper parse action for removing quotation marks from parsed quoted strings.

Example:

# by default, quotation marks are included in parsed results
quoted_string.parse_string("'Now is the Winter of our Discontent'") # -> ["'Now is the Winter of our Discontent'"]

# use remove_quotes to strip quotation marks from parsed results
quoted_string.set_parse_action(remove_quotes)
quoted_string.parse_string("'Now is the Winter of our Discontent'") # -> ["Now is the Winter of our Discontent"]

pyparsing.replaceHTMLEntity(t)¶: Helper parser action to replace common HTML entities with their special characters

pyparsing.replaceWith(repl_str)¶

Helper method for common parse actions that simply return a literal value. Especially useful when used with transform_string ().

Example:

num = Word(nums).set_parse_action(lambda toks: int(toks[0]))
na = one_of("N/A NA").set_parse_action(replace_with(math.nan))
term = na | num

term[1, ...].parse_string("324 234 N/A 234") # -> [324, 234, nan, 234]

pyparsing.replace_html_entity(t)¶: Helper parser action to replace common HTML entities with their special characters

pyparsing.replace_with(repl_str)¶

Helper method for common parse actions that simply return a literal value. Especially useful when used with transform_string ().

Example:

num = Word(nums).set_parse_action(lambda toks: int(toks[0]))
na = one_of("N/A NA").set_parse_action(replace_with(math.nan))
term = na | num

term[1, ...].parse_string("324 234 N/A 234") # -> [324, 234, nan, 234]

pyparsing.srange(s: str) → str¶

Helper to easily define string ranges for use in 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.)

pyparsing.tokenMap(func, *args) → Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]¶

Helper to define a parse action by mapping a function to all elements of a 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 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']

pyparsing.token_map(func, *args) → Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]¶

Helper to define a parse action by mapping a function to all elements of a 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 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']

pyparsing.traceParseAction(f: Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]) → Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]¶

Decorator for debugging parse actions.

When the parse action is called, this decorator will print ">> entering method-name(line:<current_source_line>, <parse_location>, <matched_tokens>)". 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'], {}))
<<leaving remove_duplicate_chars (ret: 'dfjkls')
['dfjkls']

pyparsing.trace_parse_action(f: Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]) → Union[Callable[], Any], Callable[[pyparsing.results.ParseResults], Any], Callable[[int, pyparsing.results.ParseResults], Any], Callable[[str, int, pyparsing.results.ParseResults], Any]]¶

Decorator for debugging parse actions.

When the parse action is called, this decorator will print ">> entering method-name(line:<current_source_line>, <parse_location>, <matched_tokens>)". 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'], {}))
<<leaving remove_duplicate_chars (ret: 'dfjkls')
['dfjkls']

pyparsing.ungroup(expr: pyparsing.core.ParserElement) → pyparsing.core.ParserElement¶: Helper to undo pyparsing’s default grouping of And expressions, even if all but one are non-empty.

class pyparsing.unicode_set¶

Bases: object

A set of Unicode characters, for language-specific strings for alphas, nums, alphanums, and printables. A unicode_set is defined by a list of ranges in the Unicode character set, in a class attribute _ranges. Ranges can be specified using 2-tuples or a 1-tuple, such as:

_ranges = [
    (0x0020, 0x007e),
    (0x00a0, 0x00ff),
    (0x0100,),
    ]

Ranges are left- and right-inclusive. A 1-tuple of (x,) is treated as (x, x).

A unicode set can also be defined using multiple inheritance of other unicode sets:

class CJK(Chinese, Japanese, Korean):
    pass

__weakref__¶: list of weak references to the object (if defined)

pyparsing.withAttribute(*args, **attr_dict)¶

Helper to create a validating parse action to be used with start tags created with make_xml_tags or make_html_tags. Use with_attribute to qualify a starting tag with a required attribute value, to avoid false matches on common tags such as <TD> or <DIV>.

Call with_attribute with a series of attribute names and values. Specify the list of filter attributes names and values as:

keyword arguments, as in (align="right"), or
as an explicit dict with ** operator, when an attribute name is also a Python reserved word, as in **{"class":"Customer", "align":"right"}
a list of name-value tuples, as in (("ns1:class", "Customer"), ("ns2:align", "right"))

For attribute names with a namespace prefix, you must use the second form. Attribute names are matched insensitive to upper/lower case.

If just testing for class (with or without a namespace), use with_class.

To verify that the attribute exists, but without specifying a value, pass with_attribute.ANY_VALUE as the value.

Example:

html = '''
    <div>
    Some text
    <div type="grid">1 4 0 1 0</div>
    <div type="graph">1,3 2,3 1,1</div>
    <div>this has no type</div>
    </div>

'''
div,div_end = make_html_tags("div")

# only match div tag having a type attribute with value "grid"
div_grid = div().set_parse_action(with_attribute(type="grid"))
grid_expr = div_grid + SkipTo(div | div_end)("body")
for grid_header in grid_expr.search_string(html):
    print(grid_header.body)

# construct a match with any div tag having a type attribute, regardless of the value
div_any_type = div().set_parse_action(with_attribute(type=with_attribute.ANY_VALUE))
div_expr = div_any_type + SkipTo(div | div_end)("body")
for div_header in div_expr.search_string(html):
    print(div_header.body)

prints:

1 4 0 1 0

1 4 0 1 0
1,3 2,3 1,1

pyparsing.withClass(classname, namespace='')¶

Simplified version of with_attribute when matching on a div class - made difficult because class is a reserved word in Python.

Example:

html = '''
    <div>
    Some text
    <div class="grid">1 4 0 1 0</div>
    <div class="graph">1,3 2,3 1,1</div>
    <div>this &lt;div&gt; has no class</div>
    </div>

'''
div,div_end = make_html_tags("div")
div_grid = div().set_parse_action(with_class("grid"))

grid_expr = div_grid + SkipTo(div | div_end)("body")
for grid_header in grid_expr.search_string(html):
    print(grid_header.body)

div_any_type = div().set_parse_action(with_class(withAttribute.ANY_VALUE))
div_expr = div_any_type + SkipTo(div | div_end)("body")
for div_header in div_expr.search_string(html):
    print(div_header.body)

prints:

1 4 0 1 0

1 4 0 1 0
1,3 2,3 1,1

pyparsing.with_attribute(*args, **attr_dict)¶

Helper to create a validating parse action to be used with start tags created with make_xml_tags or make_html_tags. Use with_attribute to qualify a starting tag with a required attribute value, to avoid false matches on common tags such as <TD> or <DIV>.

Call with_attribute with a series of attribute names and values. Specify the list of filter attributes names and values as:

keyword arguments, as in (align="right"), or
as an explicit dict with ** operator, when an attribute name is also a Python reserved word, as in **{"class":"Customer", "align":"right"}
a list of name-value tuples, as in (("ns1:class", "Customer"), ("ns2:align", "right"))

For attribute names with a namespace prefix, you must use the second form. Attribute names are matched insensitive to upper/lower case.

If just testing for class (with or without a namespace), use with_class.

To verify that the attribute exists, but without specifying a value, pass with_attribute.ANY_VALUE as the value.

Example:

html = '''
    <div>
    Some text
    <div type="grid">1 4 0 1 0</div>
    <div type="graph">1,3 2,3 1,1</div>
    <div>this has no type</div>
    </div>

'''
div,div_end = make_html_tags("div")

# only match div tag having a type attribute with value "grid"
div_grid = div().set_parse_action(with_attribute(type="grid"))
grid_expr = div_grid + SkipTo(div | div_end)("body")
for grid_header in grid_expr.search_string(html):
    print(grid_header.body)

# construct a match with any div tag having a type attribute, regardless of the value
div_any_type = div().set_parse_action(with_attribute(type=with_attribute.ANY_VALUE))
div_expr = div_any_type + SkipTo(div | div_end)("body")
for div_header in div_expr.search_string(html):
    print(div_header.body)

prints:

1 4 0 1 0

1 4 0 1 0
1,3 2,3 1,1

pyparsing.with_class(classname, namespace='')¶

Simplified version of with_attribute when matching on a div class - made difficult because class is a reserved word in Python.

Example:

html = '''
    <div>
    Some text
    <div class="grid">1 4 0 1 0</div>
    <div class="graph">1,3 2,3 1,1</div>
    <div>this &lt;div&gt; has no class</div>
    </div>

'''
div,div_end = make_html_tags("div")
div_grid = div().set_parse_action(with_class("grid"))

grid_expr = div_grid + SkipTo(div | div_end)("body")
for grid_header in grid_expr.search_string(html):
    print(grid_header.body)

div_any_type = div().set_parse_action(with_class(withAttribute.ANY_VALUE))
div_expr = div_any_type + SkipTo(div | div_end)("body")
for div_header in div_expr.search_string(html):
    print(div_header.body)

prints:

1 4 0 1 0

1 4 0 1 0
1,3 2,3 1,1

pyparsing module¶

pyparsing module - Classes and methods to define and execute parsing grammars¶

Getting Started -¶

PyParsing

Navigation

Related Topics