|
2 | 2 | from __future__ import annotations |
3 | 3 |
|
4 | 4 | import contextlib |
| 5 | +import re |
5 | 6 | import shutil |
6 | 7 | import warnings |
7 | | -from collections.abc import Callable, Mapping, Sized |
| 8 | +from abc import ABC, abstractmethod |
| 9 | +from collections.abc import Callable, Iterable, Mapping, Sequence, Sized |
8 | 10 | from functools import wraps |
9 | 11 | from pathlib import Path |
10 | | -from typing import TYPE_CHECKING, Any, Literal, TypeVar, overload |
| 12 | +from typing import ( |
| 13 | + TYPE_CHECKING, |
| 14 | + Any, |
| 15 | + Literal, |
| 16 | + TypeVar, |
| 17 | + overload, |
| 18 | +) |
11 | 19 | from typing_extensions import ParamSpec |
12 | 20 |
|
13 | 21 | import numpy as np |
@@ -469,3 +477,57 @@ def update(self, length: int) -> None: |
469 | 477 | self._progress_bar.update(length) |
470 | 478 | if self._progress_bar.total <= self._progress_bar.n: |
471 | 479 | self._progress_bar.close() |
| 480 | + |
| 481 | + |
| 482 | +class ReprMixin(ABC): |
| 483 | + """A mixin class that provides a customizable string representation for OpenML objects. |
| 484 | +
|
| 485 | + This mixin standardizes the __repr__ output format across OpenML classes. |
| 486 | + Classes inheriting from this mixin should implement the |
| 487 | + _get_repr_body_fields method to specify which fields to display. |
| 488 | + """ |
| 489 | + |
| 490 | + def __repr__(self) -> str: |
| 491 | + body_fields = self._get_repr_body_fields() |
| 492 | + return self._apply_repr_template(body_fields) |
| 493 | + |
| 494 | + @abstractmethod |
| 495 | + def _get_repr_body_fields(self) -> Sequence[tuple[str, str | int | list[str] | None]]: |
| 496 | + """Collect all information to display in the __repr__ body. |
| 497 | +
|
| 498 | + Returns |
| 499 | + ------- |
| 500 | + body_fields : List[Tuple[str, Union[str, int, List[str]]]] |
| 501 | + A list of (name, value) pairs to display in the body of the __repr__. |
| 502 | + E.g.: [('metric', 'accuracy'), ('dataset', 'iris')] |
| 503 | + If value is a List of str, then each item of the list will appear in a separate row. |
| 504 | + """ |
| 505 | + # Should be implemented in the base class. |
| 506 | + |
| 507 | + def _apply_repr_template( |
| 508 | + self, |
| 509 | + body_fields: Iterable[tuple[str, str | int | list[str] | None]], |
| 510 | + ) -> str: |
| 511 | + """Generates the header and formats the body for string representation of the object. |
| 512 | +
|
| 513 | + Parameters |
| 514 | + ---------- |
| 515 | + body_fields: List[Tuple[str, str]] |
| 516 | + A list of (name, value) pairs to display in the body of the __repr__. |
| 517 | + """ |
| 518 | + # We add spaces between capitals, e.g. ClassificationTask -> Classification Task |
| 519 | + name_with_spaces = re.sub( |
| 520 | + r"(\w)([A-Z])", |
| 521 | + r"\1 \2", |
| 522 | + self.__class__.__name__[len("OpenML") :], |
| 523 | + ) |
| 524 | + header_text = f"OpenML {name_with_spaces}" |
| 525 | + header = f"{header_text}\n{'=' * len(header_text)}\n" |
| 526 | + |
| 527 | + _body_fields: list[tuple[str, str | int | list[str]]] = [ |
| 528 | + (k, "None" if v is None else v) for k, v in body_fields |
| 529 | + ] |
| 530 | + longest_field_name_length = max(len(name) for name, _ in _body_fields) |
| 531 | + field_line_format = f"{{:.<{longest_field_name_length}}}: {{}}" |
| 532 | + body = "\n".join(field_line_format.format(name, value) for name, value in _body_fields) |
| 533 | + return header + body |
0 commit comments