add Path typing to Narrator and Adapter.

Author: perrygoy

screenpy/narration/narrator.py

@@ -20,6 +20,7 @@
 if TYPE_CHECKING:
     from collections.abc import Generator
     from contextlib import AbstractContextManager
+    from pathlib import Path
     from typing import Any, Callable, Union
 
     from screenpy.protocols import Adapter
@@ -246,8 +247,10 @@ def explains_the_error(self, exc: Exception) -> None:
         for adapter in self.adapters:
             adapter.error(exc)
 
-    # ANN401 ignored here to allow for new adapters to use any kwargs.
-    def attaches_a_file(self, filepath: str, **kwargs: Any) -> None:  # noqa: ANN401
+    # ANN401 ignored here to allow for adapters to use needed kwargs.
+    def attaches_a_file(
+        self, filepath: Path | str, **kwargs: Any  # noqa: ANN401
+    ) -> None:
         """Attach a file for the various adapters."""
         for adapter in self.adapters:
             adapter.attach(filepath, **kwargs)

screenpy/narration/stdout_adapter/stdout_adapter.py

@@ -16,6 +16,7 @@
 
 if TYPE_CHECKING:
     from collections.abc import Generator
+    from pathlib import Path
 
     from typing_extensions import ParamSpec
 
@@ -147,6 +148,6 @@ def error(self, exc: Exception) -> None:
             self.handled_exception = exc
 
     # ANN401 ignored here to allow for new adapters to use any kwargs.
-    def attach(self, filepath: str, **__: Any) -> None:  # noqa: ANN401
+    def attach(self, filepath: Path | str, **__: Any) -> None:  # noqa: ANN401
         """Log a mention of an attached file."""
         self.manager.log(f"See reference file: {filepath}")

screenpy/protocols.py

@@ -15,6 +15,7 @@
 
 if TYPE_CHECKING:
     from collections.abc import Generator
+    from pathlib import Path
     from typing import Any, Callable
 
     from hamcrest.core.base_matcher import Matcher
@@ -130,7 +131,7 @@ def error(self, exc: Exception) -> None:
         """React to an exception being thrown, probably during a beat."""
 
     # ANN401 ignored here to allow for new adapters to use any kwargs.
-    def attach(self, filepath: str, **kwargs: Any) -> None:  # noqa: ANN401
+    def attach(self, filepath: Path | str, **kwargs: Any) -> None:  # noqa: ANN401
         """Handle attaching a file.
 
         Pass keyword arguments for specific adapters' needs.