openedx / openedx/openedx-platform

Continuously bump django-stubs and djangorestframework-stubs

Open
#35,275 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.2k
Forks
4.4k
Avg merge
6d 18h
Merged PRs (30d)
42

Description

Updated issue

( Updated Dec 2024 by @kdmccormick )

To maximize the stability and usefulness of our typechecking, we should always be constraining django-stubs to a version which is compatible with whatever our django and mypy version is. Generally, for django-stubs, that will be the latest patch release of the same major version as django or one major version greater.

Also djangorestframework-stubs may or may not need to be constrained.

There unfortunately isn't an easy way to bump those constraints automatically, so we'll leave this GitHub issue open indefinitely.

Original issue

( Created Aug 2024 by @huniafatima-arbi )

The version of django-stubs we can use depends on which Django release we're using 1.16.0 works with Django 3.2 through 4.1. Once django is updated we can remove this constraint

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a file or test. Start by locating the project’s Django and mypy dependency constraints, then read the linked django-stubs compatibility guidance. Update the constraints to match the supported Django version and verify the dependency set remains compatible.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.