mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-31 14:07:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

bpo-29623: Make PathLike objects work with ConfigParser.read() (#242)

Browse source
This commit is contained in:
David Ellis 2017-03-03 17:14:27 +00:00 • committed by Berker Peksag
parent 677ab995ce
commit 85b8d01c91
4 changed files with 31 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/configparser.rst
View file

@ -988,13 +988,16 @@ ConfigParser Objects
.. method:: read(filenames, encoding=None)
Attempt to read and parse a list of filenames, returning a list of
filenames which were successfully parsed. If *filenames* is a string, 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 directory, the user's home directory, and some system-wide
directory), and all existing configuration files in the list will be
read. If none of the named files exist, the :class:`ConfigParser`
filenames which were successfully parsed.
If *filenames* is a string or :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
directory, the user's home directory, and some system-wide directory),
and all existing configuration files in the list will be read.
If none of the named files exist, the :class:`ConfigParser`
instance will contain an empty dataset. An application which requires
initial values to be loaded from a file should load the required file or
files using :meth:`read_file` before calling :meth:`read` for any
@ -1011,6 +1014,9 @@ ConfigParser Objects
The *encoding* parameter. Previously, all files were read using the
default encoding for :func:`open`.
.. versionadded:: 3.6.1
The *filenames* parameter accepts a :term:`path-like object`.
.. method:: read_file(f, source=None)