Skip to content

gh-106368: Add tests for formatting helpers in Argument Clinic #106415

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
erlend-aasland merged 3 commits into from
Jul 4, 2023
+164 −0
Merged

gh-106368: Add tests for formatting helpers in Argument Clinic #106415

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31680b6
gh-106368: Add tests for formatting helpers in Argument Clinic
erlend-aasland Jul 4, 2023
e641995
Pull in main
erlend-aasland Jul 4, 2023
84a2cce
Address review:
erlend-aasland Jul 4, 2023
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
Prev Previous commit
Address review: 
- Be explicit

- Ditch trivial test
  • Loading branch information
@erlend-aasland
erlend-aasland committed Jul 4, 2023
commit 84a2cce05f5d21006a2ce99206b38272c3829ef8
76 changes: 39 additions & 37 deletions Lib/test/test_clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1719,16 +1719,28 @@ def test_normalize_snippet(self):
two
three
"""
template = (
"{indent}one\n"
"{indent}two\n"
"{indent}three"

# Expected outputs:
zero_indent = (
"one\n"
"two\n"
"three"
)
for indent in 0, 4, 8:
expected = template.format(indent=" " * indent)
with self.subTest(snippet=snippet, indent=indent, expected=expected):
out = clinic.normalize_snippet(snippet, indent=indent)
self.assertEqual(out, expected)
four_indent = (
" one\n"
" two\n"
" three"
)
eight_indent = (
" one\n"
" two\n"
" three"
)
expected_outputs = {0: zero_indent, 4: four_indent, 8: eight_indent}
for indent, expected in expected_outputs.items():
with self.subTest(indent=indent):
actual = clinic.normalize_snippet(snippet, indent=indent)
self.assertEqual(actual, expected)

def test_accumulator(self):
acc = clinic.text_accumulator()
Expand All @@ -1744,14 +1756,6 @@ def test_accumulator(self):
self.assertEqual(acc.output(), "cd")
self.assertEqual(acc.output(), "")

def test_c_repr(self):
dataset = "", "a", "abc"
for line in dataset:
expected = f'"{line}"'
with self.subTest(line=line, expected=expected):
out = clinic.c_repr(line)
self.assertEqual(out, expected)

def test_quoted_for_c_string(self):
dataset = (
# input, expected
Expand Down Expand Up @@ -1790,19 +1794,18 @@ def test_format_escape(self):
self.assertEqual(out, expected)

def test_indent_all_lines(self):
Comment thread
erlend-aasland marked this conversation as resolved.
prefix = "prefix"
# Blank lines are expected to be unchanged.
self.assertEqual(clinic.indent_all_lines("", prefix=prefix), "")
self.assertEqual(clinic.indent_all_lines("", prefix="bar"), "")

lines = (
"one\n"
"two" # The missing newline is deliberate.
)
expected = (
f"{prefix}one\n"
f"{prefix}two"
"barone\n"
"bartwo"
)
out = clinic.indent_all_lines(lines, prefix=prefix)
out = clinic.indent_all_lines(lines, prefix="bar")
self.assertEqual(out, expected)

# If last line is empty, expect it to be unchanged.
Expand All @@ -1813,28 +1816,27 @@ def test_indent_all_lines(self):
""
)
expected = (
f"{prefix}\n"
f"{prefix}one\n"
f"{prefix}two\n"
f""
"bar\n"
"barone\n"
"bartwo\n"
""
)
out = clinic.indent_all_lines(lines, prefix=prefix)
out = clinic.indent_all_lines(lines, prefix="bar")
self.assertEqual(out, expected)

def test_suffix_all_lines(self):
suffix = "suffix"
# Blank lines are expected to be unchanged.
self.assertEqual(clinic.suffix_all_lines("", suffix=suffix), "")
self.assertEqual(clinic.suffix_all_lines("", suffix="foo"), "")

lines = (
"one\n"
"two" # The missing newline is deliberate.
)
expected = (
f"one{suffix}\n"
f"two{suffix}"
"onefoo\n"
"twofoo"
)
out = clinic.suffix_all_lines(lines, suffix=suffix)
out = clinic.suffix_all_lines(lines, suffix="foo")
self.assertEqual(out, expected)

# If last line is empty, expect it to be unchanged.
Expand All @@ -1845,12 +1847,12 @@ def test_suffix_all_lines(self):
""
)
expected = (
f"{suffix}\n"
f"one{suffix}\n"
f"two{suffix}\n"
f""
"foo\n"
"onefoo\n"
"twofoo\n"
""
)
out = clinic.suffix_all_lines(lines, suffix=suffix)
out = clinic.suffix_all_lines(lines, suffix="foo")
self.assertEqual(out, expected)


Expand Down