Skip to content

BUG: Fix default encoding for CSVFormatter.save #17821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 11, 2017
Merged

BUG: Fix default encoding for CSVFormatter.save #17821

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cfb5e16
BUG: Fix default encoding for CSVFormatter.save
Licht-T Oct 9, 2017
a632835
TST: Add to_csv defualt encoding test
Licht-T Oct 9, 2017
0cd7bf7
DOC: Add comments on to_csv defualt encoding test
Licht-T Oct 9, 2017
08df290
DOC: added release note
TomAugspurger Oct 10, 2017
039f2cf
DOC: Add the fixing to_csv default encoding to whatsnew note
Licht-T Oct 11, 2017
c222ee8
Revert "DOC: Add the fixing to_csv default encoding to whatsnew note"
Licht-T Oct 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions pandas/io/formats/format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1573,12 +1573,20 @@ def __init__(self, obj, path_or_buf=None, sep=",", na_rep='',

def save(self):
# create the writer & save
if self.encoding is None:
if compat.PY2:
encoding = 'ascii'
else:
encoding = 'utf-8'
else:
encoding = self.encoding
Copy link
Member

@jschendel jschendel Oct 9, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is overkill, but you can do encoding = self.encoding or ('ascii' if compat.PY2 else 'utf-8') to condense this whole block of if-else logic.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, matter of taste here. I prefer the block-logic because its easier to read I find.


if hasattr(self.path_or_buf, 'write'):
f = self.path_or_buf
close = False
else:
f, handles = _get_handle(self.path_or_buf, self.mode,
encoding=self.encoding,
encoding=encoding,
compression=self.compression)
close = True

Expand All @@ -1588,11 +1596,11 @@ def save(self):
doublequote=self.doublequote,
escapechar=self.escapechar,
quotechar=self.quotechar)
if self.encoding is not None:
writer_kwargs['encoding'] = self.encoding
self.writer = UnicodeWriter(f, **writer_kwargs)
else:
if encoding == 'ascii':
self.writer = csv.writer(f, **writer_kwargs)
else:
writer_kwargs['encoding'] = encoding
self.writer = UnicodeWriter(f, **writer_kwargs)

self._save()

Expand Down
17 changes: 17 additions & 0 deletions pandas/tests/io/formats/test_to_csv.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# -*- coding: utf-8 -*-

from pandas import DataFrame
import numpy as np
import pandas as pd
Expand All @@ -6,6 +8,21 @@

class TestToCSV(object):

def test_to_csv_defualt_encoding(self):
# GH17097
df = DataFrame({'col': [u"AAAAA", u"ÄÄÄÄÄ", u"ßßßßß", u"聞聞聞聞聞"]})

with tm.ensure_clean('test.csv') as path:
# the default to_csv encoding in Python 2 is ascii, and that in
# Python 3 is uft-8.
if pd.compat.PY2:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment about why we're raising an error and what should be done to avoid this error (i.e. the encoding argument parameter should be correct).

# the encoding argument parameter should be utf-8
with tm.assert_raises_regex(UnicodeEncodeError, 'ascii'):
df.to_csv(path)
else:
df.to_csv(path)
tm.assert_frame_equal(pd.read_csv(path, index_col=0), df)

def test_to_csv_quotechar(self):
df = DataFrame({'col': [1, 2]})
expected = """\
Expand Down