oldnews 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

oldnews/__main__.py

@@ -10,6 +10,7 @@ from operator import attrgetter
 # Local imports.
 from . import __doc__, __version__
 from .data import initialise_database, reset_data
+from .data.locations import config_dir, data_dir
 from .oldnews import OldNews
 
 
@@ -49,6 +50,13 @@ def get_args() -> Namespace:
         dest="command", help="Available commands", required=False
     )
 
+    # Add the 'directories' command.
+    sub_parser.add_parser(
+        "directories",
+        aliases=["dirs", "d"],
+        help="Show the directories created and used by OldNews",
+    )
+
     # Add the 'license' command.
     sub_parser.add_parser(
         "license",
@@ -135,6 +143,9 @@ def reset_news(args: Namespace) -> None:
 def main() -> None:
     """Main entry function."""
     match (args := get_args()).command:
+        case "d" | "dirs" | "directories":
+            print(config_dir())
+            print(data_dir())
         case "reset":
             reset_news(args)
         case "license" | "licence":

oldnews/commands/__init__.py

@@ -3,12 +3,15 @@
 ##############################################################################
 # Local imports.
 from .main import (
+    AddSubscription,
     Copy,
     CopyArticleToClipboard,
     CopyFeedToClipboard,
     CopyHomePageToClipboard,
     Escape,
+    Information,
     MarkAllRead,
+    MoveSubscription,
     Next,
     NextUnread,
     OpenArticle,
@@ -16,25 +19,32 @@ from .main import (
     Previous,
     PreviousUnread,
     RefreshFromTheOldReader,
+    Remove,
+    Rename,
     ToggleShowAll,
 )
 
 ##############################################################################
 # Exports.
 __all__ = [
+    "AddSubscription",
     "Copy",
     "CopyArticleToClipboard",
     "CopyFeedToClipboard",
     "CopyHomePageToClipboard",
     "Escape",
+    "Information",
     "MarkAllRead",
     "Next",
     "NextUnread",
+    "MoveSubscription",
     "OpenArticle",
     "OpenHomePage",
     "Previous",
     "PreviousUnread",
     "RefreshFromTheOldReader",
+    "Rename",
+    "Remove",
     "ToggleShowAll",
 ]
 

oldnews/commands/main.py

@@ -105,4 +105,39 @@ class Copy(Command):
     BINDING_KEY = "ctrl+c"
 
 
+##############################################################################
+class AddSubscription(Command):
+    """Add a subscription feed"""
+
+    BINDING_KEY = "plus"
+
+
+##############################################################################
+class Rename(Command):
+    """Rename the current folder or subscription"""
+
+    BINDING_KEY = "f6"
+
+
+##############################################################################
+class Remove(Command):
+    """Remove the current folder or subscription"""
+
+    BINDING_KEY = "delete"
+
+
+##############################################################################
+class MoveSubscription(Command):
+    """Move the current subscription to folder"""
+
+    BINDING_KEY = "f7"
+
+
+##############################################################################
+class Information(Command):
+    """Show low-level information about the selected item"""
+
+    BINDING_KEY = "f8"
+
+
 ### main.py ends here

oldnews/data/__init__.py

@@ -10,6 +10,7 @@ from .config import (
     update_configuration,
 )
 from .db import initialise_database
+from .dump import data_dump
 from .last_grab import last_grabbed_data_at, remember_we_last_grabbed_at
 from .local_articles import (
     clean_old_read_articles,
@@ -17,11 +18,16 @@ from .local_articles import (
     get_unread_article_ids,
     locally_mark_article_ids_read,
     locally_mark_read,
+    move_subscription_articles,
+    remove_folder_from_articles,
+    remove_subscription_articles,
+    rename_folder_for_articles,
     save_local_articles,
 )
 from .local_folders import get_local_folders, save_local_folders
 from .local_subscriptions import get_local_subscriptions, save_local_subscriptions
 from .local_unread import LocalUnread, get_local_unread, total_unread
+from .log import Log
 from .navigation_state import get_navigation_state, save_navigation_state
 from .reset import reset_data
 
@@ -29,7 +35,9 @@ from .reset import reset_data
 # Exports.
 __all__ = [
     "Configuration",
+    "Log",
     "clean_old_read_articles",
+    "data_dump",
     "get_auth_token",
     "get_local_articles",
     "get_local_folders",
@@ -43,7 +51,11 @@ __all__ = [
     "locally_mark_read",
     "locally_mark_article_ids_read",
     "LocalUnread",
+    "move_subscription_articles",
     "remember_we_last_grabbed_at",
+    "remove_folder_from_articles",
+    "remove_subscription_articles",
+    "rename_folder_for_articles",
     "reset_data",
     "save_configuration",
     "save_local_articles",

oldnews/data/db.py

@@ -3,14 +3,11 @@
 ##############################################################################
 # Python imports.
 from pathlib import Path
-from typing import Any
 
 ##############################################################################
 # TypeDAL imports.
-from typedal import TypeDAL, TypedField, TypedTable
+from typedal import TypeDAL
 from typedal.config import TypeDALConfig
-from typedal.helpers import get_field
-from typedal.types import Field
 
 ##############################################################################
 # Local imports.
@@ -20,6 +17,7 @@ from .local_folders import LocalFolder
 from .local_subscriptions import LocalSubscription, LocalSubscriptionCategory
 from .locations import data_dir
 from .navigation_state import NavigationState
+from .tools import safely_index
 
 
 ##############################################################################
@@ -32,31 +30,6 @@ def db_file() -> Path:
     return data_dir() / "oldnews.db"
 
 
-##############################################################################
-def _safely_index(
-    table: type[TypedTable], name: str, field: str | Field | TypedField[Any]
-) -> None:
-    """Create an index on a type, but handle errors.
-
-    Args:
-        table: The table to create the index against.
-        name: The name of the index.
-        field: The field to index.
-
-    Notes:
-        From what I can gather TypeDAL *should* only create the index if it
-        doesn't exist. Instead it throws an error if it exists. So here I
-        swallow the `RuntimeError`. Hopefully there is a better way and I've
-        just missed it.
-    """
-    try:
-        table.create_index(
-            name, get_field(field) if isinstance(field, TypedField) else field
-        )
-    except RuntimeError:
-        pass
-
-
 ##############################################################################
 def initialise_database() -> TypeDAL:
     """Create the database.
@@ -73,20 +46,20 @@ def initialise_database() -> TypeDAL:
     dal = TypeDAL(f"sqlite://{db_file()}", folder=data_dir(), config=TypeDALConfig())
 
     dal.define(LocalArticle)
-    _safely_index(LocalArticle, "idx_local_article_article_id", LocalArticle.article_id)
-    _safely_index(
+    safely_index(LocalArticle, "idx_local_article_article_id", LocalArticle.article_id)
+    safely_index(
         LocalArticle,
         "idx_local_article_origin_stream_id",
         LocalArticle.origin_stream_id,
     )
 
     dal.define(LocalArticleCategory)
-    _safely_index(
+    safely_index(
         LocalArticleCategory,
         "idx_local_article_category_article",
         LocalArticleCategory.article,
     )
-    _safely_index(
+    safely_index(
         LocalArticleCategory,
         "idx_local_article_category_category",
         LocalArticleCategory.category,
@@ -97,19 +70,19 @@ def initialise_database() -> TypeDAL:
     dal.define(LocalFolder)
 
     dal.define(LocalSubscription)
-    _safely_index(
+    safely_index(
         LocalSubscription,
         "idx_local_subscription_subscription_id",
         LocalSubscription.subscription_id,
     )
 
     dal.define(LocalSubscriptionCategory)
-    _safely_index(
+    safely_index(
         LocalSubscriptionCategory,
         "idx_local_subscription_category_subscription",
         LocalSubscriptionCategory.subscription,
     )
-    _safely_index(
+    safely_index(
         LocalSubscriptionCategory,
         "idx_local_subscription_category_category_id",
         LocalSubscriptionCategory.category_id,

oldnews/data/dump.py

@@ -0,0 +1,75 @@
+"""Provides tools to dump data into an easy-to-browse format."""
+
+##############################################################################
+# Python imports.
+from functools import singledispatch
+from typing import Any
+
+##############################################################################
+# OldAS imports.
+from oldas import Article, Folder, Subscription
+
+##############################################################################
+type DataDump = tuple[tuple[str, str], ...]
+"""Type of a data dump."""
+
+
+##############################################################################
+@singledispatch
+def data_dump(data: Any) -> DataDump:
+    """Dump the given data into an easy-to-browse format.
+
+    Args:
+        data: The data to dump.
+
+    Returns:
+        A `DataDump` of the data.
+    """
+    return (("Data", str(data)),)
+
+
+##############################################################################
+@data_dump.register
+def _(data: Folder) -> DataDump:
+    return (("ID", data.id), ("Sort ID", data.sort_id))
+
+
+##############################################################################
+@data_dump.register
+def _(data: Subscription) -> DataDump:
+    return (
+        ("ID", data.id),
+        ("Title", data.title),
+        ("Sort ID", data.sort_id),
+        ("First Item Time", f"{data.first_item_time}"),
+        ("URL", data.url),
+        ("HTML URL", data.html_url),
+        *(
+            (
+                f"Category[{n}]",
+                f"{category.id}, {category.label}",
+            )
+            for n, category in enumerate(data.categories)
+        ),
+    )
+
+
+##############################################################################
+@data_dump.register
+def _(data: Article) -> DataDump:
+    # TODO: The article has pretty rich data, so in here I'm not showing
+    # it all, just enough to be useful. In the future perhaps make it a
+    # lot richer.
+    return (
+        ("ID", data.id),
+        ("Title", data.title),
+        ("Published", f"{data.published}"),
+        ("Updated", f"{data.updated}"),
+        *(
+            (f"Category[{n}]", f"{category}")
+            for n, category in enumerate(data.categories)
+        ),
+    )
+
+
+### dump.py ends here

oldnews/data/last_grab.py

@@ -8,6 +8,10 @@ from datetime import datetime, timezone
 # TypeDAL imports.
 from typedal import TypedTable
 
+##############################################################################
+# Local imports.
+from .tools import commit
+
 
 ##############################################################################
 class LastGrabbed(TypedTable):
@@ -39,10 +43,9 @@ def remember_we_last_grabbed_at(grab_time: datetime | None = None) -> None:
     Note:
         If `grab_time` isn't supplied then it is recorded as now.
     """
-    assert LastGrabbed._db is not None
     LastGrabbed.truncate()
     LastGrabbed.insert(at_time=grab_time or datetime.now(timezone.utc))
-    LastGrabbed._db.commit()
+    commit(LastGrabbed)
 
 
 ### last_grab.py ends here

oldnews/data/local_articles.py

@@ -8,13 +8,18 @@ from typing import Iterable, Iterator, cast
 
 ##############################################################################
 # OldAS imports.
-from oldas import Article, Articles, Folder, State, Subscription
+from oldas import Article, Articles, Folder, Folders, State, Subscription
 from oldas.articles import Alternate, Alternates, Direction, Origin, Summary
 
 ##############################################################################
 # TypeDAL imports.
 from typedal import TypedField, TypedTable, relationship
 
+##############################################################################
+# Local imports.
+from .log import Log
+from .tools import commit
+
 
 ##############################################################################
 class LocalArticle(TypedTable):
@@ -62,9 +67,8 @@ class LocalArticle(TypedTable):
             category: The category to add.
         """
         if not str(category) in self.categories:
-            assert LocalArticleCategory._db is not None
             LocalArticleCategory.insert(article=self.id, category=str(category))
-            LocalArticleCategory._db.commit()
+            commit(LocalArticleCategory)
 
     def remove_category(self, category: str | State) -> None:
         """Remove a given category from the local article.
@@ -73,12 +77,11 @@ class LocalArticle(TypedTable):
             category: The category to add.
         """
         if str(category) in self.categories:
-            assert LocalArticleCategory._db is not None
             LocalArticleCategory.where(
                 (LocalArticleCategory.article == self.id)
                 & (LocalArticleCategory.category == str(category))
             ).delete()
-            LocalArticleCategory._db.commit()
+            commit(LocalArticleCategory)
 
 
 ##############################################################################
@@ -113,7 +116,6 @@ def save_local_articles(articles: Articles) -> Articles:
     Returns:
         The articles.
     """
-    assert LocalArticle._db is not None
     for article in articles:
         local_article = LocalArticle.update_or_insert(
             LocalArticle.article_id == article.id,
@@ -146,7 +148,7 @@ def save_local_articles(articles: Articles) -> Articles:
                 for alternate in article.alternate
             ]
         )
-    LocalArticle._db.commit()
+    commit(LocalArticle)
     return articles
 
 
@@ -336,16 +338,93 @@ def get_unread_article_ids() -> list[str]:
 ##############################################################################
 def clean_old_read_articles(cutoff: timedelta) -> int:
     """Clean up articles that are older than the given cutoff time."""
-    assert LocalArticle._db is not None
     read = get_local_read_article_ids()
     retire_time = datetime.now() - cutoff
+    Log().debug(f"Cleaning up read articles published before {retire_time}")
     cleaned = len(
         LocalArticle.where(
             (LocalArticle.published < retire_time) & LocalArticle.id.belongs(read)
         ).delete()
     )
-    LocalArticle._db.commit()
+    Log().debug(f"Cleaned: {cleaned}")
+    commit(LocalArticle)
     return cleaned
 
 
+##############################################################################
+def rename_folder_for_articles(rename_from: str | Folder, rename_to: str) -> None:
+    """Rename a folder for all articles that are in that folder.
+
+    Args:
+        rename_from: The folder name to rename from.
+        rename_to: The folder name to rename to.
+    """
+    rename_from = Folders.full_id(rename_from)
+    rename_to = Folders.full_id(rename_to)
+    Log().debug(f"Renaming folder for local articles from {rename_from} to {rename_to}")
+    LocalArticleCategory.where(LocalArticleCategory.category == rename_from).update(
+        category=rename_to
+    )
+    commit(LocalArticleCategory)
+
+
+##############################################################################
+def remove_folder_from_articles(folder: str | Folder) -> None:
+    """Remove a folder from being associated with all articles.
+
+    Args:
+        folder: The folder to remove from all articles.
+    """
+    folder = Folders.full_id(folder)
+    Log().debug(f"Removing folder {folder} from all local articles")
+    LocalArticleCategory.where(LocalArticleCategory.category == folder).delete()
+    commit(LocalArticleCategory)
+
+
+##############################################################################
+def move_subscription_articles(
+    subscription: Subscription,
+    from_folder: str | Folder | None,
+    to_folder: str | Folder | None,
+) -> None:
+    """Move the articles of a subscription from one folder to another.
+
+    Args:
+        subscription: The subscription whose articles we should move.
+        from_folder: The folder to move from.
+        to_folder: The folder to move to.
+    """
+    from_folder = (
+        Folders.full_id(from_folder) if from_folder is not None else from_folder
+    )
+    to_folder = Folders.full_id(to_folder) if to_folder is not None else to_folder
+    Log().debug(
+        f"Moving all articles of {subscription.title} ({subscription.id}) from folder {from_folder} to {to_folder}"
+    )
+    for article in LocalArticle.where(origin_stream_id=subscription.id).join().select():
+        if from_folder:
+            LocalArticleCategory.where(
+                (LocalArticleCategory.article == article.id)
+                & (LocalArticleCategory.category == from_folder)
+            ).delete()
+            commit(LocalArticleCategory)
+        if to_folder:
+            LocalArticleCategory.insert(article=article.id, category=to_folder)
+            commit(LocalArticleCategory)
+
+
+##############################################################################
+def remove_subscription_articles(subscription: str | Subscription) -> None:
+    """Remove all the articles associated with the given subscription.
+
+    Args:
+        subscription: The subscription to remove the articles for.
+    """
+    if isinstance(subscription, Subscription):
+        subscription = subscription.id
+    Log().debug(f"Removing all local articles for subscription {subscription}")
+    LocalArticle.where(origin_stream_id=subscription).delete()
+    commit(LocalArticle)
+
+
 ### local_articles.py ends here

oldnews/data/local_folders.py

@@ -8,6 +8,10 @@ from oldas import Folder, Folders
 # TypeDAL imports.
 from typedal import TypedTable
 
+##############################################################################
+# Local imports.
+from .tools import commit
+
 
 ##############################################################################
 class LocalFolder(TypedTable):
@@ -42,12 +46,11 @@ def save_local_folders(folders: Folders) -> Folders:
     Returns:
         The folders.
     """
-    assert LocalFolder._db is not None
     LocalFolder.truncate()
     LocalFolder.bulk_insert(
         [{"folder_id": folder.id, "sort_id": folder.sort_id} for folder in folders]
     )
-    LocalFolder._db.commit()
+    commit(LocalFolder)
     return folders
 
 

oldnews/data/local_subscriptions.py

@@ -13,6 +13,10 @@ from oldas.subscriptions import Categories, Category
 # TypeDAL imports.
 from typedal import TypedTable
 
+##############################################################################
+# Local imports.
+from .tools import commit
+
 
 ##############################################################################
 class LocalSubscription(TypedTable):
@@ -83,29 +87,33 @@ def save_local_subscriptions(subscriptions: Subscriptions) -> Subscriptions:
     Returns:
         The subscriptions.
     """
-    assert LocalSubscription._db is not None
-    for subscription in subscriptions:
-        LocalSubscriptionCategory.where(subscription=subscription.id).delete()
-        LocalSubscriptionCategory.bulk_insert(
-            [
-                {
-                    "subscription": subscription.id,
-                    "category_id": category.id,
-                    "label": category.label,
-                }
-                for category in subscription.categories
-            ]
-        )
-        LocalSubscription.update_or_insert(
-            LocalSubscription.subscription_id == subscription.id,
-            subscription_id=subscription.id,
-            title=subscription.title,
-            sort_id=subscription.sort_id,
-            first_item_time=subscription.first_item_time,
-            url=subscription.url,
-            html_url=subscription.html_url,
-        )
-    LocalSubscription._db.commit()
+    LocalSubscription.truncate()
+    LocalSubscriptionCategory.truncate()
+    LocalSubscription.bulk_insert(
+        [
+            {
+                "subscription_id": subscription.id,
+                "title": subscription.title,
+                "sort_id": subscription.sort_id,
+                "first_item_time": subscription.first_item_time,
+                "url": subscription.url,
+                "html_url": subscription.html_url,
+            }
+            for subscription in subscriptions
+        ]
+    )
+    LocalSubscriptionCategory.bulk_insert(
+        [
+            {
+                "subscription": subscription.id,
+                "category_id": category.id,
+                "label": category.label,
+            }
+            for subscription in subscriptions
+            for category in subscription.categories
+        ]
+    )
+    commit(LocalSubscription)
     return subscriptions
 
 

oldnews/data/local_unread.py

@@ -2,7 +2,7 @@
 
 ##############################################################################
 # OldAS imports.
-from oldas import Folders, Subscriptions, id_is_a_folder
+from oldas import Folders, Subscriptions, id_is_a_feed
 
 ##############################################################################
 # Local imports.
@@ -41,7 +41,7 @@ def total_unread(unread: LocalUnread) -> int:
     Returns:
         The total unread.
     """
-    return sum(count for category, count in unread.items() if id_is_a_folder(category))
+    return sum(count for category, count in unread.items() if id_is_a_feed(category))
 
 
 ### local_unread.py ends here

oldnews/data/log.py

@@ -0,0 +1,38 @@
+"""Provides the application's logger."""
+
+##############################################################################
+# Python imports.
+from functools import cache
+from logging import DEBUG, INFO, Formatter, Logger, getLogger
+from logging.handlers import RotatingFileHandler
+from os import getenv
+
+##############################################################################
+# Local imports.
+from .locations import data_dir
+
+
+##############################################################################
+def _build_logger() -> Logger:
+    """Build a logger for the application.
+
+    Returns:
+        A configured `Logger` object.
+    """
+    logger = getLogger("oldnews")
+    logger.setLevel(DEBUG if getenv("OLDNEWS_DEBUG") else INFO)
+    file_handler = RotatingFileHandler(
+        data_dir() / "oldnews.log", maxBytes=1024 * 1024, backupCount=5
+    )
+    file_handler.setFormatter(
+        Formatter("%(asctime)s - %(levelname)s - %(module)s:%(lineno)d - %(message)s")
+    )
+    logger.addHandler(file_handler)
+    return logger
+
+
+##############################################################################
+Log = cache(_build_logger)
+"""The application-wide logging object."""
+
+### log.py ends here