This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: RawConfigParser modifies empty strings unconditionally
Type: behavior Stage: resolved
Components: Library (Lib) Versions: Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: lukasz.langa Nosy List: Nacsa.Kristóf, Norman.Denayer, lukasz.langa, r.david.murray
Priority: normal Keywords: easy, patch

Created on 2013-10-31 17:24 by Nacsa.Kristóf, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
89484_issue19461.patch Norman.Denayer, 2014-03-08 09:51
Messages (5)
msg201829 - (view) Author: Nacsa Kristóf (Nacsa.Kristóf) Date: 2013-10-31 17:24
http://hg.python.org/cpython/file/8d5df9602a72/Lib/ConfigParser.py#l529

RawConfigParser has a special case of replacing '""' with '' in reader.
However the writer does not do the same.

This may cause problems, for example if you merge multiple ini files into one and the 3rd party program that should use the output segfaults on an ini that has `key=` instead of `key=value`, as it is in my case. :)

I think that the reasoning with the reader maybe was that an empty string must be an empty python string. 
However there is no option to control how it gets written back to the output. One can of course walkaround it by replacing the '' values with '""', but I think the standard library is ought to be consistent, walkarounds are unpythonic, a raw parser should be transparent either way, and there should preferrably be one obvious way to do it.

I think this is not just unintuitive (especially in a parser called "raw"), but goes against the philosophy of "refusing the temptation to guess". 

As I know, the syntax of .ini files is not exactly well-defined, so the best option in my opinion would be allowing to configure the parser how to treat these values.

Whether or not adding this option is viable, I think the problem still remains that the writer now works inconsistently of the reader.
msg201830 - (view) Author: Nacsa Kristóf (Nacsa.Kristóf) Date: 2013-10-31 17:25
typo: 
    `key=` instead of `key=value` 
was meant as
    `key=` instead of `key=""`
msg201834 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2013-10-31 17:47
A configurable option is probably the only way forward, due to backward compatibility reasons, but Łukasz will know for sure.  If so, it can only go in the *next* version of Python, and while we haven't hit beta yet on 3.4 it may be too late for anyone to have time to get it in before then.

Also, I was under the impression that 'key=' was the canonical way to indicate an empty value in an ini file.  As you say, the format is not well defined (no surprise).
msg212924 - (view) Author: Norman Denayer (Norman.Denayer) * Date: 2014-03-08 09:51
I guess it's logical to have the value "" turned to '' in the reader, but I would expect the same transformation in the writer.

If the write function would write "" for an empty string, will it solve your issue?
msg226396 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2014-09-05 02:10
This bug has been fixed in Python 3.2 (see 892236137db9). Please use the configparser backport for Python 2.7.
History
Date User Action Args
2022-04-11 14:57:52adminsetgithub: 63660
2014-09-05 02:10:34lukasz.langasetstatus: open -> closed
type: enhancement -> behavior
messages: + msg226396

resolution: fixed
stage: needs patch -> resolved
2014-03-08 09:51:30Norman.Denayersetfiles: + 89484_issue19461.patch

nosy: + Norman.Denayer
messages: + msg212924

keywords: + patch
2013-11-10 21:36:51lukasz.langasetassignee: lukasz.langa
2013-10-31 17:47:42r.david.murraysettype: behavior -> enhancement
versions: + Python 3.5, - Python 2.7
keywords: + easy
nosy: + r.david.murray, lukasz.langa

messages: + msg201834
stage: needs patch
2013-10-31 17:25:41Nacsa.Kristófsetmessages: + msg201830
2013-10-31 17:24:06Nacsa.Kristófcreate