Skip to content

Commit 45cfa43

Browse files
cofinclaude
andcommitted
feat(v3)\!: Complete removal of deprecated litestar.contrib.sqlalchemy
This PR completes the deprecation and migration of SQLAlchemy functionality from `litestar.contrib.sqlalchemy` to `litestar.plugins.sqlalchemy`. BREAKING CHANGE: `litestar.contrib.sqlalchemy` module has been completely removed. All imports must now use `litestar.plugins.sqlalchemy`. Changes: - Removed entire `litestar/contrib/sqlalchemy/` directory tree - Updated all documentation examples to use new import paths - Updated all tests to use new import paths - Created proper submodule structure in `litestar/plugins/sqlalchemy/` with direct re-exports from `advanced_alchemy` - Fixed type hint preservation for re-exported modules - All functionality remains available through the new import structure Migration: - `from litestar.contrib.sqlalchemy import X` → `from litestar.plugins.sqlalchemy import X` - `from litestar.contrib.sqlalchemy.plugins import Y` → `from litestar.plugins.sqlalchemy import Y` Related PRs: - litestar-org#4069 - Initial attempt by @provinzkraut - litestar-org#4163 - Second attempt by @cofin - litestar-org#3755 - Original deprecation PR Closes litestar-org#4069 Closes litestar-org#4163 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent ebdce16 commit 45cfa43

File tree

78 files changed

+470
-1659
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+470
-1659
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,6 @@ __pypackages__/
4848
certs/
4949
pdm.toml
5050
.zed
51+
CLAUDE.md
52+
CLAUDE.*.md
53+
todos/

docs/conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@
147147
(PY_CLASS, "NoneType"),
148148
(PY_CLASS, "litestar._openapi.schema_generation.schema.SchemaCreator"),
149149
(PY_CLASS, "litestar._signature.model.SignatureModel"),
150-
(PY_CLASS, "litestar.contrib.sqlalchemy.plugins.init.config.compat._CreateEngineMixin"),
150+
(PY_CLASS, "litestar.plugins.sqlalchemy.plugins.init.config.compat._CreateEngineMixin"),
151151
(PY_CLASS, "litestar.utils.signature.ParsedSignature"),
152152
(PY_CLASS, "litestar.utils.sync.AsyncCallable"),
153153
# types in changelog that no longer exist
@@ -167,12 +167,12 @@
167167
(PY_CLASS, "litestar.response.RedirectResponse"),
168168
(PY_CLASS, "litestar.response_containers.Redirect"),
169169
(PY_CLASS, "litestar.response_containers.Template"),
170-
(PY_CLASS, "litestar.contrib.sqlalchemy.plugins.SQLAlchemyPlugin"),
171-
(PY_CLASS, "litestar.contrib.sqlalchemy.plugins.SQLAlchemySerializationPlugin"),
172-
(PY_CLASS, "litestar.contrib.sqlalchemy.plugins.SQLAlchemyInitPlugin"),
173-
(PY_CLASS, "litestar.contrib.sqlalchemy.dto.SQLAlchemyDTO"),
174-
(PY_CLASS, "litestar.contrib.sqlalchemy.types.BigIntIdentity"),
175-
(PY_CLASS, "litestar.contrib.sqlalchemy.types.JsonB"),
170+
(PY_CLASS, "litestar.plugins.sqlalchemy.SQLAlchemyPlugin"),
171+
(PY_CLASS, "litestar.plugins.sqlalchemy.SQLAlchemySerializationPlugin"),
172+
(PY_CLASS, "litestar.plugins.sqlalchemy.SQLAlchemyInitPlugin"),
173+
(PY_CLASS, "litestar.plugins.sqlalchemy.dto.SQLAlchemyDTO"),
174+
(PY_CLASS, "litestar.plugins.sqlalchemy.types.BigIntIdentity"),
175+
(PY_CLASS, "litestar.plugins.sqlalchemy.types.JsonB"),
176176
(PY_CLASS, "litestar.contrib.htmx.request.HTMXRequest"),
177177
(PY_CLASS, "litestar.typing.ParsedType"),
178178
(PY_METH, "litestar.dto.factory.DTOData.create_instance"),
@@ -220,7 +220,7 @@
220220
(PY_RE, r".*UserType"),
221221
(PY_RE, r"ModelT"),
222222
(PY_RE, r"litestar.*\.T"),
223-
(PY_RE, r"litestar.contrib.sqlalchemy.repository.ModelT"),
223+
(PY_RE, r"litestar.plugins.sqlalchemy.repository.ModelT"),
224224
(PY_RE, r"litestar\.middleware\.session\.base\.BaseSessionBackendT"),
225225
(PY_RE, r"litestar\.types.*"),
226226
(PY_RE, r"httpx.*"),
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)