# rivulet

**Repository Path**: estiag/rivulet

## Basic Information

- **Project Name**: rivulet
- **Description**: 链式Http请求处理工具，基于requests但比requests更方便
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-12
- **Last Updated**: 2025-12-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 介绍

这是一个Http请求处理模块，支持链式请求发送，方便的处理http请求。

## 使用

### 基本请求发送

```python
# 请求一个地址
Api('https://www.baidu.com').send()
# url参数
Api('https://www.baidu.com').query({'key': 'val'}).send()
# 修改请求方法
Api('https://www.baidu.com').method('post').send()
# 修改请求体
Api('https://www.baidu.com').body({'key': 'val'}).method('post').send()
# 打印响应
Api('https://www.baidu.com').send_and_print()
```

### 设置环境参数

在测试Api场景下需要对多个不同环境发送相同的请求，这时可以使用Env定义不同的服务器

```python
# 定义环境
env_dev = Env(host='192.168.0.2', port=8080, protocol='http')
env_production = Env(host='192.168.0.3', port=443, protocol='https')
# 发送请求
Api(env_dev).path('/login').body({'username': 'xx'}).send()
```

### 链式请求发送

一些请求有先后顺序和依赖关系，例如OAUTH流程或解析某页面中的媒体元素然后下载。链式请求可以让这种
逻辑组织在一起，一个请求的参数可能要依赖上一个请求的结果

```python
# 编写API对象
def baidu_callback(resp, api_result):
    print(
        f'this http resp is {resp}, prev http res is {api_result.get_resp()}, callback result is {api_result.get_callback_result()}')
    return {'baidu': 'baidu result'}


def souhu_callback(resp, api_result):
    print(
        f'this http resp is {resp}, http res is {api_result.get_resp()}, callback result is {api_result.get_callback_result()}')
    return {'souhu': 'souhu result'}


baidu_api = Api('http://www.baidu.com').callback(baidu_callback)
souhu_api = Api('https://www.sohu.com/').callback(souhu_callback)
# 组织发送顺序
baidu_api.then(souhu_api).send()
```
### 请求组
有可能一个请求依赖一个以上的前置请求的结果，这时可以使用请求组
```python
# 假设api_a、api_b、api_c、api_d分别是创建好的Api对象，api_b、api_c的callback函数会
# 收到来自api_a的结果，api_d会收到来自api_b, api_c的合并结果
api_a.then([api_b, api_c]).then(api_d).send()
```
### 返回结果

发送类函数(包括send / get / post / send_and_print / send_and_get_json)的返回结果是一个ApiResult对象，包含两部分，
Response对象和Callback结果对象

### API文档
[api.api.html](api.api.html)