refactor(config): rename config method and refactor to centralize --config logic

Author: bearomorphism

commitizen/cli.py

@@ -675,12 +675,12 @@ def main() -> None:
         extra_args = " ".join(unknown_args[1:])
         arguments["extra_cli_args"] = extra_args
 
-    conf = config.read_cfg(args.config)
     args = cast("Args", args)
+    config_object = config.search_and_read_config_file(args.config)
     if args.name:
-        conf.update({"name": args.name})
-    elif not conf.path:
-        conf.update({"name": "cz_conventional_commits"})
+        config_object.update({"name": args.name})
+    elif not config_object.path:
+        config_object.update({"name": "cz_conventional_commits"})
 
     if args.debug:
         logging.getLogger("commitizen").setLevel(logging.DEBUG)
@@ -692,7 +692,7 @@ def main() -> None:
         )
         sys.excepthook = no_raise_debug_excepthook
 
-    args.func(conf, arguments)()  # type: ignore[arg-type]
+    args.func(config_object, arguments)()  # type: ignore[arg-type]
 
 
 if __name__ == "__main__":

commitizen/config/__init__.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from collections.abc import Generator
 from pathlib import Path
 
 from commitizen import defaults, git
@@ -10,37 +9,51 @@
 from .base_config import BaseConfig
 
 
-def _resolve_config_paths(filepath: str | None = None) -> Generator[Path, None, None]:
-    if filepath is not None:
-        out_path = Path(filepath)
+def _try_read_config_file(filename: Path) -> BaseConfig | None:
+    with open(filename, "rb") as f:
+        data: bytes = f.read()
+
+    conf = create_config(data=data, path=filename)
+    if not conf.is_empty_config:
+        return conf
+
+    return None
+
+
+def search_and_read_config_file(specified_config_path: str | None = None) -> BaseConfig:
+    """Search and read config file from specified path, current directory, or git project root. If not found, return empty config object.
+
+    Args:
+        specified_config_path (str | None, optional): from --config command line argument. Defaults to None.
+
+    Raises:
+        ConfigFileNotFound: specified config file not found
+        ConfigFileIsEmpty: specified config file is empty
+
+    Returns:
+        BaseConfig: config object
+    """
+    if specified_config_path is not None:
+        out_path = Path(specified_config_path)
         if not out_path.exists():
             raise ConfigFileNotFound()
 
-        yield out_path
-        return
+        if (ret := _try_read_config_file(out_path)) is not None:
+            return ret
+        raise ConfigFileIsEmpty()
 
-    git_project_root = git.find_git_project_root()
     cfg_search_paths = [Path(".")]
-    if git_project_root:
+    if git_project_root := git.find_git_project_root():
         cfg_search_paths.append(git_project_root)
 
     for path in cfg_search_paths:
         for filename in defaults.CONFIG_FILES:
             out_path = path / Path(filename)
-            if out_path.exists():
-                yield out_path
-
-
-def read_cfg(filepath: str | None = None) -> BaseConfig:
-    for filename in _resolve_config_paths(filepath):
-        with open(filename, "rb") as f:
-            data: bytes = f.read()
-
-        conf = create_config(data=data, path=filename)
-        if not conf.is_empty_config:
-            return conf
-
-        if filepath is not None:
-            raise ConfigFileIsEmpty()
+            if (
+                out_path.exists()
+                and (ret := _try_read_config_file(out_path)) is not None
+            ):
+                return ret
 
+    # TODO: add comment about why we return empty config object
     return BaseConfig()

tests/test_conf.py

@@ -175,9 +175,9 @@ def test_find_git_project_root(tmpdir):
     "config_files_manager", defaults.CONFIG_FILES.copy(), indirect=True
 )
 def test_set_key(config_files_manager):
-    _conf = config.read_cfg()
+    _conf = config.search_and_read_config_file()
     _conf.set_key("version", "2.0.0")
-    cfg = config.read_cfg()
+    cfg = config.search_and_read_config_file()
     assert cfg.settings == _new_settings
 
 
@@ -186,12 +186,12 @@ class TestReadCfg:
         "config_files_manager", defaults.CONFIG_FILES.copy(), indirect=True
     )
     def test_load_conf(_, config_files_manager):
-        cfg = config.read_cfg()
+        cfg = config.search_and_read_config_file()
         assert cfg.settings == _settings
 
     def test_conf_returns_default_when_no_files(_, tmpdir):
         with tmpdir.as_cwd():
-            cfg = config.read_cfg()
+            cfg = config.search_and_read_config_file()
             assert cfg.settings == defaults.DEFAULT_SETTINGS
 
     def test_load_empty_pyproject_toml_and_cz_toml_with_config(_, tmpdir):
@@ -201,23 +201,25 @@ def test_load_empty_pyproject_toml_and_cz_toml_with_config(_, tmpdir):
             p = tmpdir.join(".cz.toml")
             p.write(PYPROJECT)
 
-            cfg = config.read_cfg()
+            cfg = config.search_and_read_config_file()
             assert cfg.settings == _settings
 
     def test_load_pyproject_toml_from_config_argument(_, tmpdir):
         with tmpdir.as_cwd():
             _not_root_path = tmpdir.mkdir("not_in_root").join("pyproject.toml")
             _not_root_path.write(PYPROJECT)
 
-            cfg = config.read_cfg(filepath="./not_in_root/pyproject.toml")
+            cfg = config.search_and_read_config_file(
+                filepath="./not_in_root/pyproject.toml"
+            )
             assert cfg.settings == _settings
 
     def test_load_cz_json_not_from_config_argument(_, tmpdir):
         with tmpdir.as_cwd():
             _not_root_path = tmpdir.mkdir("not_in_root").join(".cz.json")
             _not_root_path.write(JSON_STR)
 
-            cfg = config.read_cfg(filepath="./not_in_root/.cz.json")
+            cfg = config.search_and_read_config_file(filepath="./not_in_root/.cz.json")
             json_cfg_by_class = JsonConfig(data=JSON_STR, path=_not_root_path)
             assert cfg.settings == json_cfg_by_class.settings
 
@@ -226,7 +228,7 @@ def test_load_cz_yaml_not_from_config_argument(_, tmpdir):
             _not_root_path = tmpdir.mkdir("not_in_root").join(".cz.yaml")
             _not_root_path.write(YAML_STR)
 
-            cfg = config.read_cfg(filepath="./not_in_root/.cz.yaml")
+            cfg = config.search_and_read_config_file(filepath="./not_in_root/.cz.yaml")
             yaml_cfg_by_class = YAMLConfig(data=YAML_STR, path=_not_root_path)
             assert cfg.settings == yaml_cfg_by_class._settings
 
@@ -236,7 +238,9 @@ def test_load_empty_pyproject_toml_from_config_argument(_, tmpdir):
             _not_root_path.write("")
 
             with pytest.raises(ConfigFileIsEmpty):
-                config.read_cfg(filepath="./not_in_root/pyproject.toml")
+                config.search_and_read_config_file(
+                    filepath="./not_in_root/pyproject.toml"
+                )
 
 
 @pytest.mark.parametrize(