Merge pull request #353 from loonghao/change_read_mode

fix(config): change read mode from `r` to `rb`

Author: woile

commitizen/config/__init__.py

@@ -28,8 +28,8 @@ def read_cfg() -> BaseConfig:
 
         _conf: Union[TomlConfig, JsonConfig, YAMLConfig]
 
-        with open(filename, "r") as f:
-            data: str = f.read()
+        with open(filename, "rb") as f:
+            data: bytes = f.read()
 
         if "toml" in filename.suffix:
             _conf = TomlConfig(data=data, path=filename)

commitizen/config/base_config.py

@@ -31,5 +31,5 @@ def update(self, data: dict):
     def add_path(self, path: Union[str, Path]):
         self._path = Path(path)
 
-    def _parse_setting(self, data: str) -> dict:
+    def _parse_setting(self, data: Union[bytes, str]) -> dict:
         raise NotImplementedError()

commitizen/config/json_config.py

@@ -6,7 +6,7 @@
 
 
 class JsonConfig(BaseConfig):
-    def __init__(self, *, data: str, path: Union[Path, str]):
+    def __init__(self, *, data: Union[bytes, str], path: Union[Path, str]):
         super(JsonConfig, self).__init__()
         self.is_empty_config = False
         self._parse_setting(data)
@@ -22,15 +22,15 @@ def set_key(self, key, value):
         For now only strings are supported.
         We use to update the version number.
         """
-        with open(self.path, "r") as f:
+        with open(self.path, "rb") as f:
             parser = json.load(f)
 
         parser["commitizen"][key] = value
         with open(self.path, "w") as f:
             json.dump(parser, f)
         return self
 
-    def _parse_setting(self, data: str):
+    def _parse_setting(self, data: Union[bytes, str]):
         """We expect to have a section in .cz.json looking like
 
         ```

commitizen/config/toml_config.py

@@ -7,7 +7,7 @@
 
 
 class TomlConfig(BaseConfig):
-    def __init__(self, *, data: str, path: Union[Path, str]):
+    def __init__(self, *, data: Union[bytes, str], path: Union[Path, str]):
         super(TomlConfig, self).__init__()
         self.is_empty_config = False
         self._parse_setting(data)
@@ -23,15 +23,15 @@ def set_key(self, key, value):
         For now only strings are supported.
         We use to update the version number.
         """
-        with open(self.path, "r") as f:
+        with open(self.path, "rb") as f:
             parser = parse(f.read())
 
         parser["tool"]["commitizen"][key] = value
         with open(self.path, "w") as f:
             f.write(parser.as_string())
         return self
 
-    def _parse_setting(self, data: str):
+    def _parse_setting(self, data: Union[bytes, str]):
         """We expect to have a section in pyproject looking like
 
         ```

commitizen/config/yaml_config.py

@@ -7,7 +7,7 @@
 
 
 class YAMLConfig(BaseConfig):
-    def __init__(self, *, data: str, path: Union[Path, str]):
+    def __init__(self, *, data: Union[bytes, str], path: Union[Path, str]):
         super(YAMLConfig, self).__init__()
         self.is_empty_config = False
         self._parse_setting(data)
@@ -17,7 +17,7 @@ def init_empty_config_content(self):
         with open(self.path, "a") as json_file:
             yaml.dump({"commitizen": {}}, json_file)
 
-    def _parse_setting(self, data: str):
+    def _parse_setting(self, data: Union[bytes, str]):
         """We expect to have a section in cz.yaml looking like
 
         ```
@@ -37,7 +37,7 @@ def set_key(self, key, value):
         For now only strings are supported.
         We use to update the version number.
         """
-        with open(self.path, "r") as yaml_file:
+        with open(self.path, "rb") as yaml_file:
             parser = yaml.load(yaml_file, Loader=yaml.FullLoader)
 
         parser["commitizen"][key] = value