Skip to content

gh-130167: Improve the error case for textwrap.dedent #132666

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.

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 5 commits into from
Apr 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions Lib/test/test_textwrap.py
Original file line number Diff line number Diff line change
Expand Up @@ -765,6 +765,13 @@ def test_subsequent_indent(self):
# of IndentTestCase!
class DedentTestCase(unittest.TestCase):

def test_type_error(self):
with self.assertRaisesRegex(TypeError, "expected str object, not"):
dedent(0)

with self.assertRaisesRegex(TypeError, "expected str object, not"):
dedent(b'')

def assertUnchanged(self, text):
"""assert that dedent() has no effect on 'text'"""
self.assertEqual(text, dedent(text))
Expand Down
9 changes: 5 additions & 4 deletions Lib/textwrap.py
Original file line number Diff line number Diff line change
Expand Up @@ -426,10 +426,11 @@ def dedent(text):

Entirely blank lines are normalized to a newline character.
"""
if not text:
return text

lines = text.split('\n')
try:
lines = text.split('\n')
except (AttributeError, TypeError):
msg = f'expected str object, not {type(text).__qualname__!r}'
raise TypeError(msg) from None

# Get length of leading whitespace, inspired by ``os.path.commonprefix()``.
non_blank_lines = [l for l in lines if l and not l.isspace()]
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.14.0a7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ Improve the import time of the :mod:`ast` module by extracting the
.. nonce: 8M-HVz
.. section: Library

Improved performance of :func:`textwrap.dedent` by an average of ~1.3x.
Improved performance of :func:`textwrap.indent` by an average of ~1.3x.
Patch by Adam Turner.

..
Expand Down
Loading