Skip to content

Preserve docstrings in the new parser #21890

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
JukkaL merged 1 commit into from
Aug 25, 2026
+12 −0
Merged

Preserve docstrings in the new parser #21890

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions mypy/nativeparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,8 @@ def read_func_def(state: State, data: ReadBuffer) -> FuncDef:
# TODO: This seems wasteful, can we avoid it?
func_def.unanalyzed_type = typ.copy_modified()
expect_end_tag(data)
if state.options.include_docstrings:
func_def.docstring = get_docstring(body)
return func_def


Expand Down Expand Up @@ -769,9 +771,19 @@ def read_class_def(state: State, data: ReadBuffer) -> ClassDef:
)
check_type_param_defaults(state, type_params, class_def.line, class_def.column)
expect_end_tag(data)
if state.options.include_docstrings:
class_def.docstring = get_docstring(body)
return class_def


def get_docstring(body: Block) -> str | None:
if body.body and isinstance(body.body[0], ExpressionStmt):
expr = body.body[0].expr
if isinstance(expr, StrExpr):
return expr.value
return None


def read_type_alias_stmt(state: State, data: ReadBuffer) -> TypeAliasStmt:
"""Read PEP 695 type alias statement."""
name = read_expression(state, data)
Expand Down
Loading