Skip to content

docs: use parse API in the README example #79

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
RonnyPfannschmidt merged 1 commit into from
Oct 6, 2026
+6 −2
Merged

docs: use parse API in the README example #79

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
8 changes: 6 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ If you have an ini file like this:
line1
line2

then you can do:
use ``IniConfig.parse()`` to strip inline comments from values:

.. code-block:: pycon

>>> import iniconfig
>>> ini = iniconfig.IniConfig("example.ini")
>>> ini = iniconfig.IniConfig.parse("example.ini")
>>> ini['section1']['name1'] # raises KeyError if not exists
'value1'
>>> ini.get('section1', 'name1b', [], lambda x: x.split(","))
Expand All @@ -52,3 +52,7 @@ then you can do:
True
>>> 'inexistendsection' in ini
False

The ``IniConfig()`` constructor preserves inline comments in values for backward
compatibility. Use ``IniConfig.parse(..., strip_inline_comments=False)`` to
preserve them when using the parsing method.