# ireturn

**Repository Path**: aidings/ireturn

## Basic Information

- **Project Name**: ireturn
- **Description**: 返回一个结果的结构体{"code": 200, "msg": "返回成功", "res" : {}}
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-06
- **Last Updated**: 2022-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ireturn

> 一个规范化统一接口的类


#### 安装
1. 最新版使用 `pip install git+https://gitee.com/cvding/ireturn.git`
2. 稳定版请前往这里[发行版本](https://gitee.com/cvding/ireturn.git)


#### 使用
```python
from ireturn import Returns

r = Retruns(project='ptsd', csv_def=None) # or csv_def: ./doc/PTSD.help.csv

r.bind(code=200, msg='success')             # r[200] = 'success'
r.bind(code=401, msg='failed to decode')    # r[401] = 'failed to decode'

r.doc("./doc") # save into ./doc/PTSD.help.csv
# code, msg
# 0, PTSD:success
# 200, PTSD:success
# 401, PTSD:failed to decode

res = r.warp(code=0, ret={"name": "zhifeng", "age": 10})

print(res)
# {'code': 0, 'res': {'name': "zhifeng", "age": 10}, 'msg': 'PTSD:success'}
```