Add support for specifying mutability when parsing a configuration

This commit is contained in:
2026-03-15 23:10:15 +01:00
parent 264f8a0083
commit e46a9784bb
7 changed files with 64 additions and 10 deletions
@@ -40,7 +40,6 @@ class Configuration:
raise TypeError('configuration is immutable')
return wrapper
def _set(self, name: str, value: str) -> None:
@self._mutate
def _set(name: str, value: str) -> None:
+6 -2
View File
@@ -14,7 +14,7 @@
from __future__ import annotations
import typing
from ._configuration import Configuration
from ._configuration import Configuration, set_mutability
from .parse.ini import _COMMENT_PREFIXES, _QUOTATION_MARKS, parse_ini
from .serialize.ini import serialize as serialize_ini
@@ -28,7 +28,7 @@ class INIConfiguration(Configuration):
return iter({k: dict(v) if isinstance(v, INIConfigurationSection) else v for k, v in self._config.items()}.items())
@classmethod
def from_string(cls, data: str | bytes, comment_prefixes: typing.Collection[str] = _COMMENT_PREFIXES, quotation_marks: typing.Collection[str] = _QUOTATION_MARKS, ignore_errors: bool = False, default: INIConfiguration = None):
def from_string(cls, data: str | bytes, comment_prefixes: typing.Collection[str] = _COMMENT_PREFIXES, quotation_marks: typing.Collection[str] = _QUOTATION_MARKS, ignore_errors: bool = False, default: INIConfiguration = None, mutable: bool = True):
'''
Parses INI configuration from a string and returns an instance of INIConfiguration.
@@ -44,6 +44,8 @@ class INIConfiguration(Configuration):
:type ignore_errors: bool
:param default: The default configuration.
:type default: INIConfiguration
:param mutable: The mutability of the configuration
:type mutable: bool
:raises INISyntaxError: If there is a syntax error in the INI configuration and ``ignore_errors`` is ``False``.
@@ -68,6 +70,8 @@ class INIConfiguration(Configuration):
if propk not in dict(configuration[section]).keys():
configuration[section][propk] = propv
set_mutability(configuration, mutable)
return configuration
def to_string(self, separator: str = '='):
+5 -3
View File
@@ -39,7 +39,7 @@ class JSONConfiguration(Configuration):
return iter({k: v.value for k, v in self._config.items()}.items())
@classmethod
def from_string(cls, data: str | bytes, ignore_errors: bool = False):
def from_string(cls, data: str | bytes, ignore_errors: bool = False, mutable: bool = True):
'''
Parses JSON configuration from a string and returns an instance of JSONConfiguration.
@@ -47,6 +47,8 @@ class JSONConfiguration(Configuration):
:type data: str
:param ignore_errors: If True, errors will be ignored.
:type ignore_errors: bool
:param mutable: The mutability of the configuration
:type mutable: bool
:raises JSONValueSyntaxError: If a value is invalid and ``ignore_errors`` is ``False``.
:raises JSONObjectSyntaxError: If an object is invalid and ``ignore_errors`` is ``False``.
@@ -63,11 +65,11 @@ class JSONConfiguration(Configuration):
try:
data = parse_type(data).parse(data)
if isinstance(data, JSONObject):
return cls({k: _configuration(v) for k, v in data.value.items()})
return cls({k: _configuration(v) for k, v in data.value.items()}, mutable = mutable)
elif not ignore_errors:
raise JSONTypeError(f'expected object, got {data._type}. Use jcloud_config_parser.parse.json.parse_json to parse JSONs.')
except:
if ignore_errors:
return cls()
return cls(mutable = mutable)
else:
raise