Skip to content

refactor: Improve handling of typed dicts #414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pawamoy merged 2 commits into from
Sep 20, 2025
+357 −54
Merged

refactor: Improve handling of typed dicts #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
251adc2
refactor: Improve handling of typed dicts
pawamoy Sep 20, 2025
93a3af0
fixup! refactor: Improve handling of typed dicts
pawamoy Sep 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 181 additions & 51 deletions src/griffe/_internal/extensions/unpack_typeddict.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,188 @@
# TODO: Support `extra_items=type`.
# TODO: Support `closed=True/False`.

from __future__ import annotations

from typing import TYPE_CHECKING, Any
import ast
from itertools import chain
from typing import TYPE_CHECKING, Any, TypedDict

from griffe._internal.docstrings.models import DocstringParameter, DocstringSectionParameters
from griffe._internal.docstrings.models import (
DocstringParameter,
DocstringSectionParameters,
)
from griffe._internal.enumerations import DocstringSectionKind, ParameterKind
from griffe._internal.expressions import Expr, ExprSubscript
from griffe._internal.extensions.base import Extension
from griffe._internal.models import Class, Docstring, Function, Parameter, Parameters

if TYPE_CHECKING:
from collections.abc import Iterable
from collections.abc import Iterable, Iterator


class _TypedDictAttr(TypedDict):
name: str
annotation: str | Expr | None
docstring: Docstring | None


def _unwrap_annotation(annotation: str | Expr | None, *, default_required: bool) -> tuple[str | Expr | None, bool]:
required = default_required

# Annotations can be written ReadOnly[Required[T]] or Required[ReadOnly[T]],
# so we unwrap a first time here and a second time at the end.
if isinstance(annotation, ExprSubscript) and annotation.canonical_path in {
"typing.ReadOnly",
"typing_extensions.ReadOnly",
}:
annotation = annotation.slice

# Unwrap `Required` and `NotRequired`, set `required` accordingly.
if isinstance(annotation, ExprSubscript):
if annotation.canonical_path in {
"typing.Required",
"typing_extensions.Required",
}:
annotation = annotation.slice
required = True
elif annotation.canonical_path in {
"typing.NotRequired",
"typing_extensions.NotRequired",
}:
annotation = annotation.slice
required = False

# Unwrap `ReadOnly` a second time here.
if isinstance(annotation, ExprSubscript) and annotation.canonical_path in {
"typing.ReadOnly",
"typing_extensions.ReadOnly",
}:
annotation = annotation.slice

return annotation, required


def _get_or_set_attrs(cls: Class) -> tuple[list[_TypedDictAttr], list[_TypedDictAttr]]:
if (attrs := cls.extra.get("unpack_typeddict", {}).get("_attributes")) is not None:
return attrs

# Inspect `total` keyword argument to determine default requiredness.
default_required = True
for arg, value in cls.keywords.items():
if arg == "total":
try:
total = ast.literal_eval(str(value))
except (ValueError, SyntaxError):
break
if total is True:
default_required = True
elif total is False:
default_required = False
break

# Extract attributes.
required_attrs = []
optional_attrs = []
for attr in cls.attributes.values():
annotation, required = _unwrap_annotation(attr.annotation, default_required=default_required)
if required:
required_attrs.append(
_TypedDictAttr(
name=attr.name,
annotation=annotation,
docstring=attr.docstring,
),
)
else:
optional_attrs.append(
_TypedDictAttr(
name=attr.name,
annotation=annotation,
docstring=attr.docstring,
),
)

cls.extra["unpack_typeddict"]["_attributes"] = (required_attrs, optional_attrs)
return (required_attrs, optional_attrs)

def _update_docstring(func: Function, parameters: Iterable[Parameter], kwparam: Parameter | None = None) -> None:

def _update_docstring(
func: Function,
required: Iterable[_TypedDictAttr],
optional: Iterable[_TypedDictAttr],
kwparam: Parameter | None = None,
) -> None:
if not func.docstring:
func.docstring = Docstring("", parent=func)

params_section = None
sections = func.docstring.parsed

# Find existing "Parameters" section.
section_gen = (section for section in sections if section.kind is DocstringSectionKind.parameters)
if kwparam and (params_section := next(section_gen, None)):
# Remove the `**kwargs` entry.
params_section = next(section_gen, None)

# Pop original variadic keyword parameter from section.
if kwparam and params_section is not None:
param_gen = (i for i, arg in enumerate(params_section.value) if arg.name.lstrip("*") == kwparam.name)
if (kwarg_pos := next(param_gen, None)) is not None:
params_section.value.pop(kwarg_pos)
else:
# Create a parameters section if none exists.
params_section = DocstringSectionParameters([])
func.docstring.parsed.append(params_section)
# Add entries for all parameters.
for param in parameters:
if param.name != "self":

# If we have required parameters, add them to the "Parameters" section.
if required:
# Create a "Parameters" section if none exists.
if params_section is None:
params_section = DocstringSectionParameters([])
func.docstring.parsed.append(params_section)

# Add required parameters to the section.
for attr in required:
params_section.value.append(
DocstringParameter(
name=param.name,
description=param.docstring.value if param.docstring else "",
annotation=param.annotation,
value=param.default,
name=attr["name"],
description=attr["docstring"].value if attr["docstring"] else "",
annotation=attr["annotation"],
),
)

# If we have optional parameters, add them to the "Parameters" section too,
# with a default value of `...`.
if optional:
# Create a "Parameters" section if none exists.
if params_section is None:
params_section = DocstringSectionParameters([])
func.docstring.parsed.append(params_section)

def _params_from_attrs(attrs: Iterable[Any]) -> Parameters:
return Parameters(
Parameter(name="self", kind=ParameterKind.positional_or_keyword),
*(
Parameter(
name=attr.name,
annotation=attr.annotation,
kind=ParameterKind.keyword_only,
default=attr.value,
docstring=attr.docstring,
# Add optional parameters to the section.
for attr in optional:
params_section.value.append(
DocstringParameter(
name=attr["name"],
description=attr["docstring"].value if attr["docstring"] else "",
annotation=attr["annotation"],
value="...",
),
)
for attr in attrs
),
)

# TODO: Add `**kwargs` parameter if extra items are allowed.


def _params_from_attrs(required: Iterable[_TypedDictAttr], optional: Iterable[_TypedDictAttr]) -> Iterator[Parameter]:
for attr in required:
yield Parameter(
name=attr["name"],
annotation=attr["annotation"],
kind=ParameterKind.keyword_only,
docstring=attr["docstring"],
)
for attr in optional:
yield Parameter(
name=attr["name"],
annotation=attr["annotation"],
kind=ParameterKind.keyword_only,
default="...",
docstring=attr["docstring"],
)


class UnpackTypedDictExtension(Extension):
Expand All @@ -67,19 +197,23 @@ def on_class(self, *, cls: Class, **kwargs: Any) -> None: # noqa: ARG002
else:
return

attributes = cls.attributes.values()
required, optional = _get_or_set_attrs(cls)

if "__init__" not in cls.members:
# Build the `__init__` method and add it to the class.
parameters = _params_from_attrs(attributes)
parameters = Parameters(
Parameter(name="self", kind=ParameterKind.positional_or_keyword),
*_params_from_attrs(required, optional),
)
# TODO: Add `**kwargs` parameter if extra items are allowed.
init = Function(name="__init__", parameters=parameters, returns="None")
cls.set_member("__init__", init)
# Update the `__init__` docstring.
_update_docstring(init, parameters)
_update_docstring(init, required, optional)

# Remove attributes from the class, as they are now in the `__init__` method.
for attr in attributes:
cls.del_member(attr.name)
for attr in chain(required, optional):
cls.del_member(attr["name"])

def on_function(self, *, func: Function, **kwargs: Any) -> None: # noqa: ARG002
"""Expand `**kwargs: Unpack[TypedDict]` in function signatures."""
Expand All @@ -102,26 +236,22 @@ def on_function(self, *, func: Function, **kwargs: Any) -> None: # noqa: ARG002
else:
return

if "__init__" in typed_dict.members:
# The `__init__` was already generated: use its parameters.
parameters = typed_dict["__init__"].parameters
else:
# Fallback to building parameters from attributes.
parameters = _params_from_attrs(typed_dict.attributes.values())
required, optional = _get_or_set_attrs(typed_dict)

# Update any parameter section in the docstring.
# We do this before updating the signature so that
# parsing the docstring doesn't emit warnings.
_update_docstring(func, parameters, parameter)
_update_docstring(func, required, optional, parameter)

# Update the function parameters.
del func.parameters[parameter.name]
for param in parameters:
if param.name != "self":
func.parameters[param.name] = Parameter(
name=param.name,
annotation=param.annotation,
kind=ParameterKind.keyword_only,
default=param.default,
docstring=param.docstring,
)
for param in _params_from_attrs(required, optional):
func.parameters[param.name] = Parameter(
name=param.name,
annotation=param.annotation,
kind=ParameterKind.keyword_only,
default=param.default,
docstring=param.docstring,
)

# TODO: Add `**kwargs` parameter if extra items are allowed.
Loading
Loading