litestar-org/litestar

Remove `litestar.contrib` namespace

开放

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

 (0 条评论) (0 个反应) (0 位负责人)Python (550 个派生)user submission
3.xGood First IssueRefactor

仓库指标

星标
 (8,243 个星标)
PR 合并指标
 (平均合并 13小时 27分钟) (30 天内合并 26 个 PR)

描述

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

贡献者指南