python / python/typeshed

Flask-SQLAlchemy-Lite support for flask-migrate

Ouverte
#12,121 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

stubs: improvement
Langage dominant
Python
Étoiles
5.1k
Forks
2.1k
Merge moyen
1 j 19 h
PR mergées (30 j)
82

Description

Flask-SQLAlchemy-Lite was just released which is intended to be a replacement for Flask-SQLAlchemy.
https://flask-sqlalchemy-lite.readthedocs.io/en/stable/

With that there is then a type conflict with flask_migrate:
https://github.com/python/typeshed/blob/main/stubs/Flask-Migrate/flask_migrate/__init__.pyi#L52

It expects flask_sqlalchemy.extension.SQLAlchemy, but flask_sqlalchemy_lite._extension.SQLAlchemy is now a compatible alternative

I'm pretty new to python so I'm not sure what the best approach to allow the flask_migrate typings to allow both.

Would it work to:

# ...
from flask_sqlalchemy import SQLAlchemy
from flask_sqlalchemy_lite import SQLAlchemy as SQLAlchemyLite
# ...
class Migrate:
    configure_callbacks: list[_ConfigureCallback]
    db: SQLAlchemy | SQLAlchemyLite | None
    # ...

Or is there a better approach?

Guide de contribution

Ouvrir le guide de contribution

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.

Piste de recherche

Commencez par le stub Flask-Migrate dans stubs/Flask-Migrate/flask_migrate/init.pyi, en particulier le type SQLAlchemy autour de la ligne 52, et consultez la documentation liée de Flask-SQLAlchemy-Lite. Déterminez une approche de typage qui accepte les deux implémentations de SQLAlchemy sans introduire de conflit d’importation ou de compatibilité ; c’est terminé lorsque le stub prend correctement en charge l’une ou l’autre intégration.

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

Évaluation

Stack technique
flask, python, sqlalchemy
Domaine
backend, tooling
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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