diff --git a/docs/changelog.md b/docs/changelog.md index 06b76fa..8da96ea 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,7 @@ - 新增创建农历年最后一天的方法 `LunarDate.last_day_of_year` - `SolarFestival` 和`LunarFestival` 初始化函数 `freq` 参数支持字符串设置( [ #56](https://github.com/kinegratii/borax/issues/56) ) - `Period.solar_year` 和 `Period.lunar_year` 新增 `end_year` 参数,支持跨年份计算 +- 废弃模块:`borax.choices` ## v4.1.0 (20240131) diff --git a/docs/guides/choices.md b/docs/guides/choices.md index 770c1a6..cf868f6 100644 --- a/docs/guides/choices.md +++ b/docs/guides/choices.md @@ -2,7 +2,11 @@ > 模块: `borax.choices` -> Update in v3.4.0 +> Changed in v3.4.0 :适配 Django choices + +## 重要信息 + +从 Borax 4.1.0 开始,本模块被标记为 废弃 状态,推荐使用标准的 Django Choices 。关于如何迁移参考下列文档。 ## 开发背景 @@ -85,14 +89,14 @@ class YearInSchoolChoices(choices.ConstChoices): 可以直接使用 `YearInShoolChoices.FRESHMAN` 访问该选项具体的值。 - ```bash - >>> YearInShoolChoices.FRESHMAN +```bash +>>> YearInShoolChoices.FRESHMAN 'FR' >>> YearInShoolChoices.is_valid('SR') True >>> YearInShoolChoices.is_valid('Et') False - ``` +``` ## 选项(Item) ### 显式Item定义 @@ -209,7 +213,7 @@ class DirectionChoices(VerticalChoices): -## 关于Django.Choices +## 与Django.Choices ### 概述 @@ -234,12 +238,12 @@ from django.db import models from borax import choices -class MyChoices(models.TextChoices): +class MyChoices(models.TextChoices): # Django choices style GREEN = 'g', 'green' RED = 'r', 'red' YELLOW = 'y', 'yellow' -class MyChoices(choices.Choices): +class MyChoices(choices.Choices): # Borax choices style GREEN = 'g', 'green' RED = 'r', 'red' YELLOW = 'y', 'yellow' @@ -248,19 +252,23 @@ class MyChoices(choices.Choices): 表 Borax.Choices *VS* Django.Choices -| | Borax.Choices | Django.Choices | 备注 | -| --------------------------- | ------------- | ------------------ | ---- | -| MyChoices.choices | `(...)` | `(...)` | | -| MyChoices.GREEN | `'g'` | `` | | -| MyChoices['GREEN'] | - | `` | | -| MyChoices.is_valid('g') | True | - | | -| MyChoices.GREEN.name | - | `'g'` | | -| MyChoices.GREEN.label | - | `'green'` | | -| MyChoices.GREEN.value | - | - | | -| MyChoices.GREEN.display | - | - | | -| MyChoices.get_value_display | `