force XML declaration for TTML across py3.6, py3.7 and py3.8

baxtree · Jan 8, 2021 · 9e995cc · 9e995cc
1 parent d3ca0eb
commit 9e995cc
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/Makefile b/Makefile
@@ -57,7 +57,7 @@ test:
 	cat requirements.txt | xargs -L 1 .$(PYTHON)/bin/pip install; \
 	cat requirements-dev.txt | xargs -L 1 .$(PYTHON)/bin/pip install
 	PYTHONPATH=. .$(PYTHON)/bin/python -m unittest discover
-	-.$(PYTHON)/bin/pycodestyle subaligner tests examples misc bin/subaligner bin/subaligner_1pass bin/subaligner_2pass bin/subaligner_train  bin/subaligner_tune setup.py --ignore=E203,E501,W503
+	-.$(PYTHON)/bin/pycodestyle subaligner tests examples misc bin/subaligner bin/subaligner_1pass bin/subaligner_2pass bin/subaligner_train  bin/subaligner_tune setup.py --ignore=E203,E501,W503 --exclude="subaligner/lib"
 
 test-all: ## run tests on every Python version with tox
 	.$(PYTHON)/bin/tox

diff --git a/subaligner/subtitle.py b/subaligner/subtitle.py
@@ -3,6 +3,7 @@
 import os
 import re
 import xml.etree.ElementTree as ElementTree
+import inspect
 from typing import Optional, List
 from pysrt import SubRipFile, SubRipItem
 from copy import deepcopy
@@ -367,15 +368,13 @@ def export_subtitle(source_file_path: str, subs: List[SubRipItem], target_file_p
 
             # Change single quotes in the XML header to double quotes
             with open(target_file_path, "w", encoding=encoding) as target:
-                normalised = (
-                    ElementTree.tostring(tt, xml_declaration=True, method="xml")
-                    .decode(encoding)
-                    .replace(
-                        "<?xml version='1.0' encoding='",
-                        '<?xml version="1.0" encoding="',
-                    )
+                if "xml_declaration" in inspect.getfullargspec(ElementTree.tostring).kwonlyargs:  # for >= python 3.8
+                    encoded = ElementTree.tostring(tt, encoding=encoding, method="xml", xml_declaration=True)
+                else:
+                    encoded = ElementTree.tostring(tt, encoding=encoding, method="xml")
+                normalised = encoded.decode(encoding) \
+                    .replace("<?xml version='1.0' encoding='", '<?xml version="1.0" encoding="',) \
                     .replace("'?>", '"?>')
-                )
                 target.write(normalised)
         elif file_extension in Subtitle.WEBVTT_EXTENSIONS:
             try:

diff --git a/subaligner/utils.py b/subaligner/utils.py
@@ -18,6 +18,7 @@
 from .exception import TerminalException
 from subaligner.lib.to_srt import STL, SRT
 
+
 class Utils(object):
     """Utility functions
     """

diff --git a/tests/subaligner/resource/test.dfxp b/tests/subaligner/resource/test.dfxp
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="us-ascii"?>
+<?xml version="1.0" encoding="ASCII"?>
 <tt xmlns="http://www.w3.org/ns/ttml" xmlns:ns3="http://www.w3.org/ns/ttml#style" xmlns:ttm="http://www.w3.org/ns/ttml#metadata" xmlns:ttp="http://www.w3.org/ns/ttml#parameter" xml:lang="en" ttp:timeBase="media">
   <head>
     <metadata>

diff --git a/tests/subaligner/resource/test.ttml b/tests/subaligner/resource/test.ttml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="us-ascii"?>
+<?xml version="1.0" encoding="ASCII"?>
 <tt xmlns="http://www.w3.org/ns/ttml" xmlns:ns3="http://www.w3.org/ns/ttml#style" xmlns:ttm="http://www.w3.org/ns/ttml#metadata" xmlns:ttp="http://www.w3.org/ns/ttml#parameter" xml:lang="en" ttp:timeBase="media">
   <head>
     <metadata>

diff --git a/tests/subaligner/resource/test.xml b/tests/subaligner/resource/test.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="us-ascii"?>
+<?xml version="1.0" encoding="ASCII"?>
 <tt xmlns="http://www.w3.org/ns/ttml" xmlns:ns3="http://www.w3.org/ns/ttml#style" xmlns:ttm="http://www.w3.org/ns/ttml#metadata" xmlns:ttp="http://www.w3.org/ns/ttml#parameter" xml:lang="en" ttp:timeBase="media">
   <head>
     <metadata>