Database drivers become optional extras

未關閉
#1,626 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 6 天內回覆

@dimitri-yatsenko 已經在處理了。

開始於 2026年10月17日。

  • #1628 來自 @dimitri-yatsenko —— 未關閉

評估

難度
4/5
預估耗時
3-5 天
新手友好度
35/100
Issue 類型
重構
描述清晰度
描述清楚
活躍度
停滯
技術堆疊
mysql, postgresql, python

研究方向

Start by reviewing the packaging metadata for the PostgreSQL and MySQL extras, the test dependency group, and the adapter registry and connection paths. Update adapters so drivers are imported only when connecting, with missing-driver errors naming the correct extra, while preserving conda run requirements. Run the relevant packaging and adapter tests; done means bare installs load no drivers, each extra supplies its driver, test/dev environments include both, and PostgreSQL code catches DataJointError.

由索引模型根據 Issue 內容生成。

描述

enhancement

Motivation

DataJoint supports two production database backends, PostgreSQL and MySQL, but the two drivers are packaged differently:

  • pymysql (MySQL) is a core dependency. Every pip install datajoint installs it, including installs that only ever connect to PostgreSQL.
  • psycopg2-binary (PostgreSQL) is the optional datajoint[postgres] extra.

import datajoint also imports pymysql at load time, through the adapter registry, and imports psycopg2 too when it happens to be installed. A process that never connects to a database still loads both drivers.

Treating the backends alike means each driver is installed only when it is needed. It also leaves room for more backends later without adding a hard dependency for each one.

The change

  • Every database driver becomes an optional extra:

    • pip install "datajoint[postgres]" installs psycopg2-binary
    • pip install "datajoint[mysql]" installs pymysql (same >=0.7.2 floor as today)
  • A bare pip install datajoint installs no database driver, and import datajoint loads none.

  • Each adapter imports its driver when a connection is made. When the driver is missing, connecting raises a DataJointError that names the extra, e.g.:

    The MySQL backend requires the pymysql driver, which is not installed. Install it with: pip install "datajoint[mysql]"
    

    The PostgreSQL adapter raises the same kind of error. It used to raise ImportError.

  • The PostgreSQL adapter imports the psycopg2 module, so either the psycopg2 or the psycopg2-binary distribution satisfies it.

  • The test dependency group and the test and dev extras install every driver.

  • conda has no extras, so the conda-forge package keeps listing the drivers as run requirements.

Migration for MySQL users

  • Install the MySQL extra: pip install "datajoint[mysql]". In a requirements file, write datajoint[mysql] in place of datajoint.
  • An upgrade in place keeps a pymysql that is already installed. A fresh environment built from a requirements file that lists only datajoint has no driver, and the first connection says which extra to install.
  • Code that caught ImportError from PostgreSQLAdapter() should catch DataJointError.
主要語言
Python
星號
198
分支
103
平均合併
6 天 1 小時
30 天內合併 PR
10

環境準備

  • 提供 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

datajoint/datajoint-python 的其他 Issue

查看 datajoint/datajoint-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。