jCloud/jcloud-config-parser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Format docstring in parse_ini in src/jcloud_config_parser/parse/ini.py correctly

Browse Source
This commit is contained in:
Jakob Scheid
2026-03-15 23:11:44 +01:00
parent e46a9784bb
commit e8e5bddf51
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/jcloud_config_parser/parse/ini.py
+11 -10
View File
@@ -143,20 +143,21 @@ def _compress_conf(conf):
return conf.strip() return conf.strip()
def parse_ini(conf, comment_prefixes=_COMMENT_PREFIXES, quotation_marks=_QUOTATION_MARKS, ignore_errors: bool = False, global_group: bool = True) -> typing.Dict[str, typing.Dict[str, str]]: def parse_ini(conf, comment_prefixes=_COMMENT_PREFIXES, quotation_marks=_QUOTATION_MARKS, ignore_errors: bool = False, global_group: bool = True) -> typing.Dict[str, typing.Dict[str, str]]:
'''Parses INI configuration from a string and returns a nested dictionary. '''
Parses INI configuration from a string and returns a nested dictionary.
:param conf: The INI configuration string to parse. :param conf: The INI configuration string to parse.
:param comment_prefixes: A collection of prefixes that denote comments in the INI file. :param comment_prefixes: A collection of prefixes that denote comments in the INI file.
:param quotation_marks: A collection of characters used for quoting values in the INI file. :param quotation_marks: A collection of characters used for quoting values in the INI file.
:param ignore_errors: If True, parsing errors will be ignored. :param ignore_errors: If True, parsing errors will be ignored.
:param global_group: If True, key-value pairs outside of any group will be included. Otherwise, an exception will be raised. :param global_group: If True, key-value pairs outside of any group will be included. Otherwise, an exception will be raised.
:return: A nested dictionary representing the parsed INI configuration. :return: A nested dictionary representing the parsed INI configuration.
:raises INISyntaxError: If there is a syntax error in the INI configuration and ignore_errors is False. :raises INISyntaxError: If there is a syntax error in the INI configuration and ignore_errors is False.
:rtype: typing.Dict[str, typing.Dict[str, str]] :rtype: typing.Dict[str, typing.Dict[str, str]]
''' '''
conf = _compress_conf(conf) conf = _compress_conf(conf)
result = {} result = {}