Skip to content

Ticker

TickerTrackObserver generates the songticker.xml file.

TickerTrackObserver

Bases: TrackObserver

Writes the new ticker feed file.

The feed file will be consumed by the song-ticker on the RaBe website. This is the successor of the long gone PseudoRssTrackObserver format used by the pre-WordPress website. This version here gets consumed by the WordPress website.

Source code in nowplaying/track/observers/ticker.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class TickerTrackObserver(TrackObserver):
    """Writes the new ticker feed file.

    The feed file will be consumed by the song-ticker on the RaBe website. This is the
    successor of the long gone PseudoRssTrackObserver format used by the pre-WordPress
    website. This version here gets consumed by the WordPress website.
    """

    name = "Ticker"

    class Options(TrackObserver.Options):
        """TickerTrackObserver options."""

        @classmethod
        def args(
            cls: type[TTrackObserverOptions],
            args: configargparse.ArgParser,
        ) -> None:
            """Build args."""
            args.add_argument(
                "--xml-output",
                dest="ticker_output_file",
                help="ticker XML output format",
                default="/var/www/localhost/htdocs/songticker/0.9.3/current.xml",
            )

        def __init__(self: Self, file_path: str) -> None:
            """Create TickerTrackObserver.Config."""
            self.file_path = file_path

    def __init__(self: Self, options: Options) -> None:
        """Create TickerTrackObserver."""
        warnings.warn(
            "The XML ticker format will be replaced with a JSON variant in the future",
            PendingDeprecationWarning,
            stacklevel=2,
        )
        self.ticker_file_path = options.file_path

    def track_started(self: Self, track: Track) -> None:
        """Track started."""
        logger.info(
            "Updating Ticker XML file for track: %s - %s",
            track.artist,
            track.title,
        )
        try:
            tz = pytz.timezone("Europe/Zurich")
        except (
            pytz.exceptions.UnknownTimeZoneError
        ):  # pragma: no coverage due to not knowing how to trigger
            tz = pytz.timezone("UTC")

        now = isodate.datetime_isoformat(datetime.datetime.now(tz))

        MAIN_NAMESPACE = "http://rabe.ch/schema/ticker.xsd"  # noqa: N806
        XLINK_NAMESPACE = "http://www.w3.org/1999/xlink"  # noqa: N806
        XLINK = "{%s}" % XLINK_NAMESPACE  # noqa: N806, UP031

        E = lxml.builder.ElementMaker(  # noqa: N806
            namespace=MAIN_NAMESPACE,
            nsmap={None: MAIN_NAMESPACE, "xlink": XLINK_NAMESPACE},
        )
        show_ref = E.link(track.show.url)
        show_ref.attrib[XLINK + "type"] = "simple"
        show_ref.attrib[XLINK + "href"] = track.show.url
        show_ref.attrib[XLINK + "show"] = "replace"

        ticker = E.ticker(
            E.identifier(f"ticker-{uuid.uuid4()}"),
            E.creator("now-playing daemon v2"),
            E.date(now),
            E.show(
                E.name(track.show.name),
                show_ref,
                E.startTime(
                    isodate.datetime_isoformat(track.show.starttime.astimezone(tz)),
                ),
                E.endTime(
                    isodate.datetime_isoformat(track.show.endtime.astimezone(tz)),
                ),
                id=track.show.uuid,
            ),
            E.track(
                E.show(track.show.name, ref=track.show.uuid),
                E.artist(track.artist),
                E.title(track.title),
                E.startTime(isodate.datetime_isoformat(track.starttime.astimezone(tz))),
                E.endTime(isodate.datetime_isoformat(track.endtime.astimezone(tz))),
                id=track.uuid,
            ),
        )
        lxml.etree.ElementTree(ticker).write(
            self.ticker_file_path,
            pretty_print=True,
            xml_declaration=True,
            encoding="utf-8",
        )

    def track_finished(self: Self, _: Track) -> None:
        """Track finished."""

Options

Bases: Options

TickerTrackObserver options.

Source code in nowplaying/track/observers/ticker.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class Options(TrackObserver.Options):
    """TickerTrackObserver options."""

    @classmethod
    def args(
        cls: type[TTrackObserverOptions],
        args: configargparse.ArgParser,
    ) -> None:
        """Build args."""
        args.add_argument(
            "--xml-output",
            dest="ticker_output_file",
            help="ticker XML output format",
            default="/var/www/localhost/htdocs/songticker/0.9.3/current.xml",
        )

    def __init__(self: Self, file_path: str) -> None:
        """Create TickerTrackObserver.Config."""
        self.file_path = file_path

__init__(file_path)

Create TickerTrackObserver.Config.

Source code in nowplaying/track/observers/ticker.py 
52
53
54
def __init__(self: Self, file_path: str) -> None:
    """Create TickerTrackObserver.Config."""
    self.file_path = file_path

args(args) classmethod

Build args.

Source code in nowplaying/track/observers/ticker.py 
39
40
41
42
43
44
45
46
47
48
49
50
@classmethod
def args(
    cls: type[TTrackObserverOptions],
    args: configargparse.ArgParser,
) -> None:
    """Build args."""
    args.add_argument(
        "--xml-output",
        dest="ticker_output_file",
        help="ticker XML output format",
        default="/var/www/localhost/htdocs/songticker/0.9.3/current.xml",
    )

__init__(options)

Create TickerTrackObserver.

Source code in nowplaying/track/observers/ticker.py 
56
57
58
59
60
61
62
63
def __init__(self: Self, options: Options) -> None:
    """Create TickerTrackObserver."""
    warnings.warn(
        "The XML ticker format will be replaced with a JSON variant in the future",
        PendingDeprecationWarning,
        stacklevel=2,
    )
    self.ticker_file_path = options.file_path

track_finished(_)

Track finished.

Source code in nowplaying/track/observers/ticker.py 
125
126
def track_finished(self: Self, _: Track) -> None:
    """Track finished."""

track_started(track)

Track started.

Source code in nowplaying/track/observers/ticker.py 
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def track_started(self: Self, track: Track) -> None:
    """Track started."""
    logger.info(
        "Updating Ticker XML file for track: %s - %s",
        track.artist,
        track.title,
    )
    try:
        tz = pytz.timezone("Europe/Zurich")
    except (
        pytz.exceptions.UnknownTimeZoneError
    ):  # pragma: no coverage due to not knowing how to trigger
        tz = pytz.timezone("UTC")

    now = isodate.datetime_isoformat(datetime.datetime.now(tz))

    MAIN_NAMESPACE = "http://rabe.ch/schema/ticker.xsd"  # noqa: N806
    XLINK_NAMESPACE = "http://www.w3.org/1999/xlink"  # noqa: N806
    XLINK = "{%s}" % XLINK_NAMESPACE  # noqa: N806, UP031

    E = lxml.builder.ElementMaker(  # noqa: N806
        namespace=MAIN_NAMESPACE,
        nsmap={None: MAIN_NAMESPACE, "xlink": XLINK_NAMESPACE},
    )
    show_ref = E.link(track.show.url)
    show_ref.attrib[XLINK + "type"] = "simple"
    show_ref.attrib[XLINK + "href"] = track.show.url
    show_ref.attrib[XLINK + "show"] = "replace"

    ticker = E.ticker(
        E.identifier(f"ticker-{uuid.uuid4()}"),
        E.creator("now-playing daemon v2"),
        E.date(now),
        E.show(
            E.name(track.show.name),
            show_ref,
            E.startTime(
                isodate.datetime_isoformat(track.show.starttime.astimezone(tz)),
            ),
            E.endTime(
                isodate.datetime_isoformat(track.show.endtime.astimezone(tz)),
            ),
            id=track.show.uuid,
        ),
        E.track(
            E.show(track.show.name, ref=track.show.uuid),
            E.artist(track.artist),
            E.title(track.title),
            E.startTime(isodate.datetime_isoformat(track.starttime.astimezone(tz))),
            E.endTime(isodate.datetime_isoformat(track.endtime.astimezone(tz))),
            id=track.uuid,
        ),
    )
    lxml.etree.ElementTree(ticker).write(
        self.ticker_file_path,
        pretty_print=True,
        xml_declaration=True,
        encoding="utf-8",
    )