Sort functions alphabetical and fill out docstrings

discord_rss_bot/feeds.py

@@ -29,22 +29,27 @@ from requests import Response
 from discord_rss_bot.settings import logger, reader
 
 
-def check_feeds() -> None:
-    """Check all feeds"""
-    reader.update_feeds()
-    entries = reader.get_entries(read=False)
-    send_to_discord(entries)
+class IfFeedError(BaseModel):
+    """Update a feed.
 
-
-def check_feed(feed_url: str) -> None:
-    """Check a single feed"""
-    reader.update_feeds()
-    entry = reader.get_entries(feed=feed_url, read=False)
-    send_to_discord(entry)
+    Attributes:
+        feed_url: The feed to update.
+        webhook: The webhook to use.
+        error: True if error, False if no error.
+        err_msg: The error message, if any.
+        exception: The exception, if any.
+    """
+    feed_url: str
+    webhook: str
+    error: bool
+    err_msg: str = ""
+    exception: str = ""
 
 
 class NoWebhookFoundError(Exception):
-    """No webhook found error."""
+    """Raises an exception if no webhook is found.
+
+    Used in send_to_discord()."""
 
     def __init__(self, message):
         self.message = message
@@ -53,13 +58,73 @@ class NoWebhookFoundError(Exception):
         return self.message
 
 
+def add_feed(feed_url: str, webhook: str, exist_ok=False, allow_invalid_url=False) -> IfFeedError:
+    """
+    Add a feed to reader. If error occurs, it will return IfFeedError with error=True.
+
+    Args:
+        feed_url: The feed to add.
+        webhook:  The webhook to use.
+        exist_ok:  If the feed already exists, do nothing.
+        allow_invalid_url:  If the feed url is invalid, add it anyway.
+
+    Returns:
+        IfFeedError: Error or not.
+    """
+    try:
+        reader.add_feed(feed=feed_url, exist_ok=exist_ok, allow_invalid_url=allow_invalid_url)
+    except FeedExistsError as error:
+        error_msg = "Feed already exists"
+        logger.error(f"{error_msg}: {error}")
+        return IfFeedError(error=True, err_msg=error_msg, feed_url=feed_url, webhook=webhook, exception=error.message)
+
+    except InvalidFeedURLError as error:
+        error_msg = "Invalid feed URL"
+        logger.error(f"{error_msg}: {error}")
+        return IfFeedError(error=True, err_msg=error_msg, feed_url=feed_url, webhook=webhook, exception=error.message)
+
+    return IfFeedError(error=False, feed_url=feed_url, webhook=webhook)
+
+
+def check_feed(feed_url: str) -> None:
+    """Update a single feed and send its unread entries to Discord.
+
+    We don't need to mark entries as read here, because send_to_discord() does that when sending entries to Discord
+    if it was successful.
+
+    Args:
+        feed_url: The feed to check.
+    """
+    reader.update_feed(feed_url)
+    entries = reader.get_entries(feed=feed_url, read=False)
+    for entry in entries:
+        send_to_discord(entry)
+
+
+def check_feeds() -> None:
+    """Update all feeds and send all the entries that are unread to Discord.
+
+    We don't need to mark entries as read here, because send_to_discord() does that when sending entries to Discord
+    if it was successful.
+    """
+    reader.update_feeds()
+    entries = reader.get_entries(read=False)
+    for entry in entries:
+        send_to_discord(entry)
+
+
 def send_to_discord(entry) -> Response:
     """
     Send entries to Discord.
 
+    If response was not ok, we will log the error and mark the entry as unread, so it will be sent again next time.
+
     Args:
         entry: The entry to send.
 
+    Raises:
+        NoWebhookFoundError: If no webhook is found.
+
     Returns:
         Response: The response from the webhook.
     """
@@ -77,21 +142,11 @@ def send_to_discord(entry) -> Response:
                                                            f"{entry.link}", rate_limit_retry=True)
     response = webhook.execute()
     if not response.ok:
-        # TODO: Send error to discord
         logger.error(f"Error: {response.status_code} {response.reason}")
         reader.mark_entry_as_unread(entry)
     return response
 
 
-class IfFeedError(BaseModel):
-    """Update a feed."""
-    feed_url: str
-    webhook: str
-    error: bool
-    err_msg: str = ""
-    exception: str = ""
-
-
 def update_feed(feed_url: str, webhook: str) -> IfFeedError:
     """
     Update a feed.
@@ -122,29 +177,3 @@ def update_feed(feed_url: str, webhook: str) -> IfFeedError:
         return IfFeedError(error=True, err_msg=error_msg, feed_url=feed_url, webhook=webhook, exception=error.message)
 
     return IfFeedError(error=False, feed_url=feed_url, webhook=webhook)
-
-
-def add_feed(feed_url: str, webhook: str, exist_ok=False, allow_invalid_url=False) -> IfFeedError:
-    """
-    Add a feed.
-
-    Args:
-        feed_url: The feed to add.
-        webhook:  The webhook to use.
-        exist_ok:  If the feed already exists, do nothing.
-        allow_invalid_url:  If the feed url is invalid, add it anyway.
-
-    Returns:
-        IfFeedError: Error or not.
-    """
-    try:
-        reader.add_feed(feed=feed_url, exist_ok=exist_ok, allow_invalid_url=allow_invalid_url)
-    except FeedExistsError as error:
-        error_msg = "Feed already exists"
-        logger.error(f"{error_msg}: {error}")
-        return IfFeedError(error=True, err_msg=error_msg, feed_url=feed_url, webhook=webhook, exception=error.message)
-
-    except InvalidFeedURLError as error:
-        error_msg = "Invalid feed URL"
-        logger.error(f"{error_msg}: {error}")
-        return IfFeedError(error=True, err_msg=error_msg, feed_url=feed_url, webhook=webhook, exception=error.message)