Skip to content

gh-150132: Document the no-argument overload of ConfigParser.items() #150133

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

Open
Taeknology wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −6
Open

gh-150132: Document the no-argument overload of ConfigParser.items() #150133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions Lib/configparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,13 +885,17 @@ def getboolean(self, section, option, *, raw=False, vars=None,
raw=raw, vars=vars, fallback=fallback, **kwargs)

def items(self, section=_UNSET, raw=False, vars=None):
"""Return a list of (name, value) tuples for each option in a section.
"""Return the items of the parser or of a section.

All % interpolations are expanded in the return values, based on the
defaults passed into the constructor, unless the optional argument
`raw` is true. Additional substitutions may be provided using the
`vars` argument, which must be a dictionary whose contents overrides
any pre-existing defaults.
When `section` is not given, return an ItemsView of
(section_name, section_proxy) pairs, including DEFAULTSECT.

Otherwise, return a list of (name, value) tuples for each option in
the given section. All % interpolations are expanded in the return
values, based on the defaults passed into the constructor, unless the
optional argument `raw` is true. Additional substitutions may be
provided using the `vars` argument, which must be a dictionary whose
contents overrides any pre-existing defaults.

The section DEFAULT is special.
"""
Expand Down
Loading