Skip to content

[FIX] Handle nested comment markers in multiline comments #182

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

Draft
Mirochill wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[FIX] Handle nested comment markers in multiline comments #182

Show file tree
Hide file tree
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
8 changes: 7 additions & 1 deletion nbs/00_core.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3274,13 +3274,19 @@
" \"Format multiline comments by replacing multiline comment [CI] by newline and adding indentation\"\n",
" split_s = s.split(\"\\n\")\n",
" split_out = []\n",
" comment_indentation = None\n",
" for sp in split_s: # loop on query lines\n",
" comment_start = re.search(r\"\\/\\*\", sp)\n",
" if comment_start:\n",
" comment_indentation = comment_start.start() + 3\n",
" if re.search(r\"\\[CI\\]\", sp):\n",
" indentation = re.search(r\"\\/\\*\", sp).start() + 3\n",
" indentation = comment_indentation if comment_indentation is not None else 0\n",
" sp_indent = re.sub(r\"\\[CI\\]\", \"\\n\" + \" \" * indentation, sp)\n",
" split_out.append(sp_indent)\n",
" else:\n",
" split_out.append(sp)\n",
" if re.search(r\"\\*\\/\", sp):\n",
" comment_indentation = None\n",
" s = \"\\n\".join(split_out)\n",
" return s"
]
Expand Down
40 changes: 40 additions & 0 deletions nbs/99_additional_tests.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,46 @@
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Multiline comment with an inline comment marker"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"SELECT 1\n",
"/*\n",
" --\n",
" */\n"
]
}
],
"source": [
"assert_and_print(\n",
" format_sql(\"\"\"\n",
"select 1\n",
"/*\n",
"--\n",
"*/\n",
"\"\"\"),\n",
"\"\"\"\n",
"SELECT 1\n",
"/*\n",
" --\n",
" */\n",
"\"\"\".strip()\n",
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
10 changes: 8 additions & 2 deletions sql_formatter/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,13 +421,19 @@ def format_multiline_comments(s):
"Format multiline comments by replacing multiline comment [CI] by newline and adding indentation"
split_s = s.split("\n")
split_out = []
comment_indentation = None
for sp in split_s: # loop on query lines
comment_start = re.search(r"\/\*", sp)
if comment_start:
comment_indentation = comment_start.start() + 3
if re.search(r"\[CI\]", sp):
indentation = re.search(r"\/\*", sp).start() + 3
indentation = comment_indentation if comment_indentation is not None else 0
sp_indent = re.sub(r"\[CI\]", "\n" + " " * indentation, sp)
split_out.append(sp_indent)
else:
split_out.append(sp)
if re.search(r"\*\/", sp):
comment_indentation = None
s = "\n".join(split_out)
return s

Expand Down Expand Up @@ -482,4 +488,4 @@ def format_sql(s, semicolon=False, max_len=82):
subquery_pos = extract_outer_subquery(s)
# remove whitespace between word and parenthesis
s = re.sub(r"\s*\)", ")", s)
return s
return s