reader.opml.Feed -> reader.FeedToImport. #165

Author: lemon24

docs/api.rst

@@ -67,6 +67,10 @@ Data objects
 .. autoclass:: EntryUpdateStatus
     :members:
 
+.. autoclass:: FeedToImport
+    :members:
+    :undoc-members:
+
 .. autoclass:: FeedImportResult
     :members:
 
@@ -162,11 +166,11 @@ Exceptions
 .. autoexception:: PluginInitError
     :show-inheritance:
 
-
-.. autoexception:: ReaderWarning
+.. autoexception:: FeedImportError
     :show-inheritance:
 
-.. autoexception:: FeedImportError
+
+.. autoexception:: ReaderWarning
     :show-inheritance:
 
 

src/reader/__init__.py

@@ -64,6 +64,7 @@
     UpdateResult as UpdateResult,
     UpdatedFeed as UpdatedFeed,
     EntryUpdateStatus as EntryUpdateStatus,
+    FeedToImport as FeedToImport,
     FeedImportResult as FeedImportResult,
     FeedExport as FeedExport,
 )

src/reader/_app/__init__.py

@@ -30,6 +30,7 @@
 from reader import EntryNotFoundError
 from reader import FeedExistsError
 from reader import FeedNotFoundError
+from reader import FeedToImport
 from reader import InvalidFeedURLError
 from reader import opml
 from reader import UpdateError
@@ -290,7 +291,9 @@ def import_feeds():
             except opml.OPMLError as e:
                 error = str(e)
         else:
-            feeds = (opml.Feed(**json.loads(f)) for f in request.form.getlist('feed'))
+            feeds = (
+                FeedToImport(**json.loads(f)) for f in request.form.getlist('feed')
+            )
             imported_feeds = list(reader.import_feeds_iter(feeds))
             # TODO: out of band update (unlike add, there's too many to do here)
 

src/reader/core.py

@@ -70,6 +70,7 @@
 from .types import FeedImportResult
 from .types import FeedInput
 from .types import FeedSort
+from .types import FeedToImport
 from .types import JSONType
 from .types import MISSING
 from .types import MissingType
@@ -80,7 +81,6 @@
 from .types import UpdateResult
 
 if TYPE_CHECKING:  # pragma: no cover
-    from . import opml
     from ._parser import Parser
 
 
@@ -2207,12 +2207,12 @@ def import_feeds(self, file: IO[bytes], /) -> None:
             pass
 
     def import_feeds_iter(
-        self, feeds: Iterable[opml.Feed], /
+        self, feeds: Iterable[FeedToImport], /
     ) -> Iterable[FeedImportResult]:
         """Import feeds returned by :func:`reader.opml.parse`.
 
         Args:
-            feeds (iterable(reader.opml.Feed)): The feeds to import.
+            feeds (iterable(FeedToImport)): The feeds to import.
 
         Yields:
             :class:`FeedImportResult`: The feed and whether it was added.

src/reader/opml.py

@@ -5,21 +5,13 @@
 
 .. _OPML: https://opml.org/spec2.opml
 
-
 .. autofunction:: parse
 .. autofunction:: unparse
-
-.. autoclass:: Feed
-    :members:
-    :undoc-members:
-
 .. autoexception:: OPMLError
     :show-inheritance:
 
-
 .. versionadded:: 3.23
 
-
 .. todo::
 
     * use text= as user_title (both directions)
@@ -33,43 +25,27 @@
 import re
 import xml.etree.ElementTree as etree
 from collections.abc import Iterable
-from dataclasses import dataclass
-from dataclasses import KW_ONLY
 from datetime import datetime
 from email.utils import format_datetime
 from typing import cast
 from typing import IO
 
 import reader
-
-
-@dataclass
-class Feed:
-    """A feed in an OPML subscription list.
-
-    Attributes are similar to those of :class:`reader.Feed`.
-
-    """
-
-    url: str
-    _: KW_ONLY
-    title: str | None = None
-    link: str | None = None
-    subtitle: str | None = None
+from reader.types import FeedToImport
 
 
 class OPMLError(reader.FeedImportError):
     """An error occurred while parsing an OPML subscription list."""
 
 
-def parse(file: IO[bytes], max_depth: int = 10) -> list[Feed]:
+def parse(file: IO[bytes], max_depth: int = 10) -> list[FeedToImport]:
     """Extract a list of feeds from an OPML subscription list.
 
     Args:
         file (file): A binary file.
 
     Returns:
-        list(reader.opml.Feed): A list of feeds.
+        list(FeedToImport): A list of feeds.
 
     Raises:
         OPMLError:
@@ -88,7 +64,7 @@ def parse(file: IO[bytes], max_depth: int = 10) -> list[Feed]:
     if root.tag.lower() != 'opml':
         raise OPMLError(f"expected <opml> root tag, got: <{root.tag}>")
 
-    def walk(node: etree.Element, depth: int = 1) -> Iterable[Feed]:
+    def walk(node: etree.Element, depth: int = 1) -> Iterable[FeedToImport]:
         if depth > max_depth:
             raise OPMLError("tag depth limit exceeded")
 
@@ -100,7 +76,7 @@ def walk(node: etree.Element, depth: int = 1) -> Iterable[Feed]:
 
         if tag == 'outline' and type == 'rss':
             if url := attrib.get('xmlurl'):
-                yield Feed(
+                yield FeedToImport(
                     url,
                     title=attrib.get('title', attrib.get('text')),
                     link=attrib.get('htmlurl'),
@@ -154,7 +130,7 @@ def unparse(
     """Convert a list of feeds to an OPML subscription list.
 
     Args:
-        feeds (list(reader.Feed)): An iterable of feeds.
+        feeds (list(Feed)): An iterable of feeds.
         title (str or None): The list title.
         created (datetime or None): The list creation date.
 

src/reader/types.py

@@ -10,6 +10,7 @@
 from collections.abc import Sequence
 from dataclasses import dataclass
 from dataclasses import field
+from dataclasses import KW_ONLY
 from datetime import datetime
 from types import MappingProxyType
 from typing import Any
@@ -19,7 +20,6 @@
 from typing import overload
 from typing import Protocol
 from typing import Self
-from typing import TYPE_CHECKING
 from typing import TypedDict
 from typing import Union
 
@@ -31,9 +31,6 @@
 from reader._utils import MISSING as MISSING  # isort: skip # noqa: F401
 from reader._utils import MissingType as MissingType  # isort: skip # noqa: F401
 
-if TYPE_CHECKING:
-    from . import opml
-
 
 class _namedtuple_compat:
     """Add namedtuple-like methods to a dataclass."""
@@ -1242,6 +1239,23 @@ class UpdateConfig(TypedDict, total=False):
     jitter: float
 
 
+@dataclass
+class FeedToImport:
+    """A feed to be imported.
+
+    Attributes are similar to those of :class:`Feed`.
+
+    .. versionadded:: 3.23
+
+    """
+
+    url: str
+    _: KW_ONLY
+    title: str | None = None
+    link: str | None = None
+    subtitle: str | None = None
+
+
 @dataclass(frozen=True)
 class FeedImportResult:
     """The result of importing a single feed.
@@ -1251,7 +1265,7 @@ class FeedImportResult:
     """
 
     #: The feed parsed from the import file.
-    feed: opml.Feed
+    feed: FeedToImport
 
     #: Exception raised by :meth:`~add_feed`, if any.
     exception: FeedError | None = None

tests/test_opml.py

@@ -2,8 +2,8 @@
 
 import pytest
 
+from reader import FeedImportError
 from reader import InvalidFeedURLError
-from reader.opml import OPMLError
 from reader.opml import parse
 from reader.opml import unparse
 from utils import utc_datetime as datetime
@@ -92,7 +92,7 @@ def test_empty():
     ],
 )
 def test_parse_error(input, message):
-    with pytest.raises(OPMLError, match=message):
+    with pytest.raises(FeedImportError, match=message):
         parse(io.BytesIO(input.encode()), max_depth=3)