litestar-org/litestar

Remove `litestar.contrib` namespace

Open

#4,301 创建于 2025年9月22日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (8,243 star) (550 fork)user submission
3.xGood First IssueRefactor

描述

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

贡献者指南

技术栈
python
领域
backend
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Pythongitlitestar basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.