chore(internal): require explicit overrides (#153)

Author: stainless-bot

pyproject.toml

@@ -102,6 +102,9 @@ exclude = [
     ".venv",
     ".nox",
 ]
+
+reportImplicitOverride = true
+
 reportImportCycles = false
 reportPrivateUsage = false
 

src/finch/_base_client.py

@@ -29,7 +29,7 @@
     overload,
 )
 from functools import lru_cache
-from typing_extensions import Literal, get_args, get_origin
+from typing_extensions import Literal, get_args, override, get_origin
 
 import anyio
 import httpx
@@ -1588,6 +1588,7 @@ class OtherPlatform:
     def __init__(self, name: str) -> None:
         self.name = name
 
+    @override
     def __str__(self) -> str:
         return f"Other:{self.name}"
 
@@ -1649,6 +1650,7 @@ class OtherArch:
     def __init__(self, name: str) -> None:
         self.name = name
 
+    @override
     def __str__(self) -> str:
         return f"other:{self.name}"
 

src/finch/_client.py

@@ -5,6 +5,7 @@
 import os
 import asyncio
 from typing import Union, Mapping
+from typing_extensions import override
 
 import httpx
 
@@ -134,24 +135,28 @@ def __init__(
         self.request_forwarding = resources.RequestForwarding(self)
 
     @property
+    @override
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
     @property
+    @override
     def auth_headers(self) -> dict[str, str]:
         access_token = self.access_token
         if access_token is None:
             return {}
         return {"Authorization": f"Bearer {access_token}"}
 
     @property
+    @override
     def default_headers(self) -> dict[str, str | Omit]:
         return {
             **super().default_headers,
             "Finch-API-Version": "2020-09-17",
             **self._custom_headers,
         }
 
+    @override
     def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
         if self.access_token and headers.get("Authorization"):
             return
@@ -308,6 +313,7 @@ def get_auth_url(
             )
         )
 
+    @override
     def _make_status_error(
         self,
         err_msg: str,
@@ -429,24 +435,28 @@ def __init__(
         self.request_forwarding = resources.AsyncRequestForwarding(self)
 
     @property
+    @override
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
     @property
+    @override
     def auth_headers(self) -> dict[str, str]:
         access_token = self.access_token
         if access_token is None:
             return {}
         return {"Authorization": f"Bearer {access_token}"}
 
     @property
+    @override
     def default_headers(self) -> dict[str, str | Omit]:
         return {
             **super().default_headers,
             "Finch-API-Version": "2020-09-17",
             **self._custom_headers,
         }
 
+    @override
     def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
         if self.access_token and headers.get("Authorization"):
             return
@@ -606,6 +616,7 @@ def get_auth_url(
             )
         )
 
+    @override
     def _make_status_error(
         self,
         err_msg: str,

src/finch/_models.py

@@ -11,6 +11,7 @@
     Required,
     TypedDict,
     final,
+    override,
     runtime_checkable,
 )
 
@@ -59,20 +60,23 @@ class BaseModel(pydantic.BaseModel):
     else:
 
         @property
+        @override
         def model_fields_set(self) -> set[str]:
             # a forwards-compat shim for pydantic v2
             return self.__fields_set__  # type: ignore
 
         class Config(pydantic.BaseConfig):  # pyright: ignore[reportDeprecated]
             extra: Any = pydantic.Extra.allow  # type: ignore
 
+    @override
     def __str__(self) -> str:
         # mypy complains about an invalid self arg
         return f'{self.__repr_name__()}({self.__repr_str__(", ")})'  # type: ignore[misc]
 
     # Override the 'construct' method in a way that supports recursive parsing without validation.
     # Based on https://github.com/samuelcolvin/pydantic/issues/1168#issuecomment-817742836.
     @classmethod
+    @override
     def construct(
         cls: Type[ModelT],
         _fields_set: set[str] | None = None,
@@ -139,6 +143,7 @@ def construct(
         # a specifc pydantic version as some users may not know which
         # pydantic version they are currently using
 
+        @override
         def model_dump(
             self,
             *,
@@ -187,6 +192,7 @@ def model_dump(
                 exclude_none=exclude_none,
             )
 
+        @override
         def model_dump_json(
             self,
             *,

src/finch/_streaming.py

@@ -3,6 +3,7 @@
 
 import json
 from typing import TYPE_CHECKING, Any, Generic, Iterator, AsyncIterator
+from typing_extensions import override
 
 import httpx
 
@@ -123,6 +124,7 @@ def data(self) -> str:
     def json(self) -> Any:
         return json.loads(self.data)
 
+    @override
     def __repr__(self) -> str:
         return f"ServerSentEvent(event={self.event}, data={self.data}, id={self.id}, retry={self.retry})"
 

src/finch/_types.py

@@ -15,7 +15,14 @@
     Optional,
     Sequence,
 )
-from typing_extensions import Literal, Protocol, TypeAlias, TypedDict, runtime_checkable
+from typing_extensions import (
+    Literal,
+    Protocol,
+    TypeAlias,
+    TypedDict,
+    override,
+    runtime_checkable,
+)
 
 import httpx
 import pydantic
@@ -119,6 +126,7 @@ def get(timeout: Union[int, NotGiven, None] = NotGiven()) -> Response: ...
     def __bool__(self) -> Literal[False]:
         return False
 
+    @override
     def __repr__(self) -> str:
         return "NOT_GIVEN"
 

src/finch/_utils/_proxy.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, abstractmethod
 from typing import Generic, TypeVar, Iterable, cast
-from typing_extensions import ClassVar
+from typing_extensions import ClassVar, override
 
 T = TypeVar("T")
 
@@ -21,16 +21,20 @@ def __init__(self) -> None:
     def __getattr__(self, attr: str) -> object:
         return getattr(self.__get_proxied__(), attr)
 
+    @override
     def __repr__(self) -> str:
         return repr(self.__get_proxied__())
 
+    @override
     def __str__(self) -> str:
         return str(self.__get_proxied__())
 
+    @override
     def __dir__(self) -> Iterable[str]:
         return self.__get_proxied__().__dir__()
 
     @property  # type: ignore
+    @override
     def __class__(self) -> type:
         return self.__get_proxied__().__class__
 

src/finch/_utils/_transform.py

@@ -2,7 +2,7 @@
 
 from typing import Any, List, Mapping, TypeVar, cast
 from datetime import date, datetime
-from typing_extensions import Literal, get_args, get_type_hints
+from typing_extensions import Literal, get_args, override, get_type_hints
 
 from ._utils import (
     is_list,
@@ -52,6 +52,7 @@ def __init__(
         self.format = format
         self.format_template = format_template
 
+    @override
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}(alias='{self.alias}', format={self.format}, format_template='{self.format_template}')"
 

src/finch/pagination.py

@@ -1,6 +1,7 @@
 # File generated from our OpenAPI spec by Stainless.
 
 from typing import Any, List, Type, Generic, Mapping, TypeVar, Optional, cast
+from typing_extensions import override
 
 from httpx import Response
 
@@ -25,9 +26,11 @@
 class SyncSinglePage(BaseSyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
     items: List[ModelT]
 
+    @override
     def _get_page_items(self) -> List[ModelT]:
         return self.items
 
+    @override
     def next_page_info(self) -> None:
         """
         This page represents a response that isn't actually paginated at the API level
@@ -47,9 +50,11 @@ def build(cls: Type[_BaseModelT], *, response: Response, data: object) -> _BaseM
 class AsyncSinglePage(BaseAsyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
     items: List[ModelT]
 
+    @override
     def _get_page_items(self) -> List[ModelT]:
         return self.items
 
+    @override
     def next_page_info(self) -> None:
         """
         This page represents a response that isn't actually paginated at the API level
@@ -69,9 +74,11 @@ def build(cls: Type[_BaseModelT], *, response: Response, data: object) -> _BaseM
 class SyncResponsesPage(BaseSyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
     responses: List[ModelT]
 
+    @override
     def _get_page_items(self) -> List[ModelT]:
         return self.responses
 
+    @override
     def next_page_info(self) -> None:
         """
         This page represents a response that isn't actually paginated at the API level
@@ -83,9 +90,11 @@ def next_page_info(self) -> None:
 class AsyncResponsesPage(BaseAsyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
     responses: List[ModelT]
 
+    @override
     def _get_page_items(self) -> List[ModelT]:
         return self.responses
 
+    @override
     def next_page_info(self) -> None:
         """
         This page represents a response that isn't actually paginated at the API level
@@ -102,9 +111,11 @@ class SyncIndividualsPage(BaseSyncPage[ModelT], BasePage[ModelT], Generic[ModelT
     individuals: List[ModelT]
     paging: Paging
 
+    @override
     def _get_page_items(self) -> List[ModelT]:
         return self.individuals
 
+    @override
     def next_page_info(self) -> Optional[PageInfo]:
         offset = self.paging.offset
         if offset is None:
@@ -127,9 +138,11 @@ class AsyncIndividualsPage(BaseAsyncPage[ModelT], BasePage[ModelT], Generic[Mode
     individuals: List[ModelT]
     paging: Paging
 
+    @override
     def _get_page_items(self) -> List[ModelT]:
         return self.individuals
 
+    @override
     def next_page_info(self) -> Optional[PageInfo]:
         offset = self.paging.offset
         if offset is None: