ConfigParser.items returns items present in vars

[timster]

BPO	33251
Nosy	@terryjreedy, @ambv, @serhiy-storchaka, @timster
PRs	bpo-33251: Prevent ConfigParser.items returning items present in vars. #6446 bpo-33251: Revert 725476222a3c1f2f93162d75a540e6bcdeaa36fd #6494 bpo-33251: [3.7] Revert 725476222a3c1f2f93162d75a540e6bcdeaa36fd (GH-6494) #6495 bpo-33251: [3.6] Revert 725476222a3c1f2f93162d75a540e6bcdeaa36fd (GH-6494) #6496 bpo-33333 #6567 bpo-33251: Update documentation to reflect change. (GH-6446) #6583

^{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 = None
created_at = <Date 2018-04-09.20:04:26.440>
labels = ['3.8', 'type-bug', 'library']
title = 'ConfigParser.items returns items present in vars'
updated_at = <Date 2018-04-23.20:56:49.760>
user = 'https://github.com/timster'

bugs.python.org fields:

activity = <Date 2018-04-23.20:56:49.760>
actor = 'lukasz.langa'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2018-04-09.20:04:26.440>
creator = 'timster'
dependencies = []
files = []
hgrepos = []
issue_num = 33251
keywords = ['patch']
message_count = 7.0
messages = ['315148', '315374', '315375', '315390', '315628', '315673', '315679']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'lukasz.langa', 'serhiy.storchaka', 'timster']
pr_nums = ['6446', '6494', '6495', '6496', '6567', '6583']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue33251'
versions = ['Python 3.8']

[timster]

The documentation for ConfigParser.items(section, raw=False, vars=None) says the following:

Changed in version 3.2: Items present in vars no longer appear in the result. The previous behaviour mixed actual parser options with variables provided for interpolation.

https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.items

However, this does not seem to be the case. The keys from vars are present in the output. Tested on 3.6.5.

This example shows the issue:

    import configparser

    config = configparser.ConfigParser()

    config.add_section('example')
    config.set('example', 'name', 'timster %(suffix)s')

    data = config.items('example', vars={'suffix': 'user'})

    print(data)

Expected output:

[('name', 'timster user')]

Actual output:

[('name', 'timster user'), ('suffix', 'user')]

[ambv]

Hm. The documentation change was done in bpo-12036 but it seems this was actually never the case, contrary to what the conversation on that other issue there states.

I wouldn't change it for 3.6.6 anymore since it's pretty late in the release cycle. This looks like an interesting bug fix for 3.7.

[ambv]

Well, now that I think about it, this is not even a *bug* fix since it's behavior that configparser had since 1997.

So that will have to go straight to 3.8.

[serhiy-storchaka]

What *actually* was changed in 3.2?

[ambv]

What *actually* was changed in 3.2?

In terms of this issue, nothing. That piece of documentation was put without proper testing, based purely on a comment that somebody put on bpo-12036. My mistake.

[ambv]

New changeset 1d4a733 by Łukasz Langa (Chris Bradbury) in branch 'master':
bpo-33251: Prevent ConfigParser.items returning items present in vars. (bpo-6446)
1d4a733

[ambv]

New changeset e500839 by Łukasz Langa (Chris Bradbury) in branch 'master':
bpo-33251: Update documentation to reflect change. (GH-6446) (bpo-6583)
e500839

[furkanonder]

@ambv The issue seems to have been resolved. Can we close the issue?