ossapi项目中的friends方法返回空用户问题解析

ossapi项目中的friends方法返回空用户问题解析

在Python的osu! API封装库ossapi中，开发者可能会遇到一个关于获取好友列表的典型问题：当调用api.friends()方法时，返回的用户列表虽然长度正确，但所有用户对象的关键字段均为空值。本文将深入分析这一现象的技术背景和解决方案。

问题现象

当开发者使用ossapi的friends方法时，常见以下两种异常情况：

1. 直接调用api.friends()返回的UserCompact对象列表虽然长度正确，但所有用户对象的属性（如last_visit、profile_colour等）均为None
2. 通过api.get_me().friends获取好友列表时同样返回None

值得注意的是，开发者已经正确配置了必要的API权限范围（Scope），包括PUBLIC、IDENTIFY和FRIENDS_READ。

技术背景

这个问题本质上源于osu! API的版本兼容性问题。在API版本20241022及更高版本中，osu!官方修改了friends接口的返回数据结构：

• 旧版本（<20241022）：返回UserCompact对象列表
• 新版本（≥20241022）：返回UserRelation对象列表

由于ossapi默认使用的API版本（20241024）属于新版本范畴，而代码中可能仍按旧版本的数据结构处理，因此导致了字段解析失败的情况。

解决方案

目前有两种可行的解决途径：

1. 版本回退法：在初始化ossapi客户端时，显式指定使用旧版API（20241021或更早版本）。这种方法简单直接，但可能无法使用API的新特性。

2. 代码适配法：等待ossapi库更新以支持新版UserRelation数据结构。实际上，项目维护者已经通过提交37b2a3a修复了此问题，建议开发者更新到最新版本的ossapi。

最佳实践建议

对于类似API版本兼容性问题，建议开发者：

1. 仔细查阅osu! API的版本变更日志，了解各版本间的接口差异
2. 在项目初始化时明确指定API版本，避免使用默认值带来的不确定性
3. 对于关键功能，实现版本检测和兼容处理逻辑
4. 保持依赖库的及时更新，以获取最新的兼容性修复

通过理解这一问题的本质，开发者可以更好地处理其他类似的API兼容性问题，提升项目的稳定性和可维护性。