readthedocs/readthedocs.org

Use a named tuple for tags and branches data

Open

#7,798 opened on Jan 5, 2021

View on GitHub
 (5 comments) (1 reaction) (0 assignees)Python (7,765 stars) (3,748 forks)batch import
AcceptedGood First IssueImprovement

Description

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

Contributor guide

Tech stack
python
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
pythonnamedtupleceleryserialization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
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.
Use a named tuple for tags and branches data · readthedocs/readthedocs.org#7798 | Good First Issue