Fix typing errors

Author: djcopley

shelloracle/config/config.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from collections.abc import MutableMapping
+from collections.abc import MutableMapping, Iterator
 from pathlib import Path
 from typing import Any
 
@@ -43,7 +43,7 @@ def __delitem__(self, key: str) -> None:
         with self.filepath.open("w") as file:
             tomlkit.dump(config, file)
 
-    def __iter__(self) -> None:
+    def __iter__(self) -> Iterator[str]:
         with self.filepath.open("r") as file:
             config = tomlkit.load(file)
         return iter(config)
@@ -62,7 +62,7 @@ def _ensure_config_exists(self) -> None:
             tomlkit.dump(config, file)
 
     @property
-    def provider(self) -> str | None:
+    def provider(self) -> str:
         return self["shelloracle"]["provider"]
 
 

shelloracle/config/setting.py

@@ -5,7 +5,7 @@
 from . import config
 
 if TYPE_CHECKING:
-    from ..providers import Provider
+    from ..provider import Provider
 
 T = TypeVar("T")
 

shelloracle/provider.py

@@ -16,7 +16,7 @@ class Provider(Protocol):
     name: str
 
     @abstractmethod
-    async def generate(self, prompt: str) -> AsyncIterator[str]:
+    def generate(self, prompt: str) -> AsyncIterator[str]:
         """
         This is an asynchronous generator method which defines the protocol that a provider implementation
         should adhere to. The method takes a prompt as an argument and produces an asynchronous stream
@@ -25,6 +25,8 @@ async def generate(self, prompt: str) -> AsyncIterator[str]:
         :param prompt: A string value which serves as input to the provider's process of generating results.
         :return: An asynchronous generator yielding string results.
         """
+        # If you are wondering why the 'generate' signature doesn't include 'async', see
+        # https://mypy.readthedocs.io/en/stable/more_types.html#asynchronous-iterators
 
 
 def get_provider(name: str) -> type[Provider]:

shelloracle/shelloracle.py

@@ -16,7 +16,7 @@
 async def prompt_user(default_prompt: str | None = None) -> str:
     with create_app_session_from_tty():
         history_file = Path.home() / ".shelloracle_history"
-        prompt_session = PromptSession(history=FileHistory(str(history_file)))
+        prompt_session: PromptSession = PromptSession(history=FileHistory(str(history_file)))
         # Can I do this with one of the builtin methods?
         # I tried a few (including cursor_down) with limited success
         prompt_session.output.write_raw("\033[E")