feat: Parse keywords in class declarations

Author: pawamoy

docs/reference/api/expressions.md

@@ -14,6 +14,8 @@
 
 ::: griffe.get_base_class
 
+::: griffe.get_class_keyword
+
 ::: griffe.get_condition
 
 ::: griffe.get_expression
@@ -22,6 +24,8 @@
 
 ::: griffe.safe_get_base_class
 
+::: griffe.safe_get_class_keyword
+
 ::: griffe.safe_get_condition
 
 ::: griffe.safe_get_expression

src/griffe/__init__.py

@@ -127,10 +127,12 @@
 
 - [`griffe.get_annotation`][]: Get a type annotation as expression.
 - [`griffe.get_base_class`][]: Get a base class as expression.
+- [`griffe.get_class_keyword`][]: Get a class keyword as expression.
 - [`griffe.get_condition`][]: Get a condition as expression.
 - [`griffe.get_expression`][]: Get an expression from an AST node.
 - [`griffe.safe_get_annotation`][]: Get a type annotation as expression, safely (returns `None` on error).
 - [`griffe.safe_get_base_class`][]: Get a base class as expression, safely (returns `None` on error).
+- [`griffe.safe_get_class_keyword`][]: Get a class keyword as expression, safely (returns `None` on error).
 - [`griffe.safe_get_condition`][]: Get a condition as expression, safely (returns `None` on error).
 - [`griffe.safe_get_expression`][]: Get an expression from an AST node, safely (returns `None` on error).
 
@@ -321,10 +323,12 @@
     ExprYieldFrom,
     get_annotation,
     get_base_class,
+    get_class_keyword,
     get_condition,
     get_expression,
     safe_get_annotation,
     safe_get_base_class,
+    safe_get_class_keyword,
     safe_get_condition,
     safe_get_expression,
 )
@@ -582,6 +586,7 @@ def __getattr__(name: str) -> Any:
     "get__all__",
     "get_annotation",
     "get_base_class",
+    "get_class_keyword",
     "get_condition",
     "get_docstring",
     "get_expression",
@@ -618,6 +623,7 @@ def __getattr__(name: str) -> Any:
     "safe_get__all__",
     "safe_get_annotation",
     "safe_get_base_class",
+    "safe_get_class_keyword",
     "safe_get_condition",
     "safe_get_expression",
     "safe_get_value",

src/griffe/_internal/agents/visitor.py

@@ -26,6 +26,7 @@
     ExprName,
     safe_get_annotation,
     safe_get_base_class,
+    safe_get_class_keyword,
     safe_get_condition,
     safe_get_expression,
 )
@@ -320,8 +321,11 @@ def visit_classdef(self, node: ast.ClassDef) -> None:
         else:
             lineno = node.lineno
 
-        # Handle base classes.
+        # Handle base classes and keywords.
         bases = [safe_get_base_class(base, parent=self.current, member=node.name) for base in node.bases]
+        keywords = {
+            kw.arg: safe_get_class_keyword(kw.value, parent=self.current) for kw in node.keywords if kw.arg is not None
+        }
 
         class_ = Class(
             name=node.name,
@@ -331,6 +335,7 @@ def visit_classdef(self, node: ast.ClassDef) -> None:
             decorators=decorators,
             type_parameters=TypeParameters(*self._get_type_parameters(node, scope=node.name)),
             bases=bases,  # type: ignore[arg-type]
+            keywords=keywords,
             runtime=not self.type_guarded,
             analysis="static",
         )

src/griffe/_internal/expressions.py

@@ -1492,6 +1492,12 @@ def safe_get_expression(
     parse_strings=False,
     msg_format=_msg_format % "base class",
 )
+get_class_keyword = partial(get_expression, parse_strings=False)
+safe_get_class_keyword = partial(
+    safe_get_expression,
+    parse_strings=False,
+    msg_format=_msg_format % "class keyword",
+)
 get_condition = partial(get_expression, parse_strings=False)
 safe_get_condition = partial(
     safe_get_expression,

src/griffe/_internal/models.py

@@ -1910,6 +1910,11 @@ def bases(self) -> list[Expr | str]:
         """
         return cast("Class", self.final_target).bases
 
+    @property
+    def keywords(self) -> dict[str, Expr | str]:
+        """The class keywords."""
+        return cast("Class", self.final_target).keywords
+
     @property
     def decorators(self) -> list[Decorator]:
         """The class/function decorators.
@@ -2354,6 +2359,7 @@ def __init__(
         *args: Any,
         bases: Sequence[Expr | str] | None = None,
         decorators: list[Decorator] | None = None,
+        keywords: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> None:
         """Initialize the class.
@@ -2362,6 +2368,7 @@ def __init__(
             *args: See [`griffe.Object`][].
             bases: The list of base classes, if any.
             decorators: The class decorators, if any.
+            keywords: The class keywords arguments, if any.
             **kwargs: See [`griffe.Object`][].
         """
         super().__init__(*args, **kwargs)
@@ -2376,6 +2383,9 @@ def __init__(
         self.decorators: list[Decorator] = decorators or []
         """The class decorators."""
 
+        self.keywords: dict[str, Any] = keywords or {}
+        """The class keywords arguments."""
+
         self.overloads: dict[str, list[Function]] = defaultdict(list)
         """The overloaded signatures declared in this class."""