Skip to content
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

[client codegen] Unknown enumeration values, attempt 2 #135

Merged
merged 6 commits into from
Feb 6, 2025
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
19 changes: 19 additions & 0 deletions src/replit_river/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

from opentelemetry import trace
from opentelemetry.trace import Span, SpanKind, Status, StatusCode
from pydantic import (
BaseModel,
ValidationInfo,
)

from replit_river.client_transport import ClientTransport
from replit_river.error_schema import RiverError, RiverException
Expand All @@ -27,6 +31,21 @@
tracer = trace.get_tracer(__name__)


@dataclass(frozen=True)
class RiverUnknownValue(BaseModel):
tag: Literal["RiverUnknownValue"]
value: Any


def translate_unknown_value(
value: Any, handler: Callable[[Any], Any], info: ValidationInfo
) -> Any | RiverUnknownValue:
try:
return handler(value)
except Exception:
return RiverUnknownValue(tag="RiverUnknownValue", value=value)


class Client(Generic[HandshakeMetadataType]):
def __init__(
self,
Expand Down
36 changes: 13 additions & 23 deletions src/replit_river/codegen/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@
ListTypeExpr,
LiteralTypeExpr,
ModuleName,
OpenUnionTypeExpr,
RenderedPath,
TypeExpression,
TypeName,
UnionTypeExpr,
UnknownTypeExpr,
ensure_literal_type,
extract_inner_type,
render_type_expr,
Expand Down Expand Up @@ -83,15 +83,16 @@
Literal,
Optional,
Mapping,
NewType,
NotRequired,
Union,
Tuple,
TypedDict,
)
from typing_extensions import Annotated

from pydantic import BaseModel, Field, TypeAdapter
from pydantic import BaseModel, Field, TypeAdapter, WrapValidator
from replit_river.error_schema import RiverError
from replit_river.client import RiverUnknownValue, translate_unknown_value

import replit_river as river

Expand Down Expand Up @@ -311,19 +312,12 @@ def flatten_union(tpe: RiverType) -> list[RiverType]:
else
""",
)
union: TypeExpression
if permit_unknown_members:
unknown_name = TypeName(f"{prefix}AnyOf__Unknown")
chunks.append(
FileContents(
f"{unknown_name} = NewType({repr(unknown_name)}, object)"
)
)
one_of.append(UnknownTypeExpr(unknown_name))
chunks.append(
FileContents(
f"{prefix} = {render_type_expr(UnionTypeExpr(one_of))}"
)
)
union = OpenUnionTypeExpr(UnionTypeExpr(one_of))
else:
union = UnionTypeExpr(one_of)
chunks.append(FileContents(f"{prefix} = {render_type_expr(union)}"))
chunks.append(FileContents(""))

if base_model == "TypedDict":
Expand Down Expand Up @@ -386,16 +380,12 @@ def flatten_union(tpe: RiverType) -> list[RiverType]:
f"encode_{ensure_literal_type(other)}(x)"
)
if permit_unknown_members:
unknown_name = TypeName(f"{prefix}AnyOf__Unknown")
chunks.append(
FileContents(f"{unknown_name} = NewType({repr(unknown_name)}, object)")
)
any_of.append(UnknownTypeExpr(unknown_name))
union = OpenUnionTypeExpr(UnionTypeExpr(any_of))
else:
union = UnionTypeExpr(any_of)
if is_literal(type):
typeddict_encoder = ["x"]
chunks.append(
FileContents(f"{prefix} = {render_type_expr(UnionTypeExpr(any_of))}")
)
chunks.append(FileContents(f"{prefix} = {render_type_expr(union)}"))
if base_model == "TypedDict":
encoder_name = TypeName(f"encode_{prefix}")
encoder_names.add(encoder_name)
Expand Down
2 changes: 1 addition & 1 deletion src/replit_river/codegen/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def main() -> None:
client = subparsers.add_parser(
"client", help="Codegen a River client from JSON schema"
)
client.add_argument("--output", help="output file", required=True)
client.add_argument("--output", help="output path", required=True)
client.add_argument("--client-name", help="name of the class", required=True)
client.add_argument(
"--typed-dict-inputs",
Expand Down
27 changes: 18 additions & 9 deletions src/replit_river/codegen/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ class UnionTypeExpr:


@dataclass
class UnknownTypeExpr:
name: TypeName
class OpenUnionTypeExpr:
union: UnionTypeExpr


TypeExpression = (
Expand All @@ -41,7 +41,7 @@ class UnknownTypeExpr:
| ListTypeExpr
| LiteralTypeExpr
| UnionTypeExpr
| UnknownTypeExpr
| OpenUnionTypeExpr
)


Expand All @@ -55,10 +55,15 @@ def render_type_expr(value: TypeExpression) -> str:
return f"Literal[{repr(inner)}]"
case UnionTypeExpr(inner):
return " | ".join(render_type_expr(x) for x in inner)
case OpenUnionTypeExpr(inner):
return (
"Annotated["
f"{render_type_expr(inner)} | RiverUnknownValue,"
"WrapValidator(translate_unknown_value)"
"]"
)
case str(name):
return TypeName(name)
case UnknownTypeExpr(name):
return TypeName(name)
case other:
assert_never(other)

Expand All @@ -75,10 +80,12 @@ def extract_inner_type(value: TypeExpression) -> TypeName:
raise ValueError(
f"Attempting to extract from a union, currently not possible: {value}"
)
case OpenUnionTypeExpr(_):
raise ValueError(
f"Attempting to extract from a union, currently not possible: {value}"
)
case str(name):
return TypeName(name)
case UnknownTypeExpr(name):
return name
case other:
assert_never(other)

Expand All @@ -101,9 +108,11 @@ def ensure_literal_type(value: TypeExpression) -> TypeName:
raise ValueError(
f"Unexpected expression when expecting a type name: {value}"
)
case OpenUnionTypeExpr(_):
raise ValueError(
f"Unexpected expression when expecting a type name: {value}"
)
case str(name):
return TypeName(name)
case UnknownTypeExpr(name):
return name
case other:
assert_never(other)
2 changes: 1 addition & 1 deletion tests/codegen/rpc/generated/test_service/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import replit_river as river


from .rpc_method import encode_Rpc_MethodInput, Rpc_MethodInput, Rpc_MethodOutput
from .rpc_method import Rpc_MethodInput, Rpc_MethodOutput, encode_Rpc_MethodInput


class Test_ServiceService:
Expand Down
5 changes: 3 additions & 2 deletions tests/codegen/rpc/generated/test_service/rpc_method.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@
Literal,
Optional,
Mapping,
NewType,
NotRequired,
Union,
Tuple,
TypedDict,
)
from typing_extensions import Annotated

from pydantic import BaseModel, Field, TypeAdapter
from pydantic import BaseModel, Field, TypeAdapter, WrapValidator
from replit_river.error_schema import RiverError
from replit_river.client import RiverUnknownValue, translate_unknown_value

import replit_river as river

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,27 @@
Literal,
Optional,
Mapping,
NewType,
NotRequired,
Union,
Tuple,
TypedDict,
)
from typing_extensions import Annotated

from pydantic import BaseModel, Field, TypeAdapter
from pydantic import BaseModel, Field, TypeAdapter, WrapValidator
from replit_river.error_schema import RiverError
from replit_river.client import RiverUnknownValue, translate_unknown_value

import replit_river as river


NeedsenumInput = Literal["in_first"] | Literal["in_second"]
encode_NeedsenumInput: Callable[["NeedsenumInput"], Any] = lambda x: x
NeedsenumOutputAnyOf__Unknown = NewType("NeedsenumOutputAnyOf__Unknown", object)
NeedsenumOutput = (
Literal["out_first"] | Literal["out_second"] | NeedsenumOutputAnyOf__Unknown
)
NeedsenumErrorsAnyOf__Unknown = NewType("NeedsenumErrorsAnyOf__Unknown", object)
NeedsenumErrors = (
Literal["err_first"] | Literal["err_second"] | NeedsenumErrorsAnyOf__Unknown
)
NeedsenumOutput = Annotated[
Literal["out_first"] | Literal["out_second"] | RiverUnknownValue,
WrapValidator(translate_unknown_value),
]
NeedsenumErrors = Annotated[
Literal["err_first"] | Literal["err_second"] | RiverUnknownValue,
WrapValidator(translate_unknown_value),
]
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@
Literal,
Optional,
Mapping,
NewType,
NotRequired,
Union,
Tuple,
TypedDict,
)
from typing_extensions import Annotated

from pydantic import BaseModel, Field, TypeAdapter
from pydantic import BaseModel, Field, TypeAdapter, WrapValidator
from replit_river.error_schema import RiverError
from replit_river.client import RiverUnknownValue, translate_unknown_value

import replit_river as river

Expand Down Expand Up @@ -90,14 +91,12 @@ class NeedsenumobjectOutputFooOneOf_out_second(BaseModel):
bar: int


NeedsenumobjectOutputFooAnyOf__Unknown = NewType(
"NeedsenumobjectOutputFooAnyOf__Unknown", object
)
NeedsenumobjectOutputFoo = (
NeedsenumobjectOutputFoo = Annotated[
NeedsenumobjectOutputFooOneOf_out_first
| NeedsenumobjectOutputFooOneOf_out_second
| NeedsenumobjectOutputFooAnyOf__Unknown
)
| RiverUnknownValue,
WrapValidator(translate_unknown_value),
]


class NeedsenumobjectOutput(BaseModel):
Expand All @@ -112,14 +111,12 @@ class NeedsenumobjectErrorsFooAnyOf_1(RiverError):
borp: Optional[Literal["err_second"]] = None


NeedsenumobjectErrorsFooAnyOf__Unknown = NewType(
"NeedsenumobjectErrorsFooAnyOf__Unknown", object
)
NeedsenumobjectErrorsFoo = (
NeedsenumobjectErrorsFoo = Annotated[
NeedsenumobjectErrorsFooAnyOf_0
| NeedsenumobjectErrorsFooAnyOf_1
| NeedsenumobjectErrorsFooAnyOf__Unknown
)
| RiverUnknownValue,
WrapValidator(translate_unknown_value),
]


class NeedsenumobjectErrors(RiverError):
Expand Down
4 changes: 2 additions & 2 deletions tests/codegen/stream/generated/test_service/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@


from .stream_method import (
encode_Stream_MethodInput,
Stream_MethodOutput,
Stream_MethodInput,
Stream_MethodOutput,
encode_Stream_MethodInput,
)


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@
Literal,
Optional,
Mapping,
NewType,
NotRequired,
Union,
Tuple,
TypedDict,
)
from typing_extensions import Annotated

from pydantic import BaseModel, Field, TypeAdapter
from pydantic import BaseModel, Field, TypeAdapter, WrapValidator
from replit_river.error_schema import RiverError
from replit_river.client import RiverUnknownValue, translate_unknown_value

import replit_river as river

Expand Down
Loading