Skip to content
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

Mark wraptext deprecated; use TextWrapper directly in write_po #1140

Merged
merged 2 commits into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
10 changes: 6 additions & 4 deletions babel/messages/pofile.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

from babel.core import Locale
from babel.messages.catalog import Catalog, Message
from babel.util import _cmp, wraptext
from babel.util import TextWrapper, _cmp

if TYPE_CHECKING:
from typing import IO, AnyStr
Expand Down Expand Up @@ -634,8 +634,11 @@ def generate_po(
# provide the same behaviour
comment_width = width if width and width > 0 else 76

comment_wrapper = TextWrapper(width=comment_width)
header_wrapper = TextWrapper(width=width, subsequent_indent="# ")

def _format_comment(comment, prefix=''):
for line in wraptext(comment, comment_width):
for line in comment_wrapper.wrap(comment):
yield f"#{prefix} {line.strip()}\n"

def _format_message(message, prefix=''):
Expand Down Expand Up @@ -665,8 +668,7 @@ def _format_message(message, prefix=''):
if width and width > 0:
lines = []
for line in comment_header.splitlines():
lines += wraptext(line, width=width,
subsequent_indent='# ')
lines += header_wrapper.wrap(line)
comment_header = '\n'.join(lines)
yield f"{comment_header}\n"

Expand Down
7 changes: 7 additions & 0 deletions babel/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import os
import re
import textwrap
import warnings
from collections.abc import Generator, Iterable
from typing import IO, Any, TypeVar

Expand Down Expand Up @@ -217,6 +218,12 @@ def wraptext(text: str, width: int = 70, initial_indent: str = '', subsequent_in
:param subsequent_indent: string that will be prepended to all lines save
the first of wrapped output
"""
warnings.warn(
"babel.util.wraptext is deprecated and will be removed in a future version of Babel. "
akx marked this conversation as resolved.
Show resolved Hide resolved
"If you need this functionality, use the `babel.util.TextWrapper` class directly.",
PendingDeprecationWarning,
akx marked this conversation as resolved.
Show resolved Hide resolved
stacklevel=2,
)
wrapper = TextWrapper(width=width, initial_indent=initial_indent,
subsequent_indent=subsequent_indent,
break_long_words=False)
Expand Down
Loading