commitizen / commitizen/cz-cli
fix: UnicodeDecodeError when running 'cz init' on Windows with non-English locale
- Lingua principale
- JavaScript
- Stelle
- 17.5k
- Fork
- 566
- Merge medio
- 8h 16m
- PR unite (30g)
- 1
Descrizione
## Description
When running `cz init` on Windows, the command fails with a UnicodeDecodeError due to the default file encoding being 'gbk' instead of 'utf-8'.
### Steps to Reproduce
1. Create a new Python project on Windows with Chinese system locale
2. Install commitizen
3. Run `cz init`
4. Select `pyproject.toml` as config file
5. Select commit rule
### Error Message
```
UnicodeDecodeError: 'gbk' codec can't decode byte 0xaf in position 52: illegal multibyte sequence
```
### Technical Details
The error occurs in `commitizen/commands/init.py` when checking for poetry configuration:
```python
@property
def is_python_poetry(self) -> bool:
if not self.has_pyproject:
return False
with open("pyproject.toml") as f:
return "[tool.poetry]" in f.read()) # Here the file is opened without specifying encoding
```
### Expected Behavior
The file should be opened with UTF-8 encoding explicitly to ensure consistent behavior across different system locales.
### Suggested Fix
```python
# In commitizen/commands/init.py
@property
def is_python_poetry(self) -> bool:
if not self.has_pyproject:
return False
with open("pyproject.toml", encoding=self.settings["encoding"]) as f: # self.settings["encoding"] default is utf-8
return "[tool.poetry]" in f.read())
```
### Environment
- OS: Windows
- Python Version: 3.12
- Commitizen Version: latest
- System Locale: Chinese (Simplified)
### ScreenShot

Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Start in commitizen/commands/init.py at the is_python_poetry property and inspect how self.settings["encoding"] is configured. Reproduce cz init with a Chinese Windows locale and a pyproject.toml file, then verify that selecting the configuration and commit rule completes without a UnicodeDecodeError.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- cli
- Tipo di issue
- Bug
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 55/100