Bunch 项目技术文档

1. 安装指南

安装环境要求

• Python 3.x
• 可选依赖：PyYAML（用于 YAML 序列化）

安装步骤

1. 使用 pip 安装 Bunch 库：

   pip install bunch
   

2. 如果需要 YAML 支持，请安装 PyYAML：

   pip install pyyaml
   

2. 项目的使用说明

基本用法

Bunch 是一个支持属性风格访问的字典，类似于 JavaScript 中的对象。以下是一些基本用法示例：

from bunch import Bunch

# 创建一个 Bunch 对象
b = Bunch()

# 设置属性
b.hello = 'world'
print(b.hello)  # 输出: world

# 使用字典方式访问和修改
b['hello'] += "!"
print(b.hello)  # 输出: world!

# 嵌套 Bunch
b.foo = Bunch(lol=True)
print(b.foo.lol)  # 输出: True

字典方法

Bunch 是 dict 的子类，因此支持所有字典的方法，例如 keys()、update() 等：

# 获取所有键
print(b.keys())  # 输出: dict_keys(['foo', 'hello'])

# 更新 Bunch
b.update({'ponies': 'are pretty!'}, hello=42)
print(b)  # 输出: Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')

序列化

Bunch 支持 JSON 和 YAML 序列化：

import json

# JSON 序列化
json_str = json.dumps(b)
print(json_str)  # 输出: {"ponies": "are pretty!", "foo": {"lol": true}, "hello": 42}

# YAML 序列化（需要 PyYAML）
import yaml

yaml_str = yaml.dump(b)
print(yaml_str)  # 输出: !bunch.Bunch\nfoo: !bunch.Bunch {lol: true}\nhello: 42\nponies: are pretty!\n

3. 项目API使用文档

Bunch 类

• Bunch(): 创建一个 Bunch 对象。
• Bunch.toJSON(): 将 Bunch 对象转换为 JSON 字符串。
• Bunch.toYAML(): 将 Bunch 对象转换为 YAML 字符串。
• Bunch.fromDict(dict): 从普通字典创建 Bunch 对象。
• Bunch.toDict(): 将 Bunch 对象转换为普通字典。

辅助函数

• bunchify(obj): 将普通字典转换为 Bunch 对象。
• unbunchify(obj): 将 Bunch 对象转换为普通字典。

4. 项目安装方式

使用 pip 安装

pip install bunch

源码安装

1. 克隆项目仓库：

   git clone https://github.com/dsc/bunch.git
   

2. 进入项目目录并安装：

   cd bunch
   python setup.py install
   

通过以上步骤，您可以成功安装并使用 Bunch 项目。