Skip to content

(WIP) Generate field description rather than docstring #54

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

Open
devxoul wants to merge 1 commit into
base: main
Choose a base branch
from
Open

(WIP) Generate field description rather than docstring #54

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
27 changes: 17 additions & 10 deletions turms/recurse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,12 @@ def type_field_node(
target = target_from_node(node)
field_name = registry.generate_node_name(target)

field_description = (
field.description
if not field.deprecation_reason
else f"DEPRECATED {field.deprecation_reason}: : {field.description} "
)

if target != field_name:
registry.register_import("pydantic.Field")
assign = ast.AnnAssign(
Expand All @@ -571,7 +577,10 @@ def type_field_node(
value=ast.Call(
func=ast.Name(id="Field", ctx=ast.Load()),
args=[],
keywords=[ast.keyword(arg="alias", value=ast.Constant(value=target))],
keywords=[
ast.keyword(arg="alias", value=ast.Constant(value=target)),
ast.keyword(arg="description", value=ast.Constant(value=field_description)),
],
),
simple=1,
)
Expand All @@ -588,21 +597,19 @@ def type_field_node(
registry,
is_optional=is_optional,
),
value=ast.Call(
func=ast.Name(id="Field", ctx=ast.Load()),
args=[],
keywords=[
ast.keyword(arg="description", value=ast.Constant(value=field_description)),
],
),
simple=1,
)

potential_comment = (
field.description
if not field.deprecation_reason
else f"DEPRECATED {field.deprecation_reason}: : {field.description} "
)

if field.deprecation_reason:
registry.warn(
f"Field {node.name.value} on {parent} is deprecated: {field.deprecation_reason}"
)

if potential_comment:
return [assign, ast.Expr(value=ast.Constant(value=potential_comment))]

return [assign]