From 8a45a9fb891e9db56b8bb1fd3261a49261668df4 Mon Sep 17 00:00:00 2001
From: Mike Ribbons <mribbons@gmail.com>
Date: Mon, 2 Sep 2024 20:54:21 +1000
Subject: [PATCH 1/2] Fix typing errors with set_extenion methods

eg:
```
Argument of type "(span: Span, tag: str) -> str" cannot be assigned to parameter "method" of type "SpanMethod | None" in function "set_extension"
  Type "(span: Span, tag: str) -> str" is incompatible with type "SpanMethod | None"
    "function" is incompatible with protocol "SpanMethod"
      "__call__" is not present
    "function" is incompatible with "None"PylancereportArgumentType
```

Rationale:
`Callable` only accepts a single parameter, optional parameters don't work
... isn't recognized as variadic arguments (... not valid here)
SomeMethod(Protocol) __call__ approach doesn't support mapping non variadic arguments to variadic arguments.
Therefore, to not break the currently documented interface, implement a union of Callable overloads.
---
 spacy/tokens/doc.pyi   | 8 ++++++--
 spacy/tokens/span.pyi  | 8 ++++++--
 spacy/tokens/token.pyi | 8 ++++++--
 3 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/spacy/tokens/doc.pyi b/spacy/tokens/doc.pyi
index f0b68862c..62a20279c 100644
--- a/spacy/tokens/doc.pyi
+++ b/spacy/tokens/doc.pyi
@@ -28,8 +28,12 @@ from .underscore import Underscore
 
 DOCBIN_ALL_ATTRS: Tuple[str, ...]
 
-class DocMethod(Protocol):
-    def __call__(self: Doc, *args: Any, **kwargs: Any) -> Any: ...  # type: ignore[misc]
+DocMethod = Union[
+ Callable[[Doc], Any],
+ Callable[[Doc, Any], Any],
+ Callable[[Doc, Any, Any], Any],
+ Callable[[Doc, Any, Any, Any], Any],
+]
 
 class Doc:
     vocab: Vocab
diff --git a/spacy/tokens/span.pyi b/spacy/tokens/span.pyi
index b982eb810..1714f732d 100644
--- a/spacy/tokens/span.pyi
+++ b/spacy/tokens/span.pyi
@@ -8,8 +8,12 @@ from .doc import Doc
 from .token import Token
 from .underscore import Underscore
 
-class SpanMethod(Protocol):
-    def __call__(self: Span, *args: Any, **kwargs: Any) -> Any: ...  # type: ignore[misc]
+SpanMethod = Union[
+ Callable[[Span], Any],
+ Callable[[Span, Any], Any],
+ Callable[[Span, Any, Any], Any],
+ Callable[[Span, Any, Any, Any], Any],
+]
 
 class Span:
     @classmethod
diff --git a/spacy/tokens/token.pyi b/spacy/tokens/token.pyi
index 435ace527..4bc41d517 100644
--- a/spacy/tokens/token.pyi
+++ b/spacy/tokens/token.pyi
@@ -9,8 +9,12 @@ from .morphanalysis import MorphAnalysis
 from .span import Span
 from .underscore import Underscore
 
-class TokenMethod(Protocol):
-    def __call__(self: Token, *args: Any, **kwargs: Any) -> Any: ...  # type: ignore[misc]
+TokenMethod = Union[
+ Callable[[Token], Any],
+ Callable[[Token, Any], Any],
+ Callable[[Token, Any, Any], Any],
+ Callable[[Token, Any, Any, Any], Any],
+]
 
 class Token:
     i: int

From 228045464b15de57483926228cb5d045b75998b9 Mon Sep 17 00:00:00 2001
From: Mike Ribbons <mribbons@gmail.com>
Date: Tue, 10 Sep 2024 21:15:44 +1000
Subject: [PATCH 2/2] change set_extension method argument to Callable[]

---
 spacy/tokens/doc.pyi   | 13 +++----------
 spacy/tokens/span.pyi  | 13 +++----------
 spacy/tokens/token.pyi | 13 +++----------
 3 files changed, 9 insertions(+), 30 deletions(-)

diff --git a/spacy/tokens/doc.pyi b/spacy/tokens/doc.pyi
index 62a20279c..c34f7650c 100644
--- a/spacy/tokens/doc.pyi
+++ b/spacy/tokens/doc.pyi
@@ -28,13 +28,6 @@ from .underscore import Underscore
 
 DOCBIN_ALL_ATTRS: Tuple[str, ...]
 
-DocMethod = Union[
- Callable[[Doc], Any],
- Callable[[Doc, Any], Any],
- Callable[[Doc, Any, Any], Any],
- Callable[[Doc, Any, Any, Any], Any],
-]
-
 class Doc:
     vocab: Vocab
     mem: Pool
@@ -57,7 +50,7 @@ class Doc:
         default: Optional[Any] = ...,
         getter: Optional[Callable[[Doc], Any]] = ...,
         setter: Optional[Callable[[Doc, Any], None]] = ...,
-        method: Optional[DocMethod] = ...,
+        method: Optional[Callable[[Doc, Any]]] = ...,
         force: bool = ...,
     ) -> None: ...
     @classmethod
@@ -65,7 +58,7 @@ class Doc:
         cls, name: str
     ) -> Tuple[
         Optional[Any],
-        Optional[DocMethod],
+        Optional[Callable[[Doc, Any]]],
         Optional[Callable[[Doc], Any]],
         Optional[Callable[[Doc, Any], None]],
     ]: ...
@@ -76,7 +69,7 @@ class Doc:
         cls, name: str
     ) -> Tuple[
         Optional[Any],
-        Optional[DocMethod],
+        Optional[Callable[[Doc, Any]]],
         Optional[Callable[[Doc], Any]],
         Optional[Callable[[Doc, Any], None]],
     ]: ...
diff --git a/spacy/tokens/span.pyi b/spacy/tokens/span.pyi
index 1714f732d..91ede582a 100644
--- a/spacy/tokens/span.pyi
+++ b/spacy/tokens/span.pyi
@@ -8,13 +8,6 @@ from .doc import Doc
 from .token import Token
 from .underscore import Underscore
 
-SpanMethod = Union[
- Callable[[Span], Any],
- Callable[[Span, Any], Any],
- Callable[[Span, Any, Any], Any],
- Callable[[Span, Any, Any, Any], Any],
-]
-
 class Span:
     @classmethod
     def set_extension(
@@ -23,7 +16,7 @@ class Span:
         default: Optional[Any] = ...,
         getter: Optional[Callable[[Span], Any]] = ...,
         setter: Optional[Callable[[Span, Any], None]] = ...,
-        method: Optional[SpanMethod] = ...,
+        method: Optional[Callable[[Span, Any]]] = ...,
         force: bool = ...,
     ) -> None: ...
     @classmethod
@@ -31,7 +24,7 @@ class Span:
         cls, name: str
     ) -> Tuple[
         Optional[Any],
-        Optional[SpanMethod],
+        Optional[Callable[[Span, Any]]],
         Optional[Callable[[Span], Any]],
         Optional[Callable[[Span, Any], None]],
     ]: ...
@@ -42,7 +35,7 @@ class Span:
         cls, name: str
     ) -> Tuple[
         Optional[Any],
-        Optional[SpanMethod],
+        Optional[Callable[[Span, Any]]],
         Optional[Callable[[Span], Any]],
         Optional[Callable[[Span, Any], None]],
     ]: ...
diff --git a/spacy/tokens/token.pyi b/spacy/tokens/token.pyi
index 4bc41d517..9e47a1b20 100644
--- a/spacy/tokens/token.pyi
+++ b/spacy/tokens/token.pyi
@@ -9,13 +9,6 @@ from .morphanalysis import MorphAnalysis
 from .span import Span
 from .underscore import Underscore
 
-TokenMethod = Union[
- Callable[[Token], Any],
- Callable[[Token, Any], Any],
- Callable[[Token, Any, Any], Any],
- Callable[[Token, Any, Any, Any], Any],
-]
-
 class Token:
     i: int
     doc: Doc
@@ -27,7 +20,7 @@ class Token:
         default: Optional[Any] = ...,
         getter: Optional[Callable[[Token], Any]] = ...,
         setter: Optional[Callable[[Token, Any], None]] = ...,
-        method: Optional[TokenMethod] = ...,
+        method: Optional[Callable[[Token, Any]]] = ...,
         force: bool = ...,
     ) -> None: ...
     @classmethod
@@ -35,7 +28,7 @@ class Token:
         cls, name: str
     ) -> Tuple[
         Optional[Any],
-        Optional[TokenMethod],
+        Optional[Callable[[Token, Any]]],
         Optional[Callable[[Token], Any]],
         Optional[Callable[[Token, Any], None]],
     ]: ...
@@ -46,7 +39,7 @@ class Token:
         cls, name: str
     ) -> Tuple[
         Optional[Any],
-        Optional[TokenMethod],
+        Optional[Callable[[Token, Any]]],
         Optional[Callable[[Token], Any]],
         Optional[Callable[[Token, Any], None]],
     ]: ...