Skip to content

bpo-31307: Allow use of bytes object as a single argument in ConfigParser.read #3420

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
berkerpeksag merged 7 commits into from
Nov 2, 2017
Merged

bpo-31307: Allow use of bytes object as a single argument in ConfigParser.read #3420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d0e64d9
Allow use of bytes object as a single argument in ConfigParser.read()
vxgmichel Sep 7, 2017
31953c5
Fix typo + minimize diff
merwok Sep 16, 2017
3e6b700
Didn’t ask for whitespace github
merwok Sep 16, 2017
d9e25d8
Minor
merwok Sep 16, 2017
212644e
Improve phrasing
merwok Sep 16, 2017
4d8b257
Back down on full markup in news entry
merwok Sep 16, 2017
c28f235
Address berkerpeksag comments
vxgmichel Nov 2, 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
6 changes: 5 additions & 1 deletion Doc/library/configparser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,8 @@ ConfigParser Objects
Attempt to read and parse a list of filenames, returning a list of
filenames which were successfully parsed.

If *filenames* is a string or :term:`path-like object`, it is treated as
If *filenames* is a string, a :class:`bytes` object or a
:term:`path-like object`, it is treated as
a single filename. If a file named in *filenames* cannot be opened, that
file will be ignored. This is designed so that you can specify a list of
potential configuration file locations (for example, the current
Expand All @@ -1022,6 +1023,9 @@ ConfigParser Objects
.. versionadded:: 3.6.1
The *filenames* parameter accepts a :term:`path-like object`.

.. versionadded:: 3.7
The *filenames* parameter accepts a :class:`bytes` object.


.. method:: read_file(f, source=None)

Expand Down
2 changes: 1 addition & 1 deletion Lib/configparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ def read(self, filenames, encoding=None):

Return list of successfully read files.
"""
if isinstance(filenames, (str, os.PathLike)):
if isinstance(filenames, (str, bytes, os.PathLike)):
filenames = [filenames]
read_ok = []
for filename in filenames:
Expand Down
17 changes: 17 additions & 0 deletions Lib/test/test_configparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,23 @@ def test_read_returns_file_list(self):
parsed_files = cf.read([])
self.assertEqual(parsed_files, [])

def test_read_returns_file_list_with_bytestring_path(self):
if self.delimiters[0] != '=':
self.skipTest('incompatible format')
file1_bytestring = support.findfile("cfgparser.1").encode()
# check when passing an existing bytestring path
cf = self.newconfig()
parsed_files = cf.read(file1_bytestring)
self.assertEqual(parsed_files, [file1_bytestring])
# check when passing an non-existing bytestring path
cf = self.newconfig()
parsed_files = cf.read(b'nonexistent-file')
self.assertEqual(parsed_files, [])
# check when passing both an existing and non-existing bytestring path
cf = self.newconfig()
parsed_files = cf.read([file1_bytestring, b'nonexistent-file'])
self.assertEqual(parsed_files, [file1_bytestring])

# shared by subclasses
def get_interpolation_config(self):
return self.fromstring(
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2017-09-07-12-50-28.bpo-31307.AVBiNY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Allow use of bytes objects for arguments to
:meth:`configparser.ConfigParser.read`. Patch by Vincent Michel.