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

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

@@ -1,10 +1,11 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pydantic-rpc
-Version: 0.3.1
+Version: 0.4.1
 Summary: A Python library for building gRPC/ConnectRPC services with Pydantic models.
 Author: Yasushi Itoh
+License-File: LICENSE
 Requires-Python: >=3.11
-Requires-Dist: connecpy>=1.2.0
+Requires-Dist: connecpy>=1.2.1
 Requires-Dist: grpcio-health-checking>=1.56.2
 Requires-Dist: grpcio-reflection>=1.56.2
 Requires-Dist: grpcio-tools>=1.56.2
@@ -94,6 +95,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.
@@ -228,7 +230,7 @@ app.mount(Greeter())
 PydanticRPC also partially supports Connect-RPC via connecpy. Check out “greeting_connecpy.py” for an example:
 
 ```bash
-rye run python greeting_connecpy.py
+uv run greeting_connecpy.py
 ```
 
 This will launch a Connecpy-based ASGI application that uses the same Pydantic models to serve Connect-RPC requests.
@@ -261,57 +263,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 +416,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.1}/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.
@@ -214,7 +215,7 @@ app.mount(Greeter())
 PydanticRPC also partially supports Connect-RPC via connecpy. Check out “greeting_connecpy.py” for an example:
 
 ```bash
-rye run python greeting_connecpy.py
+uv run greeting_connecpy.py
 ```
 
 This will launch a Connecpy-based ASGI application that uses the same Pydantic models to serve Connect-RPC requests.
@@ -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.1}/examples/README.md

@@ -1,144 +1,152 @@
-# 📚 Examples
-
-## 📝 Prerequisites
-
-Ensure you have [Rye](https://rye-up.com/) installed on your system. If not, you can install it using the following command:
-
-```bash
-curl -sSL https://rye-up.com/install.sh | bash
-```
-
-## 🔧 Setup
-
-1. **Clone the Repository:**
-
-    ```bash
-    git clone https://github.com/i2y/pydantic-rpc.git
-    cd pydantic-rpc/examples
-    ```
-
-2. **Install Dependencies with Rye:**
-
-    ```bash
-    rye sync
-    ```
-
-## 🖥️ gRPC Server Example
-
-### 🔧 Server (`greeting.py`)
-
-A simple gRPC server.
-
-**Usage:**
-
-```bash
-rye run python greeting.py
-```
-
-### 🔗 Client (`greeter_client.py`)
-
-A gRPC client to interact with the server.
-
-**Usage:**
-
-```bash
-rye run python greeter_client.py
-```
-
-## ⚡ Asyncio gRPC Server Example
-
-### 🔧 Asyncio Server (`asyncio_greeting.py`)
-
-An asyncio gRPC server using `AsyncIOServer`.
-
-**Usage:**
-
-```bash
-rye run python asyncio_greeting.py
-```
-
-## 🌐 ASGI Integration (gRPC-Web)
-
-### 🌐 ASGI Application (`greeting_asgi.py`)
-
-Integrate **PydanticRPC** (gRPC-Web) with an ASGI-compatible framework.
-
-**Usage:**
-
-```bash
-rye run hypercorn -bind :3000 greeting_asgi:app
-```
-
-### 🔗 Client (`greeter_sonora_client.py`)
-A gRPC-Web client to interact with the server.
-
-**Usage:**
-
-```bash
-rye run python greeter_sonora_client.py
-```
-
-
-## 🌐 WSGI Integration
-
-### 🌐 WSGI Application (`greeting_wsgi.py`)
-
-Integrate **PydanticRPC** (gRPC-Web) with a WSGI-compatible framework.
-
-**Usage:**
-
-```bash
-rye run python greeting_wsgi.py
-```
-
-### 🔗 Client (`greeter_sonora_client.py`)
-A gRPC-Web client to interact with the server.
-
-**Usage:**
-
-```bash
-rye run python greeter_sonora_client.py
-```
-
-
-## 🛡️ Custom Interceptor and Running Multiple Services Exxample
-
-### 🔧 Server (`foobar.py`)
-A simple gRPC server with custom interceptor and running multiple services.
-
-**Usage:**
-
-```bash
-rye run python foobar.py
-```
-
-### 🔗 Client (`foobar_client.py`)
-A gRPC client to interact with the server.
-
-**Usage:**
-
-```bash
-rye run python foobar_client.py
-```
-
-## 🤝 Connecpy (Connect-RPC) Example
-
-### 🔧 Server (`greeting_connecpy.py`)
-
-A Connect-RPC ASGI application using PydanticRPC + connecpy.
-
-**Usage:**
-
-```bash
-rye run hypercorn --bind :3000 greeting_connecpy:app
-```
-
-### 🔗 Client (`greeter_client_connecpy.py`)
-
-A Connect-RPC client to interact with the server.
-
-**Usage:**
-
-```bash
-rye run python greeter_client_connecpy.py
-```
+# 📚 Examples
+
+## 📝 Prerequisites
+
+Ensure you have [UV](https://docs.astral.sh/uv/) installed on your system. If not, you can install it using the following command:
+
+### Linux/macOS
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### Windows
+
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+## 🔧 Setup
+
+1. **Clone the Repository:**
+
+    ```bash
+    git clone https://github.com/i2y/pydantic-rpc.git
+    cd pydantic-rpc/examples
+    ```
+
+2. **Install Dependencies with Rye:**
+
+    ```bash
+    uv sync
+    ```
+
+## 🖥️ gRPC Server Example
+
+### 🔧 Server (`greeting.py`)
+
+A simple gRPC server.
+
+**Usage:**
+
+```bash
+uv run greeting.py
+```
+
+### 🔗 Client (`greeter_client.py`)
+
+A gRPC client to interact with the server.
+
+**Usage:**
+
+```bash
+uv run greeter_client.py
+```
+
+## ⚡ Asyncio gRPC Server Example
+
+### 🔧 Asyncio Server (`asyncio_greeting.py`)
+
+An asyncio gRPC server using `AsyncIOServer`.
+
+**Usage:**
+
+```bash
+uv run asyncio_greeting.py
+```
+
+## 🌐 ASGI Integration (gRPC-Web)
+
+### 🌐 ASGI Application (`greeting_asgi.py`)
+
+Integrate **PydanticRPC** (gRPC-Web) with an ASGI-compatible framework.
+
+**Usage:**
+
+```bash
+uv run hypercorn -bind :3000 greeting_asgi:app
+```
+
+### 🔗 Client (`greeter_sonora_client.py`)
+A gRPC-Web client to interact with the server.
+
+**Usage:**
+
+```bash
+uv run greeter_sonora_client.py
+```
+
+
+## 🌐 WSGI Integration
+
+### 🌐 WSGI Application (`greeting_wsgi.py`)
+
+Integrate **PydanticRPC** (gRPC-Web) with a WSGI-compatible framework.
+
+**Usage:**
+
+```bash
+uv run greeting_wsgi.py
+```
+
+### 🔗 Client (`greeter_sonora_client.py`)
+A gRPC-Web client to interact with the server.
+
+**Usage:**
+
+```bash
+uv run greeter_sonora_client.py
+```
+
+
+## 🛡️ Custom Interceptor and Running Multiple Services Exxample
+
+### 🔧 Server (`foobar.py`)
+A simple gRPC server with custom interceptor and running multiple services.
+
+**Usage:**
+
+```bash
+uv run foobar.py
+```
+
+### 🔗 Client (`foobar_client.py`)
+A gRPC client to interact with the server.
+
+**Usage:**
+
+```bash
+uv run foobar_client.py
+```
+
+## 🤝 Connecpy (Connect-RPC) Example
+
+### 🔧 Server (`greeting_connecpy.py`)
+
+A Connect-RPC ASGI application using PydanticRPC + connecpy.
+
+**Usage:**
+
+```bash
+uv run hypercorn --bind :3000 greeting_connecpy:app
+```
+
+### 🔗 Client (`greeter_client_connecpy.py`)
+
+A Connect-RPC client to interact with the server.
+
+**Usage:**
+
+```bash
+uv run greeter_client_connecpy.py
+```

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

@@ -1,59 +1,47 @@
 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:
     def __init__(self):
+        # # if pydantic_ai >= 0.0.21
+        # ollama_model = OpenAIModel(
+        #     model_name="llama3.2",
+        #     base_url="http://localhost:11434/v1",
+        #     api_key="",
+        # )
+        # self._agent = Agent(ollama_model)
         self._agent = Agent("ollama:llama3.2")
 
     async def ask(self, req: OlympicsQuery) -> CityLocation: