Re-raise annotated_yaml.YAMLException as HomeAssistantError (home-assistant#147129)

* Re-raise annotated_yaml.YAMLException as HomeAssistantError

* Fix comment

Author: emontnemery

homeassistant/util/yaml/loader.py

@@ -6,7 +6,7 @@
 import os
 from typing import TextIO
 
-from annotatedyaml import YAMLException, YamlTypeError
+import annotatedyaml
 from annotatedyaml.loader import (
     HAS_C_LOADER,
     JSON_TYPE,
@@ -35,6 +35,10 @@
 ]
 
 
+class YamlTypeError(HomeAssistantError):
+    """Raised by load_yaml_dict if top level data is not a dict."""
+
+
 def load_yaml(
     fname: str | os.PathLike[str], secrets: Secrets | None = None
 ) -> JSON_TYPE | None:
@@ -45,7 +49,7 @@ def load_yaml(
     """
     try:
         return load_annotated_yaml(fname, secrets)
-    except YAMLException as exc:
+    except annotatedyaml.YAMLException as exc:
         raise HomeAssistantError(str(exc)) from exc
 
 
@@ -59,9 +63,9 @@ def load_yaml_dict(
     """
     try:
         return load_annotated_yaml_dict(fname, secrets)
-    except YamlTypeError:
-        raise
-    except YAMLException as exc:
+    except annotatedyaml.YamlTypeError as exc:
+        raise YamlTypeError(str(exc)) from exc
+    except annotatedyaml.YAMLException as exc:
         raise HomeAssistantError(str(exc)) from exc
 
 
@@ -71,13 +75,13 @@ def parse_yaml(
     """Parse YAML with the fastest available loader."""
     try:
         return parse_annotated_yaml(content, secrets)
-    except YAMLException as exc:
+    except annotatedyaml.YAMLException as exc:
         raise HomeAssistantError(str(exc)) from exc
 
 
 def secret_yaml(loader: LoaderType, node: yaml.nodes.Node) -> JSON_TYPE:
     """Load secrets and embed it into the configuration YAML."""
     try:
         return annotated_secret_yaml(loader, node)
-    except YAMLException as exc:
+    except annotatedyaml.YAMLException as exc:
         raise HomeAssistantError(str(exc)) from exc

tests/util/yaml/test_init.py

@@ -559,6 +559,10 @@ def test_load_yaml_dict(expected_data: Any) -> None:
 @pytest.mark.usefixtures("try_both_loaders", "mock_hass_config_yaml")
 def test_load_yaml_dict_fail() -> None:
     """Test item without a key."""
+    # Make sure we raise a subclass of HomeAssistantError, not
+    # annotated_yaml.YAMLException
+    assert issubclass(yaml_loader.YamlTypeError, HomeAssistantError)
+
     with pytest.raises(yaml_loader.YamlTypeError):
         yaml_loader.load_yaml_dict(YAML_CONFIG_FILE)