Fix rendering of Duration tags to use ISO 8601

Author: idle-code

MANUAL.md

@@ -242,8 +242,8 @@ Sometimes it is desirable to create a chain of context invocations such as:
 %Lower{%Collapse{%Strip{%Name()}}}
 ```
 
-To streamline such operations, _pipe list_ syntax sugar can be used.
-The, following expression is equivalent to the one above:
+To streamline such operations, _pipe list_ syntax sugar can be used
+and above expression can be written as:
 ```
 %Name()|%Strip()|%Collapse()|%Lower()
 ```

README.md

@@ -30,7 +30,7 @@ You can also take a look on the following examples.
 -->
 
 ## Examples
-**Note: When experimenting on your own please use `--dry-run` flag!** \
+**Note: When experimenting on your own please use `-dr`/`--dry-run` flag!** \
 **`tempren` will not override your files by default but invalid template can mangle their names.**
 
 <details>

tempren/cli.py

@@ -603,7 +603,7 @@ def render_template_evaluation_error(
 def cli_prompt_conflict_resolver(
     source_path: Path, destination_path: Path
 ) -> Union[ConflictResolutionStrategy, Path]:
-    log.warning("White processing:")
+    log.warning("While processing:")
     log.warning(f"  {source_path}")
     log.warning("following path was generated:")
     log.warning(f"  {destination_path}")

tempren/tags/audio.py

@@ -1,7 +1,9 @@
+import datetime
 from abc import ABC
 from datetime import timedelta
 from typing import Any, Dict, Optional
 
+import isodate
 import mutagen
 import mutagen.mp3
 from mutagen.easyid3 import EasyID3
@@ -31,20 +33,29 @@ def _extract_metadata(self, file: File) -> Dict[str, Any]:
         audio_file = mutagen.File(file.absolute_path)
         if audio_file is None:
             raise FileNotSupportedError()
-        metadata_dict = dict()
-        metadata_dict["duration"] = audio_file.info.length
-        metadata_dict["channels"] = audio_file.info.channels
-        metadata_dict["sample_rate"] = audio_file.info.sample_rate
-        metadata_dict["bitrate"] = audio_file.info.bitrate
+        metadata_dict: Dict[str, Any] = dict()
+        self.try_to_extract_property(metadata_dict, audio_file.info, "length")
+        self.try_to_extract_property(metadata_dict, audio_file.info, "channels")
+        self.try_to_extract_property(metadata_dict, audio_file.info, "sample_rate")
+        self.try_to_extract_property(metadata_dict, audio_file.info, "bitrate")
         if isinstance(audio_file, mutagen.mp3.MP3):
             metadata_dict["comments"] = audio_file.get("COMM::XXX", "")
             audio_file = mutagen.mp3.MP3(file.absolute_path, ID3=EasyID3)
         else:
-            metadata_dict["bits_per_sample"] = audio_file.info.bits_per_sample
+            self.try_to_extract_property(
+                metadata_dict, audio_file.info, "bits_per_sample"
+            )
 
         metadata_dict.update(dict(audio_file))
         return metadata_dict
 
+    @staticmethod
+    def try_to_extract_property(
+        metadata_dict: Dict[str, Any], audio_info, property_name: str
+    ):
+        if hasattr(audio_info, property_name):
+            metadata_dict[property_name] = getattr(audio_info, property_name)
+
     def format_value(self, metadata_value: Any):
         return metadata_value
 
@@ -92,13 +103,13 @@ class TrackTag(MutagenTagBase):
 
 
 class DurationTag(MutagenTagBase):
-    """Track duration in seconds"""
+    """Track duration in ISO 8601 notation"""
 
-    tag_key = "duration"
+    tag_key = "length"
 
     def format_value(self, metadata_value: Any):
-        duration_in_seconds = float(super().format_value(metadata_value))
-        return timedelta(seconds=duration_in_seconds)
+        duration_seconds = float(super().format_value(metadata_value))
+        return isodate.duration_isoformat(timedelta(seconds=duration_seconds))
 
 
 class ChannelsTag(MutagenTagBase):

tempren/tags/gpx.py

@@ -3,6 +3,7 @@
 from typing import Any, Optional
 
 import gpxpy
+import isodate
 from gpxpy.gpx import GPX, GPXXMLSyntaxException
 
 from tempren.exceptions import FileNotSupportedError, MissingMetadataError
@@ -56,13 +57,13 @@ def extract_metadata(self, gpx: GPX) -> Any:
 
 
 class DurationTag(GpxTagBase):
-    """Duration of the activity"""
+    """Duration of the activity in ISO 8601 notation"""
 
     def extract_metadata(self, gpx: GPX) -> timedelta:
         duration_seconds = gpx.get_duration()
         if not duration_seconds:
             raise MissingMetadataError()
-        return timedelta(seconds=duration_seconds)
+        return isodate.duration_isoformat(timedelta(seconds=duration_seconds))
 
 
 class DistanceTag(GpxTagBase):

tempren/tags/video.py

@@ -3,6 +3,7 @@
 from fractions import Fraction
 from typing import Any, Optional
 
+import isodate
 from pymediainfo import MediaInfo
 
 from tempren.exceptions import FileNotSupportedError, MissingMetadataError
@@ -92,10 +93,10 @@ def extract_video_metadata(self, video_track) -> Any:
 
 
 class DurationTag(VideoInfoTagBase):
-    """Video duration in seconds"""
+    """Video duration in ISO 8601 notation"""
 
     def extract_video_metadata(self, video_track) -> timedelta:
-        return timedelta(milliseconds=video_track.duration)
+        return isodate.duration_isoformat(timedelta(milliseconds=video_track.duration))
 
 
 class BitRateTag(VideoInfoTagBase):

tests/tags/test_audio.py

@@ -81,7 +81,7 @@ def test_duration_extraction(self, sample_file: File):
 
         duration = tag.process(sample_file, None)
 
-        assert duration == timedelta(seconds=1, microseconds=288707)
+        assert duration == "PT1.288707S"
 
     def test_channels_extraction(self, sample_file: File):
         tag = ChannelsTag()

tests/tags/test_gpx.py

@@ -90,7 +90,7 @@ def test_duration(self, tag: DurationTag, gpx_data_dir: Path):
 
         result = tag.process(walk_file, None)
 
-        assert result == timedelta(minutes=26, seconds=42, microseconds=274000)
+        assert result == "PT26M42.274S"
 
 
 class TestDistanceTag(GpxTagTests):

tests/tags/test_video.py

@@ -150,7 +150,7 @@ def test_duration(self, tag: DurationTag, video_data_dir: Path):
 
         duration = tag.process(video_file, None)
 
-        assert duration == timedelta(seconds=2, milliseconds=800)
+        assert duration == "PT2.8S"
 
 
 class TestBitRateTag(VideoInfoTagTests):