Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/git/config.py: 75%
Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
2#
3# This module is part of GitPython and is released under the
4# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
6"""Parser for reading and writing configuration files."""
8__all__ = ["GitConfigParser", "SectionConstraint"]
10import abc
11import configparser as cp
12import fnmatch
13from functools import wraps
14import inspect
15from io import BufferedReader, IOBase
16import logging
17import os
18import os.path as osp
19import re
20import sys
22from git.compat import defenc, force_text
23from git.util import LockFile
25# typing-------------------------------------------------------
27from typing import (
28 Any,
29 Callable,
30 Generic,
31 IO,
32 List,
33 Dict,
34 Sequence,
35 TYPE_CHECKING,
36 Tuple,
37 TypeVar,
38 Union,
39 cast,
40)
42from git.types import Lit_config_levels, ConfigLevels_Tup, PathLike, assert_never, _T
44if TYPE_CHECKING:
45 from io import BytesIO
47 from git.repo.base import Repo
49T_ConfigParser = TypeVar("T_ConfigParser", bound="GitConfigParser")
50T_OMD_value = TypeVar("T_OMD_value", str, bytes, int, float, bool)
52if sys.version_info[:3] < (3, 7, 2):
53 # typing.Ordereddict not added until Python 3.7.2.
54 from collections import OrderedDict
56 OrderedDict_OMD = OrderedDict
57else:
58 from typing import OrderedDict
60 OrderedDict_OMD = OrderedDict[str, List[T_OMD_value]] # type: ignore[assignment, misc]
62# -------------------------------------------------------------
64_logger = logging.getLogger(__name__)
66CONFIG_LEVELS: ConfigLevels_Tup = ("system", "user", "global", "repository")
67"""The configuration level of a configuration file."""
69CONDITIONAL_INCLUDE_REGEXP = re.compile(r"(?<=includeIf )\"(gitdir|gitdir/i|onbranch):(.+)\"")
70"""Section pattern to detect conditional includes.
72See: https://git-scm.com/docs/git-config#_conditional_includes
73"""
76class MetaParserBuilder(abc.ABCMeta): # noqa: B024
77 """Utility class wrapping base-class methods into decorators that assure read-only
78 properties."""
80 def __new__(cls, name: str, bases: Tuple, clsdict: Dict[str, Any]) -> "MetaParserBuilder":
81 """Equip all base-class methods with a needs_values decorator, and all non-const
82 methods with a :func:`set_dirty_and_flush_changes` decorator in addition to
83 that.
84 """
85 kmm = "_mutating_methods_"
86 if kmm in clsdict:
87 mutating_methods = clsdict[kmm]
88 for base in bases:
89 methods = (t for t in inspect.getmembers(base, inspect.isroutine) if not t[0].startswith("_"))
90 for name, method in methods:
91 if name in clsdict:
92 continue
93 method_with_values = needs_values(method)
94 if name in mutating_methods:
95 method_with_values = set_dirty_and_flush_changes(method_with_values)
96 # END mutating methods handling
98 clsdict[name] = method_with_values
99 # END for each name/method pair
100 # END for each base
101 # END if mutating methods configuration is set
103 new_type = super().__new__(cls, name, bases, clsdict)
104 return new_type
107def needs_values(func: Callable[..., _T]) -> Callable[..., _T]:
108 """Return a method for ensuring we read values (on demand) before we try to access
109 them."""
111 @wraps(func)
112 def assure_data_present(self: "GitConfigParser", *args: Any, **kwargs: Any) -> _T:
113 self.read()
114 return func(self, *args, **kwargs)
116 # END wrapper method
117 return assure_data_present
120def set_dirty_and_flush_changes(non_const_func: Callable[..., _T]) -> Callable[..., _T]:
121 """Return a method that checks whether given non constant function may be called.
123 If so, the instance will be set dirty. Additionally, we flush the changes right to
124 disk.
125 """
127 def flush_changes(self: "GitConfigParser", *args: Any, **kwargs: Any) -> _T:
128 rval = non_const_func(self, *args, **kwargs)
129 self._dirty = True
130 self.write()
131 return rval
133 # END wrapper method
134 flush_changes.__name__ = non_const_func.__name__
135 return flush_changes
138class SectionConstraint(Generic[T_ConfigParser]):
139 """Constrains a ConfigParser to only option commands which are constrained to
140 always use the section we have been initialized with.
142 It supports all ConfigParser methods that operate on an option.
144 :note:
145 If used as a context manager, will release the wrapped ConfigParser.
146 """
148 __slots__ = ("_config", "_section_name")
150 _valid_attrs_ = (
151 "get_value",
152 "set_value",
153 "get",
154 "set",
155 "getint",
156 "getfloat",
157 "getboolean",
158 "has_option",
159 "remove_section",
160 "remove_option",
161 "options",
162 )
164 def __init__(self, config: T_ConfigParser, section: str) -> None:
165 self._config = config
166 self._section_name = section
168 def __del__(self) -> None:
169 # Yes, for some reason, we have to call it explicitly for it to work in PY3 !
170 # Apparently __del__ doesn't get call anymore if refcount becomes 0
171 # Ridiculous ... .
172 self._config.release()
174 def __getattr__(self, attr: str) -> Any:
175 if attr in self._valid_attrs_:
176 return lambda *args, **kwargs: self._call_config(attr, *args, **kwargs)
177 return super().__getattribute__(attr)
179 def _call_config(self, method: str, *args: Any, **kwargs: Any) -> Any:
180 """Call the configuration at the given method which must take a section name as
181 first argument."""
182 return getattr(self._config, method)(self._section_name, *args, **kwargs)
184 @property
185 def config(self) -> T_ConfigParser:
186 """return: ConfigParser instance we constrain"""
187 return self._config
189 def release(self) -> None:
190 """Equivalent to :meth:`GitConfigParser.release`, which is called on our
191 underlying parser instance."""
192 return self._config.release()
194 def __enter__(self) -> "SectionConstraint[T_ConfigParser]":
195 self._config.__enter__()
196 return self
198 def __exit__(self, exception_type: str, exception_value: str, traceback: str) -> None:
199 self._config.__exit__(exception_type, exception_value, traceback)
202class _OMD(OrderedDict_OMD):
203 """Ordered multi-dict."""
205 def __setitem__(self, key: str, value: _T) -> None:
206 super().__setitem__(key, [value])
208 def add(self, key: str, value: Any) -> None:
209 if key not in self:
210 super().__setitem__(key, [value])
211 return
213 super().__getitem__(key).append(value)
215 def setall(self, key: str, values: List[_T]) -> None:
216 super().__setitem__(key, values)
218 def __getitem__(self, key: str) -> Any:
219 return super().__getitem__(key)[-1]
221 def getlast(self, key: str) -> Any:
222 return super().__getitem__(key)[-1]
224 def setlast(self, key: str, value: Any) -> None:
225 if key not in self:
226 super().__setitem__(key, [value])
227 return
229 prior = super().__getitem__(key)
230 prior[-1] = value
232 def get(self, key: str, default: Union[_T, None] = None) -> Union[_T, None]:
233 return super().get(key, [default])[-1]
235 def getall(self, key: str) -> List[_T]:
236 return super().__getitem__(key)
238 def items(self) -> List[Tuple[str, _T]]: # type: ignore[override]
239 """List of (key, last value for key)."""
240 return [(k, self[k]) for k in self]
242 def items_all(self) -> List[Tuple[str, List[_T]]]:
243 """List of (key, list of values for key)."""
244 return [(k, self.getall(k)) for k in self]
247def get_config_path(config_level: Lit_config_levels) -> str:
248 # We do not support an absolute path of the gitconfig on Windows.
249 # Use the global config instead.
250 if sys.platform == "win32" and config_level == "system":
251 config_level = "global"
253 if config_level == "system":
254 return "/etc/gitconfig"
255 elif config_level == "user":
256 config_home = os.environ.get("XDG_CONFIG_HOME") or osp.join(os.environ.get("HOME", "~"), ".config")
257 return osp.normpath(osp.expanduser(osp.join(config_home, "git", "config")))
258 elif config_level == "global":
259 return osp.normpath(osp.expanduser("~/.gitconfig"))
260 elif config_level == "repository":
261 raise ValueError("No repo to get repository configuration from. Use Repo._get_config_path")
262 else:
263 # Should not reach here. Will raise ValueError if does. Static typing will warn
264 # about missing elifs.
265 assert_never( # type: ignore[unreachable]
266 config_level,
267 ValueError(f"Invalid configuration level: {config_level!r}"),
268 )
271class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
272 """Implements specifics required to read git style configuration files.
274 This variation behaves much like the :manpage:`git-config(1)` command, such that the
275 configuration will be read on demand based on the filepath given during
276 initialization.
278 The changes will automatically be written once the instance goes out of scope, but
279 can be triggered manually as well.
281 The configuration file will be locked if you intend to change values preventing
282 other instances to write concurrently.
284 :note:
285 The config is case-sensitive even when queried, hence section and option names
286 must match perfectly.
288 :note:
289 If used as a context manager, this will release the locked file.
290 """
292 # { Configuration
293 t_lock = LockFile
294 """The lock type determines the type of lock to use in new configuration readers.
296 They must be compatible to the :class:`~git.util.LockFile` interface.
297 A suitable alternative would be the :class:`~git.util.BlockingLockFile`.
298 """
300 re_comment = re.compile(r"^\s*[#;]")
301 # } END configuration
303 optvalueonly_source = r"\s*(?P<option>[^:=\s][^:=]*)"
305 OPTVALUEONLY = re.compile(optvalueonly_source)
307 OPTCRE = re.compile(optvalueonly_source + r"\s*(?P<vi>[:=])\s*" + r"(?P<value>.*)$")
309 del optvalueonly_source
311 _mutating_methods_ = ("add_section", "remove_section", "remove_option", "set")
312 """Names of :class:`~configparser.RawConfigParser` methods able to change the
313 instance."""
315 def __init__(
316 self,
317 file_or_files: Union[None, PathLike, "BytesIO", Sequence[Union[PathLike, "BytesIO"]]] = None,
318 read_only: bool = True,
319 merge_includes: bool = True,
320 config_level: Union[Lit_config_levels, None] = None,
321 repo: Union["Repo", None] = None,
322 ) -> None:
323 """Initialize a configuration reader to read the given `file_or_files` and to
324 possibly allow changes to it by setting `read_only` False.
326 :param file_or_files:
327 A file path or file object, or a sequence of possibly more than one of them.
329 :param read_only:
330 If ``True``, the ConfigParser may only read the data, but not change it.
331 If ``False``, only a single file path or file object may be given. We will
332 write back the changes when they happen, or when the ConfigParser is
333 released. This will not happen if other configuration files have been
334 included.
336 :param merge_includes:
337 If ``True``, we will read files mentioned in ``[include]`` sections and
338 merge their contents into ours. This makes it impossible to write back an
339 individual configuration file. Thus, if you want to modify a single
340 configuration file, turn this off to leave the original dataset unaltered
341 when reading it.
343 :param repo:
344 Reference to repository to use if ``[includeIf]`` sections are found in
345 configuration files.
346 """
347 cp.RawConfigParser.__init__(self, dict_type=_OMD)
348 self._dict: Callable[..., _OMD]
349 self._defaults: _OMD
350 self._sections: _OMD
352 # Used in Python 3. Needs to stay in sync with sections for underlying
353 # implementation to work.
354 if not hasattr(self, "_proxies"):
355 self._proxies = self._dict()
357 if file_or_files is not None:
358 self._file_or_files: Union[PathLike, "BytesIO", Sequence[Union[PathLike, "BytesIO"]]] = file_or_files
359 else:
360 if config_level is None:
361 if read_only:
362 self._file_or_files = [
363 get_config_path(cast(Lit_config_levels, f)) for f in CONFIG_LEVELS if f != "repository"
364 ]
365 else:
366 raise ValueError("No configuration level or configuration files specified")
367 else:
368 self._file_or_files = [get_config_path(config_level)]
370 self._read_only = read_only
371 self._dirty = False
372 self._is_initialized = False
373 self._merge_includes = merge_includes
374 self._repo = repo
375 self._lock: Union["LockFile", None] = None
376 self._acquire_lock()
378 def _acquire_lock(self) -> None:
379 if not self._read_only:
380 if not self._lock:
381 if isinstance(self._file_or_files, (str, os.PathLike)):
382 file_or_files = self._file_or_files
383 elif isinstance(self._file_or_files, (tuple, list, Sequence)):
384 raise ValueError(
385 "Write-ConfigParsers can operate on a single file only, multiple files have been passed"
386 )
387 else:
388 file_or_files = self._file_or_files.name
390 # END get filename from handle/stream
391 # Initialize lock base - we want to write.
392 self._lock = self.t_lock(file_or_files)
393 # END lock check
395 self._lock._obtain_lock()
396 # END read-only check
398 def __del__(self) -> None:
399 """Write pending changes if required and release locks."""
400 # NOTE: Only consistent in Python 2.
401 self.release()
403 def __enter__(self) -> "GitConfigParser":
404 self._acquire_lock()
405 return self
407 def __exit__(self, *args: Any) -> None:
408 self.release()
410 def release(self) -> None:
411 """Flush changes and release the configuration write lock. This instance must
412 not be used anymore afterwards.
414 In Python 3, it's required to explicitly release locks and flush changes, as
415 ``__del__`` is not called deterministically anymore.
416 """
417 # Checking for the lock here makes sure we do not raise during write()
418 # in case an invalid parser was created who could not get a lock.
419 if self.read_only or (self._lock and not self._lock._has_lock()):
420 return
422 try:
423 self.write()
424 except IOError:
425 _logger.error("Exception during destruction of GitConfigParser", exc_info=True)
426 except ReferenceError:
427 # This happens in Python 3... and usually means that some state cannot be
428 # written as the sections dict cannot be iterated. This usually happens when
429 # the interpreter is shutting down. Can it be fixed?
430 pass
431 finally:
432 if self._lock is not None:
433 self._lock._release_lock()
435 def optionxform(self, optionstr: str) -> str:
436 """Do not transform options in any way when writing."""
437 return optionstr
439 def _read(self, fp: Union[BufferedReader, IO[bytes]], fpname: str) -> None:
440 """Originally a direct copy of the Python 2.4 version of
441 :meth:`RawConfigParser._read <configparser.RawConfigParser._read>`, to ensure it
442 uses ordered dicts.
444 The ordering bug was fixed in Python 2.4, and dict itself keeps ordering since
445 Python 3.7. This has some other changes, especially that it ignores initial
446 whitespace, since git uses tabs. (Big comments are removed to be more compact.)
447 """
448 cursect = None # None, or a dictionary.
449 optname = None
450 lineno = 0
451 is_multi_line = False
452 e = None # None, or an exception.
454 def string_decode(v: str) -> str:
455 if v and v.endswith("\\"):
456 v = v[:-1]
457 # END cut trailing escapes to prevent decode error
459 return v.encode(defenc).decode("unicode_escape")
461 # END string_decode
463 while True:
464 # We assume to read binary!
465 line = fp.readline().decode(defenc)
466 if not line:
467 break
468 lineno = lineno + 1
469 # Comment or blank line?
470 if line.strip() == "" or self.re_comment.match(line):
471 continue
472 if line.split(None, 1)[0].lower() == "rem" and line[0] in "rR":
473 # No leading whitespace.
474 continue
476 # Is it a section header?
477 mo = self.SECTCRE.match(line.strip())
478 if not is_multi_line and mo:
479 sectname: str = mo.group("header").strip()
480 if sectname in self._sections:
481 cursect = self._sections[sectname]
482 elif sectname == cp.DEFAULTSECT:
483 cursect = self._defaults
484 else:
485 cursect = self._dict((("__name__", sectname),))
486 self._sections[sectname] = cursect
487 self._proxies[sectname] = None
488 # So sections can't start with a continuation line.
489 optname = None
490 # No section header in the file?
491 elif cursect is None:
492 raise cp.MissingSectionHeaderError(fpname, lineno, line)
493 # An option line?
494 elif not is_multi_line:
495 mo = self.OPTCRE.match(line)
496 if mo:
497 # We might just have handled the last line, which could contain a quotation we want to remove.
498 optname, vi, optval = mo.group("option", "vi", "value")
499 if vi in ("=", ":") and ";" in optval and not optval.strip().startswith('"'):
500 pos = optval.find(";")
501 if pos != -1 and optval[pos - 1].isspace():
502 optval = optval[:pos]
503 optval = optval.strip()
504 if optval == '""':
505 optval = ""
506 # END handle empty string
507 optname = self.optionxform(optname.rstrip())
508 if len(optval) > 1 and optval[0] == '"' and optval[-1] != '"':
509 is_multi_line = True
510 optval = string_decode(optval[1:])
511 # END handle multi-line
512 # Preserves multiple values for duplicate optnames.
513 cursect.add(optname, optval)
514 else:
515 # Check if it's an option with no value - it's just ignored by git.
516 if not self.OPTVALUEONLY.match(line):
517 if not e:
518 e = cp.ParsingError(fpname)
519 e.append(lineno, repr(line))
520 continue
521 else:
522 line = line.rstrip()
523 if line.endswith('"'):
524 is_multi_line = False
525 line = line[:-1]
526 # END handle quotations
527 optval = cursect.getlast(optname)
528 cursect.setlast(optname, optval + string_decode(line))
529 # END parse section or option
530 # END while reading
532 # If any parsing errors occurred, raise an exception.
533 if e:
534 raise e
536 def _has_includes(self) -> Union[bool, int]:
537 return self._merge_includes and len(self._included_paths())
539 def _included_paths(self) -> List[Tuple[str, str]]:
540 """List all paths that must be included to configuration.
542 :return:
543 The list of paths, where each path is a tuple of (option, value).
544 """
545 paths = []
547 for section in self.sections():
548 if section == "include":
549 paths += self.items(section)
551 match = CONDITIONAL_INCLUDE_REGEXP.search(section)
552 if match is None or self._repo is None:
553 continue
555 keyword = match.group(1)
556 value = match.group(2).strip()
558 if keyword in ["gitdir", "gitdir/i"]:
559 value = osp.expanduser(value)
561 if not any(value.startswith(s) for s in ["./", "/"]):
562 value = "**/" + value
563 if value.endswith("/"):
564 value += "**"
566 # Ensure that glob is always case insensitive if required.
567 if keyword.endswith("/i"):
568 value = re.sub(
569 r"[a-zA-Z]",
570 lambda m: "[{}{}]".format(m.group().lower(), m.group().upper()),
571 value,
572 )
573 if self._repo.git_dir:
574 if fnmatch.fnmatchcase(str(self._repo.git_dir), value):
575 paths += self.items(section)
577 elif keyword == "onbranch":
578 try:
579 branch_name = self._repo.active_branch.name
580 except TypeError:
581 # Ignore section if active branch cannot be retrieved.
582 continue
584 if fnmatch.fnmatchcase(branch_name, value):
585 paths += self.items(section)
587 return paths
589 def read(self) -> None: # type: ignore[override]
590 """Read the data stored in the files we have been initialized with.
592 This will ignore files that cannot be read, possibly leaving an empty
593 configuration.
595 :raise IOError:
596 If a file cannot be handled.
597 """
598 if self._is_initialized:
599 return
600 self._is_initialized = True
602 files_to_read: List[Union[PathLike, IO]] = [""]
603 if isinstance(self._file_or_files, (str, os.PathLike)):
604 # For str or Path, as str is a type of Sequence.
605 files_to_read = [self._file_or_files]
606 elif not isinstance(self._file_or_files, (tuple, list, Sequence)):
607 # Could merge with above isinstance once runtime type known.
608 files_to_read = [self._file_or_files]
609 else: # For lists or tuples.
610 files_to_read = list(self._file_or_files)
611 # END ensure we have a copy of the paths to handle
613 seen = set(files_to_read)
614 num_read_include_files = 0
615 while files_to_read:
616 file_path = files_to_read.pop(0)
617 file_ok = False
619 if hasattr(file_path, "seek"):
620 # Must be a file-object.
621 # TODO: Replace cast with assert to narrow type, once sure.
622 file_path = cast(IO[bytes], file_path)
623 self._read(file_path, file_path.name)
624 else:
625 # Assume a path if it is not a file-object.
626 file_path = cast(PathLike, file_path)
627 try:
628 with open(file_path, "rb") as fp:
629 file_ok = True
630 self._read(fp, fp.name)
631 except IOError:
632 continue
634 # Read includes and append those that we didn't handle yet. We expect all
635 # paths to be normalized and absolute (and will ensure that is the case).
636 if self._has_includes():
637 for _, include_path in self._included_paths():
638 if include_path.startswith("~"):
639 include_path = osp.expanduser(include_path)
640 if not osp.isabs(include_path):
641 if not file_ok:
642 continue
643 # END ignore relative paths if we don't know the configuration file path
644 file_path = cast(PathLike, file_path)
645 assert osp.isabs(file_path), "Need absolute paths to be sure our cycle checks will work"
646 include_path = osp.join(osp.dirname(file_path), include_path)
647 # END make include path absolute
648 include_path = osp.normpath(include_path)
649 if include_path in seen or not os.access(include_path, os.R_OK):
650 continue
651 seen.add(include_path)
652 # Insert included file to the top to be considered first.
653 files_to_read.insert(0, include_path)
654 num_read_include_files += 1
655 # END each include path in configuration file
656 # END handle includes
657 # END for each file object to read
659 # If there was no file included, we can safely write back (potentially) the
660 # configuration file without altering its meaning.
661 if num_read_include_files == 0:
662 self._merge_includes = False
664 def _write(self, fp: IO) -> None:
665 """Write an .ini-format representation of the configuration state in
666 git compatible format."""
668 def write_section(name: str, section_dict: _OMD) -> None:
669 fp.write(("[%s]\n" % name).encode(defenc))
671 values: Sequence[str] # Runtime only gets str in tests, but should be whatever _OMD stores.
672 v: str
673 for key, values in section_dict.items_all():
674 if key == "__name__":
675 continue
677 for v in values:
678 fp.write(("\t%s = %s\n" % (key, self._value_to_string(v).replace("\n", "\n\t"))).encode(defenc))
679 # END if key is not __name__
681 # END section writing
683 if self._defaults:
684 write_section(cp.DEFAULTSECT, self._defaults)
685 value: _OMD
687 for name, value in self._sections.items():
688 write_section(name, value)
690 def items(self, section_name: str) -> List[Tuple[str, str]]: # type: ignore[override]
691 """:return: list((option, value), ...) pairs of all items in the given section"""
692 return [(k, v) for k, v in super().items(section_name) if k != "__name__"]
694 def items_all(self, section_name: str) -> List[Tuple[str, List[str]]]:
695 """:return: list((option, [values...]), ...) pairs of all items in the given section"""
696 rv = _OMD(self._defaults)
698 for k, vs in self._sections[section_name].items_all():
699 if k == "__name__":
700 continue
702 if k in rv and rv.getall(k) == vs:
703 continue
705 for v in vs:
706 rv.add(k, v)
708 return rv.items_all()
710 @needs_values
711 def write(self) -> None:
712 """Write changes to our file, if there are changes at all.
714 :raise IOError:
715 If this is a read-only writer instance or if we could not obtain a file
716 lock.
717 """
718 self._assure_writable("write")
719 if not self._dirty:
720 return
722 if isinstance(self._file_or_files, (list, tuple)):
723 raise AssertionError(
724 "Cannot write back if there is not exactly a single file to write to, have %i files"
725 % len(self._file_or_files)
726 )
727 # END assert multiple files
729 if self._has_includes():
730 _logger.debug(
731 "Skipping write-back of configuration file as include files were merged in."
732 + "Set merge_includes=False to prevent this."
733 )
734 return
735 # END stop if we have include files
737 fp = self._file_or_files
739 # We have a physical file on disk, so get a lock.
740 is_file_lock = isinstance(fp, (str, os.PathLike, IOBase)) # TODO: Use PathLike (having dropped 3.5).
741 if is_file_lock and self._lock is not None: # Else raise error?
742 self._lock._obtain_lock()
744 if not hasattr(fp, "seek"):
745 fp = cast(PathLike, fp)
746 with open(fp, "wb") as fp_open:
747 self._write(fp_open)
748 else:
749 fp = cast("BytesIO", fp)
750 fp.seek(0)
751 # Make sure we do not overwrite into an existing file.
752 if hasattr(fp, "truncate"):
753 fp.truncate()
754 self._write(fp)
756 def _assure_writable(self, method_name: str) -> None:
757 if self.read_only:
758 raise IOError("Cannot execute non-constant method %s.%s" % (self, method_name))
760 def add_section(self, section: str) -> None:
761 """Assures added options will stay in order."""
762 return super().add_section(section)
764 @property
765 def read_only(self) -> bool:
766 """:return: ``True`` if this instance may change the configuration file"""
767 return self._read_only
769 # FIXME: Figure out if default or return type can really include bool.
770 def get_value(
771 self,
772 section: str,
773 option: str,
774 default: Union[int, float, str, bool, None] = None,
775 ) -> Union[int, float, str, bool]:
776 """Get an option's value.
778 If multiple values are specified for this option in the section, the last one
779 specified is returned.
781 :param default:
782 If not ``None``, the given default value will be returned in case the option
783 did not exist.
785 :return:
786 A properly typed value, either int, float or string
788 :raise TypeError:
789 In case the value could not be understood.
790 Otherwise the exceptions known to the ConfigParser will be raised.
791 """
792 try:
793 valuestr = self.get(section, option)
794 except Exception:
795 if default is not None:
796 return default
797 raise
799 return self._string_to_value(valuestr)
801 def get_values(
802 self,
803 section: str,
804 option: str,
805 default: Union[int, float, str, bool, None] = None,
806 ) -> List[Union[int, float, str, bool]]:
807 """Get an option's values.
809 If multiple values are specified for this option in the section, all are
810 returned.
812 :param default:
813 If not ``None``, a list containing the given default value will be returned
814 in case the option did not exist.
816 :return:
817 A list of properly typed values, either int, float or string
819 :raise TypeError:
820 In case the value could not be understood.
821 Otherwise the exceptions known to the ConfigParser will be raised.
822 """
823 try:
824 self.sections()
825 lst = self._sections[section].getall(option)
826 except Exception:
827 if default is not None:
828 return [default]
829 raise
831 return [self._string_to_value(valuestr) for valuestr in lst]
833 def _string_to_value(self, valuestr: str) -> Union[int, float, str, bool]:
834 types = (int, float)
835 for numtype in types:
836 try:
837 val = numtype(valuestr)
838 # truncated value ?
839 if val != float(valuestr):
840 continue
841 return val
842 except (ValueError, TypeError):
843 continue
844 # END for each numeric type
846 # Try boolean values as git uses them.
847 vl = valuestr.lower()
848 if vl == "false":
849 return False
850 if vl == "true":
851 return True
853 if not isinstance(valuestr, str):
854 raise TypeError(
855 "Invalid value type: only int, long, float and str are allowed",
856 valuestr,
857 )
859 return valuestr
861 def _value_to_string(self, value: Union[str, bytes, int, float, bool]) -> str:
862 if isinstance(value, (int, float, bool)):
863 return str(value)
864 return force_text(value)
866 @needs_values
867 @set_dirty_and_flush_changes
868 def set_value(self, section: str, option: str, value: Union[str, bytes, int, float, bool]) -> "GitConfigParser":
869 """Set the given option in section to the given value.
871 This will create the section if required, and will not throw as opposed to the
872 default ConfigParser ``set`` method.
874 :param section:
875 Name of the section in which the option resides or should reside.
877 :param option:
878 Name of the options whose value to set.
880 :param value:
881 Value to set the option to. It must be a string or convertible to a string.
883 :return:
884 This instance
885 """
886 if not self.has_section(section):
887 self.add_section(section)
888 self.set(section, option, self._value_to_string(value))
889 return self
891 @needs_values
892 @set_dirty_and_flush_changes
893 def add_value(self, section: str, option: str, value: Union[str, bytes, int, float, bool]) -> "GitConfigParser":
894 """Add a value for the given option in section.
896 This will create the section if required, and will not throw as opposed to the
897 default ConfigParser ``set`` method. The value becomes the new value of the
898 option as returned by :meth:`get_value`, and appends to the list of values
899 returned by :meth:`get_values`.
901 :param section:
902 Name of the section in which the option resides or should reside.
904 :param option:
905 Name of the option.
907 :param value:
908 Value to add to option. It must be a string or convertible to a string.
910 :return:
911 This instance
912 """
913 if not self.has_section(section):
914 self.add_section(section)
915 self._sections[section].add(option, self._value_to_string(value))
916 return self
918 def rename_section(self, section: str, new_name: str) -> "GitConfigParser":
919 """Rename the given section to `new_name`.
921 :raise ValueError:
922 If:
924 * `section` doesn't exist.
925 * A section with `new_name` does already exist.
927 :return:
928 This instance
929 """
930 if not self.has_section(section):
931 raise ValueError("Source section '%s' doesn't exist" % section)
932 if self.has_section(new_name):
933 raise ValueError("Destination section '%s' already exists" % new_name)
935 super().add_section(new_name)
936 new_section = self._sections[new_name]
937 for k, vs in self.items_all(section):
938 new_section.setall(k, vs)
939 # END for each value to copy
941 # This call writes back the changes, which is why we don't have the respective
942 # decorator.
943 self.remove_section(section)
944 return self