litestar-org/litestar

Remove `litestar.contrib` namespace

Open

#4301 opened on Sep 22, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (8,243 stars) (550 forks)user submission
3.xGood First IssueRefactor

Description

The litestar.contrib module has been deprecated and will be removed in version 3, the functionality has been moved to litestar.plugins. All litestar.contrib submodules need to be removed. This is going to happen in individual PRs, and I've created a corresponding sub-issue down below.

  • Delete the litestar.contrib.<namespace> module
  • Remove tests for the deprecation warnings for importing litestar.contrib.<namespace>
  • If there is documentation in docs/usage referencing the removed module, update it to the new litestar.plugins.<namespace> references
  • If there is a file docs/reference/contrib/<namespace.rst>, delete it. If no corresponding file in docs/reference/plugins/<namespace>.rst exists, move the file there instead of deleting it
  • Add an entry in docs/release-notes/changelog.rst (use the outline below)
  • Create a PR with an appropriate title and breaking (!) indicator, e.g. feat(jwt)!: remove depreacated 'litestar.contrib.jwt' module

Changelog entry template:

.. change:: Remove deprecated ``litestar.contrib.<namespace>`` module
    :type: feature
    :breaking:
    :pr: <pr number>
    :issue: <issue number>
    
    Remove the deprecated ``litestar.contrib.<namespace>`` module. Code still using imports 
    from this module should switch to using ``litestar.plugins.<namespace>``.

    .. place special migration instructions / considerations here if necessary

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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythongitlitestar basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue provides a step by step checklist for removing a deprecated 'litestar.contrib' submodule. The contributor should first identify which submodule to remove (the issue mentions a sub issue for specific namespaces). Then, follow the steps: delete the contrib submodule, remove deprecation warning tests, update documentation in 'docs/usage' and 'docs/reference' accordingly, add a changelog entry in 'docs/release notes/changelog.rst', and create a PR with a breaking change indication. No linked PRs or comments yet, so the contributor can start fresh by selecting a submodule that hasn't been removed and following the template.