episoder 0.11.0__tar.gz → 0.11.1__tar.gz

{episoder-0.11.0 → episoder-0.11.1}/.gitlab-ci.yml

@@ -8,6 +8,9 @@ stages:
 .bookworm_image: &bookworm
   image: registry.gitlab.com/schabe/episoder:debian-bookworm
 
+.trixie_image: &trixie
+  image: registry.gitlab.com/schabe/episoder:debian-trixie
+
 .noble_image: &noble
   image: registry.gitlab.com/schabe/episoder:ubuntu-noble
 
@@ -105,3 +108,17 @@ py312-noble-pip:deploy:
   needs: ["py312-noble:test"]
   <<: *noble
   <<: *deploy_pip_venv
+
+py313-trixie:test:
+  <<: *trixie
+  <<: *test
+
+py313-trixie-setuptools:deploy:
+  needs: ["py313-trixie:test"]
+  <<: *trixie
+  <<: *deploy_setuptools
+
+py313-trixie-pip:deploy:
+  needs: ["py313-trixie:test"]
+  <<: *trixie
+  <<: *deploy_pip_venv

{episoder-0.11.0 → episoder-0.11.1}/CHANGELOG

@@ -1,3 +1,6 @@
+== 0.11.1 (8 Apr 2025) ==
+ * Use Python's EmailMessage class when sending e-mail
+
 == 0.11.0 (20 Jul 2024) ==
  * Port to sqlalchemy 2.0
 

{episoder-0.11.0 → episoder-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: episoder
-Version: 0.11.0
+Version: 0.11.1
 Summary: TV episode notifier
 Home-page: https://code.ott.net/episoder/
 Author: Stefan Ott

{episoder-0.11.0 → episoder-0.11.1}/episoder/database.py

@@ -83,7 +83,7 @@ class Episode(Base):
     notified = Column(Date)
     show = relationship(Show, backref=backref("episodes", cascade="all"))
 
-    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-arguments,too-many-positional-arguments
     def __init__(self, name, season, episode, aired, prodnum, total):
 
         self.title = name

{episoder-0.11.0 → episoder-0.11.1}/episoder/main.py

@@ -18,6 +18,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import sys
 
 from argparse import ArgumentParser
 from datetime import date, timedelta
@@ -30,7 +31,7 @@ from episoder.database import Show
 from episoder.episoder import Database
 from episoder.sources import parser_for, setup_sources
 from episoder.sources.thetvdb import TVDBShowNotFoundError
-from episoder.output import ConsoleRenderer, EmailNotifier
+from episoder.output import ColorfulRenderer, ColorlessRenderer, EmailNotifier
 from episoder.output import NewEpisodesNotification
 from episoder.version import __version__
 
@@ -38,7 +39,6 @@ from episoder.version import __version__
 class EpisoderOptions:
 
     def __init__(self):
-
         self._parser = ArgumentParser()
         self._add_options()
         self._args = None
@@ -46,7 +46,6 @@ class EpisoderOptions:
         self.loglevel = logging.WARNING
 
     def _add_options(self):
-
         yesterday = date.today() - timedelta(1)
 
         self._parser.set_defaults(func=None)
@@ -162,7 +161,6 @@ class EpisoderOptions:
                                   help="show version information")
 
     def _replace_parsed_date(self, args):
-
         if args.date.isdigit():
             daysback = int(args.date)
             args.date = date.today() - timedelta(daysback)
@@ -173,7 +171,6 @@ class EpisoderOptions:
             self._parser.error(f"{args.date}: Wrong date format")
 
     def _setup_logging(self):
-
         if self._args.debug:
             self.loglevel = logging.DEBUG
         elif self._args.verbose:
@@ -188,14 +185,13 @@ class EpisoderOptions:
             logging.basicConfig(level=level)
 
     def parse_args(self):
-
         self._args = self._parser.parse_args()
 
         # this happens automatically in python 2 but not in 3.4
         if self._args.func is None:
             self._parser.print_usage()
             stderr.write("error: too few arguments\n")
-            exit(1)
+            sys.exit(1)
 
         # turn our date string into a proper date object
         if hasattr(self._args, "date"):
@@ -206,11 +202,9 @@ class EpisoderOptions:
     def load_rcfile(self, file_):
 
         def strip_comments(line):
-
             return line.split("#")[0]
 
         def valid(line):
-
             return "=" in line
 
         self._log.info("Loading config file")
@@ -221,7 +215,6 @@ class EpisoderOptions:
         return dict(line.split("=") for line in lines)
 
     def load_config(self):
-
         if path.exists(self.args.c):
             with open(self.args.c, "rb") as file_:
                 cfg = self.load_rcfile(file_)
@@ -251,21 +244,17 @@ class EpisoderOptions:
         self._log.info("Loaded configuration")
 
     def _get_args(self):
-
         return self._args
 
     args = property(_get_args)
 
 
 class Episoder:
-
     def __init__(self, args):
-
         self._args = args
         self._log = logging.getLogger("Episoder")
 
     def update(self):
-
         database = Database(self._args.datafile)
         database.migrate()
 
@@ -283,7 +272,6 @@ class Episoder:
             shows = database.get_expired_shows()
 
         for show in shows[0:self._args.num]:
-
             try:
                 parser = parser_for(show.url)
                 parser.parse(show, database)
@@ -300,7 +288,6 @@ class Episoder:
             self._log.info("None of your shows need to be updated")
 
     def add(self):
-
         url = self._args.show
 
         database = Database(self._args.datafile)
@@ -322,14 +309,12 @@ class Episoder:
         database.commit()
 
     def remove(self):
-
         database = Database(self._args.datafile)
         database.migrate()
         database.remove_show(self._args.show)
         database.commit()
 
     def _set_show_enabled(self, database, enabled):
-
         show_id = self._args.show
         show = database.get_show_by_id(show_id)
 
@@ -341,19 +326,16 @@ class Episoder:
         database.commit()
 
     def enable(self):
-
         database = Database(self._args.datafile)
         database.migrate()
         self._set_show_enabled(database, True)
 
     def disable(self):
-
         database = Database(self._args.datafile)
         database.migrate()
         self._set_show_enabled(database, False)
 
     def shows(self):
-
         database = Database(self._args.datafile)
         database.migrate()
 
@@ -374,7 +356,6 @@ class Episoder:
             print(f"       Episodes: {len(show.episodes)}")
 
     def notify(self):
-
         opt = self._args
 
         if opt.email_to is None:
@@ -406,9 +387,11 @@ class Episoder:
         database.commit()
 
     def episodes(self):
-
         database = Database(self._args.datafile)
-        out = ConsoleRenderer(self._args.format, self._args.dateformat)
+        if self._args.nocolor:
+            out = ColorlessRenderer(self._args.format, self._args.dateformat)
+        else:
+            out = ConsoleRenderer(self._args.format, self._args.dateformat)
 
         if self._args.nodate:
             startdate = date(1900, 1, 1)
@@ -422,10 +405,9 @@ class Episoder:
         else:
             episodes = database.get_episodes(startdate, n_days)
 
-        out.render(episodes, self._args.date, not self._args.nocolor)
+        out.render(episodes, self._args.date)
 
     def search(self):
-
         tvdb = parser_for('123')  # numeric IDs are TVDB entries
 
         try:
@@ -437,7 +419,6 @@ class Episoder:
             print("Nothing found")
 
     def check_data_file(self):
-
         filename = self._args.datafile
         if not path.exists(filename):
             return
@@ -448,11 +429,10 @@ class Episoder:
         if data != b"SQLite":
             message = "%s: Please remove old data file\n"
             stderr.write(message % filename)
-            exit(4)
+            sys.exit(4)
 
 
 def main():
-
     options = EpisoderOptions()
     options.parse_args()
     options.load_config()

episoder-0.11.1/episoder/output.py

@@ -0,0 +1,169 @@
+# episoder, https://code.ott.net/episoder
+#
+# Copyright (C) 2004-2025 Stefan Ott. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from datetime import date, timedelta
+from email.message import EmailMessage
+from smtplib import SMTP
+from sys import stdout
+from typing import Optional
+
+from .database import Episode
+
+
+# pylint: disable=too-few-public-methods
+class EpisodeRenderer:
+    def __init__(self, episode_format: str, date_format: str) -> None:
+        self._format = episode_format
+        self._date_format = date_format
+
+    def format(self, episode: Episode) -> str:
+        string = self._format
+
+        airdate = episode.airdate.strftime(self._date_format)
+        string = string.replace("%airdate", airdate)
+        string = string.replace("%show", str(episode.show.name))
+        string = string.replace("%season", str(episode.season))
+        string = string.replace("%epnum", f"{episode.episode:02d}")
+        string = string.replace("%eptitle", str(episode.title))
+        string = string.replace("%totalep", str(episode.totalnum))
+        string = string.replace("%prodnum", str(episode.prodnum))
+
+        return string
+
+
+class ColorfulRenderer(EpisodeRenderer):
+    RED = "\033[31;1m"
+    CYAN = "\033[36;1m"
+    GREY = "\033[30;0m"
+    GREEN = "\033[32;1m"
+    YELLOW = "\033[33;1m"
+
+    def __init__(self, fmt: str, date_format: str, dest=stdout) -> None:
+        super().__init__(fmt, date_format)
+        self._dest = dest
+
+    def _color(self, episode: Episode, yesterday: date, today: date,
+               tomorrow: date) -> str:
+        if episode.airdate == yesterday:
+            return ColorfulRenderer.RED
+        if episode.airdate == today:
+            return ColorfulRenderer.YELLOW
+        if episode.airdate == tomorrow:
+            return ColorfulRenderer.GREEN
+        if episode.airdate > tomorrow:
+            return ColorfulRenderer.CYAN
+
+        return ColorfulRenderer.GREY
+
+    def render(self, episodes: list[Episode], today: date) -> None:
+        yesterday = today - timedelta(1)
+        tomorrow = today + timedelta(1)
+
+        for episode in episodes:
+            text = self.format(episode)
+            color = self._color(episode, yesterday, today, tomorrow)
+            self._dest.write(f'{color}{text}{ColorfulRenderer.GREY}\n')
+
+
+class ColorlessRenderer(EpisodeRenderer):
+    def __init__(self, fmt: str, date_format: str, dest=stdout) -> None:
+        super().__init__(fmt, date_format)
+        self._dest = dest
+
+    def render(self, episodes: list[Episode], _: date) -> None:
+        for episode in episodes:
+            text = self.format(episode)
+            self._dest.write(f'{text}\n')
+
+
+class EmailNotifier:
+    def __init__(self, server: str, port: int, smtp=SMTP) -> None:
+        self._server = server
+        self._port = port
+        self._smtp = smtp
+        self._user: Optional[str] = None
+        self._password: Optional[str] = None
+
+        self.use_tls = False
+
+    def __str__(self) -> str:
+        return "EmailNotifier"
+
+    def __repr__(self) -> str:
+        fmt = 'EmailNotifier("%s", %d, %s)'
+        return fmt % (self._server, self._port, str(self._smtp))
+
+    def login(self, user: str, password: str) -> None:
+        self._user = user
+        self._password = password
+
+    def _dump(self, msg: EmailMessage) -> None:
+        print(f'From: {msg["to"]}')
+        print(f'To: {msg["to"]}')
+        print(f'Subject: {msg["Subject"]}')
+        print(msg.get_content())
+
+    def send(self, body: str, to: str, pretend: bool = False) -> None:
+        message = EmailMessage()
+        message.set_content(body)
+        message['Subject'] = 'Upcoming TV episodes'
+        message['From'] = to
+        message['To'] = to
+
+        if pretend:
+            self._dump(message)
+            return
+
+        server = self._smtp(self._server, self._port)
+
+        if self.use_tls:
+            server.starttls()
+        if self._user:
+            server.login(self._user, self._password)
+
+        server.send_message(message)
+        server.quit()
+
+
+class NewEpisodesNotification(EpisodeRenderer):
+    def __init__(self, episodes: list[Episode], fmt: str,
+                 date_format: str) -> None:
+        super().__init__(fmt, date_format)
+        self._episodes = episodes
+
+    def __str__(self) -> str:
+        return f'Notification: {len(self._episodes)} new episode(s)'
+
+    def __repr__(self) -> str:
+        eps = f"<({len(self._episodes)} x Episode)"
+        fmt = 'NewEpisodesNotification(%s, "%s", "%s")'
+        return fmt % (eps, self._format, self._date_format)
+
+    def get(self) -> str:
+        return ''.join(f'{self.format(e)}x\n' for e in self._episodes)
+
+    def send(self, notifier: EmailNotifier, to: str,
+             pretend: bool = False) -> None:
+        body = "Your upcoming episodes:\n\n"
+
+        for episode in self._episodes:
+            body += f"{self.format(episode)}\n"
+
+            if not pretend:
+                episode.notified = date.today()
+
+        notifier.send(body, to, pretend)

{episoder-0.11.0 → episoder-0.11.1}/episoder/version.py

@@ -15,4 +15,4 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = "0.11.0"
+__version__ = "0.11.1"

{episoder-0.11.0 → episoder-0.11.1}/episoder.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: episoder
-Version: 0.11.0
+Version: 0.11.1
 Summary: TV episode notifier
 Home-page: https://code.ott.net/episoder/
 Author: Stefan Ott

{episoder-0.11.0 → episoder-0.11.1}/test/test_notify.py

@@ -31,11 +31,9 @@ from episoder.output import EmailNotifier, NewEpisodesNotification
 
 # pylint: disable=too-many-instance-attributes
 class MockSMTPInstance():
-
     instance = None
 
     def __init__(self, server, port):
-
         self.server = server
         self.port = port
 
@@ -49,99 +47,78 @@ class MockSMTPInstance():
         self.msg = None
 
     def reset(self):
-
         self.count = 0
         self.data = {}
         self.tls = 0
         self.user = None
         self.password = None
 
-    def sendmail(self, from_addr, to_addr, msg):
-
-        self.data["from"] = from_addr
-        self.data["to"] = to_addr
-        self.data["msg"] = msg
+    def send_message(self, msg):
+        self.data['from'] = msg['from']
+        self.data['to'] = msg['to']
+        self.data['msg'] = msg.get_content()
 
     def quit(self):
-
         self.from_addr = self.data.get("from")
         self.to_addr = self.data.get("to")
         self.msg = self.data.get("msg")
         self.count += 1
 
     def starttls(self):
-
         self.tls = 1
 
     def login(self, user, password):
-
         self.user = user
         self.password = password
 
 
 class MockSMTP():
-
     instance = None
 
     def __init__(self, server, port):
-
         if not MockSMTP.instance:
             MockSMTP.instance = MockSMTPInstance(server, port)
 
     def __str__(self):
-
         return "MockSMTP"
 
-    def sendmail(self, from_addr, to_addr, msg):
-
-        self.instance.sendmail(from_addr, to_addr, msg)
+    def send_message(self, msg):
+        self.instance.send_message(msg)
 
     def quit(self):
-
         self.instance.quit()
 
     def _get_count(self):
-
         return MockSMTP.instance.count
 
     def _set_count(self, num):
-
         MockSMTP.instance.count = num
 
     def _get_from(self):
-
         return MockSMTP.instance.from_addr
 
     def _get_to(self):
-
         return MockSMTP.instance.to_addr
 
     def _get_msg(self):
-
         return MockSMTP.instance.msg
 
     def _get_tls(self):
-
         return MockSMTP.instance.tls
 
     def _get_user(self):
-
         return MockSMTP.instance.user
 
     def _get_password(self):
-
         return MockSMTP.instance.password
 
     def starttls(self):
-
         MockSMTP.instance.starttls()
 
     def login(self, user, password):
-
         MockSMTP.instance.login(user, password)
 
     def reset(self):
-
         MockSMTP.instance.reset()
 
     count = property(_get_count, _set_count)
@@ -154,9 +131,7 @@ class MockSMTP():
 
 
 class TestNotification(TestCase):
-
     def setUp(self):
-
         self.show = Show("Test show 36")
         self.show.show_id = 36
 
@@ -168,7 +143,6 @@ class TestNotification(TestCase):
         self.smtp.reset()
 
     def test_str_and_repr(self):
-
         notify = EmailNotifier("localhost", 25, MockSMTP)
         self.assertEqual(str(notify), "EmailNotifier")
         self.assertEqual(repr(notify), 'EmailNotifier("localhost", 25, '
@@ -186,7 +160,6 @@ class TestNotification(TestCase):
         self.assertEqual(repr(message), expect)
 
     def test_send_mail_pretend(self):
-
         show1 = Show("Columbo", "")
         ep1 = Episode("Episode 1", 1, 1, date(2014, 8, 10), "x", 1)
         ep2 = Episode("Episode 2", 1, 2, date(2014, 12, 1), "x", 2)
@@ -218,7 +191,6 @@ class TestNotification(TestCase):
                          "[2014-12-01] Columbo 1x02 - Episode 2\n\n")
 
     def test_send_mail(self):
-
         show1 = Show("Columbo", "")
         ep1 = Episode("Episode 1", 1, 1, date(2014, 8, 10), "x", 1)
         ep2 = Episode("Episode 2", 1, 2, date(2014, 12, 1), "x", 2)
@@ -242,9 +214,6 @@ class TestNotification(TestCase):
         self.assertEqual(self.smtp.from_addr, "person@example.org")
         self.assertEqual(self.smtp.to_addr, "person@example.org")
         self.assertEqual(self.smtp.msg,
-                         "From: person@example.org\n"
-                         "To: person@example.org\n"
-                         "Subject: Upcoming TV episodes\n"
                          "Your upcoming episodes:\n\n"
                          "[2014-08-10] Columbo 1x01 - Episode 1\n"
                          "[2014-12-01] Columbo 1x02 - Episode 2\n")
@@ -253,7 +222,6 @@ class TestNotification(TestCase):
         self.assertIsNotNone(ep2.notified)
 
     def test_send_mail_tls(self):
-
         show1 = Show("Columbo", "")
         ep1 = Episode("Episode 1", 1, 1, date(2014, 8, 10), "x", 1)
         ep2 = Episode("Episode 2", 1, 2, date(2014, 12, 1), "x", 2)
@@ -276,15 +244,11 @@ class TestNotification(TestCase):
         self.assertEqual(self.smtp.from_addr, "xy@example.org")
         self.assertEqual(self.smtp.to_addr, "xy@example.org")
         self.assertEqual(self.smtp.msg,
-                         "From: xy@example.org\n"
-                         "To: xy@example.org\n"
-                         "Subject: Upcoming TV episodes\n"
                          "Your upcoming episodes:\n\n"
                          "[2014-08-10] Columbo 1x01 - Episode 1\n"
                          "[2014-12-01] Columbo 1x02 - Episode 2\n")
 
     def test_send_mail_auth(self):
-
         message = NewEpisodesNotification([], "", "")
 
         notifier = EmailNotifier("localhost", 97, MockSMTP)
@@ -298,7 +262,4 @@ class TestNotification(TestCase):
         self.assertEqual(self.smtp.from_addr, "xy@example.org")
         self.assertEqual(self.smtp.to_addr, "xy@example.org")
         self.assertEqual(self.smtp.msg,
-                         "From: xy@example.org\n"
-                         "To: xy@example.org\n"
-                         "Subject: Upcoming TV episodes\n"
                          "Your upcoming episodes:\n\n")