Database drivers become optional extras

Ouverte
#1,626 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 6 jours

@dimitri-yatsenko y travaille déjà.

Depuis le 17/10/2026.

  • #1628 par @dimitri-yatsenko — ouverte

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Refactorisation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
mysql, postgresql, python

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
Python
Étoiles
198
Forks
103
Merge moyen
6 j 1 h
PR mergées (30 j)
10

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de datajoint/datajoint-python

Toutes les issues de datajoint/datajoint-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.