style: I prefer audio_duration to audio_length

readalongs/web_api.py

@@ -207,10 +207,10 @@ def create_grammar(xml):
 class ConvertRequest(BaseModel):
     """Convert Request contains the RAS-processed XML and SMIL alignments"""
 
-    audio_length: float = Field(
+    audio_duration: float = Field(
         example=2.01,
         gt=0.0,
-        title="The length of the audio used to create the alignment, in seconds.",
+        title="The duration of the audio used to create the alignment, in seconds.",
     )
 
     output_format: str = Field(
@@ -291,7 +291,7 @@ async def convert_alignment(input: ConvertRequest) -> ConvertResponse:
     Encoding: all input and output is in UTF-8.
 
     Args (as dict items in the request body):
-     - audio_length: duration in seconds of the audio file used to create the alignment
+     - audio_duration: duration in seconds of the audio file used to create the alignment
      - output_format: one of TextGrid, eaf, srt, vtt
      - xml: the XML file produced by /assemble
      - smil: the SMIL file produced by SoundSwallower(.js)
@@ -333,14 +333,16 @@ async def convert_alignment(input: ConvertRequest) -> ConvertResponse:
 
         output_format = input.output_format.lower()
         if output_format == "textgrid":
-            save_label_files(words, parsed_xml, input.audio_length, prefix, "textgrid")
+            save_label_files(
+                words, parsed_xml, input.audio_duration, prefix, "textgrid"
+            )
             return ConvertResponse(
                 file_name="aligned.TextGrid",
                 file_contents=slurp_file(prefix + ".TextGrid"),
             )
 
         elif output_format == "eaf":
-            save_label_files(words, parsed_xml, input.audio_length, prefix, "eaf")
+            save_label_files(words, parsed_xml, input.audio_duration, prefix, "eaf")
             return ConvertResponse(
                 file_name="aligned.eaf",
                 file_contents=slurp_file(prefix + ".eaf"),

test/test_web_api.py

@@ -152,7 +152,7 @@ def test_debug(self):
 
     def test_convert_to_TextGrid_errors(self):
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "TextGrid",
             "xml": "this is not XML",
             "smil": self.hej_verden_smil,
@@ -161,7 +161,7 @@ def test_convert_to_TextGrid_errors(self):
         self.assertEqual(response.status_code, 422, "Invalid XML should fail.")
 
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "TextGrid",
             "xml": self.hej_verden_xml,
             "smil": "This is not SMIL",
@@ -170,7 +170,7 @@ def test_convert_to_TextGrid_errors(self):
         self.assertEqual(response.status_code, 422, "Invalid SMIL should fail.")
 
         request = {
-            "audio_length": -10.0,
+            "audio_duration": -10.0,
             "output_format": "TextGrid",
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,
@@ -180,7 +180,7 @@ def test_convert_to_TextGrid_errors(self):
 
     def test_convert_to_TextGrid(self):
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "TextGrid",
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,
@@ -246,7 +246,7 @@ class = "IntervalTier"
 
     def test_convert_to_eaf(self):
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "eaf",
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,
@@ -258,7 +258,7 @@ def test_convert_to_eaf(self):
 
     def test_convert_to_srt(self):
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "srt",
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,
@@ -297,7 +297,7 @@ def test_convert_to_srt(self):
     def test_convert_to_vtt(self):
         request = {
             "encoding": "utf-8",  # for bwd compat, make sure the encoding is allowed but ignored
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "vtt",
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,
@@ -334,7 +334,7 @@ def test_convert_to_vtt(self):
 
     def test_convert_to_bad_format(self):
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             "output_format": "not_a_known_format",
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,
@@ -343,7 +343,7 @@ def test_convert_to_bad_format(self):
         self.assertEqual(response.status_code, 422)
 
         request = {
-            "audio_length": 83.1,
+            "audio_duration": 83.1,
             # "output_format" just missing
             "xml": self.hej_verden_xml,
             "smil": self.hej_verden_smil,