Pre-release
This release is a pre-release and may not be stable for production use.
rb_schemas 사용 설명서
rb_schemas는 프로젝트 공통 Pydantic 스키마와 Flow Manager 연동 타입을 제공하는 패키지입니다.
1. 제공 구성
- 기본 스키마 (
base.py)Response_ReturnValuePDNJointfPD,NInputfPD,Vec3fPD등 공용 모델
- Flow Manager 연계 타입 (
sdk.py)FlowManagerArgs
- 스키마 유틸 (
utility.py)Pick(base, *include)Omit(base, *omit)
- FBS 기반 자동 생성 모델
rb_schemas.fbs_models.*- 클래스명은
...PD접미사 규칙
2. FlowManagerArgs 용도
FlowManagerArgs는 SDK 함수에서 Flow Manager 실행 컨텍스트를 받을 때 사용합니다.
from rb_schemas.sdk import FlowManagerArgs
def my_step_handler(flow_manager_args: FlowManagerArgs | None = None):
# step 로직 수행
if flow_manager_args is not None:
flow_manager_args.done()
3. Pick/Omit 사용 예제
from pydantic import BaseModel
from rb_schemas.utility import Omit, Pick
class UserPD(BaseModel):
user_id: str
email: str
password: str
UserPublicPD = Omit(UserPD, "password")
UserOnlyIdPD = Pick(UserPD, "user_id")
4. FBS 모델 사용 예제
# 예: 자동 생성된 모델 import
from rb_schemas.fbs_models.nexus.v1.deploy_models import Response_Deploy_ProgressPD
payload = Response_Deploy_ProgressPD(
sw_name="example",
ip="127.0.0.1",
mode="dev",
tag="v1",
percentage=80,
service_name="manipulate",
result="success",
)
5. 참고
- FBS 기반 모델은
backend.flatc실행 시 자동 재생성됩니다. - 생성 모델은 snake_case 필드와 alias(원본 CamelCase)를 함께 가질 수 있습니다.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rainbow_rb_schemas-0.1.2.dev1.tar.gz.
File metadata
- Download URL: rainbow_rb_schemas-0.1.2.dev1.tar.gz
- Upload date:
- Size: 51.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07760b4057e47683e7782818e4ec26d0d4c22bc4351a501f275d53956ab06976
|
|
| MD5 |
fa27939cf6f07364004e726ee21add87
|
|
| BLAKE2b-256 |
02e47048dca3ad5f12c2b16b49e31f7bc5ff277fcf62b0edc3b8106c54a932c0
|
File details
Details for the file rainbow_rb_schemas-0.1.2.dev1-py3-none-any.whl.
File metadata
- Download URL: rainbow_rb_schemas-0.1.2.dev1-py3-none-any.whl
- Upload date:
- Size: 88.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39ec39918034d6a257b87f8a7e80f6f6cfa0b07dd16e6baa10dedf835c02d2f8
|
|
| MD5 |
affaa2db20694f26d2432716a2c1713c
|
|
| BLAKE2b-256 |
9c02acbdd39bdc422ee59acd305ca47ffcccfa859d8f354da293dc1da5c2cb31
|
