Skip to content

Commit

Permalink
refactor(parts): separate yaml parsing from base errors
Browse files Browse the repository at this point in the history
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
  • Loading branch information
mr-cal committed Aug 31, 2023
1 parent fb2777f commit 8d0218e
Showing 1 changed file with 29 additions and 13 deletions.
42 changes: 29 additions & 13 deletions snapcraft/parts/yaml_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

from dataclasses import dataclass
from pathlib import Path
from typing import Any, Dict, List, TextIO
from typing import Any, Dict, List, TextIO, Optional

import yaml
import yaml.error
Expand Down Expand Up @@ -97,32 +97,48 @@ def __init__(self, *args, **kwargs):
)


def load(filestream: TextIO) -> Dict[str, Any]:
"""Load and parse a YAML-formatted file.
def get_base(filestream: TextIO) -> Optional[str]:
"""Get the effective base from a snapcraft.yaml file.
:param filename: The YAML file to load.
:raises SnapcraftError: if loading didn't succeed.
:raises LegacyFallback: if the project's base is a legacy base.
:returns: Effective base of the project or None if the base cannot be determined.
:raises SnapcraftError: If the yaml could not be loaded.
"""
try:
data = yaml.safe_load(filestream)
build_base = utils.get_effective_base(
return utils.get_effective_base(
base=data.get("base"),
build_base=data.get("build-base"),
project_type=data.get("type"),
name=data.get("name"),
)

if build_base is None:
raise errors.LegacyFallback("no base defined")
if build_base in _ESM_BASES:
raise errors.MaintenanceBase(build_base)
if build_base in _LEGACY_BASES:
raise errors.LegacyFallback(f"base is {build_base}")
except yaml.error.YAMLError as err:
raise errors.SnapcraftError(f"snapcraft.yaml parsing error: {err!s}") from err


def load(filestream: TextIO) -> Dict[str, Any]:
"""Load and parse a YAML-formatted file.
:param filename: The YAML file to load.
:returns: A dictionary of the yaml data.
:raises SnapcraftError: if loading didn't succeed.
:raises LegacyFallback: if the project's base is a legacy base.
:raises MaintenanceBase: if the base is not supported.
"""

build_base = get_base(filestream)

if build_base is None:
raise errors.LegacyFallback("no base defined")
if build_base in _ESM_BASES:
raise errors.MaintenanceBase(build_base)
if build_base in _LEGACY_BASES:
raise errors.LegacyFallback(f"base is {build_base}")

filestream.seek(0)

try:
Expand Down

0 comments on commit 8d0218e

Please sign in to comment.