readthedocs/readthedocs.org

Use a named tuple for tags and branches data

Open

#7,798 opened on 2021年1月5日

GitHub で見る
 (5 comments) (1 reaction) (0 assignees)Python (7,765 stars) (3,748 forks)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
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.