reader 3.17__tar.gz → 3.18__tar.gz

{reader-3.17 → reader-3.18}/CHANGES.rst

@@ -6,6 +6,25 @@ Changelog
   :no-index:
 
 
+Version 3.18
+------------
+
+Released 2025-05-04
+
+* Drop Python 3.10 support. (:issue:`354`)
+
+* Add the ``overwrite`` argument to :meth:`~Reader.add_entry`.
+* Add :class:`FeedSort`, :class:`EntrySort`, and :class:`EntrySearchSort` enums.
+  (:issue:`354`)
+
+* Fix bug causing :meth:`.Reader.update_feeds`
+  to not honor ``updates_enabled=True`` when ``scheduled=True``.
+  (:issue:`365`)
+
+* In the :mod:`~reader._plugins.cli_status` plugin,
+  overwrite the entry so it doesn't appear briefly as unread.
+
+
 Version 3.17
 ------------
 

{reader-3.17/src/reader.egg-info → reader-3.18}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: reader
-Version: 3.17
+Version: 3.18
 Summary: A Python feed reader library.
 Author: lemon24
 License: BSD-3-Clause
@@ -19,7 +19,6 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -32,7 +31,7 @@ Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: typing-extensions>=4
@@ -90,6 +89,7 @@ Requires-Dist: tox; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
 
 .. begin-intro
 

{reader-3.17 → reader-3.18}/docs/api.rst

@@ -171,6 +171,23 @@ The class hierarchy for :mod:`reader` exceptions is:
 
 
 
+Enumerations
+------------
+
+.. autoclass:: reader.FeedSort(value)
+    :show-inheritance:
+    :members:
+
+.. autoclass:: reader.EntrySort(value)
+    :show-inheritance:
+    :members:
+
+.. autoclass:: reader.EntrySearchSort(value)
+    :show-inheritance:
+    :members:
+
+
+
 .. _type aliases:
 
 Type aliases

{reader-3.17 → reader-3.18}/pyproject.toml

@@ -23,7 +23,6 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -37,7 +36,7 @@ classifiers = [
     "Topic :: Utilities",
     "Typing :: Typed",
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dependencies = [
     "typing-extensions>=4",
     "feedparser>=6",
@@ -189,7 +188,7 @@ ignore_errors = true
 
 [tool.isort]
 profile = "black"
-py_version = 310
+py_version = 311
 src_paths = ["src", "tests"]
 extend_skip = ["examples", "src/reader/_vendor"]
 skip_gitignore = true

{reader-3.17 → reader-3.18}/src/reader/__init__.py

@@ -37,7 +37,7 @@ Print the titles of the unread entries::
 
 """
 
-__version__ = '3.17'
+__version__ = '3.18'
 
 # isort: off
 
@@ -58,6 +58,9 @@ from .types import (
     FeedCounts as FeedCounts,
     EntryCounts as EntryCounts,
     EntrySearchCounts as EntrySearchCounts,
+    FeedSort as FeedSort,
+    EntrySort as EntrySort,
+    EntrySearchSort as EntrySearchSort,
     UpdateResult as UpdateResult,
     UpdatedFeed as UpdatedFeed,
     EntryUpdateStatus as EntryUpdateStatus,

{reader-3.17 → reader-3.18}/src/reader/_parser/__init__.py

@@ -239,13 +239,9 @@ class NotModified(RetrieveError):
     _default_message = "not modified"
 
 
-@dataclass(frozen=True)
-class RetrieveResult(_namedtuple_compat, Generic[F, T, E]):
+class RetrieveResult(NamedTuple, Generic[F, T, E]):
     """The result of retrieving a feed, regardless of the outcome."""
 
-    # should be a NamedTuple, but the typing one became generic only in 3.11,
-    # and we don't want to depend on typing_extensions at runtime
-
     #: The feed (a :class:`FeedArgument`, usually a :class:`FeedForUpdate`).
     feed: F
 
@@ -339,8 +335,7 @@ class FeedForUpdateRetrieverType(RetrieverType[T_co], Protocol):  # pragma: no c
         """
 
 
-@dataclass(frozen=True)
-class ParseResult(_namedtuple_compat, Generic[F, E]):
+class ParseResult(NamedTuple, Generic[F, E]):
     """The result of retrieving and parsing a feed, regardless of the outcome."""
 
     #: The feed (a :class:`FeedArgument`, usually a :class:`.FeedForUpdate`).

{reader-3.17 → reader-3.18}/src/reader/_parser/_lazy.py

@@ -259,8 +259,7 @@ class Parser:
         Takes one argument and does not raise exceptions.
 
         """
-        feed = result.feed
-        context = result.value
+        feed, context = result
 
         http_info = None
         value: ParsedFeed | None | Exception

{reader-3.17 → reader-3.18}/src/reader/_parser/requests/_lazy.py

@@ -4,6 +4,7 @@ from collections.abc import Sequence
 from dataclasses import dataclass
 from dataclasses import field
 from typing import Any
+from typing import Self
 from typing import TYPE_CHECKING
 from typing import TypeVar
 
@@ -14,8 +15,6 @@ from . import TimeoutType
 
 
 if TYPE_CHECKING:  # pragma: no cover
-    from typing_extensions import Self
-
     from . import Headers
     from . import RequestHook
     from . import ResponseHook

{reader-3.17 → reader-3.18}/src/reader/_plugins/cli_status.py

@@ -73,7 +73,6 @@ def save_output(reader, now, config, command_path, output):
 
     try:
         old_content = reader.get_entry((feed_url, entry_id)).content[0].value
-        reader.delete_entry((feed_url, entry_id))
     except EntryNotFoundError:
         old_content = ''
 
@@ -91,7 +90,8 @@ def save_output(reader, now, config, command_path, output):
             title=title,
             updated=now,
             content=[dict(type='text/plain', value=''.join(parts))],
-        )
+        ),
+        overwrite=True,
     )
     reader.mark_entry_as_read((feed_url, entry_id))
 

{reader-3.17 → reader-3.18}/src/reader/_storage/_base.py

@@ -41,7 +41,7 @@ if debug:  # pragma: no cover
                 stmt = data.pop('stmt', None)
             print('STORAGE_DEBUG', json.dumps(data), file=sys.stderr)
             if stmt:
-                print(stmt)
+                print(stmt, file=sys.stderr)
 
 
 wrap_exceptions = partial(_sqlite_utils.wrap_exceptions, StorageError)

{reader-3.17 → reader-3.18}/src/reader/_storage/_entries.py

@@ -55,7 +55,7 @@ class EntriesMixin(StorageBase):
     def get_entries(
         self,
         filter: EntryFilter = EntryFilter(),  # noqa: B008
-        sort: EntrySort = 'recent',
+        sort: EntrySort = EntrySort.RECENT,
         limit: int | None = None,
         starting_after: tuple[str, str] | None = None,
     ) -> Iterable[Entry]:
@@ -64,7 +64,7 @@ class EntriesMixin(StorageBase):
             partial(get_entries_query, filter, sort),
             row_factory=entry_factory,
         )
-        if sort != 'random':
+        if sort != EntrySort.RANDOM:
             last = self.get_entry_last(sort, starting_after) if starting_after else None
             return paginated_query(limit, last)
         else:
@@ -571,7 +571,7 @@ RECENT_SORT_KEY = SortKey(
     desc=True,
 )
 
-ENTRY_SORT_KEYS = {'recent': RECENT_SORT_KEY}
+ENTRY_SORT_KEYS = {EntrySort.RECENT: RECENT_SORT_KEY}
 
 
 def entries_recent_sort(
@@ -597,9 +597,9 @@ def entries_random_sort(query: Query) -> None:
     query.ORDER_BY("random()")
 
 
-ENTRIES_SORT: dict[str, Callable[[Query], None]] = {
-    'recent': entries_recent_sort,
-    'random': entries_random_sort,
+ENTRIES_SORT: dict[EntrySort, Callable[[Query], None]] = {
+    EntrySort.RECENT: entries_recent_sort,
+    EntrySort.RANDOM: entries_random_sort,
 }
 
 

{reader-3.17 → reader-3.18}/src/reader/_storage/_feeds.py

@@ -107,7 +107,7 @@ class FeedsMixin(StorageBase):
     def get_feeds(
         self,
         filter: FeedFilter = FeedFilter(),  # noqa: B008
-        sort: FeedSort = 'title',
+        sort: FeedSort = FeedSort.TITLE,
         limit: int | None = None,
         starting_after: str | None = None,
     ) -> Iterable[Feed]:
@@ -335,8 +335,10 @@ def feed_factory(row: tuple[Any, ...]) -> Feed:
 FEED_SORT_KEYS = {
     # values must be non-null, see #203 for details.
     # url at the end makes the order deterministic.
-    'title': SortKey(("kinda_title", "lower(coalesce(user_title, title, ''))"), "url"),
-    'added': SortKey("added", "url", desc=True),
+    FeedSort.TITLE: SortKey(
+        ("kinda_title", "lower(coalesce(user_title, title, ''))"), "url"
+    ),
+    FeedSort.ADDED: SortKey("added", "url", desc=True),
 }
 
 
@@ -358,7 +360,7 @@ def feed_filter(query: Query, filter: FeedFilter) -> dict[str, Any]:
     if new is not None:
         query.WHERE(f"last_retrieved is {'' if new else 'NOT'} NULL")
     if update_after is not None:
-        query.WHERE("update_after is NULL or update_after <= :update_after")
+        query.WHERE("(update_after is NULL or update_after <= :update_after)")
         context.update(update_after=adapt_datetime(update_after))
 
     return context

{reader-3.17 → reader-3.18}/src/reader/_storage/_search.py

@@ -28,8 +28,9 @@ from ..exceptions import SearchError
 from ..exceptions import SearchNotEnabledError
 from ..types import EntrySearchCounts
 from ..types import EntrySearchResult
+from ..types import EntrySearchSort
+from ..types import EntrySort
 from ..types import HighlightedString
-from ..types import SearchSortOrder
 from . import _entries
 from . import _html_utils
 from . import _sqlite_utils
@@ -425,7 +426,7 @@ class Search:
         self,
         query: str,
         filter: EntryFilter = EntryFilter(),  # noqa: B008
-        sort: SearchSortOrder = 'relevant',
+        sort: EntrySearchSort = EntrySearchSort.RELEVANT,
         limit: int | None = None,
         starting_after: tuple[str, str] | None = None,
     ) -> Iterable[EntrySearchResult]:
@@ -457,13 +458,13 @@ class Search:
                 )
 
         # TODO: dupe of at least Storage.get_entries(), maybe deduplicate
-        if sort != 'random':
+        if sort != EntrySearchSort.RANDOM:
             last = None
             if starting_after:
-                if sort == 'relevant':
+                if sort == EntrySearchSort.RELEVANT:
                     last = self.search_entry_last(query, starting_after)
-                elif sort == 'recent':
-                    last = self.storage.get_entry_last(sort, starting_after)
+                elif sort == EntrySearchSort.RECENT:
+                    last = self.storage.get_entry_last(EntrySort.RECENT, starting_after)
                 else:
                     assert False, "shouldn't get here"  # noqa: B011; # pragma: no cover
 
@@ -527,7 +528,7 @@ class Search:
 
 
 def make_search_entries_query(
-    filter: EntryFilter, sort: SearchSortOrder
+    filter: EntryFilter, sort: EntrySearchSort
 ) -> tuple[Query, dict[str, Any]]:
     search = (
         Query()
@@ -585,12 +586,12 @@ def relevant_sort(query: Query) -> None:
     )
 
 
-SEARCH_ENTRIES_SORT: dict[str, Callable[[Query], None]] = {
-    'relevant': relevant_sort,
-    'recent': partial(
+SEARCH_ENTRIES_SORT: dict[EntrySearchSort, Callable[[Query], None]] = {
+    EntrySearchSort.RELEVANT: relevant_sort,
+    EntrySearchSort.RECENT: partial(
         _entries.entries_recent_sort, keyword='HAVING', id_prefix='search._'
     ),
-    'random': _entries.entries_random_sort,
+    EntrySearchSort.RANDOM: _entries.entries_random_sort,
 }
 
 

{reader-3.17 → reader-3.18}/src/reader/_storage/_sql_utils.py

@@ -34,6 +34,7 @@ from collections.abc import Iterable
 from dataclasses import dataclass
 from typing import Any
 from typing import NamedTuple
+from typing import Self
 from typing import TYPE_CHECKING
 from typing import TypeVar
 from typing import Union
@@ -42,8 +43,6 @@ from typing import Union
 if TYPE_CHECKING:  # pragma: no cover
     import sqlite3
 
-    from typing_extensions import Self
-
 
 _T = TypeVar('_T')
 _U = TypeVar('_U')
@@ -197,7 +196,7 @@ class BaseQuery:
 
             yield '\n'
 
-    _indent = functools.partial(textwrap.indent, prefix='    ')
+    _indent = staticmethod(functools.partial(textwrap.indent, prefix='    '))
 
 
 if TYPE_CHECKING:  # pragma: no cover

{reader-3.17 → reader-3.18}/src/reader/_storage/_sqlite_utils.py

@@ -95,8 +95,17 @@ def wrap_exceptions(
     can only be fixed by the user (e.g. access permission denied), and aren't
     domain-related (those should have other custom exceptions).
 
-    This is an imprecise science, since the DB-API exceptions are somewhat
-    fuzzy in their meaning and we can't access the SQLite result code.
+    We intentionally rely on the error message, because:
+
+    * the DB-API exceptions are somewhat fuzzy in their meaning
+    * we can't access the SQLite result code prior to Python 3.11
+    * even having the primary result code (added in 3.11):
+      * it's generic SQLITE_ERROR for a lot of errors we care about
+        ("no such ...", "... already exists", invalid FTS5 queries)
+      * we need the table name so we don't accidentally shadow bugs
+      * we need the extended result code for the same reason
+        (e.g. SQLITE_CONSTRAINT vs SQLITE_CONSTRAINT_FOREIGNKEY)
+      * ProgrammingError usually does not have an error code
 
     Full discussion at https://github.com/lemon24/reader/issues/21
 

{reader-3.17 → reader-3.18}/src/reader/_types.py

@@ -20,7 +20,7 @@ from typing import NamedTuple
 from typing import overload
 from typing import Protocol
 from typing import runtime_checkable
-from typing import TYPE_CHECKING
+from typing import Self
 from typing import TypeVar
 from typing import Union
 
@@ -40,6 +40,7 @@ from .types import EntryCounts
 from .types import EntryInput
 from .types import EntrySearchCounts
 from .types import EntrySearchResult
+from .types import EntrySearchSort
 from .types import EntrySort
 from .types import EntrySource
 from .types import ExceptionInfo
@@ -51,15 +52,10 @@ from .types import JSONType
 from .types import MISSING
 from .types import MissingType
 from .types import ResourceId
-from .types import SearchSortOrder
 from .types import TagFilterInput
 from .types import TristateFilterInput
 
 
-if TYPE_CHECKING:  # pragma: no cover
-    from typing_extensions import Self
-
-
 log = logging.getLogger("reader")
 
 # Private API
@@ -1268,7 +1264,7 @@ class SearchType(Protocol):  # pragma: no cover
         query: str,
         /,
         filter: EntryFilter,
-        sort: SearchSortOrder,
+        sort: EntrySearchSort,
         limit: int | None,
         starting_after: tuple[str, str] | None,
     ) -> Iterable[EntrySearchResult]:

{reader-3.17 → reader-3.18}/src/reader/_update.py

@@ -430,8 +430,7 @@ class Pipeline:
         config: UpdateConfig,
         result: ParseResult[FeedForUpdate, ParseError],
     ) -> tuple[str, UpdatedFeed | None | Exception]:
-        feed = result.feed
-        value = result.value
+        feed, value, _ = result
 
         # TODO: don't duplicate code from update()
         # TODO: the feed tag value should come from get_feeds_for_update()