trpc-fastapi-python 1.0.0__py3-none-any.whl

trpc_fastapi_python-1.0.0.dist-info/METADATA

@@ -0,0 +1,373 @@
+Metadata-Version: 2.5
+Name: trpc-fastapi-python
+Version: 1.0.0
+Summary: The plugin for trpc about fastapi
+Project-URL: Homepage, https://github.com/trpc-ecosystem/python-fastapi
+Project-URL: Documentation, https://github.com/trpc-ecosystem/python-fastapi/blob/main/README.md
+Author: tRPC Group
+License: Apache-2.0
+License-File: LICENSE
+Keywords: fastapi,microservice,trpc
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: annotated-types
+Requires-Dist: fastapi
+Requires-Dist: trpc-python; sys_platform != 'win32'
+Requires-Dist: uvicorn
+Provides-Extra: all
+Requires-Dist: annotated-types; extra == 'all'
+Requires-Dist: fastapi; extra == 'all'
+Requires-Dist: jinja2; extra == 'all'
+Requires-Dist: setuptools; extra == 'all'
+Requires-Dist: websockets; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: annotated-types; extra == 'dev'
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: fastapi; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: setuptools; extra == 'dev'
+Requires-Dist: uvicorn; extra == 'dev'
+Requires-Dist: websockets; extra == 'dev'
+Requires-Dist: yapf; extra == 'dev'
+Provides-Extra: static
+Requires-Dist: jinja2; extra == 'static'
+Description-Content-Type: text/markdown
+
+[中文](README.zh_CN.md) | English
+
+# tRPC-FastAPI
+
+tRPC-FastAPI is a FastAPI integration plugin for the tRPC-Python framework (`trpc_sdk`). It provides HTTP serving out of the box, so you can develop, debug, deploy, and call HTTP APIs quickly. FastAPI is used as the server, so this plugin supports the server side only. Any HTTP client can call it.
+
+## Features
+
+- **FastAPI integration**:
+    - **Drop-in fit**: Integrates with the tRPC-Python framework and keeps every tRPC feature;
+    - **HTTP routing**: Supports every HTTP method (GET, POST, PUT, DELETE, HEAD, OPTIONS, and others);
+    - **Generated docs**: Generates OpenAPI/Swagger docs, including interactive API testing;
+    - **Type safety**: Full type-annotation support for a better development experience;
+- **Development tools**:
+    - **Static files**: Serves static assets such as HTML, CSS, JS, and images;
+    - **Templates**: Integrates the Jinja2 template engine for dynamic page rendering;
+    - **Version info**: Reads and displays the FastAPI and plugin versions;
+- **Deployment**:
+    - **Containers**: Supports Docker;
+    - **Cloud native**: Supports Kubernetes and other cloud-native environments;
+
+## Installation
+
+### Requirements
+
+- Python 3.8+
+- Linux / macOS (tRPC-Python does not support Windows)
+- tRPC-Python-SDK
+
+### Install
+
+tRPC-Python is currently pinned as a git dependency to the commit referenced above, and `pip` installs it together with the plugin:
+
+```bash
+pip install -e .
+# To install the extra that includes static templates:
+# pip install -e ".[static]"
+```
+
+## Quick start
+
+### Basic usage
+
+This assumes you already have a generated tRPC project. For the full walkthrough and the one-command run, see [examples/README.md](./examples/README.md). The main files are:
+
+```txt
+examples/
+├── normal_http/
+├── http_sse_service.py
+├── http_websocket_service.py
+├── trpc_main.py
+├── run_examples.sh
+├── trpc_python.yaml                 # one process, one uvicorn
+├── trpc_python_merge_threads.yaml   # one process, multiple handler threads
+├── trpc_python_separate_thread.yaml # one process, I/O and handlers split
+└── trpc_python_separate.yaml        # multi-process separate
+```
+
+#### 1. Register HTTP routes
+
+You can register routes in a separate file. The example below is [http_service.py](./examples/normal_http/_http_service.py):
+
+```python
+
+from trpc_fastapi import fastapi_route
+
+@fastapi_route("/fastapi_http", ["GET", "HEAD"], route_params={'response_model': dict})
+async def fastapi_http(request: Request) -> dict:
+    """Test fastapi_http http"""
+    logger.debug(f"=== normal_http, http_req header: {request.headers} ===")
+    ctx = get_trpc_ctx()
+    msg = ctx.get_client_message()
+    register_service_name = "trpc.trpc_python_group.helloworld.Greeter1"
+    msg_info = f"\n\n test_route, register service_name: {register_service_name}"
+    msg_info = f"{msg_info}, callee_service_name: {msg.callee_service_name}\n\n"
+    logger.debug(f"=== normal_http, msg_info: {msg_info} ===")
+    return {"message": "This fastapi_http for [GET, HEAD]"}
+```
+
+#### 2. RPC-style HTTP service
+
+Code generated by the stub tool includes protobuf objects. Point it at `http_fastapi` and it is reachable as-is. Calling through the stub looks like this. Full source: [test_service_rpc](./examples/client/test_service_rpc.py):
+
+```python
+from trpc_sdk.abc import TrpcContext
+from trpc_sdk.client import Options
+from trpc_sdk.serialization import SerializationType
+
+async def test_sync_Greeter_SayHello():
+    """Test Greeter of SayHello"""
+    proxy = rpc.GreeterClientProxyImpl()
+    req = pb.HelloRequest()
+    req.msg = "[sync] Hi SayHello"
+    options = (Options().set_target('ip://127.0.0.1:8000').set_protocol('http').set_serialization_type(
+        SerializationType.PB).set_network('tcp').set_short_conn(True))
+    ctx = TrpcContext()
+    try:
+        ret = await proxy.asyncSayHello(ctx, req, options)
+        print(f"SayHello ret is {ret}")
+        assert ret is not None
+    except Exception as exc:  # pylint: disable=broad-exception-caught
+        print(f"error {exc}")
+        assert 0
+```
+
+curl:
+
+```sh
+curl -X POST http://127.0.0.1:8000/trpc.trpc_python_group.helloworld.Greeter/SayHello \
+     -H 'Content-Type: application/json' -d '{"msg":"data"}'
+```
+
+Import the route-registration module in `trpc_main.py`. The import must happen before `create_server`:
+
+```python
+# Importing registers the plugin, so this has to come first.
+import trpc_fastapi as _
+# Import the registered HTTP service.
+import normal_http as _
+```
+
+To serve another protocol name through FastAPI (for example the a2a plugin), call `register_protocol_to_fastapi` at import time. This also has to happen before `create_server`:
+
+```python
+from trpc_fastapi import register_protocol_to_fastapi
+
+register_protocol_to_fastapi("a2a")
+```
+
+#### 3. Configuration
+
+See [trpc_python.yaml](./examples/trpc_python.yaml). When `global.processmodel` is omitted, the server is a single process with one event loop, and uvicorn runs on one thread of the service process.
+
+```yaml
+server:
+  service:
+    - name: trpc.trpc_python_group.helloworld.FastApiGreeter
+      ip: 0.0.0.0
+      port: 8000
+      network: tcp
+      protocol: http_fastapi
+```
+
+#### Process models
+
+| Config | `global.processmodel` | uvicorn |
+|---|---|---|
+| [trpc_python.yaml](./examples/trpc_python.yaml) | omitted | one for the whole service |
+| [trpc_python_merge_threads.yaml](./examples/trpc_python_merge_threads.yaml) | `single_process`, `handle_num: 2` | one, started on serving thread 0 |
+| [trpc_python_separate_thread.yaml](./examples/trpc_python_separate_thread.yaml) | `single_process`, `io_handle_type: separate` | one, started on serving thread 0 |
+| [trpc_python_separate.yaml](./examples/trpc_python_separate.yaml) | `multi_process`, `io_handle_type: separate`, `handle_num: 2` | one per rpc task, listening on 8000 with `SO_REUSEPORT`. The I/O process listens only on the tRPC port |
+
+Multi-process separate snippet:
+
+```yaml
+global:
+  processmodel:
+    mode: multi_process
+    io_handle_type: separate
+    handle_num: 2
+```
+
+#### 4. Start the server
+
+In [trpc_main.py](./examples/trpc_main.py), import the module that registers routes, such as `http_service.py` above.
+
+```sh
+cd examples
+./run_examples.sh
+# or start it by hand
+python3 trpc_main.py --conf trpc_python.yaml
+python3 trpc_main.py --conf trpc_python_separate.yaml
+```
+
+#### 5. Call the service
+
+- In a browser: http://{IP}:{Port}/docs (`IP` and `Port` come from the config file. If the address is `0.0.0.0`, use the IP of your environment.)
+
+- With curl:
+
+  ```sh
+  curl -X GET http://127.0.0.1:8000/details -v
+  ```
+
+### Advanced features
+
+#### SSE
+
+- Server code: [http_sse_service](./examples/http_sse_service.py)
+
+  ```python
+  import asyncio
+  from fastapi.responses import StreamingResponse
+
+  from trpc_fastapi import fastapi_route
+
+  async def event_generator():
+      """
+      Simulate async events and push one message every second.
+      """
+      counter = 0
+      while True:
+          counter += 1
+          # SSE format: data: <message>\n\n
+          yield f"data: 这是第 {counter} 条消息\n\n"
+          await asyncio.sleep(1)
+
+  @fastapi_route('/sse', ["GET"])
+  async def sse_endpoint():
+      """
+      SSE endpoint. Returns the event stream.
+      """
+      return StreamingResponse(event_generator(), media_type='text/event-stream')
+  ```
+
+- Import it in [trpc_main.py](./examples/trpc_main.py):
+
+  ```python
+  import http_sse_service as _
+  ```
+
+- Client check:
+
+  ```sh
+  curl -X GET http://127.0.0.1:8000/sse -v
+  ```
+
+#### WebSocket
+
+- Server code: [http_websocket_service](./examples/http_websocket_service.py)
+
+  ```python
+  from fastapi import WebSocket
+  from fastapi.responses import HTMLResponse
+
+  from trpc_sdk.log import logger
+  from trpc_fastapi import fastapi_route
+
+  @fastapi_route("/ws", method="WEBSOCKET")
+  async def websocket_endpoint(websocket: WebSocket):
+      await websocket.accept()
+      try:
+          while True:
+              data = await websocket.receive_text()
+              await websocket.send_text(f"Message text was: {data}")
+      except Exception as e:  # pylint: disable=broad-except
+          logger.error(f"websocket error: {e}")
+  ```
+
+- Import it in [trpc_main.py](./examples/trpc_main.py):
+
+  ```python
+  import http_websocket_service as _
+  ```
+
+- Client check:
+
+  ```sh
+  python3 examples/client/test_websocket_client.py
+  ```
+
+#### Static files
+
+See [static_http_service](./examples/normal_http/_static_http_service.py).
+
+- Install
+
+  Static pages may need template rendering. This install is the one to use:
+
+  ```sh
+  pip install -e ".[static]"
+  ```
+
+- Register the static directory
+
+  ```python
+  from trpc_fastapi import fastapi_register_static
+  # Directory of static files.
+  static_dir = Path(__file__).parent / "static"
+  # Files used by template rendering.
+  templates_dir = Path(__file__).parent / "templates"
+
+  fastapi_register_static("/static", static_dir)
+  ```
+
+- Register the static route
+
+  ```python
+  from trpc_fastapi import fastapi_register_get, trpc_fastapi_version, get_fastapi_app
+
+  @fastapi_register_get("/", route_params={'response_class': HTMLResponse})
+  async def static_page(request: Request):
+      """Root path. Returns an HTML page."""
+      return templates.TemplateResponse(
+          request,
+          "static_page.html", {
+              "trpc_fastapi_version": trpc_fastapi_version,
+              "fastapi_version": fastapi_version,
+              "endpoints": get_all_endpoints()
+          })
+  ```
+
+  Call `get_fastapi_app()` inside an `async def` route. FastAPI runs synchronous routes in a thread pool, where the app bound to the current uvicorn thread is not available.
+
+- In a browser: http://{IP}:{Port}/ (`IP` and `Port` come from the config file. If the address is `0.0.0.0`, use the IP of your environment.)
+
+### Development setup
+
+```bash
+# After cloning, enter the project directory and install dev dependencies.
+pip install -e ".[all]"
+
+# Run tests
+pytest tests
+
+# Format the code
+./format.sh
+```
+
+### Commit conventions
+
+- `feat:` for a new feature
+- `fix:` for a bug fix
+- `docs:` for a documentation update
+
+## License
+
+This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file.

trpc_fastapi_python-1.0.0.dist-info/RECORD

@@ -0,0 +1,4 @@
+trpc_fastapi_python-1.0.0.dist-info/METADATA,sha256=K1RgjCaRDj2r8xuTr1HurE14xuUL7qBw5avB6AfEOuc,12033
+trpc_fastapi_python-1.0.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+trpc_fastapi_python-1.0.0.dist-info/licenses/LICENSE,sha256=dhB8P1NUrgbnyDHwVNZ8yEY8jtXD45Ywxg9APQ8kbTk,11624
+trpc_fastapi_python-1.0.0.dist-info/RECORD,,

trpc_fastapi_python-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

trpc_fastapi_python-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,210 @@
+Tencent is pleased to support the open source community by making tRPC-FastAPI-Python available. 
+
+Copyright (C) 2026 Tencent.  All rights reserved. 
+
+tRPC-FastAPI-Python is licensed under the Apache-2.0.
+
+
+Terms of the Apache-2.0:
+--------------------------------------------------------------------
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.