tabulator 1.6.0

Installation

The package use semantic versioning. It means that major versions could include breaking changes. It’s highly recommended to specify tabulator version range if you use setup.py or requirements.txt file e.g. tabulator<2.0.

$ pip install tabulator # OR "sudo pip install tabulator"

Examples

It’s pretty simple to start with tabulator:

from tabulator import Stream

with Stream('path.csv', headers=1) as stream:
    stream.headers # [header1, header2, ..]
    for row in stream:
        row  # [value1, value2, ..]

There is an examples directory containing other code listings.

Stream

The Stream class represents a tabular stream. It takes the source argument in a form of source string or object:

<scheme>://path/to/file.<format>

and uses corresponding Loader and Parser to open and start to iterate over the tabular stream. Also user can pass scheme and format explicitly as constructor arguments. There are also alot other options described in sections below.

Let’s create a simple stream object to read csv file:

from tabulator import Stream

stream = Stream('data.csv')

This action just instantiate a stream instance. There is no actual IO interactions or source validity checks. We need to open the stream object.

stream.open()

This call will validate data source, open underlaying stream and read the data sample (if it’s not disabled). All possible exceptions will be raised on stream.open call not on constructor call.

After work with the stream is done it could be closed:

stream.close()

The Stream class supports Python context manager interface so calls above could be written using with syntax. It’s a common and recommended way to use tabulator stream:

with Stream('data.csv') as stream:
  # use stream

Now we could iterate over rows in our tabular data source. It’s important to understand that tabulator uses underlaying streams not loading it to memory (just one row at time). So the stream.iter() interface is the most effective way to use the stream:

for row in stream.iter():
  row # [value1, value2, ..]

But if you need all the data in one call you could use stream.read() function instead of stream.iter() function. But if you just run it after code snippet above the stream.read() call will return an empty list. That another important following of stream nature of tabulator - the Stream instance just iterates over an underlaying stream. The underlaying stream has internal pointer (for example as file-like object has). So after we’ve iterated over all rows in the first listing the pointer is set to the end of stream.

stream.read() # []

The recommended way is to iterate (or read) over stream just once (and save data to memory if needed). But there is a possibility to reset the steram pointer. For some sources it will not be effective (another HTTP request for remote source). But if you work with local file as a source for example it’s just a cheap file.seek() call:

stream.reset()
stream.read() # [[value1, value2, ..], ..]

The Stream class supports saving tabular data stream to the filesystem. Let’s reset stream again (dont’ forget about the pointer) and save it to the disk:

stream.reset()
stream.save('data-copy.csv')

The full session will be looking like this:

from tabulator import Stream

with Stream('data.csv') as stream:
  for row in stream.iter():
    row # [value1, value2, ..]
  stream.reset()
  stream.read() # [[value1, value2, ..], ..]
  stream.reset()
  stream.save('data-copy.csv')

It’s just a pretty basic Stream introduction. Please read the full documentation below and about Stream arguments in more detail in following sections. There are many other goodies like headers extraction, keyed output, post parse processors and many more!

Schemes

There is a list of all supported schemes.

stream = Stream('data.csv')
stream = Stream(pathlib.Path('data.csv'))

stream = Stream('http://example.com/data.csv')

stream = Stream(open('data.csv'))

stream = Stream('text://name,age\nJohn, 21\n', format='csv')

Formats

There is a list of all supported formats. Formats support read operation could be opened by Stream.open() and formats support write operation could be used in Stream.save().

stream = Stream('data.csv', delimiter=',')

stream = Stream('datapackage.json', resource=1)

stream = Stream('https://docs.google.com/spreadsheets/d/<id>?usp=sharing')
stream = Stream('https://docs.google.com/spreadsheets/d/<id>edit#gid=<gid>')

stream = Stream([['name', 'age'], ['John', 21], ['Alex', 33]])
stream = Stream([{'name': 'John', 'age': 21}, {'name': 'Alex', 'age': 33}])

stream = Stream('data.json', property='key1.key2')

stream = Stream('data.ndjson')

stream = Stream('data.ods', sheet=1)

stream = Stream('postgresql://name:pass@host:5432/database', table='data')

stream = Stream('data.tsv')

stream = Stream('data.xls', sheet=1)

Headers

By default Stream considers all data source rows as values:

with Stream([['name', 'age'], ['Alex', 21]]):
  stream.headers # None
  stream.read() # [['name', 'age'], ['Alex', 21]]

To alter this behaviour headers argument is supported by Stream constructor. This argument could be an integer - row number starting from 1 containing headers:

# Integer
with Stream([['name', 'age'], ['Alex', 21]], headers=1):
  stream.headers # ['name', 'age']
  stream.read() # [['Alex', 21]]

Or it could be a list of strings - user-defined headers:

with Stream([['Alex', 21]], headers=['name', 'age']):
  stream.headers # ['name', 'age']
  stream.read() # [['Alex', 21]]

If headers is a row number and data source is not keyed all rows before this row and this row will be removed from data stream (see first example).

Encoding

Stream constructor accepts encoding argument to ensure needed encoding will be used. As a value argument supported by python encoding name (e.g. ‘latin1’, ‘utf-8’, ..) could be used:

with Stream(source, encoding='latin1') as stream:
  stream.read()

By default an encoding will be detected automatically. If you experience a UnicodeDecodeError parsing your file, try setting this argument to ‘utf-8’.

Allow html

By default Stream will raise exceptions.FormatError on stream.open() call if html contents is detected. It’s not a tabular format and for example providing link to csv file inside html (e.g. GitHub page) is a common mistake.

But sometimes this default behaviour is not what is needed. For example you write custom parser which should support html contents. In this case allow_html option for Stream could be used:

with Stream(sorce_with_html, allow_html=True) as stream:
  stream.read() # no exception on open

Sample size

By default Stream will read some data on stream.open() call in advance. This data is provided as stream.sample. The size of this sample could be set in rows using sample_size argument of stream constructor:

with Stream(two_rows_source, sample_size=1) as stream:
  stream.sample # only first row
  stream.read() # first and second rows

Data sample could be really useful if you want to implement some initial data checks without moving stream pointer as stream.iter/read do. But if you don’t want any interactions with an actual source before first stream.iter/read call just disable data smapling with sample_size=0.

Bytes sample size

On initial reading stage tabulator should detect contents encoding. The argument bytes_sample_size customizes how many bytes will be read to detect encoding:

source = 'data/special/latin1.csv'
with Stream(source) as stream:
    stream.encoding # 'iso8859-2'
with Stream(source, sample_size=0, bytes_sample_size=10) as stream:
    stream.encoding # 'utf-8'

In this example our data file doesn’t include iso8859-2 characters in first 10 bytes. So we could see the difference in encoding detection. Note sample_size usage here - these two parameters are independent. Here we use sample_size=0 to prevent rows sample creation (will fail with bad encoding).

Force strings

Because tabulator support not only sources with string data representation as csv but also sources supporting different data types as json or inline there is a Stream option force_strings to stringify all data values on reading.

Here how stream works without forcing strings:

with Stream([['string', 1, datetime.time(17, 00)]]) as stream:
  stream.read() # [['string', 1, datetime.time(17, 00)]]

The same data source using force_strings option:

with Stream([['string', 1]], force_strings=True) as stream:
  stream.read() # [['string', '1', '17:00:00']]

For all temporal values stream will use ISO format. But if your data source doesn’t support temporal values (for instance json format) Stream just returns it as it is without converting to ISO format.

Force parse

Some data source could be partially mailformed for a parser. For example inline source could have good rows (lists or dicts) and bad rows (for example strings). By default stream.iter/read will raise exceptions.SourceError on the first bad row:

with Stream([[1], 'bad', [3]]) as stream:
  stream.read() # raise exceptions.SourceError

With force_parse option for Stream constructor this default behaviour could be changed. If it’s set to True non-parsable rows will be returned as empty rows:

with Stream([[1], 'bad', [3]]) as stream:
  stream.read() # [[1], [], [3]]

Skip rows

It’s a very common situation when your tabular data contains some rows you want to skip. It could be blank rows or commented rows. Stream constructors accepts skip_rows argument to make it possible. Value of this argument should be a list of integers and strings where:

• integer is a row number starting from 1

• string is a first row chars indicating that row is a comment

Let’s skip first, second and commented by ‘#’ symbol rows:

source = [['John', 1], ['Alex', 2], ['#Sam', 3], ['Mike', 4]]
with Stream(source, skip_rows=[1, 2, '#']) as stream
  stream.read() # [['Mike', 4]]

Post parse

Skipping rows is a very basic ETL (extrac-transform-load) feature. For more advanced data transormations there are post parse processors.

def skip_odd_rows(extended_rows):
    for row_number, headers, row in extended_rows:
        if not row_number % 2:
            yield (row_number, headers, row)

def multiply_on_two(extended_rows):
    for row_number, headers, row in extended_rows:
        yield (row_number, headers, list(map(lambda value: value * 2, row)))


with Stream([[1], [2], [3], [4]], post_parse=[skip_odd_rows, multiply_on_two]) as stream:
  stream.read() # [[4], [8]]

Post parse processor gets extended rows ([row_number, headers, row]) iterator and must yields updated extended rows back. This interface is very powerful because every processors have full control on iteration process could skip rows, catch exceptions etc.

Processors will be applied to source from left to right. For example in listing above multiply_on_two processor gets rows from skip_odd_rows processor.

Keyed and extended rows

Stream methods stream.iter/read() accept keyed and extended flags to vary data structure of output data row.

By default a stream returns every row as a list:

with Stream([['name', 'age'], ['Alex', 21]]) as stream:
  stream.read() # [['Alex', 21]]

With keyed=True a stream returns every row as a dict:

with Stream([['name', 'age'], ['Alex', 21]]) as stream:
  stream.read(keyed=True) # [{'name': 'Alex', 'age': 21}]

And with extended=True a stream returns every row as a tuple contining row number starting from 1, headers as a list and row as a list:

with Stream([['name', 'age'], ['Alex', 21]]) as stream:
  stream.read(extended=True) # (1, ['name', 'age'], ['Alex', 21])

Custom loaders

To create a custom loader Loader interface should be implemented and passed to Stream constructor as custom_loaders={'scheme': CustomLoader} argument.

For example let’s implement a custom loader:

from tabulator import Loader

class CustomLoader(Loader):
  options = []
  def __init__(self, bytes_sample_size, **options):
        pass
  def load(self, source, mode='t', encoding=None, allow_zip=False):
    # load logic

with Stream(source, custom_loaders={'custom': CustomLoader}) as stream:
  stream.read()

There are more examples in internal tabulator.loaders module.

Custom parsers

To create a custom parser Parser interface should be implemented and passed to Stream constructor as custom_parsers={'format': CustomParser} argument.

For example let’s implement a custom parser:

from tabulator import Parser

class CustomParser(Parser):
  options = []
  def __init__(self, loader, force_parse, **options):
    self.__loader = loader
  @property
  def closed(self):
    return False
  def open(self, source, encoding=None):
    # open logic
  def close(self):
    # close logic
  def reset(self):
    raise NotImplemenedError()
  @property
  def extended_rows():
    # extended rows logic

with Stream(source, custom_parsers={'custom': CustomParser}) as stream:
  stream.read()

There are more examples in internal tabulator.parsers module.

Custom writers

To create a custom writer Writer interface should be implemented and passed to Stream constructor as custom_writers={'format': CustomWriter} argument.

For example let’s implement a custom writer:

from tabulator import Writer

class CustomWriter(Writer):
  options = []
  def __init__(self, **options):
        pass
  def save(self, source, target, headers=None, encoding=None):
    # save logic

with Stream(source, custom_writers={'custom': CustomWriter}) as stream:
  stream.save(target)

There are more examples in internal tabulator.writers module.

Validate

For cases you don’t need open the source but want to know is it supported by tabulator or not you could use validate function. It also let you know what exactly is not supported raising correspondig exception class.

from tabulator import validate, exceptions

try:
  tabular = validate('data.csv')
except exceptions.TabulatorException:
  tabular = False

Exceptions

CLI

It’s a provisional API. If you use it as a part of other program please pin concrete goodtables version to your requirements file.

The library ships with a simple CLI to read tabular data:

$ tabulator data/table.csv
id, name
1, english
2, 中国人

Usage: cli.py [OPTIONS] SOURCE

Options:
  --headers INTEGER
  --scheme TEXT
  --format TEXT
  --encoding TEXT
  --limit INTEGER
  --help             Show this message and exit.

v1.6

New API added:

• Argument source for the Stream constructor now could be a pathlib.Path

v1.5

New API added:

• Argument bytes_sample_size for the Stream constructor

v1.4

Improved behaviour:

• updated encoding name to a canonical form

v1.3

New API added:

• stream.scheme

• stream.format

• stream.encoding

Promoted provisional API to stable API:

• Loader (custom loaders)

• Parser (custom parsers)

• Writer (custom writers)

• validate

v1.2

Improved behaviour:

• autodetect common csv delimiters

v1.1

New API added:

• added fill_merged_cells argument to xls/xlsx formats

v1.0

New API added:

• published Loader/Parser/Writer API

• added Stream argument force_strings

• added Stream argument force_parse

• added Stream argument custom_writers

Deprecated API removal:

• removed topen and Table - use Stream instead

• removed Stream arguments loader/parser_options - use **options instead

Provisional API changed:

• updated Loader/Parser/Writer API - please use an updated version

v0.15

Provisional API added:

• unofficial support for Stream arguments custom_loaders/parsers