Flask-SQLAlchemy import/context issue

by

The flask_sqlalchemy module does not have to be initialized with the app right away – you can do this instead:

# apps.members.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class Member(db.Model):
    # fields here
    pass

And then in your application setup you can call init_app:

# apps.application.py
from flask import Flask
from apps.members.models import db

app = Flask(__name__)
# later on
db.init_app(app)

This way you can avoid cyclical imports.

This pattern does not necessitate the you place all of your models in one file. Simply import the db variable into each of your model modules.

Example

# apps.shared.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()


# apps.members.models
from apps.shared.models import db

class Member(db.Model):
    # TODO: Implement this.
    pass


# apps.reporting.members
from flask import render_template
from apps.members.models import Member

def report_on_members():
    # TODO: Actually use arguments
    members = Member.filter(1==1).all()
    return render_template("report.html", members=members)


# apps.reporting.routes
from flask import Blueprint
from apps.reporting.members import report_on_members

reporting = Blueprint("reporting", __name__)

reporting.route("/member-report", methods=["GET","POST"])(report_on_members)


# apps.application
from flask import Flask
from apps.shared import db
from apps.reporting.routes import reporting

app = Flask(__name__)
db.init_app(app)
app.register_blueprint(reporting)

Note: this is a sketch of some of the power this gives you – there is obviously quite a bit more that you can do to make development even easier (using a create_app pattern, auto-registering blueprints in certain folders, etc.)

More Related Contents:

  1. How to execute raw SQL in Flask-SQLAlchemy app
  2. jsonify a SQLAlchemy result set in Flask [duplicate]
  3. How to build a flask application around an already existing database?
  4. Flask Download a File
  5. Implementing Flask-Login with multiple User Classes
  6. Flask sqlalchemy many-to-many insert data
  7. How to delete a record by id in Flask-SQLAlchemy
  8. Is a SQLAlchemy query vulnerable to injection attacks?
  9. Flask-SQLAlchemy db.create_all() raises RuntimeError working outside of application context
  10. Get inserted key before commit session
  11. Querying with function on Flask-SQLAlchemy model gives BaseQuery object is not callable error
  12. AttributeError: ‘int’ object has no attribute ‘_sa_instance_state’
  13. ImportError: No module named flaskext.sqlalchemy
  14. Getting first row from sqlalchemy
  15. flask-sqlalchemy or sqlalchemy
  16. Flask-SQLAlchemy Constructor
  17. Flask, SQLAlchemy : KeyError: ‘SQLALCHEMY_TRACK_MODIFICATIONS’
  18. Tyring to set up modelview with Flask-Admin causes ImportError
  19. SQLAlchemy ordering by count on a many to many relationship
  20. flask sqlalchemy query with keyword as variable
  21. Configure Flask dev server to be visible across the network
  22. What is the cause of the Bad Request Error when submitting form in Flask application?
  23. How to implement server push in Flask framework?
  24. Auto reloading python Flask app upon code changes
  25. Flask at first run: Do not use the development server in a production environment
  26. Return a download and rendered page in one Flask response
  27. Python Flask Intentional Empty Response
  28. Import could not be resolved/could not be resolved from source Pylance in VS Code using Python 3.9.2 on Windows 10
  29. How to render by Vue instead of Jinja
  30. Decoding base64 from POST to use in PIL

Leave a Comment