Language.Python.Syntax.Strings

Python string literals.

See https://docs.python.org/3.5/reference/lexical_analysis.html#string-and-bytes-literals

Datatypes

Characters

data PyChar

A character in a string literal. This is a large sum type, with a catch-all of a Haskell Char.

Constructors

Char_newline

\newline

Char_octal1 OctDigit

\1

Char_octal2 OctDigit OctDigit

\12

Char_octal3 OctDigit OctDigit OctDigit

\123

Char_hex HeXDigit HeXDigit

\xFb

Char_uni16 HeXDigit HeXDigit HeXDigit HeXDigit

\u12aD

Char_uni32 HeXDigit HeXDigit HeXDigit HeXDigit HeXDigit HeXDigit HeXDigit HeXDigit

\Udeadbeef

Char_esc_bslash

\\

Char_esc_singlequote

\'

Char_esc_doublequote

\"

Char_esc_a

\a

Char_esc_b

\b

Char_esc_f

\f

Char_esc_n

\n

Char_esc_r

\r

Char_esc_t

\t

Char_esc_v

\v

Char_lit Char

Any character

Instances

Eq PyChar

Defined in Language.Python.Syntax.Strings

Methods

(==) :: PyChar -> PyChar -> Bool

(/=) :: PyChar -> PyChar -> Bool

Ord PyChar

Defined in Language.Python.Syntax.Strings

Methods

compare :: PyChar -> PyChar -> Ordering

(<) :: PyChar -> PyChar -> Bool

(<=) :: PyChar -> PyChar -> Bool

(>) :: PyChar -> PyChar -> Bool

(>=) :: PyChar -> PyChar -> Bool

max :: PyChar -> PyChar -> PyChar

min :: PyChar -> PyChar -> PyChar

Show PyChar

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> PyChar -> ShowS

show :: PyChar -> String

showList :: [PyChar] -> ShowS

fromHaskellString :: String -> [PyChar]

Convert a Haskell string to a list of PyChar. This is useful when writing Python in Haskell.

String information

data QuoteType

Double or single quotation marks?

"Double quotes"
"""Double quotes"""
'Single quotes'
'''Single quotes'''

Constructors

SingleQuote

DoubleQuote

Instances

Eq QuoteType

Defined in Language.Python.Syntax.Strings

Methods

(==) :: QuoteType -> QuoteType -> Bool

(/=) :: QuoteType -> QuoteType -> Bool

Ord QuoteType

Defined in Language.Python.Syntax.Strings

Methods

compare :: QuoteType -> QuoteType -> Ordering

(<) :: QuoteType -> QuoteType -> Bool

(<=) :: QuoteType -> QuoteType -> Bool

(>) :: QuoteType -> QuoteType -> Bool

(>=) :: QuoteType -> QuoteType -> Bool

max :: QuoteType -> QuoteType -> QuoteType

min :: QuoteType -> QuoteType -> QuoteType

Show QuoteType

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> QuoteType -> ShowS

show :: QuoteType -> String

showList :: [QuoteType] -> ShowS

data StringType

Three pairs of quotations or one?

"""Long string"""
'''Also long string'''
"Short string"
'Also short string'

Constructors

ShortString

LongString

Instances

Eq StringType

Defined in Language.Python.Syntax.Strings

Methods

(==) :: StringType -> StringType -> Bool

(/=) :: StringType -> StringType -> Bool

Ord StringType

Defined in Language.Python.Syntax.Strings

Methods

compare :: StringType -> StringType -> Ordering

(<) :: StringType -> StringType -> Bool

(<=) :: StringType -> StringType -> Bool

(>) :: StringType -> StringType -> Bool

(>=) :: StringType -> StringType -> Bool

max :: StringType -> StringType -> StringType

min :: StringType -> StringType -> StringType

Show StringType

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> StringType -> ShowS

show :: StringType -> String

showList :: [StringType] -> ShowS

String prefixes

data StringPrefix

In Python 3.5, a prefix of u or U is allowed, but doesn't have any meaning. They exist for backwards compatibility with Python 2.

See https://www.python.org/dev/peps/pep-0414/

Constructors

Prefix_u

Prefix_U

Instances

Eq StringPrefix

Defined in Language.Python.Syntax.Strings

Methods

(==) :: StringPrefix -> StringPrefix -> Bool

(/=) :: StringPrefix -> StringPrefix -> Bool

Ord StringPrefix

Defined in Language.Python.Syntax.Strings

Methods

compare :: StringPrefix -> StringPrefix -> Ordering

(<) :: StringPrefix -> StringPrefix -> Bool

(<=) :: StringPrefix -> StringPrefix -> Bool

(>) :: StringPrefix -> StringPrefix -> Bool

(>=) :: StringPrefix -> StringPrefix -> Bool

max :: StringPrefix -> StringPrefix -> StringPrefix

min :: StringPrefix -> StringPrefix -> StringPrefix

Show StringPrefix

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> StringPrefix -> ShowS

show :: StringPrefix -> String

showList :: [StringPrefix] -> ShowS

data RawStringPrefix

Raw strings are prefixed with either r or R.

Constructors

Prefix_r

Prefix_R

Instances

Eq RawStringPrefix

Defined in Language.Python.Syntax.Strings

Methods

(==) :: RawStringPrefix -> RawStringPrefix -> Bool

(/=) :: RawStringPrefix -> RawStringPrefix -> Bool

Ord RawStringPrefix

Defined in Language.Python.Syntax.Strings

Methods

compare :: RawStringPrefix -> RawStringPrefix -> Ordering

(<) :: RawStringPrefix -> RawStringPrefix -> Bool

(<=) :: RawStringPrefix -> RawStringPrefix -> Bool

(>) :: RawStringPrefix -> RawStringPrefix -> Bool

(>=) :: RawStringPrefix -> RawStringPrefix -> Bool

max :: RawStringPrefix -> RawStringPrefix -> RawStringPrefix

min :: RawStringPrefix -> RawStringPrefix -> RawStringPrefix

Show RawStringPrefix

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> RawStringPrefix -> ShowS

show :: RawStringPrefix -> String

showList :: [RawStringPrefix] -> ShowS

data BytesPrefix

This prefix indicates it's a bytes literal rather than a string literal.

Constructors

Prefix_b

Prefix_B

Instances

Eq BytesPrefix

Defined in Language.Python.Syntax.Strings

Methods

(==) :: BytesPrefix -> BytesPrefix -> Bool

(/=) :: BytesPrefix -> BytesPrefix -> Bool

Ord BytesPrefix

Defined in Language.Python.Syntax.Strings

Methods

compare :: BytesPrefix -> BytesPrefix -> Ordering

(<) :: BytesPrefix -> BytesPrefix -> Bool

(<=) :: BytesPrefix -> BytesPrefix -> Bool

(>) :: BytesPrefix -> BytesPrefix -> Bool

(>=) :: BytesPrefix -> BytesPrefix -> Bool

max :: BytesPrefix -> BytesPrefix -> BytesPrefix

min :: BytesPrefix -> BytesPrefix -> BytesPrefix

Show BytesPrefix

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> BytesPrefix -> ShowS

show :: BytesPrefix -> String

showList :: [BytesPrefix] -> ShowS

data RawBytesPrefix

A string of raw bytes can be indicated by a number of prefixes

Constructors

Prefix_br

Prefix_Br

Prefix_bR

Prefix_BR

Prefix_rb

Prefix_rB

Prefix_Rb

Prefix_RB

Instances

Eq RawBytesPrefix

Defined in Language.Python.Syntax.Strings

Methods

(==) :: RawBytesPrefix -> RawBytesPrefix -> Bool

(/=) :: RawBytesPrefix -> RawBytesPrefix -> Bool

Ord RawBytesPrefix

Defined in Language.Python.Syntax.Strings

Methods

compare :: RawBytesPrefix -> RawBytesPrefix -> Ordering

(<) :: RawBytesPrefix -> RawBytesPrefix -> Bool

(<=) :: RawBytesPrefix -> RawBytesPrefix -> Bool

(>) :: RawBytesPrefix -> RawBytesPrefix -> Bool

(>=) :: RawBytesPrefix -> RawBytesPrefix -> Bool

max :: RawBytesPrefix -> RawBytesPrefix -> RawBytesPrefix

min :: RawBytesPrefix -> RawBytesPrefix -> RawBytesPrefix

Show RawBytesPrefix

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> RawBytesPrefix -> ShowS

show :: RawBytesPrefix -> String

showList :: [RawBytesPrefix] -> ShowS

hasPrefix :: StringLiteral a -> Bool

Most types of StringLiteral have prefixes. Plain old strings may have an optional prefix, but it is meaningless.

String literals

data StringLiteral a

A StringLiteral, complete with a prefix, information about quote type and number, and a list of PyChars.

Like many other data types in hpython, it has an annotation and trailing whitespace.

Constructors

RawStringLiteral

Fields

• _stringLiteralAnn :: a
• _unsafeRawStringLiteralPrefix :: RawStringPrefix
• _stringLiteralStringType :: StringType
• _stringLiteralQuoteType :: QuoteType
• _stringLiteralValue :: [PyChar]
• _stringLiteralWhitespace :: [Whitespace]

StringLiteral

Fields

• _stringLiteralAnn :: a
• _unsafeStringLiteralPrefix :: Maybe StringPrefix
• _stringLiteralStringType :: StringType
• _stringLiteralQuoteType :: QuoteType
• _stringLiteralValue :: [PyChar]
• _stringLiteralWhitespace :: [Whitespace]

RawBytesLiteral

Fields

• _stringLiteralAnn :: a
• _unsafeRawBytesLiteralPrefix :: RawBytesPrefix
• _stringLiteralStringType :: StringType
• _stringLiteralQuoteType :: QuoteType
• _stringLiteralValue :: [PyChar]
• _stringLiteralWhitespace :: [Whitespace]

BytesLiteral

Fields

• _stringLiteralAnn :: a
• _unsafeBytesLiteralPrefix :: BytesPrefix
• _stringLiteralStringType :: StringType
• _stringLiteralQuoteType :: QuoteType
• _stringLiteralValue :: [PyChar]
• _stringLiteralWhitespace :: [Whitespace]

Instances

Functor StringLiteral

Defined in Language.Python.Syntax.Strings

Methods

fmap :: (a -> b) -> StringLiteral a -> StringLiteral b

(<$) :: a -> StringLiteral b -> StringLiteral a

Foldable StringLiteral

Defined in Language.Python.Syntax.Strings

Methods

fold :: Monoid m => StringLiteral m -> m

foldMap :: Monoid m => (a -> m) -> StringLiteral a -> m

foldr :: (a -> b -> b) -> b -> StringLiteral a -> b

foldr' :: (a -> b -> b) -> b -> StringLiteral a -> b

foldl :: (b -> a -> b) -> b -> StringLiteral a -> b

foldl' :: (b -> a -> b) -> b -> StringLiteral a -> b

foldr1 :: (a -> a -> a) -> StringLiteral a -> a

foldl1 :: (a -> a -> a) -> StringLiteral a -> a

toList :: StringLiteral a -> [a]

null :: StringLiteral a -> Bool

length :: StringLiteral a -> Int

elem :: Eq a => a -> StringLiteral a -> Bool

maximum :: Ord a => StringLiteral a -> a

minimum :: Ord a => StringLiteral a -> a

sum :: Num a => StringLiteral a -> a

product :: Num a => StringLiteral a -> a

Traversable StringLiteral

Defined in Language.Python.Syntax.Strings

Methods

traverse :: Applicative f => (a -> f b) -> StringLiteral a -> f (StringLiteral b)

sequenceA :: Applicative f => StringLiteral (f a) -> f (StringLiteral a)

mapM :: Monad m => (a -> m b) -> StringLiteral a -> m (StringLiteral b)

sequence :: Monad m => StringLiteral (m a) -> m (StringLiteral a)

Eq a => Eq (StringLiteral a)

Defined in Language.Python.Syntax.Strings

Methods

(==) :: StringLiteral a -> StringLiteral a -> Bool

(/=) :: StringLiteral a -> StringLiteral a -> Bool

Ord a => Ord (StringLiteral a)

Defined in Language.Python.Syntax.Strings

Methods

compare :: StringLiteral a -> StringLiteral a -> Ordering

(<) :: StringLiteral a -> StringLiteral a -> Bool

(<=) :: StringLiteral a -> StringLiteral a -> Bool

(>) :: StringLiteral a -> StringLiteral a -> Bool

(>=) :: StringLiteral a -> StringLiteral a -> Bool

max :: StringLiteral a -> StringLiteral a -> StringLiteral a

min :: StringLiteral a -> StringLiteral a -> StringLiteral a

Show a => Show (StringLiteral a)

Defined in Language.Python.Syntax.Strings

Methods

showsPrec :: Int -> StringLiteral a -> ShowS

show :: StringLiteral a -> String

showList :: [StringLiteral a] -> ShowS

HasTrailingWhitespace (StringLiteral a)

Defined in Language.Python.Syntax.Strings

Methods

trailingWhitespace :: Lens' (StringLiteral a) [Whitespace]

HasNewlines (StringLiteral a)

Defined in Language.Python.Optics.Newlines

Methods

_Newlines :: Traversal' (StringLiteral a) Newline

Lenses

stringLiteralStringType :: forall a. Lens' (StringLiteral a) StringType

stringLiteralQuoteType :: forall a. Lens' (StringLiteral a) QuoteType

stringLiteralValue :: forall a. Lens' (StringLiteral a) [PyChar]

stringLiteralWhitespace :: forall a. Lens' (StringLiteral a) [Whitespace]

Rendering

showQuoteType :: QuoteType -> Char

showStringPrefix :: StringPrefix -> Text

showRawStringPrefix :: RawStringPrefix -> Text

showBytesPrefix :: BytesPrefix -> Text

showRawBytesPrefix :: RawBytesPrefix -> Text

Extra functions

isEscape :: PyChar -> Bool

Determine whether a PyChar is an escape character or not.