Project

General

Profile

1 1388 aaronmk
# CSV I/O
2
3
import csv
4
import StringIO
5
6 1623 aaronmk
import strings
7 1444 aaronmk
import util
8
9 1623 aaronmk
delims = ',\t`'
10
tsv_delim = '\t'
11
escape = '\\'
12 1442 aaronmk
13 1623 aaronmk
ending_placeholder = r'\n'
14
15
def is_tsv(dialect): return dialect.delimiter == tsv_delim
16
17 1621 aaronmk
def sniff(line):
18
    '''Automatically detects the dialect'''
19 1623 aaronmk
    dialect = csv.Sniffer().sniff(line, delims)
20 1621 aaronmk
    # TSVs usually don't quote fields (nor doublequote embedded quotes)
21 1623 aaronmk
    if is_tsv(dialect): dialect.quoting = csv.QUOTE_NONE
22 1621 aaronmk
    else: dialect.doublequote = True # Sniffer doesn't turn this on by default
23
    return dialect
24
25 1923 aaronmk
def stream_info(stream, parse_header=False):
26 1444 aaronmk
    '''Automatically detects the dialect based on the header line
27 1923 aaronmk
    @return NamedTuple {header_line, header, dialect}'''
28 1444 aaronmk
    info = util.NamedTuple()
29
    info.header_line = stream.readline()
30 1923 aaronmk
    info.header = None
31
    if info.header_line != '':
32
        info.dialect = sniff(info.header_line)
33
        if parse_header:
34
            info.header = reader_class(info.dialect)(
35
                StringIO.StringIO(info.header_line), info.dialect).next()
36 1660 aaronmk
    else: info.dialect = None # line of '' indicates EOF = empty stream
37 1444 aaronmk
    return info
38
39 1623 aaronmk
class TsvReader:
40
    '''Unlike csv.reader, for TSVs, interprets \ as escaping a line ending but
41
    ignores it before everything else (e.g. \N for NULL). Also interprets the
42
    '\n' escape sequence as a newline.'''
43
    def __init__(self, stream, dialect):
44
        assert is_tsv(dialect)
45
        self.stream = stream
46
        self.dialect = dialect
47
48
    def __iter__(self): return self
49
50
    def next(self):
51
        record = ''
52
        ending = None
53
        while True:
54
            line = self.stream.readline()
55
            if line == '': raise StopIteration
56
57
            raw_contents, ending = strings.extract_line_ending(line)
58
            contents = strings.remove_suffix(escape, raw_contents)
59
            record += contents
60
            if len(contents) == len(raw_contents): break # no line continuation
61
            record += ending_placeholder
62
        row = csv.reader(StringIO.StringIO(record), self.dialect).next()
63
        return [v.replace(ending_placeholder, '\n') for v in row]
64
65
def reader_class(dialect):
66
    if is_tsv(dialect): return TsvReader
67
    else: return csv.reader
68
69
def make_reader(stream, dialect): return reader_class(dialect)(stream, dialect)
70
71 1388 aaronmk
def reader_and_header(stream):
72
    '''Automatically detects the dialect based on the header line
73
    @return tuple (reader, header)'''
74 1923 aaronmk
    info = stream_info(stream, parse_header=True)
75
    return (reader_class(info.dialect)(stream, info.dialect), info.header)
76 1446 aaronmk
77
##### csv modifications
78
79
# Note that these methods only work on *instances* of Dialect classes
80
csv.Dialect.__eq__ = lambda self, other: self.__dict__ == other.__dict__
81
csv.Dialect.__ne__ = lambda self, other: not (self == other)