pyparsing API reference
66 public APIs from pyparsing (pyparsing/pyparsing) — 43 classes, 8 functions, 15 methods. Signatures extracted by static analysis of the actual source.
Repository: pyparsing/pyparsing
| Kind | Count |
|---|---|
| Classes | 43 |
| Functions | 8 |
| Methods | 15 |
API list
class
pyparsing.core.CaselessKeywordCaseless version of :class:`Keyword`.
class
pyparsing.core.CaselessLiteralToken to match a specified string, ignoring case of letters.
class
pyparsing.core.CombineConverter to concatenate all matching tokens to a single string.
class
pyparsing.core.EmptyAn empty token, will always match.
class
pyparsing.core.FollowedByLookahead matching of the given parse expression.
method
pyparsing.core.Keyword.identChars() -> set[str]..
class
pyparsing.core.LiteralToken to exactly match a specified string.
class
pyparsing.core.MatchFirstRequires that at least one :class:`ParserElement` is found.
class
pyparsing.core.NoMatchA token that will never match.
class
pyparsing.core.NotAnyLookahead to disallow matching with the given parse expression.
class
pyparsing.core.OneOrMoreRepetition of one or more of the given expression.
class
pyparsing.core.OptOptional matching of the given expression.
class
pyparsing.core.OrRequires that at least one :class:`ParserElement` is found.
class
pyparsing.core.ParserElementAbstract base level parser element class.
method
pyparsing.core.ParserElement.copy() -> ParserElementMake a copy of this :class:`ParserElement`.
method
pyparsing.core.ParserElement.matches(test_string:str, parse_all:bool=True, **kwargs) -> boolMethod for quick testing of a parser against a test string.
method
pyparsing.core.ParserElement.mayReturnEmpty() -> bool..
method
pyparsing.core.ParserElement.parse_string(instring:str, parse_all:bool=False, **kwargs) -> ParseResultsParse a string with respect to the parser definition.
method
pyparsing.core.ParserElement.reset_cache() -> NoneClears caches used by packrat and left-recursion.
method
pyparsing.core.ParserElement.set_default_whitespace_chars(chars:str) -> NoneOverrides the default whitespace chars Example: ..
method
pyparsing.core.ParserElement.set_fail_action(fn:ParseFailAction) -> ParserElementDefine action to perform if parsing fails at this expression.
method
pyparsing.core.ParserElement.set_whitespace_chars(chars:Union[set[str], str], copy_defaults:bool=False) -> ParserElementOverrides the default whitespace chars
method
pyparsing.core.ParserElement.validate(validateTrace=None) -> None..
class
pyparsing.core.PrecededByLookbehind matching of the given parse expression.
method
pyparsing.core.Regex.copy() -> RegexReturns a copy of this expression.
class
pyparsing.core.StringEndMatches if current position is at the end of the parse string
class
pyparsing.core.SuppressConverter for ignoring the results of a parsed expression.
class
pyparsing.core.WhiteSpecial matching class for matching whitespace.
class
pyparsing.core.WordToken for matching words composed of allowed character sets.
method
pyparsing.core.Word.copy() -> WordReturns a copy of this expression.
method
pyparsing.core.Word.initChars() -> set[str]..
class
pyparsing.core.ZeroOrMoreOptional repetition of zero or more of the given expression.
func
pyparsing.core.enable_diag(diag_enum:Diagnostics) -> NoneEnable a global pyparsing diagnostic flag (see :class:`Diagnostics`).
func
pyparsing.core.srange(s:str) -> strHelper to easily define string ranges for use in :class:`Word` construction.
func
pyparsing.core.trace_parse_action(f:ParseAction) -> ParseActionDecorator for debugging parse actions.
class
pyparsing.diagram.AnnotatedItemSimple subclass of Group that creates an annotation label
class
pyparsing.diagram.EditablePartialActs like a functools.partial, but can be edited.
class
pyparsing.diagram.ElementStateState recorded for an individual pyparsing Element
class
pyparsing.exceptions.ParseBaseExceptionbase exception class for all parsing runtime exceptions
method
pyparsing.exceptions.ParseBaseException.formatted_message() -> strOutput the formatted exception message.
method
pyparsing.exceptions.ParseBaseException.line() -> strReturn the line of text where the exception occurred.
class
pyparsing.exceptions.RecursiveGrammarException..
func
pyparsing.helpers.counted_array(expr:ParserElement, int_expr:typing.Optional[ParserElement]=None, **kwargs) -> ParserElementHelper to define a counted list of expressions.
func
pyparsing.helpers.delimited_list(expr:Union[str, ParserElement], delim:Union[str, ParserElement]=',', combine:bool=False, min:typing.Optional[int]=None, max:typing.Optional[int]=None, *allow_trailing_delim:bool=False) -> ParserElement..
func
pyparsing.helpers.indentedBlock(blockStatementExpr, indentStack, indent=True, backup_stacks=[])..
func
pyparsing.helpers.locatedExpr(expr:ParserElement) -> ParserElement..
func
pyparsing.show_best_practices(file=sys.stdout) -> Union[str, None]Load and return the project's best practices.
class
pyparsing.testing.pyparsing_testnamespace class for classes useful in writing unit tests
class
pyparsing.unicode.pyparsing_unicode.ArabicUnicode set for Arabic Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.BasicMultilingualPlaneUnicode set for the Basic Multilingual Plane
class
pyparsing.unicode.pyparsing_unicode.ChineseUnicode set for Chinese Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.CyrillicUnicode set for Cyrillic Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.DevanagariUnicode set for Devanagari Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.GreekUnicode set for Greek Unicode Character Ranges
class
pyparsing.unicode.pyparsing_unicode.HangulUnicode set for Hangul (Korean) Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.HebrewUnicode set for Hebrew Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.Japanese.HiraganaUnicode set for Hiragana Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.Japanese.KanjiUnicode set for Kanji Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.Japanese.KatakanaUnicode set for Katakana Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.Latin1Unicode set for Latin-1 Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.LatinAUnicode set for Latin-A Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.LatinBUnicode set for Latin-B Unicode Character Range
class
pyparsing.unicode.pyparsing_unicode.ThaiUnicode set for Thai Unicode Character Range
class
pyparsing.util.UnboundedMemoA memoizing mapping that retains all deleted items
class
pyparsing.warnings.PyparsingDiagnosticWarningBase warning class for all pyparsing diagnostic warnings
class
pyparsing.warnings.PyparsingWarningBase warning class for all pyparsing warnings
About this data
These signatures were extracted from the public source of pyparsing/pyparsing
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.