You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Consider the attached two files. A reader and writer with the same dialect parameters (escapechar \ quotechar " doublequote False) read, then write a CSV cell that looks like "C\\". It's written "C\". The problem is, when doublequote=False, the escapechar isn't used to escape itself, and the writer writes something that in the same dialect would be understood differently (\" isn't \ then end of string, it's an escaped quotechar within the string).
I looked at this and tried to provide a patch + tests. Please review.
The bug is that a writer can use writerow on some input data but if a reader with the same dialect reads them back they are different from the input ones. This happens when the input data contains escapechar. Contrary to msg136881, this happens regardless whether doublequote is True or False.
The docs say "On reading, the escapechar removes any special meaning from the following character". Therefore, I understand that on writing, escapechar must always be escaped by itself. If that doesn't happen, when reading it back, escapechar alters the thing that follows it instead of counting as escapechar which is precisely what this bug is about.
Thanks for the patch. The tests look good at first glance. I can’t comment on the C code, I don’t know C. Hopefully someone will do it, otherwise if you don’t get feedback in say four weeks you can ask for a review on python-dev.
Apathymannequin commented on Aug 27, 2016
Apathymannequinmannequin
Mannequin
More actions
Hi,
I can confirm that this behavior still exists in my current python versions (3.5.2 & 2.7.11). I'm happy to take a look at the code, but considering I made this account specifically to comment on this issue I assume someone else will want to, as well.
If you want to make sure this is still broken, just use any of the docs' reader and writer examples, adding a trailing escape char to the end.
FWIW, though this is arguably fixing a bug, IMO this shouldn't be back-ported to 2.7 or 3.7, but only be in 3.8+, to avoid breaking backwards-compatibility.
That being said, it would be great to get this into 3.8.0!
AldrianObaja commented on Oct 22, 2019
AldrianObajamannequin
Mannequin
More actions
I think this issue needs to be escalated, as this is clearly a bug that makes it troublesome to use csv.reader and csv.writer with escapechar.
only quote those fields which contain special characters
such as delimiter, quotechar or any of the characters in lineterminator.
this seems incorrect because escapechar is not mentioned (but at the same time it says 'such as') and maybe better matching the name 'minimal' (or one might expect 'more' quoting as a better default).
Hey @taleinat@berkerpeksag -- So this change actually introduced a pretty annoying bug as the following code now fails with the need to escape, but no escapechar set error:
import csv
value = 'my\x00string'
with io.StringIO() as buf:
writer = csv.writer(buf)
writer.writerow([value])
This code correctly worked on Python 3.9.
The issue is this C code snipped added by the fix:
else if (c == dialect->escapechar) {
want_escape = 1;
}
When no escapechar is specified then dialect->escarechar is equal to 0 and thus matches the null character (0x00 above) in the string to be written. This results in the code trying to "escape the escape character" even tho no escape character was specified and thus, no escaping is required.
The only workaround is to always specify an escapechar but that is often not desirable.
Activity
ebreck commentedon May 25, 2011
Consider the attached two files. A reader and writer with the same dialect parameters (escapechar \ quotechar " doublequote False) read, then write a CSV cell that looks like "C\\". It's written "C\". The problem is, when doublequote=False, the escapechar isn't used to escape itself, and the writer writes something that in the same dialect would be understood differently (\" isn't \ then end of string, it's an escaped quotechar within the string).
Execute python err.py first.csv to see.
merwok commentedon May 26, 2011
Thanks for the report. It would be best if you could attach files as plain text instead of archives.
cataliniacob commentedon Jul 6, 2011
I looked at this and tried to provide a patch + tests. Please review.
The bug is that a writer can use writerow on some input data but if a reader with the same dialect reads them back they are different from the input ones. This happens when the input data contains escapechar. Contrary to msg136881, this happens regardless whether doublequote is True or False.
The docs say "On reading, the escapechar removes any special meaning from the following character". Therefore, I understand that on writing, escapechar must always be escaped by itself. If that doesn't happen, when reading it back, escapechar alters the thing that follows it instead of counting as escapechar which is precisely what this bug is about.
merwok commentedon Jul 7, 2011
Thanks for the patch. The tests look good at first glance. I can’t comment on the C code, I don’t know C. Hopefully someone will do it, otherwise if you don’t get feedback in say four weeks you can ask for a review on python-dev.
Apathymannequin commentedon Aug 27, 2016
Hi,
I can confirm that this behavior still exists in my current python versions (3.5.2 & 2.7.11). I'm happy to take a look at the code, but considering I made this account specifically to comment on this issue I assume someone else will want to, as well.
If you want to make sure this is still broken, just use any of the docs' reader and writer examples, adding a trailing escape char to the end.
smontanaro commentedon Aug 27, 2016
The patch looked okay to me, and when applied to the 2.7 source, the new tests pass muster.
I'm not going to pretend I know where this patch should be applied. That's for someone else to pronounce.
xflr6 commentedon Jan 11, 2018
Hi, is there something we can do to get this going? As the issue breaks round-trip, it currently requires work-arounds like this: https://github.com/cldf/csvw/blob/1324550266c821ef32d1e79c124191e93aefbfa8/csvw/dsv.py#L67-L71
avatarofhope2 commentedon Aug 14, 2019
I needed this patch for a project, so I compiled python with the patch applied, and tested my specific use case, and it worked. Thanks for the patch!
taleinat commentedon Sep 14, 2019
FWIW, though this is arguably fixing a bug, IMO this shouldn't be back-ported to 2.7 or 3.7, but only be in 3.8+, to avoid breaking backwards-compatibility.
That being said, it would be great to get this into 3.8.0!
AldrianObaja commentedon Oct 22, 2019
I think this issue needs to be escalated, as this is clearly a bug that makes it troublesome to use csv.reader and csv.writer with escapechar.
taleinat commentedon Sep 20, 2020
New changeset 5c0eed7 by Berker Peksag in branch 'master':
bpo-12178: Fix escaping of escapechar in csv.writer() (GH-13710)
5c0eed7
taleinat commentedon Sep 20, 2020
After a great deal of delay, a fix for this has finally been merged, and will be available in Python 3.10.
Thanks to everyone involved!
xflr6 commentedon Jul 13, 2021
Thanks Tal.
AFAICT there was an undocumented change in behaviour related to this fix.
Python 3.9 quotes values with escapechar:
Btw, from
https://docs.python.org/3/library/csv.html#csv.QUOTE_MINIMAL
this seems incorrect because escapechar is not mentioned (but at the same time it says 'such as') and maybe better matching the name 'minimal' (or one might expect 'more' quoting as a better default).
Python 3.10:
cpython/Lib/test/test_csv.py
Lines 207 to 208 in 5c0eed7
See also https://github.com/xflr6/csv23/actions/runs/1027687524
eshmu commentedon Sep 23, 2022
Hey @taleinat @berkerpeksag -- So this change actually introduced a pretty annoying bug as the following code now fails with the
need to escape, but no escapechar seterror:This code correctly worked on Python 3.9.
The issue is this C code snipped added by the fix:
When no
escapecharis specified thendialect->escarecharis equal to 0 and thus matches the null character (0x00above) in the string to be written. This results in the code trying to "escape the escape character" even tho no escape character was specified and thus, no escaping is required.The only workaround is to always specify an
escapecharbut that is often not desirable.