refactor: change pystache to chevron

roedoejet · roedoejet · commit d1797c07f38f · 2021-09-28T15:27:21.000-07:00
diff --git a/readalongs/_version.py b/readalongs/_version.py
@@ -1 +1 @@
-__version__ = "0.1.20200824"
+__version__ = "0.1.20210928"
diff --git a/readalongs/align.py b/readalongs/align.py
@@ -17,7 +17,7 @@
 from datetime import timedelta
 from typing import Dict, List, Union
 
-import pystache
+import chevron
 import regex as re
 import soundswallower
 from lxml import etree
@@ -53,7 +53,7 @@
 
 @dataclass
 class WordSequence:
-    """ Sequence of "unit" XML elements
+    """Sequence of "unit" XML elements
 
     By default, the unit elements are the <w> elements.
 
@@ -69,7 +69,7 @@ class WordSequence:
 
 
 def get_sequences(xml, xml_filename, unit="w", anchor="anchor") -> List[WordSequence]:
-    """ Return the list of anchor-separated word sequences in xml
+    """Return the list of anchor-separated word sequences in xml
 
     Args:
         xml (etree): xml structure in which to search for words and anchors
@@ -122,7 +122,7 @@ def get_sequences(xml, xml_filename, unit="w", anchor="anchor") -> List[WordSequ
 
 
 def split_silences(words: List[dict], final_end, excluded_segments: List[dict]) -> None:
-    """ split the silences between words, making sure we don't step over any
+    """split the silences between words, making sure we don't step over any
         excluded segment boundaries
 
     Args:
@@ -170,7 +170,7 @@ def align_audio(  # noqa: C901
     g2p_fallbacks=None,
     verbose_g2p_warnings=False,
 ):
-    """ Align an XML input file to an audio file.
+    """Align an XML input file to an audio file.
 
     Args:
         xml_path (str): Path to XML input file in TEI-like format
@@ -429,7 +429,7 @@ def save_readalong(
     output_xhtml: bool = False,
     audiofile: str,
 ):
-    """ Save the results from align_audio() into the otuput files required for a
+    """Save the results from align_audio() into the otuput files required for a
         readalong
 
     Args:
@@ -529,7 +529,7 @@ def save_readalong(
 
 
 def return_word_from_id(xml: etree, el_id: str) -> str:
-    """ Given an XML document, return the innertext at id
+    """Given an XML document, return the innertext at id
 
     Args:
         xml (etree): XML document
@@ -542,7 +542,7 @@ def return_word_from_id(xml: etree, el_id: str) -> str:
 
 
 def return_words_and_sentences(results):
-    """ Parse xml into word and sentence 'tier' data
+    """Parse xml into word and sentence 'tier' data
 
     Args:
         results([TODO type]): [TODO description]
@@ -587,7 +587,7 @@ def return_words_and_sentences(results):
 
 
 def write_to_text_grid(words: List[dict], sentences: List[dict], duration: float):
-    """ Write results to Praat TextGrid. Because we are using pympi, we can also export to Elan EAF.
+    """Write results to Praat TextGrid. Because we are using pympi, we can also export to Elan EAF.
 
     Args:
         words (List[dict]): List of word times containing start, end, and value keys
@@ -629,7 +629,7 @@ def float_to_timedelta(n: float) -> str:
 
 
 def write_to_subtitles(data: Union[List[dict], List[List[dict]]]):
-    """ Returns WebVTT object from data.
+    """Returns WebVTT object from data.
 
     Args:
         data (Union[List[dict], List[List[dict]]]):
@@ -659,7 +659,7 @@ def write_to_subtitles(data: Union[List[dict], List[List[dict]]]):
 
 
 def convert_to_xhtml(tokenized_xml, title="Book"):
-    """ Do a simple and not at all foolproof conversion to XHTML.
+    """Do a simple and not at all foolproof conversion to XHTML.
 
     Args:
         tokenized_xml (etree): xml etree with tokens, converted in place
@@ -715,7 +715,7 @@ def convert_to_xhtml(tokenized_xml, title="Book"):
 
 
 def create_input_tei(**kwargs):
-    """ Create input xml in TEI standard.
+    """Create input xml in TEI standard.
         Uses readlines to infer paragraph and sentence structure from plain text.
         TODO: Check if path, if it's just plain text, then render that instead of reading from the file
         Assumes a double blank line marks a page break, and a single blank line
@@ -780,7 +780,7 @@ def create_input_tei(**kwargs):
         paragraphs.append({"sentences": sentences})
     if paragraphs:
         pages.append({"paragraphs": paragraphs})
-    xml = pystache.render(TEI_TEMPLATE, {**kwargs, **{"pages": pages}})
+    xml = chevron.render(TEI_TEMPLATE, {**kwargs, **{"pages": pages}})
     outfile.write(xml.encode("utf-8"))
     outfile.flush()
     outfile.close()
diff --git a/readalongs/epub/create_epub.py b/readalongs/epub/create_epub.py
@@ -12,7 +12,7 @@
 import os
 import shutil
 
-import pystache
+import chevron
 
 from readalongs.log import LOGGER
 from readalongs.text.util import (
@@ -154,15 +154,15 @@ def create_epub(input_path, output_path, unpacked=False):
 
     # container.xml file
     container_template = load_txt(CONTAINER_ORIGIN_PATH)
-    container_txt = pystache.render(
+    container_txt = chevron.render(
         container_template, {"package_path": PACKAGE_DEST_PATH}
     )
     save(output_path, CONTAINER_DEST_PATH, container_txt)
 
     # the SMIL and all the files referenced in the SMIL
     package_data = extract_files_from_SMIL(input_path)
     package_template = load_txt(PACKAGE_ORIGIN_PATH)
-    package_txt = pystache.render(package_template, package_data)
+    package_txt = chevron.render(package_template, package_data)
     save(output_path, PACKAGE_DEST_PATH, package_txt)
 
     for entry in package_data["media"]:
diff --git a/readalongs/text/make_dict.py b/readalongs/text/make_dict.py
@@ -17,7 +17,7 @@
 
 import argparse
 
-import pystache
+import chevron
 
 from readalongs.log import LOGGER
 from readalongs.text.util import load_xml, save_txt
@@ -43,7 +43,7 @@ def make_dict(word_elements, input_filename, unit="m"):
         data["items"].append({"id": e.attrib["id"], "pronunciation": text})
     if nwords == 0:
         raise RuntimeError("No words in dictionary!")
-    return pystache.render(DICT_TEMPLATE, data)
+    return chevron.render(DICT_TEMPLATE, data)
 
 
 def go(input_filename, output_filename, unit):
diff --git a/readalongs/text/make_fsg.py b/readalongs/text/make_fsg.py
@@ -18,7 +18,7 @@
 import argparse
 import os
 
-import pystache
+import chevron
 from slugify import slugify
 
 from readalongs.log import LOGGER
@@ -65,7 +65,7 @@ def make_fsg(word_elements, filename):
     data["final_state"] = data["num_states"]
     data["num_states"] += 1
 
-    return pystache.render(FSG_TEMPLATE, data)
+    return chevron.render(FSG_TEMPLATE, data)
 
 
 def go(input_filename, output_filename, unit):
diff --git a/readalongs/text/make_jsgf.py b/readalongs/text/make_jsgf.py
@@ -21,7 +21,7 @@
 import datetime
 import os
 
-import pystache
+import chevron
 
 from readalongs.text.util import load_xml, save_txt
 
@@ -56,7 +56,7 @@ def make_jsgf(xml, filename, unit="m"):
         id = e.attrib["id"]
         data["words"].append({"id": id})
 
-    return pystache.render(JSGF_TEMPLATE, data)
+    return chevron.render(JSGF_TEMPLATE, data)
 
 
 def go(input_filename, output_filename, unit):
diff --git a/readalongs/text/make_jsgf_advanced.py b/readalongs/text/make_jsgf_advanced.py
@@ -19,8 +19,6 @@
 import datetime
 import os
 
-import pystache
-
 from readalongs.text.util import load_xml, save_txt
 
 # ###################3
diff --git a/readalongs/text/make_smil.py b/readalongs/text/make_smil.py
@@ -11,7 +11,7 @@
 
 import argparse
 
-import pystache
+import chevron
 
 from readalongs.text.util import save_txt
 
@@ -36,7 +36,7 @@
 
 
 def parse_hypseg(text):
-    """ Parse hypseg alignments file and return alignements
+    """Parse hypseg alignments file and return alignements
 
     Args:
         text(str): hypseg text
@@ -61,7 +61,7 @@ def parse_hypseg(text):
 
 
 def make_smil(text_path: str, audio_path: str, results: dict) -> str:
-    """ Actually render the SMIL
+    """Actually render the SMIL
 
     Args:
         text_path(str): path to text
@@ -73,7 +73,7 @@ def make_smil(text_path: str, audio_path: str, results: dict) -> str:
     """
     results["text_path"] = text_path
     results["audio_path"] = audio_path
-    return pystache.render(SMIL_TEMPLATE, results)
+    return chevron.render(SMIL_TEMPLATE, results)
 
 
 def go(seg_path, text_path, audio_path, output_path):
diff --git a/readalongs/waveform2svg/pitch2svg.py b/readalongs/waveform2svg/pitch2svg.py
@@ -21,9 +21,9 @@
 from io import open
 from math import floor
 
+import chevron
 import librosa
 import numpy as np
-import pystache
 
 from readalongs.log import LOGGER
 from readalongs.waveform2svg.audio_util import (
@@ -54,7 +54,7 @@ def render_svg(pitches, width=512, height=100, zero_height=5):
         data["points"].append({"x": x, "y": y})
     data["points"].append({"x": float(width), "y": float(height - zero_height)})
     data["points"].append({"x": float(width), "y": float(height)})
-    return pystache.render(SVG_TEMPLATE, data)
+    return chevron.render(SVG_TEMPLATE, data)
 
 
 def extract_pitches(waveform, nbuckets=512):
diff --git a/readalongs/waveform2svg/units2svg.py b/readalongs/waveform2svg/units2svg.py
@@ -21,9 +21,9 @@
 from collections import OrderedDict
 from io import open
 
+import chevron
 import librosa
 import numpy as np
-import pystache
 from audio_util import save_txt
 from lxml import etree
 
@@ -57,7 +57,7 @@ def render_svg(data, width=512, height=100, radius=4):
             w = max((unit["duration"] / total_duration) * width - 1.0, 1.0)
             w = "%.2f" % w
             result["rects"].append({"x": x, "width": w})
-    return pystache.render(SVG_TEMPLATE, result)
+    return chevron.render(SVG_TEMPLATE, result)
 
 
 def load_xml(input_path):
@@ -66,8 +66,8 @@ def load_xml(input_path):
 
 
 def parse_smil(input_path):
-    """ Figure out the overall start and end of every unit, even if the whole
-        sequence plays out over multiple audio files """
+    """Figure out the overall start and end of every unit, even if the whole
+    sequence plays out over multiple audio files"""
     xml = load_xml(input_path)
     data = {"audio_files": OrderedDict()}
     dirname = os.path.dirname(input_path)
diff --git a/readalongs/waveform2svg/waveform2svg.py b/readalongs/waveform2svg/waveform2svg.py
@@ -18,8 +18,8 @@
 from io import open
 from math import ceil, floor
 
+import chevron
 import numpy as np
-import pystache
 
 from readalongs.log import LOGGER
 from readalongs.waveform2svg.audio_util import load_wav_or_smil, save_txt, smooth
@@ -80,7 +80,7 @@ def render_svg(
             x = width - (i / num_buckets * width + 0.5)
             data["points"].append({"x": x, "y": y})
         data["points"].append({"x": 0.0, "y": (height + zero_height) / 2})
-    return pystache.render(SVG_TEMPLATE, data)
+    return chevron.render(SVG_TEMPLATE, data)
 
 
 def make_waveform_svg(
diff --git a/requirements.txt b/requirements.txt
@@ -12,7 +12,7 @@ soundswallower==0.1.1
 pydub==0.23.1
 pympi-ling==1.69
 python-slugify==5.0.0
-pystache==0.5.4
+chevron==0.14.0
 six==1.12.0
 text-unidecode==1.3
 tqdm==4.31.1
diff --git a/test/data/fra-prepared.xml b/test/data/fra-prepared.xml
@@ -11,7 +11,7 @@
                     <s>Et voici une deuxi&egrave;me ligne dans le m&ecirc;me paragraphe.</s>
                 </p>
                 <p>
-                    <s>Un deuxi&egrave;me paragraphe pr&eacute;c&eacute;d&eacute; d&#x27;une ligne vide est ici. Avec deux phrases.</s>
+                    <s>Un deuxi&egrave;me paragraphe pr&eacute;c&eacute;d&eacute; d'une ligne vide est ici. Avec deux phrases.</s>
                 </p>
             </div>
             <div type="page">

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.1.20200824"`
	`1`	`+__version__ = "0.1.20210928"`