dataclass-csv 0.1.5

Map CSV data into dataclasses

Dataclass CSV

Dataclass CSV makes working with CSV files easier and much better than working with Dicts. It uses Python's Dataclasses to store data of every row on the CSV file and also uses type annotations which enables proper type checking and validation.

Installation

pipenv install dataclass-csv

Getting started

First, add the necessary imports:

from dataclasses import dataclass

from dataclass_csv import DataclassReader

Assuming that we have a CSV file with the contents below:

firstname,email,age
Elsa,[e-mail], 11
Astor,[e-mail], 7
Edit,[e-mail], 3
Ella,[e-mail], 2

Let's create a dataclass that will represent a row in the CSV file above:

class User():
    firstname: str
    email: str
    age: int

The dataclass User has 3 properties, firstname and email is of type str and age is of type int.

To load and read the contents of the CSV file we do the same thing as if we would be using the DictReader from the csv module in the Python's standard library. After opening the file we create an instance of the DataclassReader passing two arguments. The first is the file and the second is the dataclass that we wish to use to represent the data of every row of the CSV file. Like so:

with open(filename) as users_csv:
    reader = DataclassReader(users_csv, User)
    for row in reader:
        print(row)

The DataclassReader internally uses the DictReader from the csv module to read the CSV file which means that you can pass the same arguments that you would pass to the DictReader. The complete argument list is shown below:

dataclass_csv.DataclassReader(f, cls, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)

If you run this code you should see an output like this:

User(firstname='Elsa', email='[e-mail]', age=11)
User(firstname='Astor', email='[e-mail]', age=7)
User(firstname='Edit', email='[e-mail]', age=3)
User(firstname='Ella', email='[e-mail]', age=2)

Error handling

One of the advantages of using the DataclassReader is that it makes it easy to detect when the type of data in the CSV file is not what your application's model is expecting. And, the DataclassReader shows errors that will help to identify the rows with problem in your CSV file.

For example, say we change the contents of the CSV file shown in the Getting started section and, modify the age of the user Astor, let's change it to a string value:

Astor, [e-mail], test

Remember that in the dataclass User the age property is annotated with int. If we run the code again an exception will be raised with the message below:

ValueError: The field age is of type <class 'int'> but received a value of type <class 'str'>

Default values

The DataclassReader also handles properties with default values. Let's modify the dataclass User and add a default value for the field email:

class User():
    firstname: str
    email: str = 'Not specified'
    age: int

And we modify the CSV file and remove the email for the user Astor:

Astor,, 7

If we run the code we should see the output below:

User(firstname='Elsa', email='[e-mail]', age=11)
User(firstname='Astor', email='Not specified', age=7)
User(firstname='Edit', email='[e-mail]', age=3)
User(firstname='Ella', email='[e-mail]', age=2)

Note that now the object for the user Astor have the default value Not specified assigned to the email property.

Mapping dataclass fields to columns

The mapping between a dataclass property and a column in the CSV file will be done automatically if the names match, however, there are situations that the name of the header for a column is different. We can easily tell the DataclassReader how the mapping should be done using the method map. Assuming that we have a CSV file with the contents below:

First Name,email,age
Elsa,[e-mail], 11

Note that now, the column is called First Name and not firstname

And we can use the method map, like so:

reader = DataclassReader(users_csv, User)
reader.map('First name').to('firstname')

Now the DataclassReader will know how to extract the data from the column First Name and add it to the to dataclass property firstname

Supported type annotation

At the moment the DataclassReader support int, str, float, complex and datetime. When defining a datetime property, it is necessary to use the dateformat decorator, for example:

from dataclasses import dataclass
from datetime import datetime

from dataclass_csv import DataclassReader, dateformat


@dataclass
@dateformat('%Y/%m/%d')
class User:
    name: str
    email: str
    birthday: datetime


if __name__ == '__main__':

    with open('users.csv') as f:
        reader = DataclassReader(f, User)
        for row in reader:
            print(row)

Assuming that the CSV file have the following contents:

name,email,birthday
Edit,[e-mail],2018/11/23

The output would look like this:

User(name='Edit', email='[e-mail]', birthday=datetime.datetime(2018, 11, 23, 0, 0))

Copyright and License

Copyright (c) 2018 Daniel Furtado. Code released under BSD 3-clause license

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2018-11-25)

• First release on PyPI.

0.1.1 (2018-11-25)

• Documentation fixes.

0.1.2 (2018-11-25)

• Documentation fixes.

0.1.3 (2018-11-26)

• Bug fixes
• Removed the requirement of setting the dataclass init to True

0.1.5 (2018-11-29)

• Support for parsing datetime values.
• Better handling when default values are set to None