Skip to content

Do not raise KeyError when dumping after a Format line redefinition #38

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

Open
eeshsaxena wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Do not raise KeyError when dumping after a Format line redefinition #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion src/ass/line.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ def dump(self, field_order=None):
if field_order is None:
field_order = self.DEFAULT_FIELD_ORDER

return ",".join(_Field.dump(self.fields[field])
# A field in field_order that the line does not carry (for example when
# a section has a second "Format:" line that redefines the order after
# the lines were parsed) dumps as empty rather than raising KeyError.
return ",".join(_Field.dump(self.fields[field]) if field in self.fields
else ""
for field in field_order)

def dump_with_type(self, field_order=None):
Expand Down
13 changes: 13 additions & 0 deletions tests/test_ass.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,19 @@ def test_custom_line_section_write(self, line_section):
def test_custom_line_section_dump(self, line_section):
assert "\n".join(line_section.dump()) == self.TEST_CUSTOM

def test_dump_after_format_redefinition(self):
# A second "Format:" line in a section redefines the field order after
# the lines were parsed; dumping such a document used to raise KeyError.
doc = ass.Document.parse_string(dedent("""\
[Events]
Format: Layer, Start, End, Style, Text
Dialogue: 0,0:00:01.00,0:00:04.00,Default,Hello
Format: a"""))
out = StringIO()
doc.dump_file(out)
# the dumped document parses again without error
assert ass.Document.parse_string(out.getvalue()) is not None


class TestEvents:

Expand Down