Skip to content

Format field comments also as docstrings #304

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
merged 3 commits into from
Jan 26, 2022
Merged

Format field comments also as docstrings #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e94ac70
Format field comments also as docstrings
michaelosthege Dec 24, 2021
882a5d4
Fix placement of enum item docstrings
michaelosthege Dec 24, 2021
48b25a2
Add line breaks after class attribute or enum item docstrings
michaelosthege Dec 24, 2021
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
16 changes: 6 additions & 10 deletions src/betterproto/plugin/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,17 +147,13 @@ def get_comment(
sci_loc.leading_comments.strip().replace("\n", ""), width=79 - indent
)

if path[-2] == 2 and path[-4] != 6:
# This is a field
return f"{pad}# " + f"\n{pad}# ".join(lines)
# This is a field, message, enum, service, or method
if len(lines) == 1 and len(lines[0]) < 79 - indent - 6:
lines[0] = lines[0].strip('"')
return f'{pad}"""{lines[0]}"""'
else:
# This is a message, enum, service, or method
if len(lines) == 1 and len(lines[0]) < 79 - indent - 6:
lines[0] = lines[0].strip('"')
return f'{pad}"""{lines[0]}"""'
else:
joined = f"\n{pad}".join(lines)
return f'{pad}"""\n{pad}{joined}\n{pad}"""'
joined = f"\n{pad}".join(lines)
return f'{pad}"""\n{pad}{joined}\n{pad}"""'

return ""

Expand Down
6 changes: 4 additions & 2 deletions src/betterproto/templates/template.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ class {{ enum.py_name }}(betterproto.Enum):

{% endif %}
{% for entry in enum.entries %}
{{ entry.name }} = {{ entry.value }}
{% if entry.comment %}
{{ entry.comment }}

{% endif %}
{{ entry.name }} = {{ entry.value }}
{% endfor %}


Expand All @@ -45,10 +46,11 @@ class {{ message.py_name }}(betterproto.Message):

{% endif %}
{% for field in message.fields %}
{{ field.get_field_string() }}
{% if field.comment %}
{{ field.comment }}

{% endif %}
{{ field.get_field_string() }}
{% endfor %}
{% if not message.fields %}
pass
Expand Down