Add types to config.py GitConfigParser ._assure_writable .add_section .read_only .get_value .get_values ._string_to_value ._value_to_string .add_value .rename_section

Author: Yobmod

git/config.py

@@ -667,12 +667,13 @@ def write(self) -> None:
 fp=self._file_or_files
 
 # we have a physical file on disk, so get a lock
-is_file_lock=isinstance(fp, (str, IOBase))
+is_file_lock=isinstance(fp, (str, IOBase))# can't use Pathlike until 3.5 dropped
 ifis_file_lockandself._lockisnotNone: # else raise Error?
 self._lock._obtain_lock()
+
 ifnothasattr(fp, "seek"):
-self._file_or_files=cast(PathLike, self._file_or_files)
-withopen(self._file_or_files, "wb") asfp_open:
+fp=cast(PathLike, fp)
+withopen(fp, "wb") asfp_open:
 self._write(fp_open)
 else:
 fp=cast(IO, fp)
@@ -682,20 +683,22 @@ def write(self) -> None:
 fp.truncate()
 self._write(fp)
 
-def_assure_writable(self, method_name):
+def_assure_writable(self, method_name: str) ->None:
 ifself.read_only:
 raiseIOError("Cannot execute non-constant method %s.%s"% (self, method_name))
 
-defadd_section(self, section):
+defadd_section(self, section: str) ->None:
 """Assures added options will stay in order"""
 returnsuper(GitConfigParser, self).add_section(section)
 
 @property
-defread_only(self):
+defread_only(self)->bool:
 """:return: True if this instance may change the configuration file"""
 returnself._read_only
 
-defget_value(self, section, option, default=None):
+defget_value(self, section: str, option: str, default: Union[int, float, str, bool, None] =None
+ ) ->Union[int, float, str, bool]:
+# can default or return type include bool?
 """Get an option's value.
 
  If multiple values are specified for this option in the section, the
@@ -717,7 +720,8 @@ def get_value(self, section, option, default=None):
 
 returnself._string_to_value(valuestr)
 
-defget_values(self, section, option, default=None):
+defget_values(self, section: str, option: str, default: Union[int, float, str, bool, None] =None
+ ) ->List[Union[int, float, str, bool]]:
 """Get an option's values.
 
  If multiple values are specified for this option in the section, all are
@@ -739,16 +743,14 @@ def get_values(self, section, option, default=None):
 
 return [self._string_to_value(valuestr) forvaluestrinlst]
 
-def_string_to_value(self, valuestr):
+def_string_to_value(self, valuestr: str) ->Union[int, float, str, bool]:
 types= (int, float)
 fornumtypeintypes:
 try:
 val=numtype(valuestr)
-
 # truncated value ?
 ifval!=float(valuestr):
 continue
-
 returnval
 except (ValueError, TypeError):
 continue
@@ -768,14 +770,14 @@ def _string_to_value(self, valuestr):
 
 returnvaluestr
 
-def_value_to_string(self, value):
+def_value_to_string(self, value: Union[str, bytes, int, float, bool]) ->str:
 ifisinstance(value, (int, float, bool)):
 returnstr(value)
 returnforce_text(value)
 
 @needs_values
 @set_dirty_and_flush_changes
-defset_value(self, section, option, value):
+defset_value(self, section: str, option: str, value: Union[str, bytes, int, float, bool]) ->'GitConfigParser':
 """Sets the given option in section to the given value.
  It will create the section if required, and will not throw as opposed to the default
  ConfigParser 'set' method.
@@ -793,7 +795,7 @@ def set_value(self, section, option, value):
 
 @needs_values
 @set_dirty_and_flush_changes
-defadd_value(self, section, option, value):
+defadd_value(self, section: str, option: str, value: Union[str, bytes, int, float, bool]) ->'GitConfigParser':
 """Adds a value for the given option in section.
  It will create the section if required, and will not throw as opposed to the default
  ConfigParser 'set' method. The value becomes the new value of the option as returned
@@ -810,7 +812,7 @@ def add_value(self, section, option, value):
 self._sections[section].add(option, self._value_to_string(value))
 returnself
 
-defrename_section(self, section, new_name):
+defrename_section(self, section: str, new_name: str) ->'GitConfigParser':
 """rename the given section to new_name
  :raise ValueError: if section doesn't exit
  :raise ValueError: if a section with new_name does already exist

git/types.py

@@ -20,7 +20,7 @@
 PathLike=Union[str, os.PathLike]
 elifsys.version_info[:2] >= (3, 9):
 # os.PathLike only becomes subscriptable from Python 3.9 onwards
-PathLike=Union[str, os.PathLike[str]]
+PathLike=Union[str, 'os.PathLike[str]'] # forward ref as pylance complains unless editing with py3.9+
 
 TBD=Any