refactor: Use string and integer enumerations

By using string and integer enumerations, the enumeration values can then be compared to actual strings and integers, without using their `.value` attribute.

This also means that the enumeration values can now be serialized to JSON without special casing them.

pyproject.toml

@@ -31,6 +31,7 @@ classifiers = [
 ]
 dependencies = [
     "astunparse>=1.6; python_version < '3.9'",
+    "backports-strenum>=1.3; python_version < '3.11'",
     "colorama>=0.4",
 ]
 

src/_griffe/encoders.py

@@ -13,7 +13,7 @@
 from typing import TYPE_CHECKING, Any, Callable
 
 from _griffe import expressions
-from _griffe.enumerations import DocstringSectionKind, Kind, ParameterKind
+from _griffe.enumerations import Kind, ParameterKind
 from _griffe.models import (
     Alias,
     Attribute,
@@ -26,25 +26,15 @@
     Parameter,
     Parameters,
 )
-from griffe.enumerations import DocstringSectionKind, Kind, ParameterKind
 
 if TYPE_CHECKING:
-    from enum import Enum
-
-    from griffe.enumerations import Parser
-
-
-def _enum_value(obj: Enum) -> str | int:
-    return obj.value
+    from _griffe.enumerations import Parser
 
 
 _json_encoder_map: dict[type, Callable[[Any], Any]] = {
     Path: str,
     PosixPath: str,
     WindowsPath: str,
-    ParameterKind: _enum_value,
-    Kind: _enum_value,
-    DocstringSectionKind: _enum_value,
     set: sorted,
 }
 

src/_griffe/enumerations.py

@@ -2,10 +2,36 @@
 
 from __future__ import annotations
 
-import enum
-
-
-class DocstringSectionKind(enum.Enum):
+import sys
+from enum import IntEnum
+
+# YORE: Bump 1.0.0: Replace block with line 2.
+if sys.version_info >= (3, 11):
+    from enum import StrEnum
+else:
+    from backports.strenum import StrEnum
+
+
+class LogLevel(StrEnum):
+    """Enumeration of available log levels."""
+
+    trace: str = "trace"
+    """The TRACE log level."""
+    debug: str = "debug"
+    """The DEBUG log level."""
+    info: str = "info"
+    """The INFO log level."""
+    success: str = "success"
+    """The SUCCESS log level."""
+    warning: str = "warning"
+    """The WARNING log level."""
+    error: str = "error"
+    """The ERROR log level."""
+    critical: str = "critical"
+    """The CRITICAL log level."""
+
+
+class DocstringSectionKind(StrEnum):
     """Enumeration of the possible docstring section kinds."""
 
     text = "text"
@@ -40,7 +66,7 @@ class DocstringSectionKind(enum.Enum):
     """Admonition block."""
 
 
-class ParameterKind(enum.Enum):
+class ParameterKind(StrEnum):
     """Enumeration of the different parameter kinds."""
 
     positional_only: str = "positional-only"
@@ -55,7 +81,7 @@ class ParameterKind(enum.Enum):
     """Variadic keyword parameter."""
 
 
-class Kind(enum.Enum):
+class Kind(StrEnum):
     """Enumeration of the different object kinds."""
 
     MODULE: str = "module"
@@ -70,7 +96,7 @@ class Kind(enum.Enum):
     """Aliases (imported objects)."""
 
 
-class ExplanationStyle(enum.Enum):
+class ExplanationStyle(StrEnum):
     """Enumeration of the possible styles for explanations."""
 
     ONE_LINE: str = "oneline"
@@ -83,7 +109,7 @@ class ExplanationStyle(enum.Enum):
     """Explanation as GitHub workflow commands warnings, adapted to CI."""
 
 
-class BreakageKind(enum.Enum):
+class BreakageKind(StrEnum):
     """Enumeration of the possible API breakages."""
 
     PARAMETER_MOVED: str = "Positional parameter was moved"
@@ -112,7 +138,7 @@ class BreakageKind(enum.Enum):
     """Base class was removed"""
 
 
-class Parser(enum.Enum):
+class Parser(StrEnum):
     """Enumeration of the different docstring parsers."""
 
     google = "google"
@@ -123,7 +149,7 @@ class Parser(enum.Enum):
     """Numpydoc-style docstrings parser."""
 
 
-class ObjectKind(enum.Enum):
+class ObjectKind(StrEnum):
     """Enumeration of the different runtime object kinds."""
 
     MODULE: str = "module"
@@ -158,7 +184,7 @@ def __str__(self) -> str:
 
 
 # YORE: Bump 1.0.0: Remove block.
-class When(enum.Enum):
+class When(IntEnum):
     """Enumeration of the different times at which an extension is used.
 
     Deprecated. This enumeration is used with the `VisitorExtension` and `InspectorExtension` classes,

src/_griffe/logger.py

@@ -32,22 +32,9 @@ def get_logger(name):
 from __future__ import annotations
 
 import logging
-from enum import Enum
 from typing import Any, Callable, ClassVar
 
 
-class LogLevel(Enum):
-    """Enumeration of available log levels."""
-
-    trace: str = "trace"
-    debug: str = "debug"
-    info: str = "info"
-    success: str = "success"
-    warning: str = "warning"
-    error: str = "error"
-    critical: str = "critical"
-
-
 class _Logger:
     _default_logger: Any = logging.getLogger
     _instances: ClassVar[dict[str, _Logger]] = {}