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

Increase test coverage of the python_format checker #1176

Merged
merged 1 commit into from
Jan 31, 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
6 changes: 3 additions & 3 deletions babel/messages/checkers.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ def _validate_format(format: str, alternative: str) -> None:
arguments are not interchangeable as `alternative` may contain less
placeholders if `format` uses named placeholders.

The behavior of this function is undefined if the string does not use
Copy link
Member Author

@tomasr8 tomasr8 Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is wrong - python_format happily calls this method when format does not contain any format placeholders (for example when msgid contains them but msgid_plural does not, python_format will still call _validate_format(msgid_plural, msgstr)).

string formatting.

If the string formatting of `alternative` is compatible to `format` the
function returns `None`, otherwise a `TranslationError` is raised.

Expand Down Expand Up @@ -121,6 +118,9 @@ def _check_positional(results: list[tuple[str, str]]) -> bool:

a, b = map(_parse, (format, alternative))

if not a:
return

# now check if both strings are positional or named
a_positional, b_positional = map(_check_positional, (a, b))
if a_positional and not b_positional and not b:
Expand Down
62 changes: 61 additions & 1 deletion tests/messages/test_checkers.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@
from datetime import datetime
from io import BytesIO

import pytest

from babel import __version__ as VERSION
from babel.core import Locale, UnknownLocaleError
from babel.dates import format_datetime
from babel.messages import checkers
from babel.messages import Message, checkers
from babel.messages.catalog import TranslationError
from babel.messages.checkers import _validate_format, python_format
from babel.messages.plurals import PLURALS
from babel.messages.pofile import read_po
from babel.util import LOCALTZ
Expand Down Expand Up @@ -325,3 +329,59 @@ def test_6_num_plurals_checkers(self):
catalog = read_po(BytesIO(po_file), _locale)
message = catalog['foobar']
checkers.num_plurals(catalog, message)


class TestPythonFormat:
@pytest.mark.parametrize(('msgid', 'msgstr'), [
('foo %s', 'foo'),
(('foo %s', 'bar'), ('foo', 'bar')),
(('foo', 'bar %s'), ('foo', 'bar')),
(('foo %s', 'bar'), ('foo')),
])
def test_python_format_invalid(self, msgid, msgstr):
msg = Message(msgid, msgstr)
with pytest.raises(TranslationError):
python_format(None, msg)

@pytest.mark.parametrize(('msgid', 'msgstr'), [
('foo', 'foo'),
('foo', 'foo %s'),
(('foo %s', 'bar %d'), ('foo %s', 'bar %d')),
(('foo %s', 'bar %d'), ('foo %s', 'bar %d', 'baz')),
(('foo', 'bar %s'), ('foo')),
])
def test_python_format_valid(self, msgid, msgstr):
msg = Message(msgid, msgstr)
python_format(None, msg)

@pytest.mark.parametrize(('msgid', 'msgstr', 'error'), [
('%s %(foo)s', '%s %(foo)s', 'format string mixes positional and named placeholders'),
('foo %s', 'foo', 'placeholders are incompatible'),
('%s', '%(foo)s', 'the format strings are of different kinds'),
('%s', '%s %d', 'positional format placeholders are unbalanced'),
('%s', '%d', "incompatible format for placeholder 1: 's' and 'd' are not compatible"),
('%s %s %d', '%s %s %s', "incompatible format for placeholder 3: 'd' and 's' are not compatible"),
('%(foo)s', '%(bar)s', "unknown named placeholder 'bar'"),
('%(foo)s', '%(bar)d', "unknown named placeholder 'bar'"),
('%(foo)s', '%(foo)d', "incompatible format for placeholder 'foo': 'd' and 's' are not compatible"),
])
def test__validate_format_invalid(self, msgid, msgstr, error):
with pytest.raises(TranslationError, match=error):
_validate_format(msgid, msgstr)

@pytest.mark.parametrize(('msgid', 'msgstr'), [
('foo', 'foo'),
('foo', 'foo %s'),
('%s foo', 'foo %s'),
('%i', '%d'),
('%d', '%u'),
('%x', '%X'),
('%f', '%F'),
('%F', '%g'),
('%g', '%G'),
('%(foo)s', 'foo'),
('%(foo)s', '%(foo)s %(foo)s'),
('%(bar)s foo %(n)d', '%(n)d foo %(bar)s'),
])
def test__validate_format_valid(self, msgid, msgstr):
_validate_format(msgid, msgstr)
Loading