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.