!111: tests: aircox.management (#114)

!111

Co-authored-by: bkfox <thomas bkfox net>
Reviewed-on: rc/aircox#114

aircox/controllers/playlist_import.py

@@ -0,0 +1,117 @@
+import csv
+import logging
+import os
+
+
+from aircox.conf import settings
+from aircox.models import Track
+
+
+__all__ = ("PlaylistImport",)
+
+
+logger = logging.getLogger("aircox.commands")
+
+
+class PlaylistImport:
+    """Import one or more playlist for the given sound. Attach it to the
+    provided sound.
+
+    Playlists are in CSV format, where columns are separated with a
+    '{settings.IMPORT_PLAYLIST_CSV_DELIMITER}'. Text quote is
+    {settings.IMPORT_PLAYLIST_CSV_TEXT_QUOTE}.
+
+    If 'minutes' or 'seconds' are given, position will be expressed as timed
+    position, instead of position in playlist.
+    """
+
+    path = None
+    data = None
+    tracks = None
+    track_kwargs = {}
+
+    def __init__(self, path=None, **track_kwargs):
+        self.path = path
+        self.track_kwargs = track_kwargs
+
+    def reset(self):
+        self.data = None
+        self.tracks = None
+
+    def run(self):
+        self.read()
+        if self.track_kwargs.get("sound") is not None:
+            self.make_playlist()
+
+    def read(self):
+        if not os.path.exists(self.path):
+            return True
+        with open(self.path, "r") as file:
+            logger.info("start reading csv " + self.path)
+            self.data = list(
+                csv.DictReader(
+                    (
+                        row
+                        for row in file
+                        if not (
+                            row.startswith("#") or row.startswith("\ufeff#")
+                        )
+                        and row.strip()
+                    ),
+                    fieldnames=settings.IMPORT_PLAYLIST_CSV_COLS,
+                    delimiter=settings.IMPORT_PLAYLIST_CSV_DELIMITER,
+                    quotechar=settings.IMPORT_PLAYLIST_CSV_TEXT_QUOTE,
+                )
+            )
+
+    def make_playlist(self):
+        """Make a playlist from the read data, and return it.
+
+        If save is true, save it into the database
+        """
+        if self.track_kwargs.get("sound") is None:
+            logger.error(
+                "related track's sound is missing. Skip import of "
+                + self.path
+                + "."
+            )
+            return
+
+        maps = settings.IMPORT_PLAYLIST_CSV_COLS
+        tracks = []
+
+        logger.info("parse csv file " + self.path)
+        has_timestamp = ("minutes" or "seconds") in maps
+        for index, line in enumerate(self.data):
+            if ("title" or "artist") not in line:
+                return
+            try:
+                timestamp = (
+                    int(line.get("minutes") or 0) * 60
+                    + int(line.get("seconds") or 0)
+                    if has_timestamp
+                    else None
+                )
+
+                track, created = Track.objects.get_or_create(
+                    title=line.get("title"),
+                    artist=line.get("artist"),
+                    position=index,
+                    **self.track_kwargs
+                )
+                track.timestamp = timestamp
+                track.info = line.get("info")
+                tags = line.get("tags")
+                if tags:
+                    track.tags.add(*tags.lower().split(","))
+            except Exception as err:
+                logger.warning(
+                    "an error occured for track {index}, it may not "
+                    "have been saved: {err}".format(index=index, err=err)
+                )
+                continue
+
+            track.save()
+            tracks.append(track)
+        self.tracks = tracks
+        return tracks