Django友好型有限状态机支持技术文档

1. 安装指南

在开始使用viewflow.fsm之前，请确保您的环境中已安装了Django。以下为安装viewflow.fsm的步骤：

1. 使用pip进行安装：

   pip install viewflow.fsm
   

2. 确认安装成功：

   python -c "import viewflow.fsm; print(viewflow.fsm.__version__)"
   

   如果没有错误信息，并显示了版本号，则表示安装成功。

2. 项目的使用说明

viewflow.fsm是一个有限状态机（FSM）工作流的支持库，用于在Django项目中以声明式方式描述操作流程。

以下是一个简单的使用示例：

首先，定义一个枚举类来表示状态：

from enum import Enum

class Stage(Enum):
    NEW = 1
    DONE = 2
    HIDDEN = 3

接着，创建一个工作流类，并使用State类来定义状态：

from viewflow.fsm import State

class MyFlow(object):
    state = State(Stage, default=Stage.NEW)

    @state.transition(source=Stage.NEW, target=Stage.DONE)
    def complete(self):
        pass

    @state.transition(source=State.ANY, target=Stage.HIDDEN)
    def hide(self):
        pass

然后，实例化工作流类并使用它：

flow = MyFlow()
assert flow.state == Stage.NEW

# 尝试直接修改状态将引发错误
try:
    flow.state = Stage.DONE
except AttributeError:
    pass

# 正确的转换状态方法
flow.complete()
assert flow.state == Stage.DONE

# 重复尝试相同的状态转换将引发异常
try:
    flow.complete()
except TransitionNotAllowed:
    pass

3. 项目API使用文档

viewflow.fsm的API主要包括以下几个部分：

• State: 用于定义状态机的状态。
• transition: 装饰器，用于定义状态间的转换规则。

以下是一些核心类的简要说明：

• State: 必须与Python的枚举类或Django的枚举字段一起使用。状态值一旦设定，不能通过简单赋值改变。
• transition: 用于指定状态的转换。可以指定源状态(source)和目标状态(target)，以及触发转换的方法。

4. 项目安装方式

项目的安装方式已在“安装指南”部分进行了说明。简要概括如下：

• 使用pip安装viewflow.fsm包。
• 验证安装是否成功。

请确保按照上述步骤操作，以确保viewflow.fsm能够在您的Django项目中正常运行。