Skip to content

chore(internal): require explicit overrides #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ exclude = [
".venv",
".nox",
]

reportImplicitOverride = true

reportImportCycles = false
reportPrivateUsage = false

Expand Down
4 changes: 3 additions & 1 deletion src/orb/_base_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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}"

Expand Down Expand Up @@ -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}"

Expand Down
7 changes: 7 additions & 0 deletions src/orb/_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import os
import asyncio
from typing import Union, Mapping
from typing_extensions import override

import httpx

Expand Down Expand Up @@ -118,10 +119,12 @@ def __init__(
self.subscriptions = resources.Subscriptions(self)

@property
@override
def qs(self) -> Querystring:
return Querystring(array_format="comma")

@property
@override
def auth_headers(self) -> dict[str, str]:
api_key = self.api_key
return {"Authorization": f"Bearer {api_key}"}
Expand Down Expand Up @@ -188,6 +191,7 @@ def __del__(self) -> None:

self.close()

@override
def _make_status_error(
self,
err_msg: str,
Expand Down Expand Up @@ -346,10 +350,12 @@ def __init__(
self.subscriptions = resources.AsyncSubscriptions(self)

@property
@override
def qs(self) -> Querystring:
return Querystring(array_format="comma")

@property
@override
def auth_headers(self) -> dict[str, str]:
api_key = self.api_key
return {"Authorization": f"Bearer {api_key}"}
Expand Down Expand Up @@ -419,6 +425,7 @@ def __del__(self) -> None:
except Exception:
pass

@override
def _make_status_error(
self,
err_msg: str,
Expand Down
6 changes: 6 additions & 0 deletions src/orb/_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
Required,
TypedDict,
final,
override,
runtime_checkable,
)

Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
*,
Expand Down Expand Up @@ -187,6 +192,7 @@ def model_dump(
exclude_none=exclude_none,
)

@override
def model_dump_json(
self,
*,
Expand Down
2 changes: 2 additions & 0 deletions src/orb/_streaming.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

import json
from typing import TYPE_CHECKING, Any, Generic, Iterator, AsyncIterator
from typing_extensions import override

import httpx

Expand Down Expand Up @@ -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})"

Expand Down
10 changes: 9 additions & 1 deletion src/orb/_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"

Expand Down
6 changes: 5 additions & 1 deletion src/orb/_utils/_proxy.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand All @@ -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__

Expand Down
3 changes: 2 additions & 1 deletion src/orb/_utils/_transform.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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}')"

Expand Down
5 changes: 5 additions & 0 deletions src/orb/pagination.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# File generated from our OpenAPI spec by Stainless.

from typing import List, Generic, TypeVar, Optional
from typing_extensions import override

from ._types import ModelT
from ._models import BaseModel
Expand All @@ -21,9 +22,11 @@ class SyncPage(BaseSyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
data: List[ModelT]
pagination_metadata: PagePaginationMetadata

@override
def _get_page_items(self) -> List[ModelT]:
return self.data

@override
def next_page_info(self) -> Optional[PageInfo]:
cursor = self.pagination_metadata.next_cursor
if not cursor:
Expand All @@ -36,9 +39,11 @@ class AsyncPage(BaseAsyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
data: List[ModelT]
pagination_metadata: PagePaginationMetadata

@override
def _get_page_items(self) -> List[ModelT]:
return self.data

@override
def next_page_info(self) -> Optional[PageInfo]:
cursor = self.pagination_metadata.next_cursor
if not cursor:
Expand Down