|
| 1 | +import warnings |
| 2 | +from typing import Dict, Hashable, Iterable, List |
| 3 | + |
| 4 | +STAR = " * " |
| 5 | +TAB = len(STAR) * " " |
| 6 | + |
| 7 | + |
| 8 | +def _format_missing_row(row: str, rich: bool) -> str: |
| 9 | + if rich: |
| 10 | + return f"[grey62]{row}[/grey62]" |
| 11 | + else: |
| 12 | + return row |
| 13 | + |
| 14 | + |
| 15 | +def _format_varname(name, rich: bool): |
| 16 | + return name |
| 17 | + |
| 18 | + |
| 19 | +def _format_subtitle(name: str, rich: bool) -> str: |
| 20 | + if rich: |
| 21 | + return f"[bold]{name}[/bold]" |
| 22 | + else: |
| 23 | + return name |
| 24 | + |
| 25 | + |
| 26 | +def _format_cf_name(name: str, rich: bool) -> str: |
| 27 | + if rich: |
| 28 | + return f"[color(33)]{name}[/color(33)]" |
| 29 | + else: |
| 30 | + return name |
| 31 | + |
| 32 | + |
| 33 | +def make_text_section( |
| 34 | + accessor, |
| 35 | + subtitle: str, |
| 36 | + attr: str, |
| 37 | + dims=None, |
| 38 | + valid_values=None, |
| 39 | + default_keys=None, |
| 40 | + rich: bool = False, |
| 41 | +): |
| 42 | + |
| 43 | + from .accessor import sort_maybe_hashable |
| 44 | + |
| 45 | + if dims is None: |
| 46 | + dims = [] |
| 47 | + with warnings.catch_warnings(): |
| 48 | + warnings.simplefilter("ignore") |
| 49 | + try: |
| 50 | + vardict: Dict[str, Iterable[Hashable]] = getattr(accessor, attr, {}) |
| 51 | + except ValueError: |
| 52 | + vardict = {} |
| 53 | + |
| 54 | + # Sort keys if there aren't extra keys, |
| 55 | + # preserve default keys order otherwise. |
| 56 | + default_keys = [] if not default_keys else list(default_keys) |
| 57 | + extra_keys = list(set(vardict) - set(default_keys)) |
| 58 | + ordered_keys = sorted(vardict) if extra_keys else default_keys |
| 59 | + vardict = {key: vardict[key] for key in ordered_keys if key in vardict} |
| 60 | + |
| 61 | + # Keep only valid values (e.g., coords or data_vars) |
| 62 | + if valid_values is not None: |
| 63 | + vardict = { |
| 64 | + key: set(value).intersection(valid_values) |
| 65 | + for key, value in vardict.items() |
| 66 | + if set(value).intersection(valid_values) |
| 67 | + } |
| 68 | + |
| 69 | + # Star for keys with dims only, tab otherwise |
| 70 | + rows = [ |
| 71 | + ( |
| 72 | + f"{STAR if dims and set(value) <= set(dims) else TAB}" |
| 73 | + f"{_format_cf_name(key, rich)}: " |
| 74 | + f"{_format_varname(sort_maybe_hashable(value), rich)}" |
| 75 | + ) |
| 76 | + for key, value in vardict.items() |
| 77 | + ] |
| 78 | + |
| 79 | + # Append missing default keys followed by n/a |
| 80 | + if default_keys: |
| 81 | + missing_keys = [key for key in default_keys if key not in vardict] |
| 82 | + if missing_keys: |
| 83 | + rows.append( |
| 84 | + _format_missing_row(TAB + ", ".join(missing_keys) + ": n/a", rich) |
| 85 | + ) |
| 86 | + elif not rows: |
| 87 | + rows.append(_format_missing_row(TAB + "n/a", rich)) |
| 88 | + |
| 89 | + return _print_rows(subtitle, rows, rich) |
| 90 | + |
| 91 | + |
| 92 | +def _print_rows(subtitle: str, rows: List[str], rich: bool): |
| 93 | + subtitle = f"{subtitle.rjust(20)}:" |
| 94 | + |
| 95 | + # Add subtitle to the first row, align other rows |
| 96 | + rows = [ |
| 97 | + _format_subtitle(subtitle, rich=rich) + row |
| 98 | + if i == 0 |
| 99 | + else len(subtitle) * " " + row |
| 100 | + for i, row in enumerate(rows) |
| 101 | + ] |
| 102 | + |
| 103 | + return "\n".join(rows) + "\n\n" |
| 104 | + |
| 105 | + |
| 106 | +def _format_conventions(string: str, rich: bool): |
| 107 | + row = _print_rows( |
| 108 | + subtitle="Conventions", |
| 109 | + rows=[_format_cf_name(TAB + string, rich=rich)], |
| 110 | + rich=rich, |
| 111 | + ) |
| 112 | + if rich: |
| 113 | + row = row.rstrip() |
| 114 | + return row |
| 115 | + |
| 116 | + |
| 117 | +def _maybe_panel(textgen, title: str, rich: bool): |
| 118 | + text = "".join(textgen) |
| 119 | + if rich: |
| 120 | + from rich.panel import Panel |
| 121 | + |
| 122 | + return Panel( |
| 123 | + f"[color(241)]{text.rstrip()}[/color(241)]", |
| 124 | + expand=True, |
| 125 | + title_align="left", |
| 126 | + title=f"[bold][color(244)]{title}[/bold][/color(244)]", |
| 127 | + highlight=True, |
| 128 | + width=100, |
| 129 | + ) |
| 130 | + else: |
| 131 | + return title + ":\n" + text |
| 132 | + |
| 133 | + |
| 134 | +def _format_flags(accessor, rich): |
| 135 | + from .accessor import create_flag_dict |
| 136 | + |
| 137 | + flag_dict = create_flag_dict(accessor._obj) |
| 138 | + rows = [ |
| 139 | + f"{TAB}{_format_varname(v, rich)}: {_format_cf_name(k, rich)}" |
| 140 | + for k, v in flag_dict.items() |
| 141 | + ] |
| 142 | + return _print_rows("Flag Meanings", rows, rich) |
| 143 | + |
| 144 | + |
| 145 | +def _format_roles(accessor, dims, rich): |
| 146 | + yield make_text_section(accessor, "CF Roles", "cf_roles", dims=dims, rich=rich) |
| 147 | + |
| 148 | + |
| 149 | +def _format_coordinates(accessor, dims, coords, rich): |
| 150 | + from .accessor import _AXIS_NAMES, _CELL_MEASURES, _COORD_NAMES |
| 151 | + |
| 152 | + yield make_text_section( |
| 153 | + accessor, "CF Axes", "axes", dims, coords, _AXIS_NAMES, rich=rich |
| 154 | + ) |
| 155 | + yield make_text_section( |
| 156 | + accessor, "CF Coordinates", "coordinates", dims, coords, _COORD_NAMES, rich=rich |
| 157 | + ) |
| 158 | + yield make_text_section( |
| 159 | + accessor, |
| 160 | + "Cell Measures", |
| 161 | + "cell_measures", |
| 162 | + dims, |
| 163 | + coords, |
| 164 | + _CELL_MEASURES, |
| 165 | + rich=rich, |
| 166 | + ) |
| 167 | + yield make_text_section( |
| 168 | + accessor, "Standard Names", "standard_names", dims, coords, rich=rich |
| 169 | + ) |
| 170 | + yield make_text_section(accessor, "Bounds", "bounds", dims, coords, rich=rich) |
| 171 | + yield make_text_section( |
| 172 | + accessor, "Grid Mappings", "grid_mapping_names", dims, coords, rich=rich |
| 173 | + ) |
| 174 | + |
| 175 | + |
| 176 | +def _format_data_vars(accessor, data_vars, rich): |
| 177 | + from .accessor import _CELL_MEASURES |
| 178 | + |
| 179 | + yield make_text_section( |
| 180 | + accessor, |
| 181 | + "Cell Measures", |
| 182 | + "cell_measures", |
| 183 | + None, |
| 184 | + data_vars, |
| 185 | + _CELL_MEASURES, |
| 186 | + rich=rich, |
| 187 | + ) |
| 188 | + yield make_text_section( |
| 189 | + accessor, "Standard Names", "standard_names", None, data_vars, rich=rich |
| 190 | + ) |
| 191 | + yield make_text_section(accessor, "Bounds", "bounds", None, data_vars, rich=rich) |
| 192 | + yield make_text_section( |
| 193 | + accessor, "Grid Mappings", "grid_mapping_names", None, data_vars, rich=rich |
| 194 | + ) |
0 commit comments