PyF.Internal.PythonSyntax

This module provides a parser for python format string mini language.

Documentation

parsePythonFormatString :: [Extension] -> Parser [Item]

Parse a string, returns a list of raw string or replacement fields

>>> import Text.Megaparsec
>>> parse parsePythonFormatString "" "hello {1+1:>10.2f}"
Right [
       Raw "hello ",
       Replacement "1+1"
       (
       Just (FormatMode
                      (Padding 10 (Just (Nothing,AnyAlign AlignRight)))
                      (FixedF (Precision 2) NormalForm Minus)
                       Nothing))]

parseGenericFormatString :: [Extension] -> (Char, Char) -> Parser [Item]

data Item

A format string is composed of many chunks of raw string or replacement

Constructors

Raw String

A raw string

Replacement Exp (Maybe FormatMode)

A replacement string, composed of an arbitrary Haskell expression followed by an optional formatter

Instances

Show Item

Defined in PyF.Internal.PythonSyntax

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

data FormatMode

A Formatter, listing padding, format and and grouping char

Constructors

FormatMode Padding TypeFormat (Maybe Char)

Instances

Show FormatMode

Defined in PyF.Internal.PythonSyntax

Methods

showsPrec :: Int -> FormatMode -> ShowS

show :: FormatMode -> String

showList :: [FormatMode] -> ShowS

data Padding

Padding, containing the padding width, the padding char and the alignement mode

Constructors

PaddingDefault

Padding Integer (Maybe (Maybe Char, AnyAlign))

Instances

Show Padding

Defined in PyF.Internal.PythonSyntax

Methods

showsPrec :: Int -> Padding -> ShowS

show :: Padding -> String

showList :: [Padding] -> ShowS

Lift Padding

Defined in PyF.Internal.PythonSyntax

Methods

lift :: Padding -> Q Exp

data Precision

Floating point precision

Constructors

PrecisionDefault

Precision Integer

Instances

Show Precision

Defined in PyF.Internal.PythonSyntax

Methods

showsPrec :: Int -> Precision -> ShowS

show :: Precision -> String

showList :: [Precision] -> ShowS

Lift Precision

Defined in PyF.Internal.PythonSyntax

Methods

lift :: Precision -> Q Exp

data TypeFormat

All formating type

Constructors

DefaultF Precision SignMode

Default, depends on the infered type of the expression

BinaryF AlternateForm SignMode

Binary, such as `0b0121`

CharacterF

Character, will convert an integer to its character representation

DecimalF SignMode

Decimal, base 10 integer formatting

ExponentialF Precision AlternateForm SignMode

Exponential notation for floatting points

ExponentialCapsF Precision AlternateForm SignMode

Exponential notation with capitalised e

FixedF Precision AlternateForm SignMode

Fixed number of digits floating point

FixedCapsF Precision AlternateForm SignMode

Capitalized version of the previous

GeneralF Precision AlternateForm SignMode

General formatting: FixedF or ExponentialF depending on the number magnitude

GeneralCapsF Precision AlternateForm SignMode

Same as GeneralF but with upper case E and infinite / NaN

OctalF AlternateForm SignMode

Octal, such as 00245

StringF Precision

Simple string

HexF AlternateForm SignMode

Hexadecimal, such as 0xaf3e

HexCapsF AlternateForm SignMode

Hexadecimal with capitalized letters, such as 0XAF3E

PercentF Precision AlternateForm SignMode

Percent representation

Instances

Show TypeFormat

Defined in PyF.Internal.PythonSyntax

Methods

showsPrec :: Int -> TypeFormat -> ShowS

show :: TypeFormat -> String

showList :: [TypeFormat] -> ShowS

data AlternateForm

If the formatter use its alternate form

Constructors

AlternateForm

NormalForm

Instances

Show AlternateForm

Defined in PyF.Internal.PythonSyntax

Methods

showsPrec :: Int -> AlternateForm -> ShowS

show :: AlternateForm -> String

showList :: [AlternateForm] -> ShowS

pattern DefaultFormatMode :: FormatMode

Default formating mode, no padding, default precision, no grouping, no sign handling