| Home | Trees | Indices | Help | 
 | 
|---|
|  | 
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>!"):
from pyparsing import Word, alphas # define grammar of a greeting greet = Word( alphas ) + "," + Word( alphas ) + "!" hello = "Hello, World!" print (hello, "->", greet.parseString( 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 parsed results returned from 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:
Version: 2.0.2
Author: Paul McGuire <ptmcg@users.sourceforge.net>
| Classes | |
| ParseBaseException base exception class for all parsing runtime exceptions | |
| ParseException exception thrown when parse expressions don't match class; supported attributes by name are: | |
| ParseFatalException user-throwable exception thrown when inconsistent parse content is found; stops all parsing immediately | |
| ParseSyntaxException just like ParseFatalException, but thrown internally 
        when anErrorStop('-' operator) indicates that 
        parsing is to stop immediately because an unbacktrackable syntax 
        error has been found | |
| RecursiveGrammarException exception thrown by validate()if the grammar could be
        improperly recursive | |
| ParseResults Structured parse results, to provide multiple means of access to the parsed data: | |
| ParserElement Abstract base level parser element class. | |
| Token Abstract ParserElementsubclass, for defining atomic 
        matching patterns. | |
| Empty An empty token, will always match. | |
| NoMatch A token that will never match. | |
| Literal Token to exactly match a specified string. | |
| Keyword Token to exactly match a specified string as a keyword, that is, it must be immediately followed by a non-keyword character. | |
| CaselessLiteral Token to match a specified string, ignoring case of letters. | |
| CaselessKeyword | |
| Word Token for matching words composed of allowed character sets. | |
| Regex Token for matching strings that match a given regular expression. | |
| QuotedString Token for matching strings that are delimited by quoting characters. | |
| CharsNotIn Token for matching words composed of characters *not* in a given set. | |
| White Special matching class for matching whitespace. | |
| GoToColumn Token to advance to a specific column of input text; useful for tabular report scraping. | |
| LineStart Matches if current position is at the beginning of a line within the parse string | |
| LineEnd Matches if current position is at the end of a line within the parse string | |
| StringStart Matches if current position is at the beginning of the parse string | |
| StringEnd Matches if current position is at the end of the parse string | |
| WordStart Matches if the current position is at the beginning of a Word, and is not preceded by any character in a given set of wordChars(default=printables). | |
| WordEnd Matches if the current position is at the end of a Word, and is not followed by any character in a given set of wordChars(default=printables). | |
| ParseExpression Abstract subclass of ParserElement, for combining and post-processing parsed tokens. | |
| And Requires all given ParseExpressions to be found in the
        given order. | |
| Or Requires that at least one ParseExpressionis found. | |
| MatchFirst Requires that at least one ParseExpressionis found. | |
| Each Requires all given ParseExpressions to be found, but 
        in any order. | |
| ParseElementEnhance Abstract subclass of ParserElement, for combining and 
        post-processing parsed tokens. | |
| FollowedBy Lookahead matching of the given parse expression. | |
| NotAny Lookahead to disallow matching with the given parse expression. | |
| ZeroOrMore Optional repetition of zero or more of the given expression. | |
| OneOrMore Repetition of one or more of the given expression. | |
| Optional Optional matching of the given expression. | |
| SkipTo Token for skipping over all undefined text until the matched expression is found. | |
| Forward Forward declaration of an expression to be defined later - used for recursive grammars, such as algebraic infix notation. | |
| TokenConverter Abstract subclass of ParseExpression, for converting 
        parsed results. | |
| Upcase Converter to upper case all matching tokens. | |
| Combine Converter to concatenate all matching tokens to a single string. | |
| Group Converter to return the matched tokens as a list - useful for returning tokens of ZeroOrMoreandOneOrMoreexpressions. | |
| Dict Converter to return a repetitive expression as a list, but also as a dictionary. | |
| Suppress Converter for ignoring the results of a parsed expression. | |
| OnlyOnce Wrapper for parse actions, to ensure they are only called once. | |
| Functions | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| Variables | |
| alphas =  | |
| nums =  | |
| hexnums =  | |
| alphanums =  | |
| printables =  | |
| empty = empty | |
| lineStart = lineStart | |
| lineEnd = lineEnd | |
| stringStart = stringStart | |
| stringEnd = stringEnd | |
| opAssoc = _Constants() | |
| dblQuotedString = string enclosed in double quotes | |
| sglQuotedString = string enclosed in single quotes | |
| quotedString = quotedString using single or double quotes | |
| unicodeString = Combine:({"u" quotedString using single or dou | |
| alphas8bit =  | |
| punc8bit =  | |
| commonHTMLEntity = Combine:({"&" Re:('gt|lt|amp|nbsp|quot') ";"}) | |
| cStyleComment = C style comment | |
| htmlComment = Re:('<!--[\\s\\S]*?-->') | |
| restOfLine = Re:('.*') | |
| dblSlashComment = // comment | |
| cppStyleComment = C++ style comment | |
| javaStyleComment = C++ style comment | |
| pythonStyleComment = Python style comment | |
| commaSeparatedList = commaSeparatedList | |
| anyCloseTag = </W:(abcd...,abcd...)> | |
| anyOpenTag = <W:(abcd...,abcd...)> | |
| Function Details | 
| 
 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  | 
| 
 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  | 
| 
 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  | 
| 
 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. | 
| 
 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 = matchPreviousLiteral(first) matchExpr = first + ":" + second will match  | 
| 
 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 = matchPreviousExpr(first) matchExpr = first + ":" + second will match  | 
| 
 Helper to quickly define a set of alternative Literals, and makes sure
  to do longest-first testing when there is a conflict, regardless of the 
  input order, but returns a  Parameters: 
 | 
| 
 Helper to easily and clearly define a dictionary by specifying the 
  respective patterns for the key and value.  Takes care of defining the 
   | 
| 
 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. Simpler 
  to use than the parse action  If the optional  | 
| 
 Helper to decorate a returned token with its starting and ending locations in the input string. This helper adds the following results names: 
 Be careful if the input text contains  | 
| 
 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.)
 | 
| 
 Helper method for common parse actions that simply return a literal 
  value.  Especially useful when used with  | 
| 
 Helper parse action for removing quotation marks from parsed quoted strings. To use, add this parse action to quoted string using: quotedString.setParseAction( removeQuotes ) | 
| 
 DEPRECATED - use new helper method  | 
| 
 Helper to create a validating parse action to be used with start tags 
  created with  Call  
 For attribute names with a namespace prefix, you must use the second form. Attribute names are matched insensitive to upper/lower case. To verify that the attribute exists, but without specifying a value, 
  pass  | 
| 
 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. Parameters: 
 | 
| 
 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. Parameters: 
 | 
| 
 Helper method for defining nested lists enclosed in opening and closing delimiters ("(" and ")" are the default). Parameters: 
 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  | 
| 
 Helper method for defining space-delimited indentation blocks, such as those used to define block statements in Python source code. Parameters: 
 A valid block must contain at least one 
   | 
| Variables Details | 
| alphanums
 | 
| printables
 | 
| unicodeString
 | 
| alphas8bit
 | 
| Home | Trees | Indices | Help | 
 | 
|---|
| Generated by Epydoc 3.0.1 on Sun Apr 13 12:08:30 2014 | http://epydoc.sourceforge.net |