Rename RSSFeed->RSS, RSSBaseModel->XMLBaseModel

Update TODOs

Author: dhvcc

rss_parser/_parser.py

@@ -1,22 +1,22 @@
 from xmltodict import parse
 
-from rss_parser.models.root import RSSFeed
+from rss_parser.models.root import RSS
 
 # >>> FUTURE
-# TODO: Feature, ignore_attributes in to_dict to allow for clean output
 # TODO: May be support generator based approach for big rss feeds
 # TODO: Add cli to parse to json
 # TODO: Possibly bundle as deb/rpm/exe
+# TODO: Atom support
+# TODO: Older RSS versions?
 
 # >>>> MVP
-# TODO: class based approach, use classmethods and class attributes
+# TODO: Parser class based approach, use classmethods and class attributes
 # TODO: Also add dynamic class generator with config.
 # Parser.with_config which returns new class and also supports context managers
-# TODO: Limit, xml, schema can be set in config or in runtime
 class Parser:
     """Parser for rss files."""
 
-    def __init__(self, xml: str, limit=None, *, schema=RSSFeed):
+    def __init__(self, xml: str, limit=None, *, schema=RSS):
         self.xml = xml
         self.limit = limit
 
@@ -28,9 +28,9 @@ def __init__(self, xml: str, limit=None, *, schema=RSSFeed):
     @staticmethod
     def _check_atom(root: dict):
         if "feed" in root:
-            raise NotImplementedError("ATOM feed is not currently supported")  #
+            raise NotImplementedError("ATOM feed is not currently supported")
 
-    def parse(self) -> RSSFeed:
+    def parse(self) -> RSS:
         """
         Parse the rss and each item.py of the feed.
 

rss_parser/models/__init__.py

@@ -11,7 +11,7 @@
 from rss_parser.models.utils import camel_case
 
 
-class RSSBaseModel(BaseModel):
+class XMLBaseModel(BaseModel):
     class Config:
         # Not really sure if we want for the schema obj to be immutable, disabling for now
         # allow_mutation = False

rss_parser/models/channel.py

@@ -2,15 +2,15 @@
 
 from pydantic import Field
 
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 from rss_parser.models.image import Image
 from rss_parser.models.item import Item
 from rss_parser.models.text_input import TextInput
 from rss_parser.models.types.date import DateTimeOrStr
 from rss_parser.models.types.tag import Tag
 
 
-class RequiredChannelElementsMixin(RSSBaseModel):
+class RequiredChannelElementsMixin(XMLBaseModel):
     """https://www.rssboard.org/rss-specification#requiredChannelElements."""
 
     title: Tag[str] = None  # GoUpstate.com News Headlines
@@ -23,7 +23,7 @@ class RequiredChannelElementsMixin(RSSBaseModel):
     "Phrase or sentence describing the channel."
 
 
-class OptionalChannelElementsMixin(RSSBaseModel):
+class OptionalChannelElementsMixin(XMLBaseModel):
     """https://www.rssboard.org/rss-specification#optionalChannelElements."""
 
     items: Optional[List[Tag[Item]]] = Field(alias="item", default=[])
@@ -55,7 +55,6 @@ class OptionalChannelElementsMixin(RSSBaseModel):
     docs: Optional[Tag[str]] = None  # https://www.rssboard.org/rss-specification
     "A URL that points to the documentation for the format used in the RSS file. It's probably a pointer to this " "page. It's for people who might stumble across an RSS file on a Web server 25 years from now and wonder what " "it is."  # noqa
 
-    # TODO: should support self-closing tags with their attributes?
     cloud: Optional[Tag[str]] = None  # <cloud domain="rpc.sys.com" protocol="soap"/>
     "Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight " "publish-subscribe protocol for RSS feeds."  # noqa
 
@@ -78,5 +77,5 @@ class OptionalChannelElementsMixin(RSSBaseModel):
     "A hint for aggregators telling them which days they can skip. This element contains up to seven <day> " "sub-elements whose value is Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday. Aggregators " "may not read the channel during days listed in the <skipDays> element."  # noqa
 
 
-class Channel(RequiredChannelElementsMixin, OptionalChannelElementsMixin, RSSBaseModel):
+class Channel(RequiredChannelElementsMixin, OptionalChannelElementsMixin, XMLBaseModel):
     pass

rss_parser/models/image.py

@@ -1,10 +1,10 @@
 from typing import Optional
 
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 from rss_parser.models.types.tag import Tag
 
 
-class Image(RSSBaseModel):
+class Image(XMLBaseModel):
     """https://www.rssboard.org/rss-specification#ltimagegtSubelementOfLtchannelgt."""
 
     url: Tag[str] = None

rss_parser/models/item.py

@@ -1,10 +1,10 @@
 from typing import Optional
 
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 from rss_parser.models.types.tag import Tag
 
 
-class RequiredItemElementsMixin(RSSBaseModel):
+class RequiredItemElementsMixin(XMLBaseModel):
     title: Tag[str] = None  # Venice Film Festival Tries to Quit Sinking
     "The title of the item."
 
@@ -18,7 +18,7 @@ class RequiredItemElementsMixin(RSSBaseModel):
     "The item synopsis."
 
 
-class OptionalItemElementsMixin(RSSBaseModel):
+class OptionalItemElementsMixin(XMLBaseModel):
     author: Optional[Tag[str]] = None
     "Email address of the author of the item."
 
@@ -41,5 +41,5 @@ class OptionalItemElementsMixin(RSSBaseModel):
     "The RSS channel that the item came from."
 
 
-class Item(RequiredItemElementsMixin, OptionalItemElementsMixin, RSSBaseModel):
+class Item(RequiredItemElementsMixin, OptionalItemElementsMixin, XMLBaseModel):
     """https://www.rssboard.org/rss-specification#hrelementsOfLtitemgt."""

rss_parser/models/root.py

@@ -2,11 +2,13 @@
 
 from pydantic import Field
 
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 from rss_parser.models.channel import Channel
 from rss_parser.models.types.tag import Tag
 
 
-class RSSFeed(RSSBaseModel):
+class RSS(XMLBaseModel):
+    """RSS 2.0."""
+
     version: Optional[Tag[str]] = Field(alias="@version")
     channel: Tag[Channel]

rss_parser/models/text_input.py

@@ -1,8 +1,8 @@
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 from rss_parser.models.types.tag import Tag
 
 
-class TextInput(RSSBaseModel):
+class TextInput(XMLBaseModel):
     """
     The purpose of the <textInput> element is something of a mystery. You can use it to specify a search engine box.
     Or to allow a reader to provide feedback. Most aggregators ignore it.

rss_parser/models/types/tag.py

@@ -9,7 +9,7 @@
 from pydantic.generics import GenericModel
 from pydantic.json import pydantic_encoder
 
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 
 T = TypeVar("T")
 
@@ -68,7 +68,7 @@ def pre_convert(cls, v: Union[T, dict], **kwargs):  # noqa
     def flatten_tag_encoder(cls, v):
         """Encoder that translates Tag objects (dict) to plain .content values (T)."""
         bases = v.__class__.__bases__
-        if RSSBaseModel in bases:
+        if XMLBaseModel in bases:
             # Can't pass encoder to .dict :/
             return loads(v.json_plain())
         if cls in bases:

tests/test_tag.py

@@ -4,11 +4,11 @@
 from random import randint
 from typing import Optional
 
-from rss_parser.models import RSSBaseModel
+from rss_parser.models import XMLBaseModel
 from rss_parser.models.types.tag import Tag
 
 
-class Model(RSSBaseModel):
+class Model(XMLBaseModel):
     number: Optional[Tag[int]]
     float_number: Optional[Tag[float]]
     string: Optional[Tag[str]]