readthedocs/readthedocs.org

Use a named tuple for tags and branches data

Open

#7,798 创建于 2021年1月5日

在 GitHub 查看
 (5 评论) (1 反应) (0 负责人)Python (7,765 star) (3,748 fork)batch import
AcceptedGood First IssueImprovement

描述

We are passing a list of dictionaries with verbose_name and identifier, we should use a data structure for this instead to avoid bugs. We need to make sure that celery can serialize named tuples.

ref https://github.com/readthedocs/readthedocs.org/pull/7548#discussion_r542636920

贡献者指南

技术栈
python
领域
backend
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
pythonnamedtupleceleryserialization
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
55
研究方向
Examine the code referenced in PR #7548 discussion (https://github.com/readthedocs/readthedocs.org/pull/7548#discussion r542636920) to understand the current implementation using list of dictionaries. Look for places where tags and branches data is passed. Create a named tuple class with fields 'verbose name' and 'identifier', and replace all usages. Ensure Celery tasks that use this data can serialize the named tuple, possibly by registering a custom serializer or using a compatible type. Verify no regressions in tests.