Jkit

**这是一个 Alpha 版本，可能随时进行重大变更。**

功能变动：

- 避免不必要的验证流程
- 移除主包导出
- 添加自定义数据校验异常
- 部分 user_info -> author_info
- DataObject -> ResourceObject 转换方法更名

CI / CD：

- 发布新版本前运行静态检查
- 优化自动版本发布逻辑

**这是一个 Alpha 版本，可能随时进行重大变更。**

功能变动：

- 支持获取专题信息
- 支持获取用户简书钻、简书贝和总资产数据
- 修改部分参数为强制关键字参数
- 部分资源对象支持校验
- 添加版本号变量
- 更新部分 API 文档
- 网络请求模块更名

错误修复：

- 修复错误的 PyPI classifier

**这是一个 Alpha 版本，可能随时进行重大变更。**

JRT 已更名为 JKit，这是 v3 的首个开发者预览版。

bash
pip install jkit --pre


该版本并未包含全部功能，目前支持的功能：

- 配置修改
- 标识符校验与转换
- 文章收益排行榜、作者收益排行榜、资产排行榜数据获取
- 用户、文章部分数据获取

同时，我们整理了简书部分 API 的文档，可使用 [Bruno](https://github.com/usebruno/bruno) 打开 `jianshu_apis` 目录查看并测试。

我们将持续为 JKit v3 添加新功能，并发布后续的 Alpha 版本供开发者评估。

功能变动：

- **贝壳小岛已于 2022 年 9 月 30 日关闭，该版本移除了贝壳小岛数据获取模块（`beikeisland`）**
- **现在 TCP 连接将被自动复用，以提升批量请求时的性能**
- **现在所有请求将使用 HTTP/2 协议发送，以提升批量请求时的性能**
- 全部时间相关数据现在均不再包含时区信息，您可在升级后从代码中安全移除 `.replace(tzinfo=None)` 语句
- 原始 API 封装优化
- 使用 `Ruff` 优化代码风格
- 使用 `Pyright` 增强类型安全
- 格式化代码
- 修改贡献指南中过时的示例
- 修改开源许可证年份

错误修复：

- 修复失败的测试用例
- 修复总资产排行榜将总资产数据作为简书钻数据返回的问题
- `GetAssetsRankData` 函数的返回数据中新增 `assets` 字段
- 为保证向后兼容，`FP` 字段在 v2 中暂不移除，其值与 `assets` 字段相同。
- 若 `GetAssetsRankData` 函数的 `get_full` 参数为 True，将获取真实的简书钻数据，并替换兼容用途的 FP 字段，简书贝（FTN）字段也将正确计算。
- 修复用户时间线信息解析错误
- **[不兼容更改] `GetUserTimelineInfo` 函数中 `operation_type` 参数的可能取值 `comment_note`（评论文章）现已变更为 `comment_article`**

依赖变动：

- **迁移到 Poetry**
- 新增依赖 `h2`
- 新增开发依赖 `ruff`、`pyright`、`black`
- 移除开发依赖 `flake8`、`mypy`、`yapf`

错误修复：

- 修复 objects 模块中部分函数不可用的问题
- 修复贝壳小岛接口变动导致获取交易单失败的问题

代码规范：

- 修复一些注释与代码不匹配的问题，删减非必要的括号

依赖变动：

- 不再限定开发依赖版本，同时在开发依赖中加入代码格式化工具 yapf

功能变动：

- 现在，对象在初始化时会对其有效性进行检查，并在检查不通过时抛出 `InputError`（链接格式不合法）或 `ResourceError`（资源状态异常），因此对象的创建时间成本提高，目前不支持手动禁用检查
- 在 `objects` 模块中新增函数 `get_cache_items_count`、`get_cache_status`、`set_cache_status` 和 `clear_cache`，用于对 `objects` 模块的全局缓存进行操作
- `objects` 模块中的 `DISABLE_CACHE` 常量被重命名为 `_DISABLE_CACHE`，请使用 `objects.get_cache_status` 函数获取缓存状态，`objects.set_cache_status` 设置缓存状态
- `objects` 模块中的每个对象都新增了 `from_url` 和 `from_slug` 类方法，用于以特定方式构建资源对象
- 优化了错误信息展示，现在大部分错误信息都会包含引起错误的资源 URL
- 现在，`assets_funcs.py` 中所有关于链接有效性判断的函数均变为基于正则进行判断
- 为所有模块加入 `__all__` 变量，使用 `from JianshuResearchTools.module_name import *` 导入时，不再会导入无关的函数
- 支持使用 `objects.Article.markdown` 获取 Markdown 格式的文章内容
- 优化对象初始化逻辑
- 内部模块 `headers` 中的变量 `jianshu_request_header` 更名为 `api_request_header`

错误修复：

- 修复面向对象模块中缓存逻辑错误导致缓存跨对象生效的问题
- 修复部分函数因参数顺序错误导致在某些情况下报错的问题
- 修复测试用例中的 Type Hints 错误

性能优化：

- 通过对正则表达式的优化，提升了 `article.GetArticleHtml` 函数的性能

代码重构：

- 新增内部模块 `utils`，包含供包内共享的工具函数
- 将面向对象模块中 `__str__` 字符串的生成逻辑抽象成单独函数 `utils.NameValueMappingToString`
- 将 `objects` 模块中禁用检查调用函数的逻辑抽象成单独的函数 `utils.CallWithoutCheck`
- 将对象初始化时判断传入参数是否合法的逻辑抽象成单独的函数 `utils.OnlyOne`

文档更改：

- 更新 `README.md` 中的部分代码示例
- 为 `objects.Article` 类中关于获取文章内容的属性加入了风险提示
- 规范了代码注释中 `URL` 的写法，为保证兼容性，函数名将延迟到下一个大版本中进行修改
- 为 `utils.NameValueMappingToString` 函数加入了注释

依赖变动：

- 更新 `usjon` 到 v5.3.0 以修复 CVE-2021-45958 漏洞
- 在 `Pipfile` 中加入缺失的开发依赖 `pyyaml==6.0.0`
- 为避免依赖版本问题导致的异常，我们固定了 `Pipfile` 和 `setup.py` 文件中所有依赖库的版本

测试用例：

- 更新部分测试用例
- 移除已废弃函数的测试代码