Entry point for DefaultImpl subclasses? (or, just use plugins?)

Đang mở
  • Có gì không ổn?
#1,874 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

@dwreeves đang làm issue này rồi.

Từ ngày 4/10/2026.

  • #1875 của @dwreeves — đang mở

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python, sqlalchemy
Lĩnh vực
tooling

Hướng nghiên cứu

Review Alembic's existing plugin ecosystem and the linked pull request #1875, then compare that approach with the proposed alembic.implementations entry point. Done means the project has a clear decision on registration order and whether the existing plugin pattern should be documented or a new entry point supported.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

code review in progress migration environment use case
Discussed in https://github.com/sqlalchemy/alembic/discussions/1872

Originally posted by dwreeves September 30, 2026
Hello,

I could not find any discussion on this elsewhere.

I'm wondering if it would make sense for Alembic to support entry-points for Defaultmpl subclasses.

Right now, it looks like the pattern some third-party providers use (e.g. sqlalchemy-redshift) is to load the impl as a side-effect of importing the SqlAlchemy dialect module entry-point.

There are two advantages of an entry-point. The first would be not needing to import Alembic or register anything during the normal runtime of the application. Not usually a big deal to have Alembic in the sys modules, but could be nice-to-have for custom dialects.

The second is a little more subtle, but the entry-point invocation could control the order of registration of dialects, so that the env.py's dialect is guaranteed to resolve last.

The second is actually relevant to a PR I have open for snowflake-sqlalchemy: right now there is no guarantee of whether the library provided SnowflakeImpl will resolve before or after a user's custom implementation; it's totally dependent on the env.py's imports. If entry-points are respected however, then Alembic can always resolve entry-points before env.py runs, guaranteeing user-generated DefaultImpls are resolved last. https://github.com/snowflakedb/snowflake-sqlalchemy/issues/758

So e.g. I have a SQLAlchemy driver for MyCoolSqlDatabase, I could structure like this:

pyproject.toml
src/
  mycoolsqldatabase_sqlalchemy/
    __init__.py
    dialect.py
    alembic.py

# pyproject.toml
[project.entry-points."sqlalchemy.dialects"]
mycoolsqldatabase = "mycoolsqldatabase_sqlalchemy:dialect"

[project.entry-points."alembic.implementations"]
mycoolsqldatabase = "mycoolsqldatabase_sqlalchemy:alembic"  # alternatively mycoolsqldatabase_sqlalchemy.alembic:MyCoolSqlDatabaseImpl

An argument against this--

I am aware that Alembic uses entry-points for plugins.

Perhaps the pattern you might suggest is to create a plugin with an empty setup() that registers the Alembic impl as a side-effect? E.g.

# plugin.py
from alembic.ddl.impl import DefaultImpl

class MyCoolSqlDatabaseImpl(DefaultImpl):
    __dialect__ = "my_cool_sql_database"

def setup(plugin):
    pass

If so, it may make sense to show that as an example in the documentation. If that is guaranteed to resolve before env.py, then that could also work as a path for the aforementioned PR.

I think the upside to using the existing plugin ecosystem is that it reduces the API surface on Alembic's end, but the downside is this is very cheeky and not intuitive, especially without a documented example.

Lastly, thanks for the awesome ecosystem, zzzeeek.

Ngôn ngữ chính
Python
Star
4.5k
Fork
391
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của sqlalchemy/alembic

Tất cả issue của sqlalchemy/alembic

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.