Fix of list index out of range error in PoFileParser.add_message when translations is empty #1135
Conversation
babel/messages/pofile.py
Outdated
| @@ -247,6 +247,9 @@ def _add_message(self) -> None: | |||
|
|
|||
| def _finish_current_message(self) -> None: | |||
| if self.messages: | |||
| if not len(self.translations): | |||
| self.translations.append([0, _NormalizedString("")]) | |||
| self._invalid_pofile("", self.offset, "invalid po file provided") | |||
There was a problem hiding this comment.
I think we can use a more descriptive error message here. Maybe something like Missing msgstr for msgid {msgid}?
Co-authored-by: Tomas R <[email protected]>
…babel into PoFileParser_Patch
…sponding msgid without msgstr
|
I updated the error message and added a test. Let me know if there's any other changes that should be made! |
|
Thanks! I'll take a look later today or tomorrow (ping me in case I forget) |
tests/messages/test_pofile.py
Outdated
| buf = StringIO('''msgid "this is an invalid po file" | ||
| msgstr "hello world" | ||
| msgid "msgid without str"''') | ||
| with pytest.raises(pofile.PoFileError): |
There was a problem hiding this comment.
PoFileError is raised for various reasons, I'd also assert that the exception message matches ours:
with pytest.raises(pofile.PoFileError) as excinfo:
pofile.read_po(buf, abort_invalid=True)
assert str(excinfo.value) == "..."
tests/messages/test_pofile.py
Outdated
| msgstr "hello world" | ||
| msgid "msgid without str"''') | ||
| with pytest.raises(pofile.PoFileError): | ||
| pofile.read_po(buf, abort_invalid=True) |
There was a problem hiding this comment.
I'd also add a test when abort_invalid is False and maybe one test when the input includes msgid_plural e.g.
msgid "foo"
msgid_plural "foos"
(Also, there's a missing newline at the end of this file ;))
Co-authored-by: Tomas R <[email protected]>
Co-authored-by: Tomas R <[email protected]>
|
Sorry for the delay, it's been a busy couple of days. I just added a couple more test cases! |
tests/messages/test_pofile.py
Outdated
| with pytest.raises(pofile.PoFileError) as e: | ||
| pofile.read_po(buf, abort_invalid=True) | ||
| assert(str(e.value)) == "missing msgstr for msgid 'foo' on 1" |
Co-authored-by: Tomas R <[email protected]>
Co-authored-by: Tomas R <[email protected]>
…babel into PoFileParser_Patch
|
Made those extra changes. Thanks for sticking with me as I work through everything! |
Thank you for working on the fix! It's looking good to me but I don't have commit rights in this repo so I'm pinging @akx 🙂 |
Addresses #1134
Previously, the
add_messagefunction would try to access the PoFileParser object's translations list without any checks. However, when an invalid po file is provided, this can lead to an index out of range error.This PR adds a check to the
_finish_current_messagefunction and raises aninvalid_pofileexception when the messages list is populated and translations is empty. This also adds a dummy translation to the translations list to avoid the index out of range error when aninvalid_pofileexception is treated as a warning rather than raised.