Add --reset option to archive_feed command

This commit is contained in:
Joakim Hellsén 2026-03-24 15:28:26 +01:00
commit 0e1624c2c9
Signed by: Joakim Hellsén
SSH key fingerprint: SHA256:/9h/CsExpFp+PRhsfA0xznFx2CGfTT5R/kpuFfUgEQk
2 changed files with 114 additions and 3 deletions

View file

@ -1,34 +1,106 @@
from typing import TYPE_CHECKING
from typing import Any
from django.core.management.base import BaseCommand
from feeds.models import Entry
from feeds.models import Feed
from feeds.services import fetch_and_archive_feed
if TYPE_CHECKING:
from django.core.management.base import CommandParser
from pytest_django.asserts import QuerySet
class Command(BaseCommand):
"""Django management command to fetch and archive a feed by URL."""
help = "Fetch and archive a feed by URL."
amount_to_show: int = 10
def add_arguments(self, parser: CommandParser) -> None:
"""Add URL argument to the command."""
parser.add_argument("url", type=str, help="Feed URL to fetch and archive.")
"""Add URL argument and --reset option to the command."""
parser.add_argument(
"url",
type=str,
help="Feed URL to fetch and archive.",
)
parser.add_argument(
"--reset",
action="store_true",
help="Remove all entries for this feed before archiving.",
)
def handle(self, *args, **options) -> None: # noqa: ARG002
"""Handle the command execution."""
url: str = options["url"]
reset: bool = options.get("reset", False)
feed, created = Feed.objects.get_or_create(url=url)
if created:
self.stdout.write(self.style.SUCCESS(f"Created new feed for URL: {url}"))
msg = f"Created new feed for URL: {url}"
self.stdout.write(self.style.SUCCESS(msg))
if reset:
entries_qs: QuerySet[Entry, Entry] = Entry.objects.filter(feed=feed)
count: int = entries_qs.count()
if count == 0:
msg = f"No entries found for feed: {url}"
self.stdout.write(self.style.WARNING(msg))
else:
msg = f"The following {count} entries will be removed for feed: {url}"
self.stdout.write(self.style.WARNING(msg))
entries = entries_qs.order_by("-published_at")[: self.amount_to_show]
for entry in entries:
title: str | None = get_entry_title(entry)
msg = f"- entry_id: {entry.entry_id}, published_at: {entry.published_at}, title: {title}"
self.stdout.write(self.style.WARNING(msg))
if count > self.amount_to_show:
self.stdout.write(f"...and {count - self.amount_to_show} more.")
prompt = "Are you sure you want to delete these entries? Type 'yes' to confirm: "
confirm: str = input(prompt)
if confirm.strip().lower() == "yes":
deleted, _ = entries_qs.delete()
msg = f"Deleted {deleted} entr{'y' if deleted == 1 else 'ies'} for feed: {url}"
self.stdout.write(self.style.SUCCESS(msg))
else:
msg = "Aborted reset. No entries were deleted."
self.stdout.write(self.style.ERROR(msg))
return
new_entries: int = fetch_and_archive_feed(feed)
if new_entries:
msg: str = f"Archived {new_entries} new entr{'y' if new_entries == 1 else 'ies'} for URL: {url}"
self.stdout.write(self.style.SUCCESS(msg))
else:
msg: str = "\tFeed is up to date, but no new entries were archived."
self.stdout.write(self.style.WARNING(msg))
def get_entry_title(entry: Entry) -> str | None:
"""Get the title from an entry's data.
Args:
entry (Entry): The Entry object from which to extract the title.
Returns:
str | None: The title of the entry if available, otherwise None.
"""
# entry_data is a JSONField
entry_data: dict[str, Any] | list[Any] | None = entry.data
if not isinstance(entry_data, dict):
return None
return entry_data.get("title")

View file

@ -0,0 +1,39 @@
import builtins
from typing import TYPE_CHECKING
import pytest
from django.core.management import call_command
from feeds.models import Entry
from feeds.models import Feed
if TYPE_CHECKING:
from collections.abc import Callable
@pytest.mark.django_db
def test_reset_option_removes_only_feed_entries(db: None) -> None:
"""Test that the --reset option in the archive_feed command only removes entries for the specified feed."""
url1 = "http://example.com/feed1.xml"
url2 = "http://example.com/feed2.xml"
feed1: Feed = Feed.objects.create(url=url1, domain="example.com")
feed2: Feed = Feed.objects.create(url=url2, domain="example.com")
# Create entries for both feeds
_e1: Entry = Entry.objects.create(feed=feed1, entry_id="a", content_hash=1)
_e2: Entry = Entry.objects.create(feed=feed1, entry_id="b", content_hash=2)
_e3: Entry = Entry.objects.create(feed=feed2, entry_id="c", content_hash=3)
assert Entry.objects.filter(feed=feed1).count() == 2
assert Entry.objects.filter(feed=feed2).count() == 1
# Simulate user confirmation by patching input
orig_input: Callable[[object], str] = builtins.input
builtins.input = lambda _: "yes"
try:
call_command("archive_feed", url1, "--reset")
finally:
builtins.input = orig_input
# Only feed1's entries should be deleted
assert Entry.objects.filter(feed=feed1).count() == 0
assert Entry.objects.filter(feed=feed2).count() == 1