pydantic-rpc 0.3.1__tar.gz → 0.4.0__tar.gz

{pydantic_rpc-0.3.1 → pydantic_rpc-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pydantic-rpc
-Version: 0.3.1
+Version: 0.4.0
 Summary: A Python library for building gRPC/ConnectRPC services with Pydantic models.
 Author: Yasushi Itoh
 Requires-Python: >=3.11
@@ -94,6 +94,7 @@ app.mount(OlympicsLocationAgent())
 - 🔄 **Automatic Protobuf Generation:** Automatically creates protobuf files matching the method signatures of your Python objects.
 - ⚙️ **Dynamic Code Generation:** Generates server and client stubs using `grpcio-tools`.
 - ✅ **Pydantic Integration:** Uses `pydantic` for robust type validation and serialization.
+- 📄 **Pprotobuf File Export:** Exports the generated protobuf files for use in other languages.
 - **For gRPC:**
   - 💚 **Health Checking:** Built-in support for gRPC health checks using `grpc_health.v1`.
   - 🔎 **Server Reflection:** Built-in support for gRPC server reflection.
@@ -261,57 +262,38 @@ Please see the sample code below:
 
 ```python
 import asyncio
-from typing import AsyncIterator
+from typing import Annotated, AsyncIterator
 
-from pydantic import field_validator
+from pydantic import Field
 from pydantic_ai import Agent
 from pydantic_rpc import AsyncIOServer, Message
 
 
 # `Message` is just a pydantic BaseModel alias
 class CityLocation(Message):
-    city: str
-    country: str
+    city: Annotated[str, Field(description="The city where the Olympics were held")]
+    country: Annotated[
+        str, Field(description="The country where the Olympics were held")
+    ]
 
 
 class OlympicsQuery(Message):
-    year: int
+    year: Annotated[int, Field(description="The year of the Olympics", ge=1896)]
 
     def prompt(self):
         return f"Where were the Olympics held in {self.year}?"
 
-    @field_validator("year")
-    def validate_year(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
 
 class OlympicsDurationQuery(Message):
-    start: int
-    end: int
+    start: Annotated[int, Field(description="The start year of the Olympics", ge=1896)]
+    end: Annotated[int, Field(description="The end year of the Olympics", ge=1896)]
 
     def prompt(self):
         return f"From {self.start} to {self.end}, how many Olympics were held? Please provide the list of countries and cities."
 
-    @field_validator("start")
-    def validate_start(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
-    @field_validator("end")
-    def validate_end(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
 
 class StreamingResult(Message):
-    answer: str
+    answer: Annotated[str, Field(description="The answer to the query")]
 
 
 class OlympicsAgent:
@@ -433,18 +415,27 @@ Using this generated proto file and tools as `protoc`, `buf` and `BSR`, you coul
 
 ## 📖 Data Type Mapping
 
-| Python Type        | Protobuf Type   |
-|--------------------|-----------------|
-| str                | string          |
-| bool               | bool            |
-| int                | int32, int64    |
-| float              | float, double   |
-| list[T], tuple[T]  | repeated T      |
-| dict[K, V]         | map<K, V>       |
+| Python Type                    | Protobuf Type             |
+|--------------------------------|---------------------------|
+| str                            | string                    |
+| bytes                          | bytes                     |
+| bool                           | bool                      |
+| int                            | int32                     |
+| float                          | float, double             |
+| list[T], tuple[T]              | repeated T                |
+| dict[K, V]                     | map<K, V>                 |
+| datetime.datetime              | google.protobuf.Timestamp |
+| datetime.timedelta             | google.protobuf.Duration  |
+| typing.Union[A, B]             | oneof A, B                |
+| subclass of enum.Enum          | enum                      |
+| subclass of pydantic.BaseModel | message                   |
 
 
 ## TODO
 - [ ] Streaming Support
+  - [x] unary-stream
+  - [ ] stream-unary
+  - [ ] stream-stream
 - [ ] Betterproto Support
 - [ ] Sonora-connect Support
 - [ ] Custom Health Check Support

{pydantic_rpc-0.3.1 → pydantic_rpc-0.4.0}/README.md

@@ -80,6 +80,7 @@ app.mount(OlympicsLocationAgent())
 - 🔄 **Automatic Protobuf Generation:** Automatically creates protobuf files matching the method signatures of your Python objects.
 - ⚙️ **Dynamic Code Generation:** Generates server and client stubs using `grpcio-tools`.
 - ✅ **Pydantic Integration:** Uses `pydantic` for robust type validation and serialization.
+- 📄 **Pprotobuf File Export:** Exports the generated protobuf files for use in other languages.
 - **For gRPC:**
   - 💚 **Health Checking:** Built-in support for gRPC health checks using `grpc_health.v1`.
   - 🔎 **Server Reflection:** Built-in support for gRPC server reflection.
@@ -247,57 +248,38 @@ Please see the sample code below:
 
 ```python
 import asyncio
-from typing import AsyncIterator
+from typing import Annotated, AsyncIterator
 
-from pydantic import field_validator
+from pydantic import Field
 from pydantic_ai import Agent
 from pydantic_rpc import AsyncIOServer, Message
 
 
 # `Message` is just a pydantic BaseModel alias
 class CityLocation(Message):
-    city: str
-    country: str
+    city: Annotated[str, Field(description="The city where the Olympics were held")]
+    country: Annotated[
+        str, Field(description="The country where the Olympics were held")
+    ]
 
 
 class OlympicsQuery(Message):
-    year: int
+    year: Annotated[int, Field(description="The year of the Olympics", ge=1896)]
 
     def prompt(self):
         return f"Where were the Olympics held in {self.year}?"
 
-    @field_validator("year")
-    def validate_year(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
 
 class OlympicsDurationQuery(Message):
-    start: int
-    end: int
+    start: Annotated[int, Field(description="The start year of the Olympics", ge=1896)]
+    end: Annotated[int, Field(description="The end year of the Olympics", ge=1896)]
 
     def prompt(self):
         return f"From {self.start} to {self.end}, how many Olympics were held? Please provide the list of countries and cities."
 
-    @field_validator("start")
-    def validate_start(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
-    @field_validator("end")
-    def validate_end(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
 
 class StreamingResult(Message):
-    answer: str
+    answer: Annotated[str, Field(description="The answer to the query")]
 
 
 class OlympicsAgent:
@@ -419,18 +401,27 @@ Using this generated proto file and tools as `protoc`, `buf` and `BSR`, you coul
 
 ## 📖 Data Type Mapping
 
-| Python Type        | Protobuf Type   |
-|--------------------|-----------------|
-| str                | string          |
-| bool               | bool            |
-| int                | int32, int64    |
-| float              | float, double   |
-| list[T], tuple[T]  | repeated T      |
-| dict[K, V]         | map<K, V>       |
+| Python Type                    | Protobuf Type             |
+|--------------------------------|---------------------------|
+| str                            | string                    |
+| bytes                          | bytes                     |
+| bool                           | bool                      |
+| int                            | int32                     |
+| float                          | float, double             |
+| list[T], tuple[T]              | repeated T                |
+| dict[K, V]                     | map<K, V>                 |
+| datetime.datetime              | google.protobuf.Timestamp |
+| datetime.timedelta             | google.protobuf.Duration  |
+| typing.Union[A, B]             | oneof A, B                |
+| subclass of enum.Enum          | enum                      |
+| subclass of pydantic.BaseModel | message                   |
 
 
 ## TODO
 - [ ] Streaming Support
+  - [x] unary-stream
+  - [ ] stream-unary
+  - [ ] stream-stream
 - [ ] Betterproto Support
 - [ ] Sonora-connect Support
 - [ ] Custom Health Check Support

{pydantic_rpc-0.3.1 → pydantic_rpc-0.4.0}/examples/agent_aio_grpc.py

@@ -1,55 +1,36 @@
 import asyncio
-from typing import AsyncIterator
+from typing import Annotated, AsyncIterator
 
-from pydantic import field_validator
+from pydantic import Field
 from pydantic_ai import Agent
 from pydantic_rpc import AsyncIOServer, Message
 
 
 # `Message` is just a pydantic BaseModel alias
 class CityLocation(Message):
-    city: str
-    country: str
+    city: Annotated[str, Field(description="The city where the Olympics were held")]
+    country: Annotated[
+        str, Field(description="The country where the Olympics were held")
+    ]
 
 
 class OlympicsQuery(Message):
-    year: int
+    year: Annotated[int, Field(description="The year of the Olympics", ge=1896)]
 
     def prompt(self):
         return f"Where were the Olympics held in {self.year}?"
 
-    @field_validator("year")
-    def validate_year(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
 
 class OlympicsDurationQuery(Message):
-    start: int
-    end: int
+    start: Annotated[int, Field(description="The start year of the Olympics", ge=1896)]
+    end: Annotated[int, Field(description="The end year of the Olympics", ge=1896)]
 
     def prompt(self):
         return f"From {self.start} to {self.end}, how many Olympics were held? Please provide the list of countries and cities."
 
-    @field_validator("start")
-    def validate_start(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
-    @field_validator("end")
-    def validate_end(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        return value
-
 
 class StreamingResult(Message):
-    answer: str
+    answer: Annotated[str, Field(description="The answer to the query")]
 
 
 class OlympicsAgent:

{pydantic_rpc-0.3.1 → pydantic_rpc-0.4.0}/examples/agent_connecpy.py

@@ -1,33 +1,29 @@
 import asyncio
 
+from typing import Annotated
+
 from hypercorn.asyncio import serve
 from hypercorn.config import Config
-from pydantic import field_validator
+from pydantic import Field
 from pydantic_ai import Agent
 from pydantic_rpc import ConnecpyASGIApp, Message
 
 
 class CityLocation(Message):
-    city: str
-    country: str
+    city: Annotated[str, Field(description="The city where the Olympics were held")]
+    country: Annotated[
+        str, Field(description="The country where the Olympics were held")
+    ]
 
 
 class Olympics(Message):
-    year: int
+    year: Annotated[
+        int, Field(description="The year of the Olympics", ge=1896, multiple_of=4)
+    ]
 
     def prompt(self):
         return f"Where were the Olympics held in {self.year}?"
 
-    @field_validator("year")
-    def validate_year(cls, value):
-        if value < 1896:
-            raise ValueError("The first modern Olympics was held in 1896.")
-
-        if value % 4 != 0:
-            raise ValueError("The Olympics are held every 4 years.")
-
-        return value
-
 
 class OlympicsLocationAgent:
     def __init__(self):

pydantic_rpc-0.4.0/examples/olympicsagent.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+
+package olympicsagent.v1;
+
+
+service OlympicsAgent {
+    rpc Ask (OlympicsQuery) returns (CityLocation);
+    rpc AskStream (OlympicsDurationQuery) returns (stream StreamingResult);
+}
+
+message CityLocation {
+    // The city where the Olympics were held
+    string city = 1;
+    // The country where the Olympics were held
+    string country = 2;
+}
+
+message OlympicsQuery {
+    // The year of the Olympics
+    // Constraint:
+    //   greater than or equal to 1896
+    int32 year = 1;
+}
+
+message StreamingResult {
+    // The answer to the query
+    string answer = 1;
+}
+
+message OlympicsDurationQuery {
+    // The start year of the Olympics
+    // Constraint:
+    //   greater than or equal to 1896
+    int32 start = 1;
+    // The end year of the Olympics
+    // Constraint:
+    //   greater than or equal to 1896
+    int32 end = 2;
+}
+

{pydantic_rpc-0.3.1 → pydantic_rpc-0.4.0}/examples/olympicslocationagent.proto

@@ -8,11 +8,17 @@ service OlympicsLocationAgent {
 }
 
 message CityLocation {
+    // The city where the Olympics were held
     string city = 1;
+    // The country where the Olympics were held
     string country = 2;
 }
 
 message Olympics {
+    // The year of the Olympics
+    // Constraint:
+    //   greater than or equal to 1896
+    //   multiple of 4
     int32 year = 1;
 }
 

{pydantic_rpc-0.3.1 → pydantic_rpc-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pydantic-rpc"
-version = "0.3.1"
+version = "0.4.0"
 description = "A Python library for building gRPC/ConnectRPC services with Pydantic models."
 authors = [
     { name = "Yasushi Itoh" }