Skip to content

PEP 8 planning

Paul McGuire edited this page Jan 14, 2019 · 8 revisions

Migration of Pyparsing's API over to PEP-8 will be a multi-step process, involving synonym definitions of many methods, method arguments, and module-level variables to provide a migration path for existing pyparsing users. These include:

  • no change to existing class names, as they are already PEP-8 compliant

  • no change to pyparsing_unicode or pyparsing_common; even though these are classes, their intent is to serve as module-like namespaces, so they will retain module naming style

  • conversion of non-PEP-8 methods to classes (while redefining current names as synonyms to the new names):

    • delimitedList -> DelimitedList
    • oneOf -> OneOf
    • dictOf -> DictOf
    • infixNotation -> InfixNotation countedArray->CountedArray matchPreviousLiteral -> MatchPreviousLiteral
    • matchPreviousExpr -> MatchPreviousExpr
    • originalTextFor -> OriginalTextFor
    • locatedExpr -> LocatedExpr
    • nestedExpr -> NestedExpr
    • indentedBlock -> IndentedBlock

    This conversion will also make grammar definitions more consistent in appearance, as most will use just class names, not a mix of class names and method names

  • no change to:

    • alphas
    • nums
    • alphanums
    • hexnums
    • printables
    • col
    • lineno
    • line
  • renaming (with retained synonyms):

    • quotedString -> quoted_string
    • dblQuotedString -> dbl_quoted_string
    • sglQuotedString -> sgl_quoted_string
Clone this wiki locally