refactor: simplify code with pathlib Path object (#1840)

Author: bearomorphism

commitizen/changelog_formats/base.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
-import os
 from abc import ABCMeta
+from pathlib import Path
 from typing import IO, TYPE_CHECKING, Any, ClassVar
 
 from commitizen.changelog import IncrementalMergeInfo, Metadata
@@ -36,12 +36,11 @@ def __init__(self, config: BaseConfig) -> None:
         )
 
     def get_metadata(self, filepath: str) -> Metadata:
-        if not os.path.isfile(filepath):
+        file = Path(filepath)
+        if not file.is_file():
             return Metadata()
 
-        with open(
-            filepath, encoding=self.config.settings["encoding"]
-        ) as changelog_file:
+        with file.open(encoding=self.config.settings["encoding"]) as changelog_file:
             return self.get_metadata_from_file(changelog_file)
 
     def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
@@ -74,12 +73,11 @@ def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
         return meta
 
     def get_latest_full_release(self, filepath: str) -> IncrementalMergeInfo:
-        if not os.path.isfile(filepath):
+        file = Path(filepath)
+        if not file.is_file():
             return IncrementalMergeInfo()
 
-        with open(
-            filepath, encoding=self.config.settings["encoding"]
-        ) as changelog_file:
+        with file.open(encoding=self.config.settings["encoding"]) as changelog_file:
             return self.get_latest_full_release_from_file(changelog_file)
 
     def get_latest_full_release_from_file(self, file: IO[Any]) -> IncrementalMergeInfo:

commitizen/commands/changelog.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-import os
-import os.path
 from difflib import SequenceMatcher
 from operator import itemgetter
 from pathlib import Path
@@ -66,7 +64,7 @@ def __init__(self, config: BaseConfig, arguments: ChangelogArgs) -> None:
                 f"or the setting `changelog_file` in {self.config.path}"
             )
         self.file_name = (
-            os.path.join(str(self.config.path.parent), changelog_file_name)
+            Path(self.config.path.parent, changelog_file_name).as_posix()
             if self.config.path is not None
             else changelog_file_name
         )
@@ -282,9 +280,10 @@ def __call__(self) -> None:
             raise DryRunExit()
 
         lines = []
-        if self.incremental and os.path.isfile(self.file_name):
-            with open(
-                self.file_name, encoding=self.config.settings["encoding"]
+        changelog_path = Path(self.file_name)
+        if self.incremental and changelog_path.is_file():
+            with changelog_path.open(
+                encoding=self.config.settings["encoding"]
             ) as changelog_file:
                 lines = changelog_file.readlines()
 

commitizen/commands/commit.py

@@ -61,9 +61,7 @@ def _read_backup_message(self) -> str | None:
             return None
 
         # Read commit message from backup
-        with open(
-            self.backup_file_path, encoding=self.config.settings["encoding"]
-        ) as f:
+        with self.backup_file_path.open(encoding=self.config.settings["encoding"]) as f:
             return f.read().strip()
 
     def _get_message_by_prompt_commit_questions(self) -> str:

commitizen/commands/init.py

@@ -288,11 +288,12 @@ def _get_config_data(self) -> dict[str, Any]:
             ],
         }
 
-        if not Path(".pre-commit-config.yaml").is_file():
+        pre_commit_config_path = Path(self._PRE_COMMIT_CONFIG_PATH)
+        if not pre_commit_config_path.is_file():
             return {"repos": [CZ_HOOK_CONFIG]}
 
-        with open(
-            self._PRE_COMMIT_CONFIG_PATH, encoding=self.config.settings["encoding"]
+        with pre_commit_config_path.open(
+            encoding=self.config.settings["encoding"]
         ) as config_file:
             config_data: dict[str, Any] = yaml.safe_load(config_file) or {}
 

commitizen/config/__init__.py

@@ -28,10 +28,8 @@ def _resolve_config_candidates() -> list[BaseConfig]:
 
 
 def _create_config_from_path(path: Path) -> BaseConfig:
-    with open(path, "rb") as f:
-        data: bytes = f.read()
-
-    return create_config(data=data, path=path)
+    with path.open("rb") as f:
+        return create_config(data=f.read(), path=path)
 
 
 def read_cfg(filepath: str | None = None) -> BaseConfig:

commitizen/config/toml_config.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import os
 from typing import TYPE_CHECKING
 
 from tomlkit import TOMLDocument, exceptions, parse, table
@@ -33,25 +32,25 @@ def contains_commitizen_section(self) -> bool:
 
     def init_empty_config_content(self) -> None:
         config_doc = TOMLDocument()
-        if os.path.isfile(self.path):
-            with open(self.path, "rb") as input_toml_file:
+        if self.path.is_file():
+            with self.path.open("rb") as input_toml_file:
                 config_doc = parse(input_toml_file.read())
 
         if config_doc.get("tool") is None:
             config_doc["tool"] = table()
         config_doc["tool"]["commitizen"] = table()  # type: ignore[index]
 
-        with open(self.path, "wb") as output_toml_file:
+        with self.path.open("wb") as output_toml_file:
             output_toml_file.write(
                 config_doc.as_string().encode(self._settings["encoding"])
             )
 
     def set_key(self, key: str, value: object) -> Self:
-        with open(self.path, "rb") as f:
+        with self.path.open("rb") as f:
             config_doc = parse(f.read())
 
         config_doc["tool"]["commitizen"][key] = value  # type: ignore[index]
-        with open(self.path, "wb") as f:
+        with self.path.open("wb") as f:
             f.write(config_doc.as_string().encode(self._settings["encoding"]))
 
         return self

commitizen/config/yaml_config.py

@@ -56,7 +56,7 @@ def _parse_setting(self, data: bytes | str) -> None:
             pass
 
     def set_key(self, key: str, value: object) -> Self:
-        with open(self.path, "rb") as yaml_file:
+        with self.path.open("rb") as yaml_file:
             config_doc = yaml.load(yaml_file, Loader=yaml.FullLoader)
 
         config_doc["commitizen"][key] = value

commitizen/cz/conventional_commits/conventional_commits.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import os
+from pathlib import Path
 from typing import TYPE_CHECKING, TypedDict
 
 from commitizen import defaults
@@ -214,7 +214,6 @@ def schema_pattern(self) -> str:
         )
 
     def info(self) -> str:
-        dir_path = os.path.dirname(os.path.realpath(__file__))
-        filepath = os.path.join(dir_path, "conventional_commits_info.txt")
-        with open(filepath, encoding=self.config.settings["encoding"]) as f:
+        filepath = Path(__file__).parent / "conventional_commits_info.txt"
+        with filepath.open(encoding=self.config.settings["encoding"]) as f:
             return f.read()

commitizen/cz/jira/jira.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import os
+from pathlib import Path
 from typing import TYPE_CHECKING
 
 from commitizen.cz.base import BaseCommitizen
@@ -73,7 +73,6 @@ def schema_pattern(self) -> str:
         return r".*[A-Z]{2,}\-[0-9]+( #| .* #).+( #.+)*"
 
     def info(self) -> str:
-        dir_path = os.path.dirname(os.path.realpath(__file__))
-        filepath = os.path.join(dir_path, "jira_info.txt")
-        with open(filepath, encoding=self.config.settings["encoding"]) as f:
+        filepath = Path(__file__).parent / "jira_info.txt"
+        with filepath.open(encoding=self.config.settings["encoding"]) as f:
             return f.read()

commitizen/providers/cargo_provider.py

@@ -39,7 +39,7 @@ def set(self, document: TOMLDocument, version: str) -> None:
 
     def set_version(self, version: str) -> None:
         super().set_version(version)
-        if self.lock_file.exists():
+        if self.lock_file.is_file():
             self.set_lock_version(version)
 
     def set_lock_version(self, version: str) -> None: