A bug of the write funtion of ConfigParser.py

[zouxiangliming]

BPO	32581
Nosy	@bitdancer, @ambv, @zouxiangliming, @iritkatriel

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-06-18.15:14:33.042>
created_at = <Date 2018-01-17.14:11:48.865>
labels = ['type-bug', 'library']
title = 'A bug of the write funtion of ConfigParser.py'
updated_at = <Date 2021-06-18.15:14:33.041>
user = 'https://github.com/zouxiangliming'

bugs.python.org fields:

activity = <Date 2021-06-18.15:14:33.041>
actor = 'iritkatriel'
assignee = 'none'
closed = True
closed_date = <Date 2021-06-18.15:14:33.042>
closer = 'iritkatriel'
components = ['Library (Lib)']
creation = <Date 2018-01-17.14:11:48.865>
creator = 'jiangjinhu666'
dependencies = []
files = []
hgrepos = []
issue_num = 32581
keywords = []
message_count = 7.0
messages = ['310168', '310172', '310175', '310176', '310179', '310181', '396069']
nosy_count = 4.0
nosy_names = ['r.david.murray', 'lukasz.langa', 'jiangjinhu666', 'iritkatriel']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue32581'
versions = ['Python 2.7']

[zouxiangliming]

By the write funtion of ConfigParser.py,the partial content of the configue will change.

[bitdancer]

Please provide a way to reproduce the problem you are observing. There is insufficient information here so far to understand the problem.

[zouxiangliming]

def write(self, fp):
        """Write an .ini-format representation of the configuration state."""
        if self._defaults:
            fp.write("[%s]\n" % DEFAULTSECT)
            for (key, value) in self._defaults.items():
                fp.write("%s = %s\n" % (key, str(value).replace('\n', '\n\t')))
            fp.write("\n")
        for section in self._sections:
            fp.write("[%s]\n" % section)
            for (key, value) in self._sections[section].items():
                if key == "__name__":
                    continue
                if (value is not None) or (self._optcre == self.OPTCRE):
                    if value == "":    #
                        value = "\"\""  #
                        key = " = ".join((key, str(value).replace('\n', '\n\t')))#
                    else:                                         #
                        key = " = ".join((key, str(value).replace('\n', '\n\t')))

  #              key = " = ".join((key, str(value).replace('\n', '\n\t')))

                fp.write("%s\n" % (key))
            fp.write("\n")

[zouxiangliming]

The configure file "test.ini":

[section_a]
addr = "127.0.0.1"
password = ""

Change the value of addr by the "test.py":

import ConfigParser

tmpfile = "test.ini"
conf = ConfigParser.ConfigParser()
conf.read(tmpfile)
conf.set("section_a", "addr", "\"127.0.0.2\"")
cfgfile = open(tmpfile, 'w')
conf.write(cfgfile) 

After change the value of addr to 127.0.0.2,the test.ini will be:

[section_a]
addr = "127.0.0.2"
password =

The "" of the password lost!

And one method which will fix this bug of the write function of the ConfigParder.py:

    def write(self, fp):
        """Write an .ini-format representation of the configuration state."""
        if self._defaults:
            fp.write("[%s]\n" % DEFAULTSECT)
            for (key, value) in self._defaults.items():
                fp.write("%s = %s\n" % (key, str(value).replace('\n', '\n\t')))
            fp.write("\n")
        for section in self._sections:
            fp.write("[%s]\n" % section)
            for (key, value) in self._sections[section].items():
                if key == "__name__":
                    continue
                if (value is not None) or (self._optcre == self.OPTCRE):
                    if value == "":    #
                        value = "\"\""  #
                        key = " = ".join((key, str(value).replace('\n', '\n\t')))#
                    else:                                         #
                        key = " = ".join((key, str(value).replace('\n', '\n\t')))

    
                fp.write("%s\n" % (key))
            fp.write("\n") 

Please check it.
Thanks!

[bitdancer]

I'll defer to Lukasz, but I don't believe this is a bug. An empty value and a value of "" are equivalent in config.ini syntax, as far as I know.

[zouxiangliming]

But accidentally,with the "password = "" " in the configure files ,which are called by my services, the service will start successfully,and with "password = ",the services can not.On the other hand ,I just set the option "addr = "127.0.0.1"",why the option "password = "" " will change.
Just add this.

[iritkatriel]

I trued this on 3.11/Windows and 3.10/Linux and could not reproduce the issue. The Password remained "" in both cases.