Switch to mypy - see also RobertCraigie/pyright-python#300

.pre-commit-config.yaml

@@ -13,29 +13,32 @@ repos:
         args:
           - --fix
           - --unsafe-fixes
-  # Does not have support for PEP 695 generics yet
-  #  - repo: https://github.com/pre-commit/mirrors-mypy
-  #    rev: v1.10.1
-  #    hooks:
-  #      - id: mypy
-  #        name: mypy
-  #        files: ^(?!(tests)).*\.py$
-  #        args:
-  #          - --install-types
-  - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.382.post0
+     # Does not have support for PEP 695 generics yet
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
     hooks:
-      - id: pyright
-        name: pyright
+      - id: mypy
+        name: mypy
         files: ^(?!(tests)).*\.py$
+        args:
+          - --install-types
+          - --enable-incomplete-feature=NewGenericSyntax
         additional_dependencies:
-          # https://github.com/RobertCraigie/pyright-python/issues/164
-          - pyright[nodejs]
           - pydantic-settings~=2.3
           - shortuuid~=1.0
-          - sphinx~=7.3
           - tomlkit~=0.13
           - typer~=0.12
+#  - repo: https://github.com/RobertCraigie/pyright-python
+#    rev: v1.1.382.post0
+#    hooks:
+#      - id: pyright
+#        name: pyright
+#        files: ^(?!(tests)).*\.py$
+#        additional_dependencies:
+#          - pydantic-settings~=2.3
+#          - shortuuid~=1.0
+#          - tomlkit~=0.13
+#          - typer~=0.12
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.17.0
     hooks:

src/chango/_cli/__init__.py

@@ -17,7 +17,7 @@
 app = typer.Typer(help="CLI for chango - CHANgelog GOvernor for Your Project")
 
 
-def version_callback(value: bool):
+def version_callback(value: bool) -> None:
     if value:
         typer.echo(__version__)
         raise typer.Exit
@@ -29,7 +29,7 @@ def main(
         bool,
         typer.Option("--version", callback=version_callback, help="Show the version and exit."),
     ] = False,
-):
+) -> None:
     pass
 
 

src/chango/_cli/config.py

@@ -29,7 +29,7 @@
 
 
 @app.callback()
-def callback(context: typer.Context, path: _PATH_ANNOTATION = None):
+def callback(context: typer.Context, path: _PATH_ANNOTATION = None) -> None:
     if not path:
         effective_path = Path.cwd() / "pyproject.toml"
     elif path.is_absolute():
@@ -48,15 +48,15 @@ def callback(context: typer.Context, path: _PATH_ANNOTATION = None):
         raise typer.BadParameter(f"Failed to parse the configuration file: {exc}") from exc
 
     try:
-        context.obj["data"] = toml_data["tool"]["chango"]  # type: ignore[reportIndexIssue]
+        context.obj["data"] = toml_data["tool"]["chango"]  # type: ignore[index]
     except KeyError as exc:
         raise typer.BadParameter(
             "No configuration found for chango in the configuration file."
         ) from exc
 
 
 @app.command()
-def show(context: typer.Context):
+def show(context: typer.Context) -> None:
     """Show the configuration."""
     string = f"""
 Showing the configuration of the chango CLIas configured in {context.obj['path']}.
@@ -68,13 +68,13 @@ def show(context: typer.Context):
 
 
 @app.command()
-def schema():
+def schema() -> None:
     """Show the JSON schema of the configuration."""
     rprint(Markdown(f"```json\n{json.dumps(CLIConfig.model_json_schema(), indent=2)}\n```"))
 
 
 @app.command()
-def validate(context: typer.Context):
+def validate(context: typer.Context) -> None:
     """Validate the configuration."""
     try:
         config = CLIConfig.model_validate(dict(context.obj["data"]))

src/chango/_cli/config_module/__init__.py

@@ -11,13 +11,13 @@
 
 
 class _UserConfigManager:
-    def __init__(self):
+    def __init__(self) -> None:
         self._chango_instance: ChanGo | None = None
 
     def get_chango_instance(self) -> ChanGo:
         if self._chango_instance is None:
             self._chango_instance = import_chango_instance_from_config(
-                CLIConfig()  # type: ignore[reportCallIssue]
+                CLIConfig()  # type: ignore[call-arg]
             )
         return self._chango_instance
 

src/chango/_cli/edit.py

@@ -20,6 +20,6 @@ def edit(
             help="The unique identifier of the change note to edit.", show_default=False
         ),
     ],
-):
+) -> None:
     """Edit an existing change note in the default editor."""
     typer.launch(get_chango_instance().scanner.lookup_change_note(uid).path.as_posix())

src/chango/_cli/new.py

@@ -18,7 +18,7 @@ def new(
     edit: Annotated[
         bool, typer.Option(help="Whether to open the change note in the default editor.")
     ] = True,
-):
+) -> None:
     """Create a new change note."""
     change_note = get_chango_instance().build_template_change_note(slug=slug)
     path = get_chango_instance().write_change_note(change_note, version=None)

src/chango/_cli/release.py

@@ -22,7 +22,7 @@ def release(
     date: Annotated[
         dtm.date, typer.Argument(help="The date of the version release.", parser=date_callback)
     ],
-):
+) -> None:
     """Release the unreleased changes to a new version."""
     if get_chango_instance().release(Version(uid, date)):
         typer.echo(f"Released version {uid} on {date}")

src/chango/_cli/report.py

@@ -31,7 +31,7 @@ def version(
     ],
     markup: MARKUP = MarkupLanguage.MARKDOWN,
     output: OUTPUT_FILE = None,
-):
+) -> None:
     """Print a report of the change notes for a specific version."""
     version_note = get_chango_instance().load_version_note(uid)
     text = version_note.render(markup=markup)
@@ -43,7 +43,7 @@ def version(
 
 
 @app.command()
-def history(markup: MARKUP = MarkupLanguage.MARKDOWN, output: OUTPUT_FILE = None):
+def history(markup: MARKUP = MarkupLanguage.MARKDOWN, output: OUTPUT_FILE = None) -> None:
     """Print a report of the version history."""
     version_history = get_chango_instance().load_version_history()
     text = version_history.render(markup=markup)

src/chango/_utils/types.py

@@ -11,6 +11,5 @@
 
 VersionUID = str | None
 VUIDInput = Union["Version", str] | None
-VersionIO = Union["Version", None]
 CNUIDInput = Union["ChangeNote", str]
 PathLike = str | Path

src/chango/abc/_versionhistory.py

@@ -20,7 +20,7 @@ class VersionHistory[VNT: VersionNote](MutableMapping[VersionUID, VNT], abc.ABC)
         themselves.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._version_notes: dict[VersionUID, VNT] = {}
 
     def __delitem__(self, __key: VUIDInput) -> None:
@@ -50,15 +50,15 @@ def add_version_note(self, version_note: VNT) -> None:
         Args:
             version_note: The version note to add.
         """
-        self[version_note.uid] = version_note  # type: ignore[reportArgumentType]
+        self[version_note.uid] = version_note  # type: ignore[index]
 
     def remove_version_note(self, version_note: VNT) -> None:
         """Remove a version note from the version note.
 
         Args:
             version_note: The version note to remove.
         """
-        del self[version_note.uid]  # type: ignore[reportArgumentType]
+        del self[version_note.uid]  # type: ignore[arg-type]
 
     @abc.abstractmethod
     def render(self, markup: str) -> str:

src/chango/abc/_versionnote.py

@@ -8,14 +8,13 @@
 from typing import TYPE_CHECKING, overload
 
 from .._utils.filename import FileName
-from .._utils.types import VersionIO
 from ..abc._changenote import ChangeNote
 
 if TYPE_CHECKING:
     from chango import Version
 
 
-class VersionNote[CNT: ChangeNote, V: VersionIO](MutableMapping[str, CNT], abc.ABC):
+class VersionNote[CNT: ChangeNote, V: (Version, None)](MutableMapping[str, CNT], abc.ABC):
     """Abstract base class for a version note describing the set of changes in a software project
     for a single version.
 

src/chango/concrete/_commentversionnote.py

@@ -3,7 +3,7 @@
 #  SPDX-License-Identifier: MIT
 from typing import override
 
-from .._utils.types import VersionIO
+from .. import Version
 from ..abc import VersionNote
 from ..concrete import CommentChangeNote
 from ..constants import MarkupLanguage
@@ -16,7 +16,7 @@ def _indent_multiline(text: str, indent: int = 2) -> str:
     )
 
 
-class CommentVersionNote[V: VersionIO](VersionNote[CommentChangeNote, V]):
+class CommentVersionNote[V: (Version, None)](VersionNote[CommentChangeNote, V]):
     """A simple version note implementation that works with
     :class:`~chango.concrete.CommentChangeNote`.
     """

src/chango/concrete/_directoryversionscanner.py

@@ -57,7 +57,7 @@ def __init__(
         if (path := Path(unreleased_directory)).is_dir():
             self.unreleased_directory: Path = path
         else:
-            self.unreleased_directory: Path = self.base_directory / unreleased_directory
+            self.unreleased_directory = self.base_directory / unreleased_directory
 
         self.__available_versions: dict[str, _VersionInfo] | None = None
 

src/chango/concrete/_headerversionhistory.py

@@ -31,7 +31,7 @@ def render(self, markup: str) -> str:
         if has_dates:
             changes = sorted(
                 released_notes,
-                key=lambda note: note.date,  # type: ignore[reportArgumentType]
+                key=lambda note: note.date,  # type: ignore[arg-type,return-value]
             )
             match markup:
                 case MarkupLanguage.MARKDOWN:
@@ -66,8 +66,10 @@ def render(self, markup: str) -> str:
         template = string.Template(tpl_str)
         return "\n\n".join(
             template.substitute(
-                uid=note.uid or "Unreleased",
-                date=note.date.isoformat() if note.date else "unknown",
+                uid="Unreleased" if note.uid is None else "Unreleased",
+                date=(
+                    "unknown" if (note.date is None) else note.date.isoformat()  # type: ignore[attr-defined]
+                ),
                 comment=note.render(markup),
             )
             for note in changes