带描述的自枚举工具类
用于需要同时提供枚举数值和枚举描述,又要求枚举项命名高可读性的场合, 例如常见的错误类型,错误码和错误描述, 又或是状态名称, 状态值和状态描述等应用场景, 其枚举项如下:
| 枚举项 | ClientSideError.NotFound | |
|---|---|---|
| 枚举值 | ClientSideError.NotFound.value | 404 |
| 枚举描述 | ClientSideError.NotFound.doc | 资源找不到 |
继承该类时可以指定如下属性:
| 属性名称 | 作用 | 默认值 |
|---|---|---|
| initial_number | 枚举值的初始值 | 0 |
| dict_name | 枚举项名称对应的键名 | 'name' |
| dict_value | 枚举值对应的键名 | 'value' |
| dict_doc | 枚举描述对应的键名 | 'doc' |
##使用方法
可参考smaple.py中的代码，这段代码展示了如何使用此工具类方便生成错误码，对于API设计便捷了不少。