Skip to main content

Consistent interface for stream reading and writing tabular data (csv/xls/json/etc)

Project description

Travis
Coveralls
PyPi
SemVer
Gitter

Consistent interface for stream reading and writing tabular data (csv/xls/json/etc).

Features

  • supports various formats: csv/tsv/xls/xlsx/json/native/etc

  • reads data from variables, filesystem or Internet

  • streams data instead of using a lot of memory

  • processes data via simple user processors

  • saves data using the same interface

Getting Started

Installation

To get started:

$ pip install tabulator

Example

Open tabular stream from csv source:

from tabulator import Stream

with Stream('path.csv', headers=1) as stream:
    print(stream.headers) # will print headers from 1 row
    for row in stream:
        print(row)  # will print row values list

Stream

Stream takes the source argument:

<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. User can force Tabulator to use encoding of choice to open the table passing encoding argument.

In this example we use context manager to call stream.open() on enter and stream.close() when we exit:

  • stream can be iterated like file-like object returning row by row

  • stream can be used for manual iterating with iter(keyed/extended) function

  • stream can be read into memory using read(keyed/extended) function with row count limit

  • headers can be accessed via headers property

  • rows sample can be accessed via sample property

  • stream pointer can be set to start via reset method

  • stream could be saved to filesystem using save method

Below the more expanded example is presented:

from tabulator import Stream

def skip_even_rows(extended_rows):
    for number, headers, row in extended_rows:
        if number % 2:
            yield (number, headers, row)

stream = Stream('http://example.com/source.xls',
    headers=1, encoding='utf-8', sample_size=1000,
    post_parse=[skip_even_rows], parser_options={delimeter': ',', quotechar: '|'})
stream.open()
print(stream.sample)  # will print sample
print(stream.headers)  # will print headers list
print(stream.read(limit=10))  # will print 10 rows
stream.reset()
for keyed_row in stream.iter(keyed=True):
    print keyed_row  # will print row dict
for extended_row in stream.iter(extended=True):
    print extended_row  # will print (number, headers, row)
stream.reset()
stream.save('target.csv')
stream.close()

API Reference

Snapshot

Stream(source,
       headers=None,
       scheme=None,
       format=None,
       encoding=None,
       post_parse=None,
       sample_size=None,
       loader_options=None,
       parser_options=None)
    closed/open/close/reset
    headers -> list
    sample -> rows
    iter(keyed/extended=False) -> (generator) (keyed/extended)row[]
    read(keyed/extended=False, limit=None) -> (keyed/extended)row[]
    save(target, format=None, encoding=None, **writer_options)
exceptions
~cli

Detailed

Contributing

Please read the contribution guideline:

How to Contribute

Thanks!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tabulator-0.7.5.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

tabulator-0.7.5-py2.py3-none-any.whl (27.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file tabulator-0.7.5.tar.gz.

File metadata

  • Download URL: tabulator-0.7.5.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for tabulator-0.7.5.tar.gz
Algorithm Hash digest
SHA256 b3592c2e33913014d0ce3538842d91e82f47ec8412b6b764d954a33112da21cc
MD5 276ec7debddf259f7be378bdbbc81ee3
BLAKE2b-256 d7ff0bbd1743e441a6e9af547bfb06b281b2a46aee4b6ed56f2c5c7d7955d65d

See more details on using hashes here.

Provenance

File details

Details for the file tabulator-0.7.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for tabulator-0.7.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bddb05474ccd4ea68d26c03b0f677f651d5b944b94c69019a3e26dde58d8d3be
MD5 2b405f2aef627f5a8c8461dc12d19dd5
BLAKE2b-256 47813283e83622e03c1ccbf98d913bb88b9f95737d9c9ad97c1c5deb67cf7887

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page