Add mypy, remove =None for non-optional fields

Poetry update

Author: dhvcc

.github/workflows/ci.yml

@@ -43,5 +43,8 @@ jobs:
       - name: Lint code with ruff
         run: poetry run ruff check .
 
+      - name: Lint code with mypy
+        run: poetry run mypy rss_parser
+
       - name: Test code with pytest
         run: poetry run pytest --doctest-modules

.pre-commit-config.yaml

@@ -24,6 +24,16 @@ repos:
         types: [ python ]
         stages: [ commit ]
 
+      - id: mypy-check-staged
+        name: mypy
+        entry: poetry
+        args:
+          - run
+          - mypy
+          - rss_parser
+        language: system
+        stages: [ push ]
+
       - id: ruff-check-global
         name: ruff
         entry: poetry

poetry.lock

@@ -41,14 +41,16 @@ packages = [{ include = "rss_parser" }, { include = "rss_parser/py.typed" }]
 python = "^3.9"
 pydantic = ">1.9"
 xmltodict = "^0.13.0"
+types-xmltodict = "^0.14.0.20241009"
 
 [tool.poetry.group.dev.dependencies]
 ipython = "*"
-black = "^22.3.0"
+black = "*"
 pre-commit = "^2.12.0"
 ruff = "*"
 rich = "*"
 pytest = "^7.4.0"
+mypy = "*"
 
 [tool.pytest.ini_options]
 addopts = "--color=yes"
@@ -79,7 +81,6 @@ select = [
     "EXE", # flake8-executable
     "T20", # flake8-print
     "TID", # flake8-tidy-imports
-    "TCH", # flake8-type-checking
     "ARG", # flake8-unused-arguments
     "RUF", # ruff
 ]

pyproject.toml

@@ -3,12 +3,17 @@
 
 Some types and validation may be a bit custom to account for broken standards in some RSS feeds.
 """
+
 from json import loads
+from typing import TYPE_CHECKING
 
 from rss_parser.models.utils import camel_case
 from rss_parser.pydantic_proxy import import_v1_pydantic
 
-pydantic = import_v1_pydantic()
+if TYPE_CHECKING:
+    from pydantic import v1 as pydantic
+else:
+    pydantic = import_v1_pydantic()
 
 
 class XMLBaseModel(pydantic.BaseModel):
@@ -19,7 +24,7 @@ def json_plain(self, **kw):
         """
         Run pydantic's json with custom encoder to encode Tags as only content.
         """
-        from rss_parser.models.types.tag import Tag
+        from rss_parser.models.types.tag import Tag  # noqa: PLC0415
 
         return self.json(models_as_dict=False, encoder=Tag.flatten_tag_encoder, **kw)
 

rss_parser/models/__init__.py

@@ -15,13 +15,13 @@
 class RequiredChannelElementsMixin(XMLBaseModel):
     """https://www.rssboard.org/rss-specification#requiredChannelElements."""
 
-    title: Tag[str] = None  # GoUpstate.com News Headlines
+    title: Tag[str]  # GoUpstate.com News Headlines
     "The name of the channel. It's how people refer to your service. If you have an HTML website that contains " "the same information as your RSS file, the title of your channel should be the same as the title of your " "website."  # noqa
 
-    link: Tag[str] = None  # http://www.goupstate.com/
+    link: Tag[str]  # http://www.goupstate.com/
     "The URL to the HTML website corresponding to the channel."
 
-    description: Tag[str] = None  # The latest news from GoUpstate.com, a Spartanburg Herald-Journal Web site.
+    description: Tag[str]  # The latest news from GoUpstate.com, a Spartanburg Herald-Journal Web site.
     "Phrase or sentence describing the channel."
 
 
@@ -33,7 +33,7 @@ class OptionalChannelElementsMixin(XMLBaseModel):
     language: Optional[Tag[str]] = None  # en-us
     "The language the channel is written in. This allows aggregators to group all Italian language sites, " "for example, on a single page."  # noqa
 
-    copyright: Optional[Tag[str]] = None  # Copyright 2002, Spartanburg Herald-Journal  # noqa
+    copyright: Optional[Tag[str]] = None  # Copyright 2002, Spartanburg Herald-Journal
     "Copyright notice for content in the channel."
 
     "Email address for person responsible for editorial content."

rss_parser/models/rss/channel.py

@@ -7,13 +7,13 @@
 class Image(XMLBaseModel):
     """https://www.rssboard.org/rss-specification#ltimagegtSubelementOfLtchannelgt."""
 
-    url: Tag[str] = None
+    url: Tag[str]
     "The URL of a GIF, JPEG or PNG image that represents the channel."
 
-    title: Tag[str] = None
+    title: Tag[str]
     "Describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML."
 
-    link: Tag[str] = None
+    link: Tag[str]
     "The URL of the site, when the channel is rendered, the image is a link to the site. (Note, in practice the " "image <title> and <link> should have the same value as the channel's <title> and <link>."  # noqa
 
     width: Optional[Tag[int]] = None

rss_parser/models/rss/image.py

@@ -9,15 +9,13 @@
 
 
 class RequiredItemElementsMixin(XMLBaseModel):
-    title: Tag[str] = None  # Venice Film Festival Tries to Quit Sinking
+    title: Tag[str]  # Venice Film Festival Tries to Quit Sinking
     "The title of the item."
 
     links: OnlyList[Tag[str]] = pydantic.Field(alias="link")  # http://nytimes.com/2004/12/07FEST.html
     "The URL of the item."
 
-    description: Tag[
-        str
-    ] = None  # <description>Some of the most heated chatter at the Venice Film Festival this week was
+    description: Tag[str]  # <description>Some of the most heated chatter at the Venice Film Festival this week was
     # about the way that the arrival of the stars at the Palazzo del Cinema was being staged.</description>
     "The item synopsis."
 

rss_parser/models/rss/item.py

@@ -10,14 +10,14 @@ class TextInput(XMLBaseModel):
     https://www.rssboard.org/rss-specification#lttextinputgtSubelementOfLtchannelgt
     """
 
-    title: Tag[str] = None
+    title: Tag[str]
     "The label of the Submit button in the text input area."
 
-    description: Tag[str] = None
+    description: Tag[str]
     "Explains the text input area."
 
-    name: Tag[str] = None
+    name: Tag[str]
     "The name of the text object in the text input area."
 
-    link: Tag[str] = None
+    link: Tag[str]
     "The URL of the CGI script that processes text input requests."

rss_parser/models/rss/text_input.py

@@ -1,5 +1,6 @@
 from datetime import datetime
 from email.utils import parsedate_to_datetime
+from typing import Union
 
 from rss_parser.pydantic_proxy import import_v1_pydantic
 
@@ -25,7 +26,7 @@ def __repr__(self):
         return f"DateTimeOrStp({super().__repr__()})"
 
 
-def validate_dt_or_str(value: str) -> datetime:
+def validate_dt_or_str(value: str) -> Union[datetime, str]:
     # Try to parse standard (RFC 822)
     try:
         return parsedate_to_datetime(value)