|
| 1 | +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +from __future__ import annotations |
| 5 | + |
| 6 | +import re |
| 7 | + |
| 8 | +from pathlib import Path |
| 9 | +from typing import Any, Callable, Dict, List, Optional |
| 10 | +from dataclasses import dataclass, field |
| 11 | + |
| 12 | +from aws_doc_sdk_examples_tools import metadata_errors |
| 13 | +from .metadata_errors import ( |
| 14 | + MetadataErrors, |
| 15 | +) |
| 16 | + |
| 17 | + |
| 18 | +def fake_gotmpl(tmpl: Optional[str], service: str, action: str): |
| 19 | + if not tmpl: |
| 20 | + return |
| 21 | + values = { |
| 22 | + ".ServiceEntity.Short": service, |
| 23 | + ".Action": action, |
| 24 | + } |
| 25 | + return re.sub( |
| 26 | + r"{{(?P<name>[.\w]+)}}", |
| 27 | + lambda x: values[ |
| 28 | + x.groupdict()["name"] |
| 29 | + ], # This will be a KeyError if the replacement isn't in the values dict |
| 30 | + tmpl, |
| 31 | + ) |
| 32 | + |
| 33 | + |
| 34 | +@dataclass |
| 35 | +class TitleInfo: |
| 36 | + title: Optional[str] = field(default=None) |
| 37 | + title_abbrev: Optional[str] = field(default=None) |
| 38 | + synopsis: Optional[str] = field(default=None) |
| 39 | + title_suffixes: str | Dict[str, str] = field(default_factory=dict) |
| 40 | + |
| 41 | + @classmethod |
| 42 | + def from_yaml(cls, yaml: Dict[str, str] | None) -> Optional[TitleInfo]: |
| 43 | + if yaml is None: |
| 44 | + return None |
| 45 | + |
| 46 | + title = yaml.get("title") |
| 47 | + title_suffixes: str | Dict[str, str] = yaml.get("title_suffixes", {}) |
| 48 | + title_abbrev = yaml.get("title_abbrev") |
| 49 | + synopsis = yaml.get("synopsis") |
| 50 | + |
| 51 | + return cls( |
| 52 | + title=title, |
| 53 | + title_suffixes=title_suffixes, |
| 54 | + title_abbrev=title_abbrev, |
| 55 | + synopsis=synopsis, |
| 56 | + ) |
| 57 | + |
| 58 | + |
| 59 | +@dataclass |
| 60 | +class Prefix: |
| 61 | + one: Optional[str] |
| 62 | + many: Optional[str] |
| 63 | + |
| 64 | + @classmethod |
| 65 | + def from_yaml(cls, yaml: Optional[Dict[str, str]]) -> Optional[Prefix]: |
| 66 | + if yaml is None: |
| 67 | + return None |
| 68 | + |
| 69 | + one = yaml.get("one") |
| 70 | + many = yaml.get("many") |
| 71 | + |
| 72 | + return cls( |
| 73 | + one=one, |
| 74 | + many=many, |
| 75 | + ) |
| 76 | + |
| 77 | + |
| 78 | +@dataclass |
| 79 | +class CategoryWithNoDisplayError(metadata_errors.MetadataError): |
| 80 | + def message(self): |
| 81 | + return "Category has no display value" |
| 82 | + |
| 83 | + |
| 84 | +empty_title_info = TitleInfo() |
| 85 | + |
| 86 | + |
| 87 | +@dataclass |
| 88 | +class Category: |
| 89 | + key: str |
| 90 | + display: str |
| 91 | + defaults: Optional[TitleInfo] = field(default=None) |
| 92 | + overrides: Optional[TitleInfo] = field(default=None) |
| 93 | + description: Optional[str] = field(default=None) |
| 94 | + synopsis_prefix: Optional[Prefix] = field(default=None) |
| 95 | + more_info: Optional[str] = field(default=None) |
| 96 | + |
| 97 | + def evaluate( |
| 98 | + self, |
| 99 | + value: Optional[str], |
| 100 | + field: Callable[[TitleInfo], Optional[str]], |
| 101 | + service: str, |
| 102 | + action: str, |
| 103 | + ): |
| 104 | + overrides = field(self.overrides or empty_title_info) |
| 105 | + if overrides: |
| 106 | + return fake_gotmpl(overrides, service, action) |
| 107 | + if value: |
| 108 | + return value |
| 109 | + defaults = field(self.defaults or empty_title_info) |
| 110 | + if defaults: |
| 111 | + return fake_gotmpl(defaults, service, action) |
| 112 | + return f"{service} {action}" |
| 113 | + |
| 114 | + def validate(self, errors: MetadataErrors): |
| 115 | + if not self.display: |
| 116 | + errors.append(CategoryWithNoDisplayError(id=self.key)) |
| 117 | + |
| 118 | + @classmethod |
| 119 | + def from_yaml( |
| 120 | + cls, key: str, yaml: Dict[str, Any] |
| 121 | + ) -> tuple[Category, MetadataErrors]: |
| 122 | + errors = MetadataErrors() |
| 123 | + display = str(yaml.get("display")) |
| 124 | + defaults = TitleInfo.from_yaml(yaml.get("defaults")) |
| 125 | + overrides = TitleInfo.from_yaml(yaml.get("overrides")) |
| 126 | + description = yaml.get("description") |
| 127 | + synopsis_prefix = Prefix.from_yaml(yaml.get("synopsis_prefix")) |
| 128 | + more_info = yaml.get("more_info") |
| 129 | + |
| 130 | + return ( |
| 131 | + cls( |
| 132 | + key=key, |
| 133 | + display=display, |
| 134 | + defaults=defaults, |
| 135 | + overrides=overrides, |
| 136 | + description=description, |
| 137 | + synopsis_prefix=synopsis_prefix, |
| 138 | + more_info=more_info, |
| 139 | + ), |
| 140 | + errors, |
| 141 | + ) |
| 142 | + |
| 143 | + |
| 144 | +def parse( |
| 145 | + file: Path, yaml: Dict[str, Any] |
| 146 | +) -> tuple[List[str], Dict[str, Category], MetadataErrors]: |
| 147 | + categories: Dict[str, Category] = {} |
| 148 | + errors = MetadataErrors() |
| 149 | + |
| 150 | + standard_cats = yaml.get("standard_categories", []) |
| 151 | + # Work around inconsistency where some tools use 'Actions' and DocGen uses 'Api' to refer to single-action examples. |
| 152 | + for i in range(len(standard_cats)): |
| 153 | + if standard_cats[i] == "Actions": |
| 154 | + standard_cats[i] = "Api" |
| 155 | + for key, yaml_cat in yaml.get("categories", {}).items(): |
| 156 | + if yaml_cat is None: |
| 157 | + errors.append(metadata_errors.MissingCategoryBody(id=key, file=file)) |
| 158 | + else: |
| 159 | + category, cat_errs = Category.from_yaml(key, yaml_cat) |
| 160 | + categories[key] = category |
| 161 | + for error in cat_errs: |
| 162 | + error.file = file |
| 163 | + error.id = key |
| 164 | + errors.extend(cat_errs) |
| 165 | + |
| 166 | + return standard_cats, categories, errors |
| 167 | + |
| 168 | + |
| 169 | +if __name__ == "__main__": |
| 170 | + from pprint import pp |
| 171 | + import yaml |
| 172 | + |
| 173 | + path = Path(__file__).parent / "config" / "categories.yaml" |
| 174 | + with open(path) as file: |
| 175 | + meta = yaml.safe_load(file) |
| 176 | + standard_cats, cats, errs = parse(path, meta) |
| 177 | + pp(standard_cats) |
| 178 | + pp(cats) |
0 commit comments