| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Frames.CSV
Description
Infer row types from comma-separated values (CSV) data and read that data from files. Template Haskell is used to generate the necessary types so that you can write type safe programs referring to those types.
Synopsis
- type Separator = Text
- type QuoteChar = Char
- data QuotingMode
- data ParserOptions = ParserOptions {}
- defaultParser :: ParserOptions
- defaultSep :: Separator
- tokenizeRow :: ParserOptions -> Text -> [Text]
- reassembleRFC4180QuotedParts :: Separator -> QuoteChar -> [Text] -> [Text]
- prefixInference :: (ColumnTypeable a, Semigroup a, Monad m, Show a) => Parser [Text] m [a]
- readColHeaders :: (ColumnTypeable a, Semigroup a, Monad m, Show a) => ParserOptions -> Producer [Text] m () -> m [(Text, a)]
- class ReadRec rs where
- pipeLines :: MonadSafe m => (Handle -> IO (Either IOException Text)) -> FilePath -> Producer Text m ()
- produceTextLines :: MonadSafe m => FilePath -> Producer Text m ()
- produceTokens :: MonadSafe m => FilePath -> Separator -> Producer [Text] m ()
- consumeTextLines :: MonadSafe m => FilePath -> Consumer Text m r
- readFileLatin1Ln :: MonadSafe m => FilePath -> Producer [Text] m ()
- readRow :: ReadRec rs => ParserOptions -> Text -> Rec (Either Text :. ElField) rs
- readTableMaybeOpt :: (MonadSafe m, ReadRec rs, RMap rs) => ParserOptions -> FilePath -> Producer (Rec (Maybe :. ElField) rs) m ()
- pipeTableMaybeOpt :: (Monad m, ReadRec rs, RMap rs) => ParserOptions -> Pipe [Text] (Rec (Maybe :. ElField) rs) m ()
- pipeTableEitherOpt :: (Monad m, ReadRec rs) => ParserOptions -> Pipe Text (Rec (Either Text :. ElField) rs) m ()
- readTableMaybe :: (MonadSafe m, ReadRec rs, RMap rs) => FilePath -> Producer (Rec (Maybe :. ElField) rs) m ()
- pipeTableMaybe :: (Monad m, ReadRec rs, RMap rs) => Pipe [Text] (Rec (Maybe :. ElField) rs) m ()
- pipeTableEither :: (Monad m, ReadRec rs) => Pipe Text (Rec (Either Text :. ElField) rs) m ()
- readTableOpt :: (MonadSafe m, ReadRec rs, RMap rs) => ParserOptions -> FilePath -> Producer (Record rs) m ()
- pipeTableOpt :: (ReadRec rs, RMap rs, Monad m) => ParserOptions -> Pipe [Text] (Record rs) m ()
- readTable :: (MonadSafe m, ReadRec rs, RMap rs) => FilePath -> Producer (Record rs) m ()
- readRecEither :: (ReadRec rs, RMap rs) => [Text] -> Either (Rec (Either Text :. ElField) rs) (Record rs)
- readTableDebug :: forall m rs. (MonadSafe m, ReadRec rs, RMap rs, RecMapMethod ShowCSV (Either Text :. ElField) rs, RecordToList rs) => FilePath -> Producer (Record rs) m ()
- pipeTable :: (ReadRec rs, RMap rs, Monad m) => Pipe [Text] (Record rs) m ()
- showFieldsCSV :: (RecMapMethod ShowCSV ElField ts, RecordToList ts) => Record ts -> [Text]
- produceCSV :: forall f ts m. (ColumnHeaders ts, Foldable f, Monad m, RecordToList ts, RecMapMethod ShowCSV ElField ts) => f (Record ts) -> Producer String m ()
- produceDSV :: forall f ts m. (ColumnHeaders ts, Foldable f, Monad m, RecordToList ts, RecMapMethod ShowCSV ElField ts) => ParserOptions -> f (Record ts) -> Producer String m ()
- pipeToCSV :: forall ts m. (Monad m, ColumnHeaders ts, RecordToList ts, RecMapMethod ShowCSV ElField ts) => Pipe (Record ts) Text m ()
- writeCSV :: (ColumnHeaders ts, Foldable f, RecordToList ts, RecMapMethod ShowCSV ElField ts) => FilePath -> f (Record ts) -> IO ()
- writeDSV :: (ColumnHeaders ts, Foldable f, RecordToList ts, RecMapMethod ShowCSV ElField ts) => ParserOptions -> FilePath -> f (Record ts) -> IO ()
Parsing
data QuotingMode Source #
Constructors
| NoQuoting | No quoting enabled. The separator may not appear in values |
| RFC4180Quoting QuoteChar | Quoted values with the given quoting character. Quotes are escaped by doubling them. Mostly RFC4180 compliant, except doesn't support newlines in values |
Instances
| Show QuotingMode Source # | |
Defined in Frames.CSV Methods showsPrec :: Int -> QuotingMode -> ShowS # show :: QuotingMode -> String # showList :: [QuotingMode] -> ShowS # | |
| Eq QuotingMode Source # | |
Defined in Frames.CSV | |
| Lift QuotingMode Source # | |
Defined in Frames.CSV Methods lift :: Quote m => QuotingMode -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => QuotingMode -> Code m QuotingMode # | |
data ParserOptions Source #
Constructors
| ParserOptions | |
Fields | |
Instances
| Show ParserOptions Source # | |
Defined in Frames.CSV Methods showsPrec :: Int -> ParserOptions -> ShowS # show :: ParserOptions -> String # showList :: [ParserOptions] -> ShowS # | |
| Eq ParserOptions Source # | |
Defined in Frames.CSV Methods (==) :: ParserOptions -> ParserOptions -> Bool # (/=) :: ParserOptions -> ParserOptions -> Bool # | |
| Lift ParserOptions Source # | |
Defined in Frames.CSV Methods lift :: Quote m => ParserOptions -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ParserOptions -> Code m ParserOptions # | |
defaultParser :: ParserOptions Source #
Default ParseOptions get column names from a header line, and
use commas to separate columns.
defaultSep :: Separator Source #
Default separator string.
tokenizeRow :: ParserOptions -> Text -> [Text] Source #
Helper to split a Text on commas and strip leading and
trailing whitespace from each resulting chunk.
reassembleRFC4180QuotedParts :: Separator -> QuoteChar -> [Text] -> [Text] Source #
Post processing applied to a list of tokens split by the separator which should have quoted sections reassembled
prefixInference :: (ColumnTypeable a, Semigroup a, Monad m, Show a) => Parser [Text] m [a] Source #
Infer column types from a prefix (up to 1000 lines) of a CSV file.
readColHeaders :: (ColumnTypeable a, Semigroup a, Monad m, Show a) => ParserOptions -> Producer [Text] m () -> m [(Text, a)] Source #
Extract column names and inferred types from a CSV file.
Loading CSV Data
class ReadRec rs where Source #
Parsing each component of a RecF from a list of text chunks,
one chunk per record component.
pipeLines :: MonadSafe m => (Handle -> IO (Either IOException Text)) -> FilePath -> Producer Text m () Source #
produceTokens :: MonadSafe m => FilePath -> Separator -> Producer [Text] m () Source #
Produce lines of tokens that were separated by the given separator.
consumeTextLines :: MonadSafe m => FilePath -> Consumer Text m r Source #
Consume lines of Text, writing them to a file.
readFileLatin1Ln :: MonadSafe m => FilePath -> Producer [Text] m () Source #
Produce the lines of a latin1 (or ISO8859 Part 1) encoded file as ’T.Text’ values.
readRow :: ReadRec rs => ParserOptions -> Text -> Rec (Either Text :. ElField) rs Source #
Read a RecF from one line of CSV.
readTableMaybeOpt :: (MonadSafe m, ReadRec rs, RMap rs) => ParserOptions -> FilePath -> Producer (Rec (Maybe :. ElField) rs) m () Source #
Produce rows where any given entry can fail to parse.
pipeTableMaybeOpt :: (Monad m, ReadRec rs, RMap rs) => ParserOptions -> Pipe [Text] (Rec (Maybe :. ElField) rs) m () Source #
Stream lines of CSV data into rows of ’Rec’ values values where any given entry can fail to parse.
pipeTableEitherOpt :: (Monad m, ReadRec rs) => ParserOptions -> Pipe Text (Rec (Either Text :. ElField) rs) m () Source #
Stream lines of CSV data into rows of ’Rec’ values values where
any given entry can fail to parse. In the case of a parse failure, the
raw Text of that entry is retained.
readTableMaybe :: (MonadSafe m, ReadRec rs, RMap rs) => FilePath -> Producer (Rec (Maybe :. ElField) rs) m () Source #
Produce rows where any given entry can fail to parse.
pipeTableMaybe :: (Monad m, ReadRec rs, RMap rs) => Pipe [Text] (Rec (Maybe :. ElField) rs) m () Source #
Stream lines of CSV data into rows of ’Rec’ values where any given entry can fail to parse.
pipeTableEither :: (Monad m, ReadRec rs) => Pipe Text (Rec (Either Text :. ElField) rs) m () Source #
Stream lines of CSV data into rows of ’Rec’ values where any
given entry can fail to parse. In the case of a parse failure, the
raw Text of that entry is retained.
readTableOpt :: (MonadSafe m, ReadRec rs, RMap rs) => ParserOptions -> FilePath -> Producer (Record rs) m () Source #
Returns a producer of rows for which each column was successfully parsed.
pipeTableOpt :: (ReadRec rs, RMap rs, Monad m) => ParserOptions -> Pipe [Text] (Record rs) m () Source #
Pipe lines of CSV text into rows for which each column was successfully parsed.
readTable :: (MonadSafe m, ReadRec rs, RMap rs) => FilePath -> Producer (Record rs) m () Source #
Returns a producer of rows for which each column was successfully parsed.
readRecEither :: (ReadRec rs, RMap rs) => [Text] -> Either (Rec (Either Text :. ElField) rs) (Record rs) Source #
readTableDebug :: forall m rs. (MonadSafe m, ReadRec rs, RMap rs, RecMapMethod ShowCSV (Either Text :. ElField) rs, RecordToList rs) => FilePath -> Producer (Record rs) m () Source #
Similar to readTable except that rows that fail to parse are
printed to stderr with columns that failed to parse printed as
"Left rawtext" while those that were successfully parsed are
shown as "Right text".
pipeTable :: (ReadRec rs, RMap rs, Monad m) => Pipe [Text] (Record rs) m () Source #
Pipe lines of CSV text into rows for which each column was successfully parsed.
Writing CSV Data
showFieldsCSV :: (RecMapMethod ShowCSV ElField ts, RecordToList ts) => Record ts -> [Text] Source #
produceCSV :: forall f ts m. (ColumnHeaders ts, Foldable f, Monad m, RecordToList ts, RecMapMethod ShowCSV ElField ts) => f (Record ts) -> Producer String m () Source #
produceDSV :: forall f ts m. (ColumnHeaders ts, Foldable f, Monad m, RecordToList ts, RecMapMethod ShowCSV ElField ts) => ParserOptions -> f (Record ts) -> Producer String m () Source #
pipeToCSV :: forall ts m. (Monad m, ColumnHeaders ts, RecordToList ts, RecMapMethod ShowCSV ElField ts) => Pipe (Record ts) Text m () Source #
yield a header row with column names followed by a line of
text for each Record with each field separated by a comma. This
is the same as produceCSV, but adapted for cases where you have
streaming input that you wish to use to produce streaming output.
writeCSV :: (ColumnHeaders ts, Foldable f, RecordToList ts, RecMapMethod ShowCSV ElField ts) => FilePath -> f (Record ts) -> IO () Source #
Write a header row with column names followed by a line of text
for each Record to the given file.
writeDSV :: (ColumnHeaders ts, Foldable f, RecordToList ts, RecMapMethod ShowCSV ElField ts) => ParserOptions -> FilePath -> f (Record ts) -> IO () Source #
Write a header row with column names followed by a line of text
for each Record to the given file.