oldnews 0.8.0__tar.gz → 0.9.0__tar.gz

{oldnews-0.8.0 → oldnews-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oldnews
-Version: 0.8.0
+Version: 0.9.0
 Summary: A terminal-based client for TheOldReader
 Keywords: atom,client,Google Reader,RSS,TheOldReader,terminal,news-reader,news
 Author: Dave Pearson
@@ -20,7 +20,7 @@ Requires-Dist: oldas>=0.10.0
 Requires-Dist: textual>=6.3.0
 Requires-Dist: textual-autocomplete>=4.0.6
 Requires-Dist: textual-enhanced>=1.2.0
-Requires-Dist: typedal>=4.2.2
+Requires-Dist: tortoise-orm>=0.25.4
 Requires-Dist: xdg-base-dirs>=6.0.2
 Requires-Python: >=3.12
 Project-URL: Homepage, https://github.com/davep/oldnews

{oldnews-0.8.0 → oldnews-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oldnews"
-version = "0.8.0"
+version = "0.9.0"
 description = "A terminal-based client for TheOldReader"
 readme = "README.md"
 authors = [
@@ -25,7 +25,7 @@ dependencies = [
     "textual>=6.3.0",
     "textual-autocomplete>=4.0.6",
     "textual-enhanced>=1.2.0",
-    "typedal>=4.2.2",
+    "tortoise-orm>=0.25.4",
     "xdg-base-dirs>=6.0.2",
 ]
 classifiers = [
@@ -51,7 +51,7 @@ Discussions = "https://github.com/davep/oldnews/discussions"
 oldnews = "oldnews.__main__:main"
 
 [build-system]
-requires = ["uv_build>=0.9.4,<0.10.0"]
+requires = ["uv_build>=0.9.4,<0.11.0"]
 build-backend = "uv_build"
 
 [[tool.uv.index]]
@@ -73,3 +73,26 @@ dev = [
     "ruff>=0.14.0",
     "textual-dev>=1.8.0",
 ]
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+]
+ignore = [
+    # I think try...expect...pass reads far better.
+    "SIM105",
+]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120

{oldnews-0.8.0 → oldnews-0.9.0}/src/oldnews/__main__.py

@@ -9,7 +9,7 @@ from operator import attrgetter
 ##############################################################################
 # Local imports.
 from . import __doc__, __version__
-from .data import initialise_database, reset_data
+from .data import reset_data
 from .data.locations import config_dir, data_dir
 from .oldnews import OldNews
 
@@ -155,7 +155,6 @@ def main() -> None:
         case "themes":
             show_themes()
         case _:
-            initialise_database()
             OldNews(args).run()
 
 

{oldnews-0.8.0 → oldnews-0.9.0}/src/oldnews/data/__init__.py

@@ -9,7 +9,6 @@ from .config import (
     save_configuration,
     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 (
@@ -24,6 +23,7 @@ from .local_articles import (
     rename_folder_for_articles,
     save_local_articles,
 )
+from .local_data import initialise_local_data, shutdown_local_data
 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
@@ -34,9 +34,8 @@ from .reset import reset_data
 ##############################################################################
 # Exports.
 __all__ = [
-    "Configuration",
-    "Log",
     "clean_old_read_articles",
+    "Configuration",
     "data_dump",
     "get_auth_token",
     "get_local_articles",
@@ -45,12 +44,13 @@ __all__ = [
     "get_local_unread",
     "get_navigation_state",
     "get_unread_article_ids",
-    "initialise_database",
+    "initialise_local_data",
     "last_grabbed_data_at",
     "load_configuration",
-    "locally_mark_read",
     "locally_mark_article_ids_read",
+    "locally_mark_read",
     "LocalUnread",
+    "Log",
     "move_subscription_articles",
     "remember_we_last_grabbed_at",
     "remove_folder_from_articles",
@@ -63,6 +63,7 @@ __all__ = [
     "save_local_subscriptions",
     "save_navigation_state",
     "set_auth_token",
+    "shutdown_local_data",
     "total_unread",
     "update_configuration",
 ]

{oldnews-0.8.0 → oldnews-0.9.0}/src/oldnews/data/config.py

@@ -2,12 +2,12 @@
 
 ##############################################################################
 # Python imports.
+from collections.abc import Iterator
 from contextlib import contextmanager
 from dataclasses import asdict, dataclass, field
-from functools import lru_cache
+from functools import cache
 from json import dumps, loads
 from pathlib import Path
-from typing import Iterator
 
 ##############################################################################
 # Local imports.
@@ -37,6 +37,9 @@ class Configuration:
     startup_refresh_holdoff_period: float = 600
     """The number of seconds to wait before hitting TheOldReader again on startup."""
 
+    article_download_batch_size: int = 50
+    """The batch size to use when downloading articles."""
+
 
 ##############################################################################
 def configuration_file() -> Path:
@@ -66,7 +69,7 @@ def save_configuration(configuration: Configuration) -> Configuration:
 
 
 ##############################################################################
-@lru_cache(maxsize=None)
+@cache
 def load_configuration() -> Configuration:
     """Load the configuration.
 

{oldnews-0.8.0 → oldnews-0.9.0}/src/oldnews/data/last_grab.py

@@ -2,39 +2,31 @@
 
 ##############################################################################
 # Python imports.
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 ##############################################################################
-# TypeDAL imports.
-from typedal import TypedTable
+# Tortoise imports.
+from tortoise.transactions import in_transaction
 
 ##############################################################################
 # Local imports.
-from .tools import commit
+from .models import LastGrabbed
 
 
 ##############################################################################
-class LastGrabbed(TypedTable):
-    """Table that holds details of when data was last grabbed."""
-
-    at_time: datetime
-    """The time at which data was last grabbed."""
-
-
-##############################################################################
-def last_grabbed_data_at() -> datetime | None:
+async def last_grabbed_data_at() -> datetime | None:
     """The time at which data was last grabbed.
 
     Returns:
         The time at which we last grabbed data, or `None` if we never have.
     """
-    if (row := LastGrabbed.select(LastGrabbed.ALL).first()) is not None:
-        return row.at_time
+    if last_grabbed := await LastGrabbed.first():
+        return last_grabbed.at_time
     return None
 
 
 ##############################################################################
-def remember_we_last_grabbed_at(grab_time: datetime | None = None) -> None:
+async def remember_we_last_grabbed_at(grab_time: datetime | None = None) -> None:
     """Remember the time we last grabbed data.
 
     Args:
@@ -43,9 +35,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.
     """
-    LastGrabbed.truncate()
-    LastGrabbed.insert(at_time=grab_time or datetime.now(timezone.utc))
-    commit(LastGrabbed)
+    async with in_transaction():
+        await LastGrabbed.all().delete()
+        await LastGrabbed.create(at_time=grab_time or datetime.now(UTC))
 
 
 ### last_grab.py ends here

oldnews-0.9.0/src/oldnews/data/local_articles.py

@@ -0,0 +1,291 @@
+"""Code relating to persisting articles."""
+
+##############################################################################
+# Python imports.
+from collections.abc import Iterable
+from datetime import UTC, datetime, timedelta
+from html import unescape
+from typing import cast
+
+##############################################################################
+# OldAS imports.
+from oldas import Article, Articles, Folder, Folders, State, Subscription
+from oldas.articles import Alternate, Alternates, Direction, Origin, Summary
+
+##############################################################################
+# Tortoise imports.
+from tortoise.transactions import in_transaction
+
+##############################################################################
+# Local imports.
+from .log import Log
+from .models import LocalArticle, LocalArticleAlternate, LocalArticleCategory
+
+
+##############################################################################
+async def save_local_articles(articles: Articles) -> Articles:
+    """Locally save the given articles.
+
+    Args:
+        articles: The articles to save.
+
+    Returns:
+        The articles.
+    """
+    for article in articles:
+        async with in_transaction():
+            local_article, _ = await LocalArticle.update_or_create(
+                article_id=article.id,
+                defaults={
+                    "title": article.title,
+                    "published": article.published,
+                    "updated": article.updated,
+                    "author": article.author,
+                    "summary_direction": article.summary.direction,
+                    "summary_content": article.summary.content,
+                    "origin_stream_id": article.origin.stream_id,
+                    "origin_title": article.origin.title,
+                    "origin_html_url": article.origin.html_url,
+                },
+            )
+            await LocalArticleCategory.filter(article=local_article).delete()
+            await LocalArticleCategory.bulk_create(
+                LocalArticleCategory(article=local_article, category=str(category))
+                for category in article.categories
+            )
+            await LocalArticleAlternate.filter(article=local_article).delete()
+            await LocalArticleAlternate.bulk_create(
+                LocalArticleAlternate(
+                    article=local_article,
+                    href=alternate.href,
+                    mime_type=alternate.mime_type,
+                )
+                for alternate in article.alternate
+            )
+    return articles
+
+
+##############################################################################
+async def get_local_read_article_ids() -> set[str]:
+    """Get the set of local articles that have been read.
+
+    Returns:
+        A `set` of IDs of articles that have been read.
+    """
+    return {
+        category.article.article_id
+        for category in await LocalArticleCategory.filter(
+            category=str(State.READ)
+        ).prefetch_related("article")
+    }
+
+
+##############################################################################
+async def get_local_articles(
+    related_to: Folder | Subscription, unread_only: bool
+) -> Articles:
+    """Get all available unread articles.
+
+    Args:
+        related_to: The folder or feed the articles should relate to.
+        unread_only: Only load up the unread articles?
+
+    Returns: The unread articles.
+    """
+    local_articles = (
+        LocalArticle.filter(categories__category=related_to.id)
+        if isinstance(related_to, Folder)
+        else LocalArticle.filter(origin_stream_id=related_to.id)
+    )
+    if unread_only and (read := (await get_local_read_article_ids())):
+        local_articles = local_articles.filter(article_id__not_in=read)
+
+    articles: list[Article] = []
+    for article in await local_articles.prefetch_related(
+        "categories", "alternates"
+    ).order_by("-published"):
+        articles.append(
+            Article(
+                id=article.article_id,
+                title=unescape(article.title),
+                published=article.published,
+                updated=article.updated,
+                author=article.author,
+                categories=Article.clean_categories(
+                    category.category
+                    for category in article.categories  # type: ignore
+                ),
+                alternate=Alternates(
+                    Alternate(href=alternate.href, mime_type=alternate.mime_type)
+                    for alternate in article.alternates  # type: ignore
+                ),
+                origin=Origin(
+                    stream_id=article.origin_stream_id,
+                    title=unescape(article.origin_title),
+                    html_url=article.origin_html_url,
+                ),
+                summary=Summary(
+                    direction=cast(Direction, article.summary_direction),
+                    content=article.summary_content,
+                ),
+            )
+        )
+    return Articles(articles)
+
+
+##############################################################################
+async def locally_mark_read(article: Article) -> None:
+    """Mark the given article as read.
+
+    Args:
+        article: The article to locally mark as read.
+    """
+    if local_article := await LocalArticle.filter(article_id=article.id).get_or_none():
+        await local_article.add_category(str(State.READ))
+
+
+##############################################################################
+async def locally_mark_article_ids_read(articles: Iterable[str]) -> None:
+    """Locally mark a collection of article IDs as being read.
+
+    Args:
+        articles: The article IDs to mark as read.
+    """
+    if article_ids := set(articles):
+        Log().debug(f"Number of articles to mark as read: {len(article_ids)}")
+        await LocalArticleCategory.bulk_create(
+            [
+                LocalArticleCategory(article=article, category=str(State.READ))
+                for article in await LocalArticle.filter(article_id__in=article_ids)
+            ],
+            ignore_conflicts=True,
+        )
+
+
+##############################################################################
+async def unread_count_in(
+    category: Folder | Subscription, read: set[str] | None = None
+) -> int:
+    """Get the count of unread articles in a given category.
+
+    Args:
+        category: The category (Folder or Subscription) to get the unread count for.
+        read: The set of IDs of read articles.
+
+    Returns:
+        The count of unread articles in that category.
+    """
+    query = (
+        LocalArticle.filter(categories__category=category.id)
+        if isinstance(category, Folder)
+        else LocalArticle.filter(origin_stream_id=category.id)
+    )
+    if read := read if read is not None else await get_local_read_article_ids():
+        query = query.filter(article_id__not_in=read)
+    return await query.count()
+
+
+##############################################################################
+async def get_unread_article_ids() -> list[str]:
+    """Get a list of all the unread article IDs.
+
+    Returns:
+        The list of IDs of unread articles.
+    """
+    read = await get_local_read_article_ids()
+    return [
+        article.article_id
+        for article in await LocalArticle.filter(article_id__not_in=read)
+    ]
+
+
+##############################################################################
+async def clean_old_read_articles(cutoff: timedelta) -> int:
+    """Clean up articles that are older than the given cutoff time.
+
+    Args:
+        cutoff: The cutoff period after which articles will be removed.
+
+    Returns:
+        The number of removed articles.
+    """
+    read = await get_local_read_article_ids()
+    retire_time = datetime.now(UTC) - cutoff
+    Log().debug(f"Cleaning up read articles published before {retire_time}")
+    cleaned = await LocalArticle.filter(
+        published__lt=retire_time, article_id__in=read
+    ).delete()
+    Log().debug(f"Cleaned: {cleaned}")
+    return cleaned
+
+
+##############################################################################
+async 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}")
+    await LocalArticleCategory.filter(category=rename_from).update(category=rename_to)
+
+
+##############################################################################
+async 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")
+    await LocalArticleCategory.filter(category=folder).delete()
+
+
+##############################################################################
+async 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 await LocalArticle.filter(
+        origin_stream_id=subscription.id
+    ).prefetch_related("categories"):
+        if from_folder:
+            await article.remove_category(from_folder)
+        if to_folder:
+            await article.add_category(to_folder)
+
+
+##############################################################################
+async 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}")
+    deleted = await LocalArticle.filter(origin_stream_id=subscription).delete()
+    Log().debug(f"Articles removed that belonged to {subscription}: {deleted}")
+
+
+### local_articles.py ends here

oldnews-0.9.0/src/oldnews/data/local_data.py

@@ -0,0 +1,45 @@
+"""Provides code for setting up the local database."""
+
+##############################################################################
+# Python imports.
+from pathlib import Path
+
+##############################################################################
+# Tortoise imports.
+from tortoise import Tortoise
+
+##############################################################################
+# Local imports.
+from .locations import data_dir
+from .log import Log
+
+
+##############################################################################
+def local_db_file() -> Path:
+    """Get the file that contains the database.
+
+    Returns:
+        The file that contains the database.
+    """
+    return data_dir() / "oldnews.db"
+
+
+##############################################################################
+async def initialise_local_data() -> None:
+    """Initialise the local storage."""
+    Log().debug("Database startup")
+    await Tortoise.init(
+        db_url=f"sqlite://{local_db_file()}",
+        modules={"models": ["oldnews.data.models"]},
+    )
+    await Tortoise.generate_schemas()
+
+
+##############################################################################
+async def shutdown_local_data() -> None:
+    """Close down the local connection."""
+    await Tortoise.close_connections()
+    Log().debug("Database shutdown")
+
+
+### local_data.py ends here

{oldnews-0.8.0 → oldnews-0.9.0}/src/oldnews/data/local_folders.py

@@ -5,26 +5,16 @@
 from oldas import Folder, Folders
 
 ##############################################################################
-# TypeDAL imports.
-from typedal import TypedTable
+# Tortoise imports.
+from tortoise.transactions import in_transaction
 
 ##############################################################################
 # Local imports.
-from .tools import commit
+from .models import LocalFolder
 
 
 ##############################################################################
-class LocalFolder(TypedTable):
-    """A local copy of a folder."""
-
-    folder_id: str
-    """The ID of the folder."""
-    sort_id: str
-    """The sort ID of the folder."""
-
-
-##############################################################################
-def get_local_folders() -> Folders:
+async def get_local_folders() -> Folders:
     """Gets the local cache of known folders.
 
     Returns:
@@ -32,12 +22,12 @@ def get_local_folders() -> Folders:
     """
     return Folders(
         Folder(id=folder.folder_id, sort_id=folder.sort_id)
-        for folder in LocalFolder.select(LocalFolder.ALL)
+        for folder in await LocalFolder.all()
     )
 
 
 ##############################################################################
-def save_local_folders(folders: Folders) -> Folders:
+async def save_local_folders(folders: Folders) -> Folders:
     """Save the local copy of the known folders.
 
     Args:
@@ -46,11 +36,12 @@ def save_local_folders(folders: Folders) -> Folders:
     Returns:
         The folders.
     """
-    LocalFolder.truncate()
-    LocalFolder.bulk_insert(
-        [{"folder_id": folder.id, "sort_id": folder.sort_id} for folder in folders]
-    )
-    commit(LocalFolder)
+    async with in_transaction():
+        await LocalFolder.all().delete()
+        await LocalFolder.bulk_create(
+            LocalFolder(folder_id=folder.id, sort_id=folder.sort_id)
+            for folder in folders
+        )
     return folders