Fix document filter return

sandflow · Dec 22, 2023 · fbe05b2 · fbe05b2
1 parent 3cb8985
commit fbe05b2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/src/main/python/ttconv/filters/doc/lcd.py b/src/main/python/ttconv/filters/doc/lcd.py
@@ -245,3 +245,5 @@ def process(self, doc: ContentDocument) -> ContentDocument:
 
     if doc.get_body() is not None and not self.config.preserve_text_align:
       doc.get_body().set_style(StyleProperties.TextAlign, TextAlignType.center)
+
+    return doc
diff --git a/src/main/python/ttconv/filters/document_filter.py b/src/main/python/ttconv/filters/document_filter.py
@@ -40,7 +40,7 @@ def __init__(self, config: ModuleConfiguration) -> None:
     self.config = config
 
   def process(self, doc: ContentDocument) -> ContentDocument:
-    """Process the specified doc and returns it."""
+    """Processes the specified document in place and returns it."""
     raise NotImplementedError
 
   @classmethod

diff --git a/src/test/python/test_lcd_filter.py b/src/test/python/test_lcd_filter.py
@@ -131,7 +131,7 @@ def test_region_merging(self):
 
     filter = LCDFilter(LCDFilterConfig())
 
-    filter.process(doc)
+    self.assertIs(filter.process(doc), doc)
 
     self.assertSetEqual(
       set(["r1", "r3", "r5"]),
@@ -256,7 +256,7 @@ def test_region_resizing(self):
     # apply filter
     filter = LCDFilter(LCDFilterConfig())
 
-    filter.process(doc)
+    self.assertIs(filter.process(doc), doc)
 
     self.assertSetEqual(
       set(["r1", "r2"]),
@@ -318,7 +318,7 @@ def test_text_align(self):
     # apply filter
     filter = LCDFilter(LCDFilterConfig())
 
-    filter.process(doc)
+    self.assertIs(filter.process(doc), doc)
 
     self.assertIsNone(p1.get_style(styles.StyleProperties.TextAlign))
     self.assertEqual(body.get_style(styles.StyleProperties.TextAlign), styles.TextAlignType.center)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -245,3 +245,5 @@ def process(self, doc: ContentDocument) -> ContentDocument:

		if doc.get_body() is not None and not self.config.preserve_text_align:
		doc.get_body().set_style(StyleProperties.TextAlign, TextAlignType.center)

		return doc