Class TomlConfig

commitizen/config/toml_config.py:22–70

class TomlConfig(BaseConfig):
    def __init__(self, *, data: bytes | str, path: Path) -> None:
        super().__init__()
        self.path = path
        self._parse_setting(data)

    def contains_commitizen_section(self) -> bool:
        config_doc = parse(self.path.read_bytes())
        return config_doc.get("tool", {}).get("commitizen") is not None

    def init_empty_config_content(self) -> None:
        config_doc = TOMLDocument()
        if self.path.is_file():
            config_doc = parse(self.path.read_bytes())

        if config_doc.get("tool") is None:
            config_doc["tool"] = table()
        config_doc["tool"]["commitizen"] = table()  # type: ignore[index]

        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:
        config_doc = parse(self.path.read_bytes())

        config_doc["tool"]["commitizen"][key] = value  # type: ignore[index]
        self.path.write_bytes(config_doc.as_string().encode(self._settings["encoding"]))

        return self

    def _parse_setting(self, data: bytes | str) -> None:
        """We expect to have a section in pyproject looking like

        ```
        [tool.commitizen]
        name = "cz_conventional_commits"
        ```
        """
        try:
            doc = parse(data)
        except exceptions.ParseError as e:
            raise InvalidConfigurationError(f"Failed to parse {self.path}: {e}")

        try:
            self.settings.update(doc["tool"]["commitizen"])  # type: ignore[index,typeddict-item] # TODO: fix this
        except exceptions.NonExistentKey:
            pass