pyrpc-codegen 0.3.3__tar.gz → 0.6.1__tar.gz

{pyrpc_codegen-0.3.3 → pyrpc_codegen-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrpc-codegen
-Version: 0.3.3
+Version: 0.6.1
 Summary: Codegen and CLI tools for pyRPC
 Requires-Python: >=3.11
 Requires-Dist: jinja2>=3.1.0

pyrpc_codegen-0.6.1/README.md

@@ -0,0 +1,21 @@
+# pyrpc-codegen
+
+Code generation utilities for [pyRPC](https://pyrpc.com). Generates TypeScript type definitions from Python procedure schemas.
+
+## What it does
+
+- `generate_typescript_client(schemas)` - generates TypeScript interface source code from a schema dict
+- `save_typescript_client(schemas, output_path)` - generates and writes TypeScript types to a file
+- `DEFAULT_OUTPUT` - default output filename constant
+
+## Installation
+
+Installed automatically as a dependency of `pyrpc-core`:
+
+```bash
+uv add pyrpc-core
+```
+
+## License
+
+MIT

{pyrpc_codegen-0.3.3 → pyrpc_codegen-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyrpc-codegen"
-version = "0.3.3"
+version = "0.6.1"
 description = "Codegen and CLI tools for pyRPC"
 requires-python = ">=3.11"
 dependencies = [

{pyrpc_codegen-0.3.3 → pyrpc_codegen-0.6.1}/src/pyrpc_codegen/ts_codegen.py

@@ -141,10 +141,12 @@ def generate_typescript_client(schemas: Dict[str, Any]) -> str:
     )
 
 
-def save_typescript_client(schemas: Dict[str, Any], output_path: str = DEFAULT_OUTPUT):
-    content = generate_typescript_client(schemas)
+def save_typescript_client(schemas: Dict[str, Any], output_path: str):
     if not os.path.isabs(output_path):
-        output_path = os.path.join(os.getcwd(), output_path)
+        raise ValueError(
+            "save_typescript_client requires an absolute path"
+        )
+    content = generate_typescript_client(schemas)
     os.makedirs(os.path.dirname(output_path), exist_ok=True)
     with open(output_path, "w", encoding="utf-8") as f:
         f.write(content)

pyrpc_codegen-0.6.1/tests/test_codegen.py

@@ -0,0 +1,91 @@
+import json
+import os
+import tempfile
+import pytest
+from pyrpc_core import rpc, default_router, get_registry_schema
+from pyrpc_codegen import generate_typescript_client, save_typescript_client
+
+
+@pytest.fixture(autouse=True)
+def clear_registry():
+    default_router._procedures.clear()
+
+
+def test_generate_typescript_client():
+    @rpc
+    def add(a: int, b: int) -> int:
+        """Add two numbers."""
+        return a + b
+
+    schemas = get_registry_schema(default_router)
+    content = generate_typescript_client(schemas)
+
+    assert "export interface Types" in content
+    assert "add(a: number, b: number): Promise<number>;" in content
+
+
+def test_generate_typescript_client_empty():
+    schemas = get_registry_schema(default_router)
+    content = generate_typescript_client(schemas)
+    assert "export interface Types {" in content
+
+
+def test_save_typescript_client_from_file():
+    schemas = {
+        "greet": {
+            "name": "greet",
+            "doc": "Say hello",
+            "parameters": [
+                {"name": "name", "type": "<class 'str'>", "required": True, "default": None}
+            ],
+            "return_type": "<class 'str'>",
+        }
+    }
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        schema_file = os.path.join(tmpdir, "schema.json")
+        with open(schema_file, "w") as f:
+            json.dump(schemas, f)
+
+        from pyrpc_core.cli import _load_schema
+        loaded = _load_schema(schema_file)
+        assert loaded == schemas
+
+        output_file = os.path.join(tmpdir, "types.ts")
+        save_typescript_client(schemas, output_file)
+
+        with open(output_file) as f:
+            content = f.read()
+
+        assert "export interface Types" in content
+        assert "greet(name: string): Promise<string>;" in content
+
+
+def test_save_typescript_client_serialized_schema():
+    @rpc
+    def add(a: int) -> int:
+        return a
+
+    schemas = get_registry_schema(default_router)
+
+    serializable = {}
+    for name, schema in schemas.items():
+        serializable[name] = {
+            "name": schema.name,
+            "doc": schema.doc or "",
+            "parameters": [
+                {"name": p.name, "type": p.type, "required": p.required, "default": p.default}
+                for p in schema.parameters
+            ],
+            "return_type": schema.return_type,
+        }
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        output_file = os.path.join(tmpdir, "types.ts")
+        save_typescript_client(serializable, output_file)
+
+        with open(output_file) as f:
+            content = f.read()
+
+        assert "export interface Types" in content
+        assert "add(a: number): Promise<number>;" in content