Skip to content

💫 Toolkit to help you get started with SDD or any other process!

fix(extensions): use explicit UTF-8 encoding when reading manifest YAML (#2370)

Quratulain-bilal3a7f64c8a529
diff --git a/src/specify_cli/extensions.py b/src/specify_cli/extensions.py
index 916038cd5..a419ebf1d 100644
--- a/src/specify_cli/extensions.py
+++ b/src/specify_cli/extensions.py
@@ -139,12 +139,18 @@ class ExtensionManifest:
def _load_yaml(self, path: Path) -> dict:
"""Load YAML file safely."""
try:
- with open(path, 'r') as f:
+ with open(path, 'r', encoding='utf-8') as f:
data = yaml.safe_load(f)
except yaml.YAMLError as e:
raise ValidationError(f"Invalid YAML in {path}: {e}")
except FileNotFoundError:
raise ValidationError(f"Manifest not found: {path}")
+ except UnicodeDecodeError as e:
+ raise ValidationError(
+ f"Manifest is not valid UTF-8: {path} ({e.reason} at byte {e.start})"
+ )
+ except OSError as e:
+ raise ValidationError(f"Could not read manifest {path}: {e}")
if not isinstance(data, dict):
raise ValidationError(
f"Manifest must be a YAML mapping, got {type(data).__name__}: {path}"
diff --git a/src/specify_cli/presets.py b/src/specify_cli/presets.py
index 24de73521..27054a77f 100644
--- a/src/specify_cli/presets.py
+++ b/src/specify_cli/presets.py
@@ -136,12 +136,25 @@ class PresetManifest:
def _load_yaml(self, path: Path) -> dict:
"""Load YAML file safely."""
try:
- with open(path, 'r') as f:
- return yaml.safe_load(f) or {}
+ with open(path, 'r', encoding='utf-8') as f:
+ data = yaml.safe_load(f)
except yaml.YAMLError as e:
raise PresetValidationError(f"Invalid YAML in {path}: {e}")
except FileNotFoundError:
raise PresetValidationError(f"Manifest not found: {path}")
+ except UnicodeDecodeError as e:
+ raise PresetValidationError(
+ f"Manifest is not valid UTF-8: {path} ({e.reason} at byte {e.start})"
+ )
+ except OSError as e:
+ raise PresetValidationError(f"Could not read manifest {path}: {e}")
+ if data is None:
+ return {}
+ if not isinstance(data, dict):
+ raise PresetValidationError(
+ f"Manifest must be a YAML mapping, got {type(data).__name__}: {path}"
+ )
+ return data
def _validate(self):
"""Validate manifest structure and required fields."""
diff --git a/tests/test_extensions.py b/tests/test_extensions.py
index e6a206c06..c5be0ab4f 100644
--- a/tests/test_extensions.py
+++ b/tests/test_extensions.py
@@ -225,6 +225,35 @@ class TestExtensionManifest:
with pytest.raises(ValidationError, match="YAML mapping"):
ExtensionManifest(manifest_path)
+ def test_utf8_non_ascii_description_loads(self, temp_dir, valid_manifest_data):
+ """Regression for #2325: non-ASCII (UTF-8) description loads on any platform.
+
+ On Windows, Python's default text-mode encoding is the locale codepage
+ (e.g. cp1252/GBK), which raises UnicodeDecodeError on UTF-8 bytes
+ outside the ASCII range. The loader must open with encoding='utf-8'.
+ """
+ import yaml
+
+ valid_manifest_data["extension"]["description"] = "中文测试 — émojis 🚀"
+ manifest_path = temp_dir / "extension.yml"
+ # Write UTF-8 bytes explicitly so the test exercises the read path,
+ # not the (locale-dependent) write path.
+ manifest_path.write_bytes(
+ yaml.safe_dump(valid_manifest_data, allow_unicode=True).encode("utf-8")
+ )
+
+ manifest = ExtensionManifest(manifest_path)
+ assert manifest.description == "中文测试 — émojis 🚀"
+
+ def test_invalid_utf8_bytes_raises_validation_error(self, temp_dir):
+ """Negative case: file containing invalid UTF-8 bytes raises ValidationError, not raw UnicodeDecodeError."""
+ manifest_path = temp_dir / "extension.yml"
+ # 0xFF/0xFE are not valid UTF-8 lead bytes.
+ manifest_path.write_bytes(b"\xff\xfe not valid utf-8 \xff\n")
+
+ with pytest.raises(ValidationError, match="not valid UTF-8"):
+ ExtensionManifest(manifest_path)
+
def test_invalid_extension_id(self, temp_dir, valid_manifest_data):
"""Test manifest with invalid extension ID format."""
import yaml
diff --git a/tests/test_presets.py b/tests/test_presets.py
index ee4a6dddb..4b167ed9b 100644
--- a/tests/test_presets.py
+++ b/tests/test_presets.py
@@ -160,6 +160,38 @@ class TestPresetManifest:
with pytest.raises(PresetValidationError, match="Invalid YAML"):
PresetManifest(bad_file)
+ def test_utf8_non_ascii_description_loads(self, temp_dir, valid_pack_data):
+ """Regression for #2325: non-ASCII (UTF-8) description loads on any platform.
+
+ On Windows, Python's default text-mode encoding is the locale codepage
+ (e.g. cp1252/GBK), which raises UnicodeDecodeError on UTF-8 bytes
+ outside the ASCII range. The loader must open with encoding='utf-8'.
+ """
+ valid_pack_data["preset"]["description"] = "中文测试 — émojis 🚀"
+ manifest_path = temp_dir / "preset.yml"
+ manifest_path.write_bytes(
+ yaml.safe_dump(valid_pack_data, allow_unicode=True).encode("utf-8")
+ )
+
+ manifest = PresetManifest(manifest_path)
+ assert manifest.description == "中文测试 — émojis 🚀"
+
+ def test_invalid_utf8_bytes_raises_validation_error(self, temp_dir):
+ """Negative case: file containing invalid UTF-8 bytes raises PresetValidationError, not raw UnicodeDecodeError."""
+ manifest_path = temp_dir / "preset.yml"
+ manifest_path.write_bytes(b"\xff\xfe not valid utf-8 \xff\n")
+
+ with pytest.raises(PresetValidationError, match="not valid UTF-8"):
+ PresetManifest(manifest_path)
+
+ def test_non_mapping_yaml_raises_validation_error(self, temp_dir):
+ """Manifest whose YAML root is a scalar or list raises PresetValidationError, not TypeError."""
+ manifest_path = temp_dir / "preset.yml"
+ for bad_content in ("42\n", "[1, 2]\n"):
+ manifest_path.write_text(bad_content, encoding="utf-8")
+ with pytest.raises(PresetValidationError, match="YAML mapping"):
+ PresetManifest(manifest_path)
+
def test_missing_schema_version(self, temp_dir, valid_pack_data):
"""Test missing schema_version field."""
del valid_pack_data["schema_version"]